AgoraLobbyVC

open class AgoraLobbyVC : UIViewController

extension AgoraLobbyVC: UITextFieldDelegate

The AgoraLobbyVC is a UIViewController that provides a manged UIView that gives the user the ability to enter a channel name and choose their role as either a Broadcaster or Audience. Based on their selection an ARBroadcaster or ARAudience ViewController is presented.

Note

All class methods can be extended or overwritten.

debug
Undocumented
Declaration
Swift

public var debug: Bool
banner
The UIImageView containing the banner image vsible within the Lobby view
Declaration
Swift

public var banner: UIImageView?
bannerImage
The UIImage representing the banner image vsible within the Lobby view.
Declaration
Swift

public var bannerImage: UIImage?
bannerFrame
The CGRect that is used as the .frame for the banner
Declaration
Swift

public var bannerFrame: CGRect?
broadcastBtnText
The String used to set the text value for the button that launches the ARBroadcaster
Declaration
Swift

public var broadcastBtnText: String
broadcastBtnColor
The UIColor used to set the text color for the button that launches the ARBroadcaster
Declaration
Swift

public var broadcastBtnColor: UIColor
audienceBtnText
The String used to set the text value for the button that launches the ARAudience
Declaration
Swift

public var audienceBtnText: String
audienceBtnColor
The UIColor used to set the text color for the button that launches the ARAudience
Declaration
Swift

public var audienceBtnColor: UIColor
userInput
The UITextField used to set the set the Agora channel name
Declaration
Swift

public var userInput: UITextField!
textFieldPlaceholder
The String used to set the set the placeholder text value for the userInput text field
Declaration
Swift

public var textFieldPlaceholder: String

VC Events

loadView()
Undocumented
Declaration
Swift

override open func loadView()
viewDidLoad()
Undocumented
Declaration
Swift

override open func viewDidLoad()


                    
                    
                    viewWillAppear(_:)

Undocumented

Declaration

Swift

override open func viewWillAppear(_ animated: Bool)


                    
                    
                    viewDidAppear(_:)

Undocumented

Declaration

Swift

override open func viewDidAppear(_ animated: Bool)


                    
                    
                    viewWillDisappear(_:)

Undocumented

Declaration

Swift

override open func viewWillDisappear(_ animated: Bool)


                    
                    
                    touchesBegan(_:with:)

Undocumented

Declaration

Swift

override open func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?)

Create UI

createUI()
The createUI() method is used to generate the managed UI for the “Lbby”, a view where hte user has the ability to enter a channel name and choose their role within the channel
Declaration
Swift

open func createUI()

Button Actions

createSession()
The createSession method is called whenever the user taps the Broadcast button. Ovveride this method to implement a custom ARBroadcaster.
Declaration
Swift

@IBAction open func createSession()
joinSession()
The joinSession method is called whenever the user taps the Audience button
Declaration
Swift

@IBAction open func joinSession()

Textfield Delegates


                    
                    
                    textFieldDidBeginEditing(_:)

Undocumented

Declaration

Swift

open func textFieldDidBeginEditing(_ textField: UITextField)


                    
                    
                    textFieldDidEndEditing(_:)

Undocumented

Declaration

Swift

open func textFieldDidEndEditing(_ textField: UITextField)


                    
                    
                    textFieldShouldBeginEditing(_:)

Undocumented

Declaration

Swift

open func textFieldShouldBeginEditing(_ textField: UITextField) -> Bool


                    
                    
                    textFieldShouldClear(_:)

Undocumented

Declaration

Swift

open func textFieldShouldClear(_ textField: UITextField) -> Bool


                    
                    
                    textFieldShouldEndEditing(_:)

Undocumented

Declaration

Swift

open func textFieldShouldEndEditing(_ textField: UITextField) -> Bool


                    
                    
                    textField(_:shouldChangeCharactersIn:replacementString:)

Undocumented

Declaration

Swift

open func textField(
    _ textField: UITextField,
    shouldChangeCharactersIn range: NSRange,
    replacementString string: String
) -> Bool


                    
                    
                    textFieldShouldReturn(_:)

Undocumented

Declaration

Swift

open func textFieldShouldReturn(_ textField: UITextField) -> Bool