Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Update: emptyTimeout in CreateOptions #127

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading