authToken
and sessionId
.
authToken
: User can get the auth token from CometChatSDK that has a static method getUsersAuthToken().
sessionId
: Any random string.
Parameter | Description |
---|---|
sessionId | The unique random session ID. In case you are using default call then session ID is available in the Call object. |
userAuthToken | The use auth token is logged in user auth token which you can get by calling CometChat Chat SDK method CometChat.getUserAuthToken() |
Error Code | Error Message |
---|---|
INVALID_ARGUMENT_EXCEPTION | If you pass invalid param to a function or you don’t pass the required params. example: Authtoken and session are required, Invalid callToken passed, please verify. |
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.
PresentationSettingsBuilder
class takes the 1 mandatory parameter as a part of the constructor:
Presenter
& Participant
, You can set this PresentationSettingsBuilder
by using the following method isPresenter(true/false)
A basic example of how to start a Presentation:
The mandatory parameters that are required to be present for any call/conference to work are:
Properties | Description |
---|---|
setIsPresenter(Bool) | If set to true, the user will join the call as a presenter. If set to false, the user will join the call as an audience member. Default value = false |
setDefaultLayout(Bool) | 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 CallView. Default value = true |
setIsAudioOnly(Bool) | 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 |
setEndCallButtonDisable(Bool) | 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 |
setShowRecordingButton(Bool) | If set to true it displays the ShowRecordingButton in Button Layout. If set to false it hides the ShowRecordingButton in Button Layout. Default value = true |
setSwitchCameraButtonDisable(Bool) | 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 |
setMuteAudioButtonDisable(Bool) | If set to true it displays the MuteAudioButton in Button Layout. If set to false it hides the MuteAudioButton in Button Layout. |
setPauseVideoButtonDisable(Bool) | 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 |
setAudioModeButtonDisable(Bool) | 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 |
setStartAudioMuted(Bool) | This ensures the call is started with the audio muted if set to true. Default value = false |
setStartVideoMuted(Bool) | This ensures the call is started with the video muted if set to true. Default value = false |
setDefaultAudioMode(“BLUETOOTH”) | This method can be used if you wish to start the call with a specific audio mode. The available options are SPEAKER, EARPIECE, BLUETOOTH & HEADPHONES |
setDelegate(CallsEventsDelegate.self) | Pass the reference of the UIViewController where the CallsEventsDelegate will conform. |
callToken
and presenterSettings
.
callToken
In the success block of generateToken(), user get the callToken.
PresentationSettings
presenterSettings
can be set from the presentationSettingsBuilder
View
This is going to be the view in which CometChatCalls can load the calling views
Error Code | Error Message |
---|---|
INVALID_PROP_EXCEPTION | If you pass an invalid prop to a functional component or you don’t pass the required prop. example: Component requires valid call settings |
API_ERROR | If there is some error thrown by the API server For example unauthorized |
UNKNOWN_API_ERROR | If there is some API error but it didn’t come from the server. For example, if the internet is not available and API is called. |
AUTH_ERR_TOKEN_INVALID_SIGNATURE | if Token is invalid |
Listener (CallEventsDelegate) | |
---|---|
Listener | Description |
onCallEnded() | This method is called when the call is successfully ended. |
onCallEndButtonPressed() | This method is called when the end call button press. |
onUserJoined(user: NSDictionary) | This method is called when any other user joins the call. The user details can be obtained from the user as parameter. |
onUserLeft(user: NSDictionary) | This method is called when a user leaves the call. The details of the user can be obtained from the provided user as parameter. |
onUserListChanged(userList: NSArray) | This method is triggered when user list changes. |
onAudioModeChanged(audioModeList: NSArray) | This method is triggered when audio mode changes. |
onCallSwitchedToVideo(info: NSDictionary) | This callback is triggered when an audio call is converted into a video call. you will get the information in info as parameter. |
onUserMuted(info: NSDictionary) | This method is triggered when a user is muted in the ongoing call. |
onRecordingToggled(info: NSDictionary) | This method is triggered when a user toggles recording. |