PresentationSettings
class. This class allows you to set the various parameters for the Presentation Mode. In order to set the various parameters of the PresentationSettings
class, you need to use the PresentationSettingsBuilder
class. Below are the various options available with the PresentationSettings
class.
You will need to set the User Type, There are 2 type of users in Presenter Mode, Presenter
& Participant
, You can set this PresentationSettingsBuilder
by using the following method setIsPresenter(true/false)
A basic example of how to start a Presentation:
.setCallEventListener(listeners : OngoingCallListener)
method in CallSettingsBuilder
or PresenterSettingsBuilder
class. The second way is to use CometChatCalls.addCallEventListener(name: string, callListener: OngoingCallListener)
by this you can add multiple listeners and remove the specific listener by their name CometChatCalls.removeCallEventListener(name: string)
CometChatCallsEventsListener
listener provides you with the below callback methods:
Callback Method | Description |
---|---|
onCallEnded() | This method is called when the call is successfully ended. The call details can be obtained from the Call object provided. |
onCallEndButtonPressed() | This method is called when the user press end call button. |
onUserJoined(user: RTCUser) | This method is called when any other user joins the call. The user details can be obtained from the User object provided. |
onUserLeft(user: RTCUser) | This method is called when a user leaves the call. The details of the user can be obtained from the provided User object. |
onUserListUpdated(users: Array<RTCUser>) | This method is triggered every time a participant joins or leaves the call providing the list of users active in the call |
onAudioModesUpdated(devices: Array<AudioMode>) | This callback is triggered if any new audio output source is available or becomes unavailable. |
onUserMuted(muteObj: RTCMutedUser) | This method is triggered when a user is muted in the ongoing call. |
onRecordingStarted(user: RTCUser) | This method is triggered when a recording starts. |
onRecordingStopped(user: RTCUser) | This method is triggered when a recording stops. |
onError(e: CometChatException) | This method is called when there is some error in establishing the call. |
PresentationSettings
class is the most important class when it comes to the implementation of the Calling feature. This is the class that allows you to customize the overall calling experience. The properties for the call/conference can be set using the PresentationSettingsBuilder
class. This will eventually give you and object of the PresentationSettings
class which you can pass to the joinPresentation()
method to start the call.
The mandatory parameters that are required to be present for any call/conference to work are:
Parameter | Description |
---|---|
setIsPresenter(isPresenter: boolean) | If set to true user will join as the presenter. If set to false user will join as the viewer. |
enableDefaultLayout(defaultLayout: boolean) | If set to true enables the default layout for handling the call operations. If set to false it hides the button layout and just displays the Call View. Default value = true |
showEndCallButton(showEndCallButton: boolean) | If set to true it displays the EndCallButton in Button Layout. If set to false it hides the EndCallButton in Button Layout. Default value = true |
showEndCallButton(showEndCallButton: boolean) | If set to true it displays the PauseVideoButton in Button Layout. If set to false it hides the PauseVideoButton in Button Layout. Default value = true |
showMuteAudioButton (showMuteAudioButton: boolean)“ | If set to true it displays the MuteAudioButton in Button Layout. If set to false it hides the MuteAudioButton in Button Layout. Default value = true |
showSwitchCameraButton (showSwitchCameraButton: boolean)“ | If set to true it displays the SwitchCameraButton in Button Layout. If set to false it hides the SwitchCameraButton in Button Layout. Default value = true |
showAudioModeButton (showAudioModeButton: boolean)“ | If set to true it displays the AudioModeButton in Button Layout. If set to false it hides the AudioModeButton in Button Layout. Default value = true |
setIsAudioOnlyCall(audioOnly: boolean) | If set to true , the call will be strictly an audio call. If set to false , the call will be an audio-video call.Default value = false |
startWithAudioMuted(audioMuted: boolean) | This ensures the call is started with the audio muted if set to true. Default value = false |
startWithVideoMuted(videoMuted: boolean) | This ensures the call is started with the video paused if set to true. Default value = false |
startWithVideoMuted(videoMuted: boolean) | If set to true it displays the Recording in Button Layout. if set to false it hides the Recording in Button Layout. Default value = false |
setDefaultAudioMode(audioMode: string) | This method can be used if you wish to start the call with a specific audio mode. The available options are 1. CometChatCalls.AUDIO_MODE.SPEAKER = “SPEAKER” 2. CometChatCalls.AUDIO_MODE.EARPIECE = “EARPIECE” 3. CometChatCalls.AUDIO_MODE.BLUETOOTH = “BLUETOOTH” 4. CometChatCalls.AUDIO_MODE.HEADPHONES = “HEADPHONES” |
setEventListener(new CometChatCallsEventsListener()) | The CometChatCallsEventsListener listener provides you callbacks |