Constructor Detail

Method Detail

• onJoin

   abstract Unit onJoin(HMSRoom room)

  Called when joining of HMSRoom is successful

  Parameters:

  room - : The fully formed HMSRoom object

• onRoomUpdate

   abstract Unit onRoomUpdate(HMSRoomUpdate type, HMSRoom hmsRoom)

  Called if there is any update related to the HMSRoom

  Parameters:

  type - specifies the type of update

  hmsRoom - The updated HMSRoom object

• onPeerUpdate

   abstract Unit onPeerUpdate(HMSPeerUpdate type, HMSPeer peer)

  Called if there is any update related to the HMSPeer

  Parameters:

  type - specifies the type of update of the peer

  peer - is the newly updated HMSPeer object

• onTrackUpdate

   abstract Unit onTrackUpdate(HMSTrackUpdate type, HMSTrack track, HMSPeer peer)

  Called if there is any update related to HMSTrack

  Parameters:

  type - specifies the type of update of the track

  track - the updated HMSTrack object

  peer - the corresponding HMSPeer which contains this track

• onRoleChangeRequest

   abstract Unit onRoleChangeRequest(HMSRoleChangeRequest request)

  Called when there is a non forced role change request from another HMSPeer

  Parameters:

  request - A HMSRoleChangeRequest mentioning the details of the request

• onMessageReceived

   abstract Unit onMessageReceived(HMSMessage message)

  Called when there is a HMSMessage send by another HMSPeer

  Parameters:

  message - : the HMSMessage received

• onReconnecting

   Unit onReconnecting(HMSException error)

  Called when the SDK is trying to reconnect automatically on a network drop/switch etc

  Parameters:

  error - The HMSException that defines the error due to which SDK is trying to reconnect

• onReconnected

   Unit onReconnected()

  Called when the SDK has successfully recovered from a network glitch

• onRemovedFromRoom

   Unit onRemovedFromRoom(HMSRemovedFromRoom notification)

  Called when you have been removed from a room. Causes are:

  • The room was ended for everyone.

  • The receiver particularly was removed from the room.

  Parameters:

  notification - the HMSRemovedFromRoom which contains details.

• onChangeTrackStateRequest

   abstract Unit onChangeTrackStateRequest(HMSChangeTrackStateRequest details)

  Called when a peer remotely changes a track property. For example, forcing the receivers mic to mute.

  Parameters:

  details - a HMSChangeTrackStateRequest that contains details on the request.

• peerListUpdated

   Unit peerListUpdated(ArrayList<HMSPeer> addedPeers, ArrayList<HMSPeer> removedPeers)

  Called when new peers are added to peerlist. Use this to show the list of peers on UI This is called with the intial set of peer on joining a room as well as with update list of peers if some peer joins or leaves the room

  Parameters:

  addedPeers - List of HMSPeer to be added to the list

  removedPeers - List of HMSPeer to be removed from the list

• onSessionStoreAvailable

   Unit onSessionStoreAvailable(HmsSessionStore sessionStore)

  Called when the session store is available.

• onTranscripts

   Unit onTranscripts(HmsTranscripts transcripts)

  Called when the webrtc session has transcription of the audio. Not to be confused with transcripts during HLS streams.