Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ygit committed Jul 24, 2024
1 parent ae00f3a commit 99f41f7
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions packages/react-native-hms/src/classes/HMSUpdateListenerActions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,18 @@ export enum HMSUpdateListenerActions {
*/
ON_PEER_UPDATE = '3',

/**
* Event emitted when the list of peers in the room is updated.
*
* This event is triggered whenever there is a change in the list of peers present in the room, such as when a new peer joins,
* an existing peer leaves. It allows the application to react to changes in the room's
* participant list, enabling dynamic updates to the UI or other logic based on the current set of participants.
*
* @type {string}
* @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/large-room
*/
ON_PEER_LIST_UPDATED = 'ON_PEER_LIST_UPDATED',

/**
* Event emitted when there is an update related to a track in the room.
*
Expand Down Expand Up @@ -260,7 +272,7 @@ export enum HMSUpdateListenerActions {
ON_REMOTE_VIDEO_STATS = 'ON_REMOTE_VIDEO_STATS',

/**
* Event emitted when the audio device has changed.
* Event emitted when the audio device has changed. Android only.
*
* This event is triggered whenever there is a change in the audio output device, such as switching from the built-in speaker to a Bluetooth headset.
* Handling this event allows the application to update any UI elements or settings related to the current audio device, ensuring that the user is always aware of which device is being used for audio output.
Expand Down Expand Up @@ -294,18 +306,6 @@ export enum HMSUpdateListenerActions {
*/
ON_SESSION_STORE_CHANGED = 'ON_SESSION_STORE_CHANGED',

/**
* Event emitted when the list of peers in the room is updated.
*
* This event is triggered whenever there is a change in the list of peers present in the room, such as when a new peer joins,
* an existing peer leaves, or a peer's properties are updated. It allows the application to react to changes in the room's
* participant list, enabling dynamic updates to the UI or other logic based on the current set of participants.
*
* @type {string}
* @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/large-room
*/
ON_PEER_LIST_UPDATED = 'ON_PEER_LIST_UPDATED',

/**
* Event emitted when transcripts are available.
*
Expand Down

0 comments on commit 99f41f7

Please sign in to comment.