Class HMSSDK

• Calling this function will accept the most recent roleChange request made by anyone in the room

• This is a temporary solution for the situation when mic access is taken from the app and user returns to the app with no mic access. It will re-acquire the mic by setting the volume from native side

• This is a prototype event listener that takes action and listens for updates related to that particular action

• Attaches all the listeners to native callbacks. Note: this function connects sdk to native side and not app to sdk.

• Attaches preview listener for native callbacks. Note:this function connects sdk to native side and not app to sdk.

• changeMetadata changes a specific field in localPeer which is [metadata] it is a string that can be used for various functionalities like raiseHand, beRightBack and many more that explains the current status of the peer.

• This function can be used to change name of localPeer.

• This function can be used in a situation when we want to change role hence manipulate their access and rights in the current room, it takes the peer HMSPeer whom role we want to change, role HMSRole which will be the new role for that peer and weather to forcefully change the role or ask the to accept the role change request using a boolean force.

• This function can be used to manipulate mute status of any track.
• Targeted peer affected by this action will get a callback in onChangeTrackStateRequestListener.

• changeTrackStateForRoles is an enhancement on the functionality of changeTrackState.
• We can change mute status for all the tracks of peers having a particular role.
• @param source determines the source of the track ex. video, audio etc.
• The peers affected by this action will get a callback in onChangeTrackStateRequestListener.

• Calls removeListeners that in turn breaks all connections with native listeners.

• disable RTCStats sets the same boolean to false that was set true by enableRTCStats. that activates a check which filters out the events acquired in native listeners and don't let them pass through bridge

• enableRTCStats sets a boolean in native side which in turn allows several events to be passed through the bridge these events are RTCStatsListener, onRemoteVideoStatsListener, onRemoteAudioStatsListener, onLocalAudioStatsListener and onLocalVideoStatsListener

• endRoom can be used in a situation where we want to disconnect all the peers from current room and end the call.
• everyone in the room will get an update of this action in onRemovedFromRoomListener.

• getRoom is a wrapper function on an existing native function also known as getRoom the returns current room object which is of type HMSRoom

• Returns a boolean stating if the screen is currently shared or not

takes an instance of HMSConfig and joins the room. after joining the room user will start receiving the events and updates of the room.

Calls leave function of native sdk and session of current user is invalidated.

• Below are all the listeners that are connected to native side.

• preview function is used to initiate a preview for the localPeer.
• We can call this function and wait for a response in previewListener, the response will contain previewTracks for local peer.

• previewForRole can be used when there is role change request for current localPeer and we want to show the localPeer how the tracks look before publishing them to room.

• This function mutes audio for all peers in the room.

removes all the listeners

• This is a prototype event listener that takes action and listens for updates related to that particular action

Disconnects all the listeners of this sdk from native listeners. Note: this function is only called from destroy function and should only be called when the current instance of HMSSDK is not required anymore.

• removePeer can forcefully disconnect a Peer from the room.
• the user who's removed from this action will get a callback in onRemovedFromRoomListener.

• This function sends message to all the peers in the room, the get the message in onMessage listener.

• sendDirectMessage sends a private message to a single peer, only that peer will get the message in onMessage Listener.

• sendGroupMessage sends a message to specific set of roles, whoever has any of those role in room will get the message in onMessage listener.

• Updates the logger for this instance of HMSSDK

• setPlaybackForAllAudio is an extension of the abilities of setPlaybackAllowed in HMSRemoteAudioTrack, it sets mute status for all peers in the room

• This function sets the volume of any peer in the room

• This function starts HLSStreaming.
• we get the response of this function in onRoomUpdate as HLS_STREAMING_STATE_UPDATED.

• startRTMPOrRecording takes a configuration object HMSRTMPConfig and stats the RTMP recording
• this object of HMSRTMPConfig sets the urls for streaming and weather to set recording on or not
• we get the response of this function in onRoomUpdate as RTMP_STREAMING_STATE_UPDATED.

• This function is used to start screenshare, currently available only for android

• stopHLSStreaming function stops the ongoing HLSStreams.
• we get the response of this function in onRoomUpdate as HLS_STREAMING_STATE_UPDATED.

• this function stops all the ongoing RTMP streaming and recording.
• we get the response of this function in onRoomUpdate as RTMP_STREAMING_STATE_UPDATED.

• stops the screenShare, currently available for android only.