Skip to content

Commit

Permalink
Enhancing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
punitsu committed Jan 8, 2024
1 parent f4407b3 commit 80f320f
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions src/RoomServiceClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,17 @@ export interface CreateOptions {
name: string;

/**
* number of seconds the room should clean up after being empty
* The `emptyTimeout` property represents the number of seconds a room should remain open after being empty.
*
* Behavior:
* 1. When creating a room with an `emptyTimeout` of, for example, 10 minutes:
* - If no participant joins within 20 seconds of room creation, the room will automatically close.
*
* 2. If a participant joins and later disconnects:
* - The empty timeout countdown begins only after the last participant disconnects.
* - If the last participant disconnects and no new participant joins, the room will continue to exist for the
* specified `emptyTimeout` duration (e.g., 10 minutes) before automatically closing.
* - If a new participant joins before the empty timeout elapses, the countdown is reset, and the room remains open.
*/
emptyTimeout?: number;

Expand Down Expand Up @@ -60,7 +70,7 @@ export interface CreateOptions {

/**
* improves A/V sync when min_playout_delay set to a value larger than 200ms.
* It will disables transceiver re-use -- this option is not recommended
* It will disable transceiver re-use -- this option is not recommended
* for rooms with frequent subscription changes
*/
syncStreams?: boolean;
Expand Down

0 comments on commit 80f320f

Please sign in to comment.