HMSSDK

When a peer is requested to change their role (see changeRole) to accept the new role this has to be called. Once this method is called, the peer's role will be changed to the requested one.

API to add plugin

Network quality will begin to be measured and sent into the observer until the call ends. Only one observer may be active at a time. If multiple observers are added, the previous ones will be unregistered.

Change the metadata that appears inside HMSPeer.metadata. This change is persistent and all peers joining after the change will still see these values.

Change the name that appears inside HMSPeer.name This change is persistent and all peers joining after the change will still see these values.

Requests a change of HMSRole to a new role.

Requests a change of HMSRole to a new role.

Requests a change of every peer with any role in ofRoles to have their roles changed to the role toRole.

To change the mute status of a single remote HMSTrack.

To change the mute status of one or many remote HMSTrack for all peers of a particular role, or all tracks of a particular source, type or source AND type.

End the room and make all participants leave.

get current available list of devices type through which audio output can be routed.

get current device type through which audio output is being routed.

API to fetch room token by shortcode

Returns an instance of the local peer if one existed. A local peer only exists during a preview and an active call.

Returns all peers, remote and local.

API to get List of plugins attached

Returns only remote peers. The peer's own instance will not be included in this. To get all peers including the local one consider getPeers or for only the local one consider getLocalPeer.

Returns a HMSRoom object if one is currently active. A room will be present after preview or after join. Will return null if the user is not currently in a preview or a room.

API to fetch layout config by token

A method to check if the screen share is currently active on device

Join the call.

Exit the call.

API to lower local peer's hand

API to lower a remote peer's hand. The remote peer will be notified via HMSUpdateListener.onPeerUpdate

Begin a preview so that the local peer's audio and video can be displayed to them before they join a call.

API to raise local peer's hand

Removes the given peer from the audio/video conference.

API to remove plugin

Sends a message to everyone in the call.

Sends a message a particular peer only. The one specified in peerTo.

Sends the hls error event to analytics.

Sends a message to the roles defined in hmsRolesTo. All peers currently with that role will receive the message.

set a listener to receive updates whenever audio changes.

API to set the mode in which audio mixing needs to be done after capturing the audio from system

API to change Audio Mode manually The most common usecase would be toggle between in-call volume/media volume

Sets the hls-session metadata. This information will be sent as a part of stream when streaming the content.

Does not check to see if permissions are really granted. If they aren't granted it will proceed and the tracks for which permissions are missing will be disabled.

API to start audio share of your android device. Only supported on Android 10 and above

Starts HLS streaming on the parameters described in config.

Starts rtmp streaming or recording on the parameters described in config.

API to start screen share of your android device

API to stop audio share of device

Stop HLS streaming on the parameters described in config.

Stops a previously started rtmp recording or stream. See startRtmpOrRecording for starting.

API to stop screen share

Switch the device through which audio output should be sent.