Enumeration HMSUpdateListenerActions

Enum for HMSUpdateListenerActions.

This enumeration defines the set of possible events that can be emitted by the HMSSDK during a Session. These events cover a wide range of actions, from joining a room to receiving updates about peers and tracks, and more. For more info about these events, checkout Event Listener docs

See

https://www.100ms.live/docs/react-native/v2/how-to-guides/listen-to-room-updates/event-listeners

Example

hmsInstance.addEventListener(HMSUpdateListenerActions.ON_JOIN, ({ room: HMSRoom }}) => {
 console.log('Joined room', data);
 // Handle the event
});

Enumeration Members

ON_AUDIO_DEVICE_CHANGED ON_CHANGE_TRACK_STATE_REQUEST ON_ERROR ON_JOIN ON_LOCAL_AUDIO_STATS ON_LOCAL_VIDEO_STATS ON_MESSAGE ON_PEER_LIST_UPDATED ON_PEER_UPDATE ON_PERMISSIONS_REQUESTED ON_PREVIEW ON_REMOTE_AUDIO_STATS ON_REMOTE_VIDEO_STATS ON_REMOVED_FROM_ROOM ON_ROLE_CHANGE_REQUEST ON_ROOM_UPDATE ON_RTC_STATS ON_SESSION_STORE_AVAILABLE ON_SESSION_STORE_CHANGED ON_SPEAKER ON_TRACK_UPDATE ON_TRANSCRIPTS RECONNECTED RECONNECTING

Enumeration Members

ON_AUDIO_DEVICE_CHANGED

ON_AUDIO_DEVICE_CHANGED: "ON_AUDIO_DEVICE_CHANGED"

Emitted when the audio device has changed.

ON_CHANGE_TRACK_STATE_REQUEST

ON_CHANGE_TRACK_STATE_REQUEST: "ON_CHANGE_TRACK_STATE_REQUEST"

Emitted when there is a request to change the state of a track.

ON_ERROR

ON_ERROR: "ON_ERROR"

Emitted when an error occurs.

ON_JOIN

ON_JOIN: "ON_JOIN"

Emitted when the local user joins the room.

ON_LOCAL_AUDIO_STATS

ON_LOCAL_AUDIO_STATS: "ON_LOCAL_AUDIO_STATS"

Emitted when stats for the local audio track are available.

ON_LOCAL_VIDEO_STATS

ON_LOCAL_VIDEO_STATS: "ON_LOCAL_VIDEO_STATS"

Emitted when stats for the local video track are available.

ON_MESSAGE

ON_MESSAGE: "ON_MESSAGE"

Emitted when a message is received.

ON_PEER_LIST_UPDATED

ON_PEER_LIST_UPDATED: "ON_PEER_LIST_UPDATED"

Emitted when the list of peers is updated.

ON_PEER_UPDATE

ON_PEER_UPDATE: "3"

Emitted when there is an update related to a peer in the room.

ON_PERMISSIONS_REQUESTED

ON_PERMISSIONS_REQUESTED: "ON_PERMISSIONS_REQUESTED"

Emitted when permissions are requested.

ON_PREVIEW

ON_PREVIEW: "ON_PREVIEW"

Emitted when the local preview is available.

ON_REMOTE_AUDIO_STATS

ON_REMOTE_AUDIO_STATS: "ON_REMOTE_AUDIO_STATS"

Emitted when stats for a remote audio track are available.

ON_REMOTE_VIDEO_STATS

ON_REMOTE_VIDEO_STATS: "ON_REMOTE_VIDEO_STATS"

Emitted when stats for a remote video track are available.

ON_REMOVED_FROM_ROOM

ON_REMOVED_FROM_ROOM: "ON_REMOVED_FROM_ROOM"

Emitted when the local user is removed from the room.

ON_ROLE_CHANGE_REQUEST

ON_ROLE_CHANGE_REQUEST: "ON_ROLE_CHANGE_REQUEST"

Emitted when there is a request to change the role of a peer.

ON_ROOM_UPDATE

ON_ROOM_UPDATE: "ON_ROOM_UPDATE"

Emitted when there is an update related to the room.

ON_RTC_STATS

ON_RTC_STATS: "ON_RTC_STATS"

Emitted when RTC stats are available.

ON_SESSION_STORE_AVAILABLE

ON_SESSION_STORE_AVAILABLE: "ON_SESSION_STORE_AVAILABLE"

Emitted when the session store is available.

ON_SESSION_STORE_CHANGED

ON_SESSION_STORE_CHANGED: "ON_SESSION_STORE_CHANGED"

Emitted when the session store has changed.

ON_SPEAKER

ON_SPEAKER: "ON_SPEAKER"

Emitted when there is an update on the current speaker.

ON_TRACK_UPDATE

ON_TRACK_UPDATE: "ON_TRACK_UPDATE"

Emitted when there is an update related to a track in the room.

ON_TRANSCRIPTS

ON_TRANSCRIPTS: "ON_TRANSCRIPTS"

Emitted when transcripts are available.

RECONNECTED

RECONNECTED: "RECONNECTED"

Emitted when the SDK has successfully reconnected to the room.

RECONNECTING

RECONNECTING: "RECONNECTING"

Emitted when the SDK is attempting to reconnect to the room.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc