LiveRoomViewController
class LiveRoomViewController : SWBaseViewController, UIGestureRecognizerDelegate, AVCaptureVideoDataOutputSampleBufferDelegate, AVCaptureAudioDataOutputSampleBufferDelegate
Undocumented
-
UIView which contains elapsed time label and network strength icon at view’s top.
Declaration
Swift
@IBOutlet weak var timerAndNetworkView: UIView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var backgroundImageView: UIImageView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var blurView: UIView!
-
Undocumented
Declaration
Swift
var bgImage: UIImage?
-
Undocumented
Declaration
Swift
@IBOutlet weak var joinButtonView: UIView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var DraggableBtnCenterConstraint: NSLayoutConstraint!
-
Undocumented
Declaration
Swift
@IBOutlet weak var joinRoomBarView: UIView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var joinBtn: UIButton!
-
Undocumented
Declaration
Swift
@IBOutlet weak var joinDraggableView: UIView!
-
UILabel to show elapsed time over total broadcast time.
Declaration
Swift
@IBOutlet weak var timerLabel: UILabel!
-
UIView which contains timer label.
Declaration
Swift
@IBOutlet weak var timerLabelContainerView: UIView!
-
UILabel to show static label of
Broadcast is ending soon
This label should appear for last 30 seconds for 2 minutes broadcast or for last 60 seconds for other broadcasts duration.Declaration
Swift
@IBOutlet weak var broadcastEndingSoonLbl: UILabel!
-
UIButton at view’s bottom.
Declaration
Swift
@IBOutlet weak var remoteContainerView: UIView!
-
Undocumented
Declaration
Swift
@IBOutlet var sessionButtons: [UIButton]!
-
UIButton to switch between front and back camera.
Declaration
Swift
@IBOutlet weak var backCameraButton: UIButton!
-
NSLayoutConstraint to animate camera button when scroll pages.
Declaration
Swift
@IBOutlet weak var backCameraButtonLeftConstraint: NSLayoutConstraint!
-
UILabel to appear for 1 second only when camera button is clicked to show
Back On
orFront On
Declaration
Swift
@IBOutlet weak var cameraBtnLbl: UILabel!
-
UIButton to close this view.
Declaration
Swift
@IBOutlet weak var leaveButton: UIButton!
-
Should show action sheet with options depends on current user when clicked.
Declaration
Swift
@IBOutlet weak var activityBtn: UIButton!
-
NSLayoutConstraint to animate activity button when scroll pages.
Declaration
Swift
@IBOutlet weak var activityButtonRightConstraint: NSLayoutConstraint!
-
NSLayoutConstraint to animate close button when scroll pages.
Declaration
Swift
@IBOutlet weak var leaveButtonRightConstraint: NSLayoutConstraint!
-
UIImageView used to show gradient shadow at viw’s top.
Declaration
Swift
@IBOutlet weak var gradientTopIV: UIImageView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var previewWaitingScreen: UIView!
-
flash button which is to be shown to the broadcaster only
Declaration
Swift
@IBOutlet weak var flashButton: UIButton!
-
Undocumented
Declaration
Swift
@IBOutlet weak var zoomSlider: UISlider! { get set }
-
Undocumented
Declaration
Swift
@IBOutlet weak var zoomSliderHeightConstraints: NSLayoutConstraint!
-
Undocumented
Declaration
Swift
@IBOutlet weak var zoomSliderTrailingConstraints: NSLayoutConstraint!
-
Undocumented
Declaration
Swift
@IBOutlet weak var commentButton: UIControl!
-
Undocumented
Declaration
Swift
@IBOutlet weak var commentPlaceholder: UILabel!
-
commentsbar height constraints which contains the comments bar/ play pause and activity button
Declaration
Swift
@IBOutlet weak var commentsBarHeightConstraints: NSLayoutConstraint!
-
commentsbar view which contains the comments bar/ play pause and activity button
Declaration
Swift
@IBOutlet weak var commentsBarView: UIView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var userIcon: UIImageView!
-
this flag indicates if the user is landed in waiting room; will be set if it is true
Declaration
Swift
var inWaitingRoom: Bool
-
Undocumented
Declaration
Swift
var logginInitiator: LoginInitiator
-
Undocumented
Declaration
Swift
var firebaseDatabaseReference: DatabaseReference?
-
Undocumented
Declaration
Swift
var broadcastHasEndedDialogShown: Bool
-
Undocumented
Declaration
Swift
var timer: Timer?
-
Undocumented
Declaration
Swift
var waitingRoomTimer: Timer?
-
Undocumented
Declaration
Swift
let waitingRoomTime: Int
-
Undocumented
Declaration
Swift
var startBroadcastCountDownTimer: Timer?
-
Undocumented
Declaration
Swift
var startBroadcastCountDownTime: Int
-
Undocumented
Declaration
Swift
var countDownSessionStarted: Bool
-
Undocumented
Declaration
Swift
var endTime: Date
-
Undocumented
Declaration
Swift
var finalTimeText: String
-
Undocumented
Declaration
Swift
var expectedDurationInMilliseconds: Int
-
Undocumented
Declaration
Swift
var timerCounter: Int
-
Undocumented
Declaration
Swift
var viewerStartTime: Int
-
Undocumented
Declaration
Swift
var eventId: NSNumber!
-
Undocumented
Declaration
Swift
var callUuid: NSUUID!
-
Undocumented
Declaration
Swift
var roomName: String!
-
Undocumented
Declaration
Swift
var roomDescription: String!
-
Undocumented
Declaration
Swift
var broadcastId: NSNumber!
-
Undocumented
Declaration
Swift
var hasBeenInvited: Bool
-
Undocumented
Declaration
Swift
var isProfilePopupPresented: Bool
-
Undocumented
Declaration
Swift
var visibilityOfButtons: ButtonVisibility
-
Undocumented
Declaration
Swift
var streamObject: SWStream
-
Undocumented
Declaration
Swift
var profilePopupView: ProfilePopup!
-
Undocumented
Declaration
Swift
var broadcastingReference: DatabaseReference!
-
Undocumented
Declaration
Swift
var broadcastViewerReference: DatabaseReference!
-
Undocumented
Declaration
Swift
var broadcastAttachmentsReference: DatabaseReference!
-
Undocumented
Declaration
Swift
var broadcastChatStatusReference: DatabaseReference!
-
Undocumented
Declaration
Swift
var liveBroadcastWatchStartTimer: Date?
-
Undocumented
Declaration
Swift
var retryJoinApiCallCount: Int
-
Undocumented
Declaration
Swift
var mutedUser: Set<String>
-
Undocumented
Declaration
Swift
var isCurrentUserMuted: Bool
-
Undocumented
Declaration
Swift
var videoQuality: BroadcastQualityType
-
Undocumented
Declaration
Swift
var checkNetworkForParticipant: Bool
-
Undocumented
Declaration
Swift
var enableNetworkQualityTest: Bool
-
Undocumented
Declaration
Swift
var isCommentsDisabled: Bool
-
Undocumented
Declaration
Swift
var overlayCommentVC: SWOverlayCommentsViewController?
-
Reference to Live Messaging view controller
Declaration
Swift
var liveMessagingViewController: SWLiveMessagingViewController?
-
Undocumented
Declaration
Swift
var zoomLevel: CGFloat
-
Undocumented
Declaration
Swift
var maxZoomLevelAllowed: CGFloat
-
Undocumented
Declaration
Swift
var minZoomLevelAllowed: CGFloat
-
UIView to hold all paging views.
Declaration
Swift
var pagingView: UIView!
-
Boolean value to disable / enable paging scrolling.
Declaration
Swift
var isPagingScrollDisabled: Bool
-
Begin point of pan gesture.
Declaration
Swift
var panBeginPoint: CGPoint!
-
Index of current page. Takes values 0, -1, -2. Default value is -1
Declaration
Swift
var currentPageIndex: CGFloat
-
Undocumented
Declaration
Swift
@objc var isAutoRotateAllowed: Bool
-
Undocumented
Declaration
Swift
var pagingBeginPanFrame: CGRect!
-
Boolean value used to keep Page0 UI controls hidden when fadeOutPageZeroUIControls is called until fadeInPageZeroUIControls is called
Declaration
Swift
var isPage0ControlsHidden: Bool
-
Reference to Processing view controller, it is nil as long as processing view is not shown yet.
Declaration
Swift
var processingVC: KLProcessingScreenViewController?
-
Undocumented
Declaration
Swift
var scheduleProcessingVC: SWScheduleLandingViewController?
-
Undocumented
Declaration
Swift
var scheduledOrProcessingVC: SWScheduleOrProcessingViewController?
-
Reference to merged broadcast details view controller.
Declaration
Swift
var mergedDetailsVC: SWMergedBroadcastDetailsViewController!
-
Undocumented
Declaration
Swift
var overlayViewController: SWBroadcastOverlayViewController?
-
Constant key used to count how many times couch mark was shown when finish recording and going to enter waiting room and to access related view controller within storyboard.
Declaration
Swift
static let kStartGreenRoomCoachMarkKey: String
-
Undocumented
Declaration
Swift
var clapsViewController: SWClapsViewController?
-
Undocumented
Declaration
Swift
var likeViewTapGesture: UITapGestureRecognizer?
-
Undocumented
Declaration
Swift
var pinchToZoomGesture: UIPinchGestureRecognizer?
-
Undocumented
Declaration
Swift
var clientRole: AgoraClientRole
-
Undocumented
Declaration
Swift
var clientSubRole: AgoraRtcClientSubRole
-
this indicates whether the flash is turned on by user
Declaration
Swift
var flashOn: Bool
-
AVPlayer used to play and control recorded broadcast.
Declaration
Swift
var player: AVPlayer?
-
AVPlayerLayer used to show recorded broadcast at the view.
Declaration
Swift
var playerLayer: AVPlayerLayer?
-
indicates the number of pages added in view controller; currently its 3 (-1, 0, +1)
Declaration
Swift
var numberOfpages: CGFloat
-
to refresh the view as per the orientation when the current view is presented at the top
Declaration
Swift
var refreshViewToLandscapeOrientation: Bool
-
Undocumented
Declaration
Swift
var playerPaused: Bool
-
Undocumented
Declaration
Swift
var playerRechedEnd: Bool
-
Undocumented
See moreDeclaration
Swift
enum BroadcastActionState : String
-
Undocumented
Declaration
Swift
var broadcastActionState: LiveRoomViewController.BroadcastActionState
-
Boolean value indicates if video should be recorded or broadcasted live.
Declaration
Swift
var isRecordingMode: Bool
-
AVCaptureSession used for video and audio capturing for recording mode.
Declaration
Swift
var cameraSession: AVCaptureSession!
-
Screenshot of recording broadcast to be saved to a file and uploaded along with recorded broadcast.
Declaration
Swift
var recordingBroadcastScreenshot: UIImage?
-
CALayer used to show camera’s video.
Declaration
Swift
var previewLayer: AVCaptureVideoPreviewLayer?
-
File name used to record broadcast locally.
Declaration
Swift
var recordingFileName: String
-
AVAssetWriter used to write video file.
Declaration
Swift
var videoWriter: AVAssetWriter!
-
AVAssetWriterInput used to pass video data from AVCaptureVideoDataOutput to AVAssetWriter for recording mode.
Declaration
Swift
var videoWriterInput: AVAssetWriterInput!
-
AVCaptureVideoDataOutput used to pass video data from AVCaptureSession to AVAssetWriterInput for recording mode.
Declaration
Swift
var videoDataOutput: AVCaptureVideoDataOutput!
-
AVAssetWriterInput used to pass audio data from AVCaptureAudioDataOutput to AVAssetWriter
Declaration
Swift
var audioWriterInput: AVAssetWriterInput!
-
AVCaptureAudioDataOutput used to pass audio data from AVCaptureSession to AVAssetWriterInput
Declaration
Swift
var audioDataOutput: AVCaptureAudioDataOutput!
-
Boolean value to indicate if captured data from capture session should be recorded to video file.
Declaration
Swift
var isRecording: Bool
-
Holds time when recording started. Used to update UI.
Declaration
Swift
var recordingStartTimeStamp: CMTime?
-
Holds time of last recorded data sample.
Declaration
Swift
var lastRecordedTimeStamp: CMTime?
-
refresh the plus one screen when you scroll to plus one screen
Declaration
Swift
var refreshPlusOneScreen: Bool
-
indiates the device orientation
Declaration
Swift
@objc var deviceOrientation: UIInterfaceOrientation
-
this icon is used to change the device orientation
Declaration
Swift
@IBOutlet weak var orientationButton: UIButton!
-
Undocumented
Declaration
Swift
@IBOutlet weak var orientationButtonLeadingConstraint: NSLayoutConstraint!
-
Undocumented
Declaration
Swift
var orienatationButtonLeadingOffset: CGFloat
-
this variable is used to set the offset to be considered when the backcamera is visible
Declaration
Swift
var orientationButtonLeadingConstraintOffset: CGFloat { get }
-
Undocumented
Declaration
Swift
override var shouldAutorotate: Bool { get }
-
Undocumented
Declaration
Swift
@IBOutlet weak var countDownView: UIView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var countDownImageView: UIImageView!
-
Undocumented
Declaration
Swift
@IBOutlet weak var countDownLabel: UILabel!
-
Undocumented
Declaration
Swift
var isLiveStarted: Bool
-
Hide status bar.
Declaration
Swift
override var prefersStatusBarHidden: Bool { get }
-
Undocumented
Declaration
Swift
override var preferredStatusBarStyle: UIStatusBarStyle { get }
-
Undocumented
Declaration
Swift
var rtcEngine: AgoraRtcEngineKit!
-
Undocumented
Declaration
Swift
fileprivate lazy var agoraEnhancer: AgoraYuvEnhancerObjc? { get set }
-
Undocumented
Declaration
Swift
fileprivate var isBroadcaster: Bool { get }
-
Undocumented
Declaration
Swift
fileprivate var isFrontCameraOn: Bool { get set }
-
Undocumented
Declaration
Swift
var isMuted: Bool { get set }
-
Undocumented
Declaration
Swift
var isSpeakerOff: Bool { get set }
-
Undocumented
Declaration
Swift
var isSpeakerOffStatusBeforeGoingInBackground: Bool
-
Undocumented
Declaration
Swift
fileprivate var videoSessions: [AGBVideoSession] { get set }
-
Undocumented
Declaration
Swift
fileprivate var fullSession: AGBVideoSession? { get set }
-
Undocumented
Declaration
Swift
fileprivate let animator: SWAnimator
-
Undocumented
Declaration
Swift
fileprivate let viewLayouter: AGBVideoViewLayouter
-
Undocumented
Declaration
Swift
func liveOrJoinBtnTappedOrDragged()
-
Undocumented
Declaration
Swift
func joinAsParticipant()
-
Undocumented
Declaration
Swift
@IBAction func liveOrJoinBtnTapped(_ sender: Any)
-
Handler for Pan event of Live or Waiting Room draggable button. Drag the button among user action and decide for proper action when button is released.
Declaration
Swift
@objc func liveRoomButtonDidDragged(_ gestureRecognizer: UIPanGestureRecognizer)
Parameters
gestureRecognizer
<#gestureRecognizer description#>
-
Should open action sheet with the following options.
- Share (all users)
- Invite (Broadcaster)
Report (Viewers)
Declaration
Swift
@IBAction func activityBtnClicked(_ sender: Any)
Parameters
sender
-
Handler for tapping messages button. It should show messages view; which is part of comment view controller.
Declaration
Swift
@IBAction func commentButtonClicked(_ sender: Any?)
Parameters
sender
<#sender description#>
-
Undocumented
Declaration
Swift
func openComments()
-
Undocumented
Declaration
Swift
func setCommentsVCCallbacks()
-
Undocumented
Declaration
Swift
@IBAction func flashButtonTapped(_ sender: Any)
-
Undocumented
Declaration
Swift
func toggleFlash()
-
specifies if the flash icon is to be shown or not
Declaration
Swift
func shouldFlashIconVisible() -> Bool
Return Value
true/ false
-
specifies if the zoomslider be visible
Declaration
Swift
func shouldZoomSliderBeVisible() -> Bool
Return Value
true/ false
-
Specifies if the orientation change button should be visible or not
Declaration
Swift
func shouldOrientationButtonBeVisible() -> Bool
Return Value
<#return value description#>
-
Undocumented
Declaration
Swift
override func viewDidLoad()
-
Undocumented
Declaration
Swift
func setZoomSliderHeight()
-
Instantiate video writer then add video and audio inputs to it.
Declaration
Swift
func initializeVideoAndAudioWriter()
-
this functions changes the view of mute options
Declaration
Swift
func adjustMuteOptionView()
-
When a user is blocked, check if it is creator of current broadcast then close it.
Declaration
Swift
@objc func userBlockedHandler(notification: Notification)
Parameters
notification
notification data
-
Returns proper Camera (AVCaptureDevice has AVMediaTypeVideo) for specified position (Front / Back) or default device if not found.
Declaration
Swift
func cameraDeviceForCurrentSelectedPosition() -> AVCaptureDevice
Parameters
position
<#position description#>
Return Value
<#return value description#>
-
Delegate method being invoked when video and audio data output buffer receive sample buffer. This method should pass received sample buffer to asset writer input.
Declaration
Swift
func captureOutput(_ output: AVCaptureOutput, didOutput sampleBuffer: CMSampleBuffer, from connection: AVCaptureConnection)
Parameters
output
<#output description#>
sampleBuffer
<#sampleBuffer description#>
connection
<#connection description#>
-
Undocumented
Declaration
Swift
func canRotate()
-
Undocumented
Declaration
Swift
override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator)
-
Undocumented
Declaration
Swift
func refreshUIViewBeforeOrientationChanges(toInterfaceOrientation: UIInterfaceOrientation)
-
Undocumented
Declaration
Swift
func refreshUIViews()
-
set the orientation to specified input
Declaration
Swift
func setOrientation(to: UIInterfaceOrientation)
Parameters
to
<#to description#>
-
responds to the orientation button tapped
Declaration
Swift
@IBAction func orientationButtonTapped(_ sender: UIButton)
Parameters
sender
<#sender description#>
-
this sets the orientation of the frame as per received from the server
Declaration
Swift
func setOrientationReceivedFromStream()
-
Undocumented
Declaration
Swift
override func viewWillAppear(_ animated: Bool)
-
Undocumented
Declaration
Swift
override func viewDidAppear(_ animated: Bool)
-
Undocumented
Declaration
Swift
override func viewWillDisappear(_ animated: Bool)
-
this coachmarks to be shown when the broadcast is live
Declaration
Swift
func showCoachmarks()
-
show the loading screen till the time we get the latest status of the braodcast from the server
Declaration
Swift
func showLoadingScreen()
-
Undocumented
Declaration
Swift
func showCommentPlaceholderText()
-
Undocumented
Declaration
Swift
func startBroadcastFromScheduleState()
-
Undocumented
Declaration
Swift
func showScheduleOrProcessingViewWith(state: ScheduleOrProcessingScreenState)
-
sets the processing screen frame as per the orienation set
Declaration
Swift
func setProcessingScreenFrame()
-
Hides the processing screen shown
Declaration
Swift
func hideProcessingScreen()
-
Scroll paging view to Page0 which has index of -1
Declaration
Swift
@objc func scrollToPage0()
-
Implement scrolling horizontally with animation.
Declaration
Swift
@objc func panGestureRecognizerHandler(panGesture: UIPanGestureRecognizer)
Parameters
panGesture
<#panGesture description#>
-
Undocumented
Declaration
Swift
func setupPermissions()
-
Undocumented
Declaration
Swift
func resolveMicrophonePermission()
-
Undocumented
Declaration
Swift
func requestForAudioPermission()
-
Undocumented
Declaration
Swift
func setupFirebaseSockets()
-
Undocumented
Declaration
Swift
func setupBroadcastingReference()
-
Undocumented
Declaration
Swift
private func handlePreviewUnavailable()
-
Undocumented
Declaration
Swift
private func updateLoggedInUserstatus()
-
makes and api call to get all teh references and update the references on -1 screen
Declaration
Swift
func getOrUpdateReferences()
-
this function writes the current time of
Declaration
Swift
func writeCountDownEventInFirebaseDatabase()
-
this method updates the data shown to user when the bottom action is pressed
Declaration
Swift
func updateOverlayOptionsAndData()
-
Undocumented
Declaration
Swift
func setupConnectionReference()
-
Undocumented
Declaration
Swift
func writeDisconnectionToDatabaseIfBroadcaster(ref: DatabaseReference, value: [String : Any])
-
Undocumented
Declaration
Swift
func setupModel()
-
Undocumented
Declaration
Swift
func loadLayeredViewControllerForChildViewControllers()
-
reloads the layout for the paging views
Declaration
Swift
func reloadLayoutOfPagingViews()
-
adding the plus one screen to the paging
Declaration
Swift
func addPlusOneViewToPageView()
-
Undocumented
Declaration
Swift
func setPlusOneViewFrame()
-
adds the overlayview controller view to the paging view
Declaration
Swift
func addOverlayViewToPageView()
-
Undocumented
Declaration
Swift
func setOverlayViewFrame()
-
adds the claps layer onto the 0th layer of the scrollview with the lapha value as 0
Declaration
Swift
func addClapsView()
-
Undocumented
Declaration
Swift
func setClapsViewFrame()
-
checks and refresh the claps position based on the orientation
Declaration
Swift
func setClapsPosition()
-
adds the message view to the
Declaration
Swift
func addMessageViewToPageView()
-
Undocumented
Declaration
Swift
func setMessageViewFrame()
-
adds a tap gestures for the
Declaration
Swift
func enableZoomTapGesture()
-
allows the broadcaster to zoom on the recorded view
Declaration
Swift
@objc func pinchToZoom(sender: UIPinchGestureRecognizer)
-
Undocumented
Declaration
Swift
@IBAction func zoomLevelChanged(_ sender: UISlider)
-
Undocumented
Declaration
Swift
func getDevice() -> AVCaptureDevice?
-
sets the zoom at the level specified; depending on the stream type
Declaration
Swift
func setZoomAt(level: CGFloat)
Parameters
level
<#level description#>
-
options to display actions could be taken for the broadcast
Declaration
Swift
func addOverlayView()
-
add video player view to display the preview
Declaration
Swift
func addVideoPreviewScreen()
-
pause the video if preview is playing and vice versa
Declaration
Swift
@IBAction func playPauseVideoPreview(_ sender: UIButton)
Parameters
sender
<#sender description#>
-
Handler for changes of player state. rate (Play / pause) should be passed to chat controller (commentView) playbackBufferEmpty should show activity view. playbackLikelyToKeepUp, playbackBufferFull should hide activity view.
Declaration
Swift
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?)
Parameters
keyPath
<#keyPath description#>
object
<#object description#>
change
<#change description#>
context
<#context description#>
-
callback for the player has ended the preview
Declaration
Swift
@objc func playerDidReachEnd()
-
Undocumented
Declaration
Swift
func replayVideo()
-
decides and plays the video preview
Declaration
Swift
func playPauseVideoPreview()
-
stops playing the video and removing the video
Declaration
Swift
func closePreviewPlayer()
-
Undocumented
Declaration
Swift
func setupUI()
-
timer for the regular broadcast
Declaration
Swift
func setupTimer()
-
Undocumented
Declaration
Swift
@objc func updateTimerLabelForLiveBroadcast()
-
Return boolean value to indicate if Broadcast ending soon label should be shown at UI according to current user and provided total time and current time
Declaration
Swift
func shouldShowBroadcastEndingLabel(totalTime: Int, currentTime: Int) -> Bool
Parameters
totalTime
<#totalTime description#>
currentTime
<#currentTime description#>
Return Value
<#return value description#>
-
Undocumented
Declaration
Swift
func updateTimerUI()
-
update timer for greenRoom
Declaration
Swift
func updateGreenRoomTimerUI()
-
Undocumented
Declaration
Swift
func timeInMinutesAndSecondsFormatFor(time: Int) -> String
-
Hides label of camera button. Used as a method to support legacy timer methods.
Declaration
Swift
@objc func hideCameraBtnLbl()
-
Undocumented
Declaration
Swift
@IBAction func doSwitchCameraPressed(_ sender: UIButton)
-
Handler for tapping mute mic button. It should toggle state of muting the mic.
Declaration
Swift
func muteMicBtnClicked()
Parameters
sender
<#sender description#>
-
Undocumented
Declaration
Swift
@objc func muteSpeakerIfUnmuted()
-
Undocumented
Declaration
Swift
@objc func unMuteSpeakerIfMutedEarlier()
-
Handler for tapping mute speaker button. It should toggle state of muting the speaker.
Declaration
Swift
func muteSpeakerBtnClicked()
Parameters
sender
<#sender description#>
-
Fade out all UI controls related to Page 0
Declaration
Swift
func fadeOutPageZeroUIControls()
-
hides all the page 0 controls and displays the acitiybutton by bringing it in front used for WIP
Declaration
Swift
func showOnlyActivityIndicator()
-
Fade in all UI Controls related to Page 0
Declaration
Swift
func fadeInPageZeroUIControls()
-
this function has to be called if its confirm that the logged in user is invited as participant to the broadcast and currently not joined as broadcast
Declaration
Swift
func checkAndShowActionButtonForParticipant()
-
Makes an api call to denote the broadcast is started and should be avialable for all users (only for broadcast) Makes an api call to join the broadcast as participant
Declaration
Swift
@IBAction func broadcastActionButtonPressed(_ sender: UIButton)
Parameters
sender
button pressed
-
Undocumented
Declaration
Swift
func removeScheduledUILayer()
-
show the countdown for the broadcast to go live
Declaration
Swift
func startAboutToGoLiveCountdown()
-
Undocumented
Declaration
Swift
func showLayoutViewsOnLiveFromSchedule()
-
Undocumented
Declaration
Swift
func setCountdownLabel()
-
Undocumented
Declaration
Swift
@objc func updateCountdownLabel()
-
makes an api call to indicate that the broadcast is about to go live
Declaration
Swift
func sendBroadcastAPICall()
-
Undocumented
Declaration
Swift
@IBAction func doLikePressed(_ sender: UIButton)
-
Undocumented
Declaration
Swift
@IBAction func doDoubleTapped(_ sender: UITapGestureRecognizer)
-
Undocumented
Declaration
Swift
deinit
-
Undocumented
Declaration
Swift
@objc func forceCloseBroadcast()
-
Undocumented
Declaration
Swift
func closeBroadcast(isForced: Bool)
-
Undocumented
Declaration
Swift
@IBAction func doLeavePressed(_ sender: UIButton)
-
Undocumented
Declaration
Swift
class func checkAndDismissLiveRoomControllerIfPresent(successBlock:@escaping ((Bool) -> Void))
-
Undocumented
Declaration
Swift
func updateScreenName()
-
Undocumented
Declaration
Swift
func minusOneScreenName() -> ScreenName?
-
Undocumented
Declaration
Swift
func plusOneScreenName() -> ScreenName?
-
Undocumented
Declaration
Swift
func trackPageScroll(from fromIndex: CGFloat, to toIndex: CGFloat)
-
Undocumented
Declaration
Swift
func trackEvent(eventName:EventName,eventProperty:[EventProperties: String]? = nil)
-
Undocumented
Declaration
Swift
@objc func appEntersBackground()
-
Undocumented
Declaration
Swift
@objc func appEntersForeground()
-
Undocumented
Declaration
Swift
func updateButtonsVisiablity()
-
Undocumented
Declaration
Swift
func setupCustomButtons()
-
Undocumented
Declaration
Swift
func invalidateWaitingRoomTimer()
-
Undocumented
Declaration
Swift
func leaveChannel(dismissView: Bool = true)
-
Undocumented
Declaration
Swift
func cleanUpCamera()
-
Undocumented
Declaration
Swift
func disconnectCall()
-
Undocumented
Declaration
Swift
func updateServer(completion: ((Bool) -> ())?)
-
Force dismiss this view controller and any presented view by keep calling dissmis view controller method until this view controller is deattached from UI herarchy
Declaration
Swift
func forceDismissSelfAndAllPresentedView(animated: Bool)
Parameters
animated
<#animated description#>
-
Undocumented
Declaration
Swift
func closeRoom()
-
Undocumented
Declaration
Swift
func openPublishQuickLiveVC()
-
End recording broadcast for recording mode only.
Declaration
Swift
func endRecording()
-
Undocumented
Declaration
Swift
func checkOrUpdateRecordedVideo()
-
Undocumented
Declaration
Swift
func setIdleTimerActive(_ active: Bool)
-
Undocumented
Declaration
Swift
func alert(string: String)
-
Undocumented
Declaration
Swift
func alertWithCloseFor(message: String)
-
Undocumented
Declaration
Swift
func updateInterface(withAnimation animation: Bool)
-
Undocumented
Declaration
Swift
func updateInterface()
-
Undocumented
Declaration
Swift
func setStreamType(forSessions sessions: [AGBVideoSession], fullSession: AGBVideoSession?)
-
Undocumented
Declaration
Swift
func addLocalSession()
-
Undocumented
Declaration
Swift
func setupLocalVideoWith(session: AGBVideoSession)
-
Undocumented
Declaration
Swift
func fetchSession(ofUid uid: Int64) -> AGBVideoSession?
-
Undocumented
Declaration
Swift
func videoSession(ofUid uid: Int64) -> AGBVideoSession
-
Undocumented
Declaration
Swift
func loadAgoraKit()
-
Undocumented
Declaration
Swift
func setAgoraKitConstants()
-
Undocumented
Declaration
Swift
func initializeAgoraRtcEngine()
-
join the channel initiated
Declaration
Swift
func joinBroadcast()
-
Undocumented
Declaration
Swift
func rtcEngine(_ engine: AgoraRtcEngineKit, firstRemoteVideoDecodedOfUid uid: UInt, size: CGSize, elapsed: Int)
-
Undocumented
Declaration
Swift
func rtcEngine(_ engine: AgoraRtcEngineKit, firstLocalVideoFrameWith size: CGSize, elapsed: Int)
-
Undocumented
Declaration
Swift
func rtcEngine(_ engine: AgoraRtcEngineKit, didJoinedOfUid uid: UInt, elapsed: Int)
-
Undocumented
Declaration
Swift
func rtcEngine(_ engine: AgoraRtcEngineKit, didOfflineOfUid uid: UInt, reason: AgoraUserOfflineReason)
-
Undocumented
Declaration
Swift
func rtcEngineCameraDidReady(_ engine: AgoraRtcEngineKit)
-
Undocumented
Declaration
Swift
func initialiseCameraView()
-
Undocumented
Declaration
Swift
func rtcEngine(_ engine: AgoraRtcEngineKit, networkQuality uid: UInt, txQuality: AgoraNetworkQuality, rxQuality: AgoraNetworkQuality)
-
this leads to the creation of the live broadcast
Declaration
Swift
func proceedToLiveBroadcast()
-
display error message to user when the network is weak to broadcast
Declaration
Swift
func showWeakNetworkError()
-
Undocumented
Declaration
Swift
func trackViewerView()
-
Undocumented
Declaration
Swift
func trackViewerLike()
-
Undocumented
Declaration
Swift
func trackViewerLeave()
-
Undocumented
Declaration
Swift
func trackModeratorStopBroadcast()
-
Undocumented
Declaration
Swift
func trackParticipantLeaveBroadcast()
-
Undocumented
Declaration
Swift
func trackClickChat()
-
Undocumented
Declaration
Swift
private func streamUpdated(onChatCreation theStream: SWStream!)
-
Undocumented
Declaration
Swift
func likeMessageRecieved(from user: SWUser!)
-
Undocumented
Declaration
Swift
func likeMessageRecieved(withParams paramsDict: NSMutableDictionary!)
-
Undocumented
Declaration
Swift
func broadcastDetailViewControllerShowProfilePopup(for userObj: SWUser!)
-
Undocumented
Declaration
Swift
func broadcastDetailViewControllerExitBroadcast()
-
Undocumented
Declaration
Swift
func openUserProfileWithUserObj(paramUser: SWUser!)
-
Undocumented
Declaration
Swift
func profilePopUpViewCloseAction(sender: UIButton)
-
Undocumented
Declaration
Swift
func shareBroadcast()
-
Undocumented
Declaration
Swift
func inviteSpeakers()
-
Undocumented
Declaration
Swift
func deleteBroadcast()
-
Undocumented
Declaration
Swift
func deleteScheduleBroadcast()
-
Undocumented
Declaration
Swift
func attachText()
-
Undocumented
Declaration
Swift
func attachUrl()
-
this function displays the maximum references limit reached screen
Declaration
Swift
func maxReferenceLimitReached()
-
Undocumented
Declaration
Swift
func reportBroadcastWith(reason: String)
-
Undocumented
Declaration
Swift
func reportBroadcastTapped()
-
Undocumented
Declaration
Swift
func speakerNotes()
-
Undocumented
Declaration
Swift
func broadcastOverlayViewControllerIsMicMuted(_ viewController: SWBroadcastOverlayViewController) -> Bool
-
Undocumented
Declaration
Swift
func broadcastOverlayViewControllerIsSpeakerMuted(_ viewController: SWBroadcastOverlayViewController) -> Bool
-
Undocumented
Declaration
Swift
func broadcastOverlayViewControllerTappedMicButton(_ viewController: SWBroadcastOverlayViewController)
-
Undocumented
Declaration
Swift
func broadcastOverlayViewControllerTappedSpeakerButton(_ viewController: SWBroadcastOverlayViewController)
-
Undocumented
Declaration
Swift
func broadcastOverlayViewController(_ viewController: SWBroadcastOverlayViewController, hideComments hide: Bool)
-
Undocumented
Declaration
Swift
fileprivate func showSpeakerNotesVC(_ notes: String)
-
Undocumented
Declaration
Swift
fileprivate func showEditNotesVC(_ notes: String?)
-
Undocumented
Declaration
Swift
func broadCastReported()
-
Undocumented
Declaration
Swift
func loginSuccessful()
-
Undocumented
Declaration
Swift
func editNotesTapped(_ notes: String)
-
Undocumented
Declaration
Swift
func handleCloseButton()
-
Undocumented
Declaration
Swift
func backButtonTapped(_ notes: String)
-
Undocumented
Declaration
Swift
func saveNotesTapped(_ editSpeakerNotesVC: SWEditSpeakerNotesViewController, notes: String)
-
Undocumented
Declaration
Swift
func handleDismiss()
-
Undocumented
Declaration
Swift
func commentViewControllerTappedBack(_ viewController: SWOverlayCommentsViewController)
-
Undocumented
Declaration
Swift
func commentViewController(_ viewController: SWOverlayCommentsViewController, isUserParticipant userId: NSNumber) -> Bool
-
Undocumented
Declaration
Swift
func isLoginRequired() -> Bool
-
Undocumented
Declaration
Swift
func startLogInFlow(from initiator: LoginInitiator)
-
Undocumented
Declaration
Swift
func handleUserAction(_ viewController: SWLiveMessagingViewController, actionType: LoginInitiator)
-
Undocumented
Declaration
Swift
func messagesTapped(_ viewController: SWLiveMessagingViewController)
-
Undocumented
Declaration
Swift
func clappsViewControllerTappedClap(_ viewController: SWClapsViewController)
-
Undocumented
Declaration
Swift
func handleClap()
-
Undocumented
Declaration
Swift
func likeMessageReceivedFromFB(withLikeMessage likeMessage: SWLikeModel)