HMSSDK
Types
Functions
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.
Initializes video pre-processors such as Virtual Background and blur.
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.
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.
Turns noise cancellation on or off dynamically. It only applies when a call is active. No-op if called when no room is joined. To turn on noise cancellation by default look into the property enableNoiseCancellation of live.hms.video.media.settings.HMSAudioTrackSettings and set it in the builder property while creating an HMSSDK instance. Will not be enabled if isNoiseCancellationAvailable returns anything other than AvailabilityStatus.Available. isNoiseCancellationAvailable will also list the reason why it can't be enabled.
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.
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.
Given a peerId, returns the HMSPeer for that peerId.
Gets the list of active plugins.
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.
Fetch layout config by token.
Returns whether noise cancellation is currently enabled. Will always return false if no room is joined. If this is unexpectedly false, check isNoiseCancellationAvailable.
Whether noise cancellation is available. Noise cancellation will not be available if the library is not imported. Look at Docs for details.
A method to check if the screen share is currently active on device
Join the call.
Exit the call.
Lower local peer's hand.
Lowers 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.
Removes a plugin and clears its effects.
Only in a large room, search for a peer's name.
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.
Sets the mode in which audio mixing needs to be done after capturing the audio from system
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.
Starts audio share of your android device. Only supported on Android 10 and above.
Starts HLS streaming on the parameters described in config.
Starts real time transcription for all peers in the room.
Starts rtmp streaming or recording on the parameters described in config.
Start screen sharing from your android device.
Stop audio sharing.
Stop HLS streaming on the parameters described in config.
Stops real time transcription for all peers in the room.
Stops a previously started rtmp recording or stream. See startRtmpOrRecording for starting.
Stops screen share.
Switch the device through which audio output should be sent.