Helpers
The following methods used to get the information about current call details, user call status, user audio/video mute/unmute status, etc... So you don't need to store these information in the client side.
#
Get Call InfoTo get the current details such as roomId, calltype & groupId use below method.
#
Sample Response:#
Response Property Details:Property | Description |
---|---|
roomId | Call room ID. |
callType | Describe the audio or video call. |
groupId | Contain the group ID If the call is group call. Otherwise, the value will be NULL. |
isAudioMute | To determine audio is mute or not |
isVideoMute | To determine video is mute or not |
roomLink | Call room Link. |
toUsers | Array of User JID of callee users. |
userDetails | User details object of the callee users. |
#
Get User Call StatusGet a user call status by providing the user JID into getUserCallStatus method. The response will be the status of the user. If no user found, it will return undefined
#
Sample Response:#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
USER_JID | User JID | String | true |
#
Get User Audio mute/unmute stateGet a user audio track mute/unmute state by providing the user JID into isRemoteAudioMuted method. The response will be the boolean based on mute/unmute state.
#
Sample Response:#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
USER_JID | User JID | String | true |
#
Get User Video mute/unmute stateGet a user video track mute/unmute state by providing the user JID into isRemoteVideoMuted method. The response will be the boolean based on mute/unmute state.
#
Sample Response:#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
USER_JID | User JID | String | true |
#
Get All Users in Call Video mute/unmute stateGet all the users in call video track mute/unmute state by using isAllUsersVideoMuted method. The response will be the boolean based on mute/unmute state.
#
Sample Response:#
End a User from Call LocallyEnd (Set a user DISCONNECTED state) a user from call locally which would set the user state as DISCONNECTED locally by using endUserFromCall method. This wouldn't send disconnected state of the user to remote user, it would update in local data only.
#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
USER_JID | User JID | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |