generateToken
method of CometChatCalls
class.
Parameter | Description |
---|---|
sessionID | The unique random session ID. In case you are using default call then session ID is available in the Call object. |
authToken | The use auth token is logged in user auth tooken which you can get by calling CometChat Chat SDK method CometChat.getLoggedinUser() |
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. |
generateToken
method you will get the response object containing call token with key named token
.
CallSettings
class. This class allows you to set the various parameters for the call/conference. In order to set the various parameters of the CallSettings
class, you need to use the CallSettingsBuilder
class. Below are the various options available with the CallSettings
class.
The mandatory parameters that are required to be present for any call/conference to work are:
CometChatCalls.Component
.
Parameter | Description |
---|---|
callToken | Received in generate token onSuccess() method response |
callSettings | Object of CallSettings class. |
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 |
OngoingCallListener
listener provides you with the below callback methods:
Callback Method | Description |
---|---|
onUserJoined(user) | This method is called when any other user joins the call. The user details can be obtained from the User object provided. |
onUserLeft(user) | This method is called when a user leaves the call. The details of the user can be obtained from the provided User object. |
onError() | This method is called when there is some error in establishing the call. |
onCallEnded() | This method is called when the call is successfully ended. The call details can be obtained from the Call object provided. |
onSessionTimeout() Available since v4.2.0 | This method is called when the call is ended due to session timeout. |
onUserListUpdated(userList) | This method is triggered every time a participant joins or leaves the call providing the list of users active in the call. |
onMediaDeviceListUpdated(deviceList) | This method is triggered if any new audio output source is available or becomes unavailable. |
onUserMuted(user) | This method is triggered when a user is muted in the ongoing call. |
onScreenShareStarted() | This method is triggered when the local user starts sharing a screen. |
onScreenShareStopped() | This method is triggered when the local user stops sharing a screen. |
onCallSwitchedToVideo(sessionId, callSwitchInitiatedBy, callSwitchAcceptedBy) | This callback is triggered when an audio call is converted into a video call. |
.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)
CometChat.endCall()
method, which belongs to the CometChat Chat SDK, and the CometChatCalls.endSession()
method, which belongs to the CometChat Calls SDK.
The user who pressed the end call button will call the CometChat.endCall() method, and the another user how was on call will call the two methods which is CometChat.clearActiveCall()
and CometChatCalls.endSession()
methods to release the calling resources
CallSettings
class is the most important class when it comes to the implementation of the Calling feature. This is the class that allows you to customise the overall calling experience. The properties for the call/conference can be set using the CallSettingsBuilder
class. This will eventually give you an object of the CallSettings
class which you can pass to the startCall()
method to start the call.
The options available for customization of calls are:
Setting | Description |
---|---|
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 |
showPauseVideoButton(showPauseVideoButton: 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 |
setMode(mode: string) | CometChat provides 3 options for the calling UI. 1. CometChat.CALL_MODE.DEFAULT 2. CometChat.CALL_MODE.SPOTLIGHT 3. CometChat.CALL_MODE.SINGLE Default value = CometChat.CALL_MODE.DEFAULT |
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 |
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. CometChat.AUDIO_MODE.SPEAKER = “SPEAKER” 2. CometChat.AUDIO_MODE.EARPIECE = “EARPIECE” 3. CometChat.AUDIO_MODE.BLUETOOTH = “BLUETOOTH” 4. CometChat.AUDIO_MODE.HEADPHONES = “HEADPHONES” |
showSwitchToVideoCallButton(switchCall: boolean) | This method shows/hides the switch to video call button. If set to true it will display the switch to video call button. If set to false it will hide the switch to video call button. Default value = true |
setAvatarMode(avatarMode: string) | This method sets the mode of avatar. The avatar mode can be circle , square or fullscreen . Default value = circle |
setMainVideoContainerSetting(containerSettings: MainVideoContainerSetting) | This method can be used to customize the main video container. You can read more about this here. |
enableVideoTileClick(enableVideoTileClick: boolean) | This method can be used to enable/disable video tile click functionality in Spotlight mode. Default value = true |
enableVideoTileDrag(enableVideoTileDrag: boolean) | This method can be used to enable/disable video tile drag functionality in Spotlight mode. Default value = true |
setIdleTimeoutPeriod(idleTimeoutPeriod: number) Available since v4.2.0 | Sets the idle timeout duration for the call. If the user remains the only participant for the specified time, a prompt will appear 60 seconds before the call is automatically ended. Default value = 180 seconds |
switchCamera()
Method to toggle between camera sources.
muteAudio(mute: boolean)
Method to mute your Audio Stream to the end-user.
true
the Audio Stream is muted and if set to false
Audio Stream is transmitted.
pauseVideo(pause: boolean)
Method to pause Video Stream to the end-user.
true
the Video Stream is muted and if set to false
Video Stream is transmitted.
setAudioMode(mode: string)
to set the output of the audio stream.
CometChat.AUDIO_MODE.SPEAKER = "SPEAKER"
CometChat.AUDIO_MODE.EARPIECE = "EARPIECE"
CometChat.AUDIO_MODE.BLUETOOTH = "BLUETOOTH"
CometChat.AUDIO_MODE.HEADPHONES= "HEADPHONES"
switchToVideoCall()
method to switch from audio call to video call.
setAudioMode()
method.
CometChat.AUDIO_MODE.SPEAKER = "SPEAKER"
CometChat.AUDIO_MODE.EARPIECE = "EARPIECE"
CometChat.AUDIO_MODE.BLUETOOTH = "BLUETOOTH"
CometChat.AUDIO_MODE.HEADPHONES= "HEADPHONES"