generateToken
method of CometChatCalls
class.
Parameter | Description |
---|---|
sessionID | A unique random session ID. In case you are using default call then session ID is available in the Call object. |
authToken | The user auth token is logged in user auth token which you can get by calling CometChat’s 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:
setIsAudioOnlyCall()
method allows you to set if the call is supposed to be an audio call or an audio-video call. If set to true, the call will be an audio-only call else when set to false the call will be an audio-video call. The default is false, so if not set, the call will be an audio-video call.
Parameter | Description |
---|---|
callToken | An authorization token used to start the call session, received by calling generateToken method of CometChatCalls class. |
callSettings | Object of CallSettings class. |
htmlElement | DOM element inside which the call UI wll be rendered. |
Error Code | Error Messages |
---|---|
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 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.1.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(event) | This method is triggered when a user is muted in the ongoing call. The event object contains two keys named muted and mutedBy |
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(event) | This callback is triggered when an audio call is converted into a video call. The event object contains three keys named sessionId , initiator and responder |
.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)
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 startSession()
method to start the call.
The options available for customisation 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 |
showScreenShareButton(showScreenShareButton: boolean) | If set to true it displays the ShareScreenButton in Button Layout. if set to false it hides the ShareScreenButton in Button Layout. Default value = true |
showModeButton(showModeButton: boolean) | If set to true it displays the ShowModeButton in Button Layout. if set to false it hides the ShowModeButton 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 2 options for the calling UI. 1. CometChat.CALL_MODE.DEFAULT 2. CometChat.CALL_MODE.SPOTLIGHT 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 |
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 |
setMainVideoContainerSetting(containerSettings: MainVideoContainerSetting) | This method can be used to customize the main video container. You can read more about this here. |
setIdleTimeoutPeriod(idleTimeoutPeriod: number) Available since v4.1.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 |
muteAudio(mute: boolean)
method to mute/unmute your audio stream.
true
the audio stream will be muted and if set to false
the audio stream will be unmuted.
pauseVideo(pause: boolean)
method to pause/unpause video stream.
true
the video stream will be paused and if set to false
the video stream will be unpaused.
startScreenShare()
to start the screen share.
stopScreenShare()
to stop the screen share.
setMode(mode: string)
method to set the mode.
getAudioInputDevices()
method to get all the available audio input devices.
getAudioOutputDevices()
method to get all the available audio output devices.
getVideoInputDevices()
method to get all the available video input devices.
setAudioInputDevice(deviceId)
method to set the active audio input device.
setAudioOutputDevice(deviceId)
method to set the active audio output device.
setVideoInputDevice(deviceId)
method to set the active video input device.
switchToVideoCall()
method to switch from audio call to video call.