Skip to content

Commit

Permalink
Update docs (#1411)
Browse files Browse the repository at this point in the history
# Description

- Update docs

### Pre-launch Checklist

- [x] The [Documentation] is updated accordingly, or this PR doesn't
require it.
- [x] I have updated the `ExampleAppChangelog.txt` file with relevant
changes.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I added new tests to check the change I am making, or this PR is
test-exempt.
- [x] All existing and new tests are passing.

<!-- Links -->

[Documentation]: https://www.100ms.live/docs
  • Loading branch information
ygit authored Jul 26, 2024
1 parent ae00f3a commit 5ffc173
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions packages/react-native-hms/src/classes/HMSUpdateListenerActions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
*
* @enum {string}
*
* @example
* ```typescript
* hmsInstance.addEventListener(HMSUpdateListenerActions.ON_JOIN, ({ room: HMSRoom }}) => {
* console.log('Joined room', data);
* // Handle the event
* });
* ```
*
* @property {string} ON_PREVIEW - Emitted when the local preview is available.
* @property {string} ON_JOIN - Emitted when the local user joins the room.
* @property {string} ON_ROOM_UPDATE - Emitted when there is an update related to the room.
Expand Down Expand Up @@ -85,6 +93,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 +280,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 +314,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 5ffc173

Please sign in to comment.