Class: Room
Represents a room within the Odin framework, managing connections, peers, and media.
The Room
class provides functionality to join and interact with an audio/video room,
monitor its state, handle events, and manage media streams.
This class extends OdinEventTarget
to handle custom event types and listeners.
Extends
Constructors
new Room()
new Room():
Room
Returns
Overrides
Defined in
ari/lib/api/room/index.d.ts:164
Properties
connectionStatsInterval
connectionStatsInterval:
number
Interval how often the connection statistics are updated.
Defined in
ari/lib/api/room/index.d.ts:28
defaultGateway
readonly
defaultGateway:"https://gateway.odin.4players.io"
="https://gateway.odin.4players.io"
The default gateway if no gateway was specified when joining the room.
Defined in
ari/lib/api/room/index.d.ts:32
onAudioActivity()?
optional
onAudioActivity: (payload
) =>void
A callback function that is invoked when audio activity occurs and voice activity detection (VAD) was set to true.
Parameters
• payload: AudioActivityPayload
An object containing the AudioMedia.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:82
onAudioInputStarted()?
optional
onAudioInputStarted: (payload
) =>void
A callback function that gets invoked when an AudioInput was started.
Parameters
• payload: AudioInputPayload
An object containing the AudioInput that was started.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:121
onAudioInputStopped()?
optional
onAudioInputStopped: (payload
) =>void
A callback function that gets invoked when an AudioInput was stopped.
Parameters
• payload: AudioInputPayload
An object containing the AudioInput that was stopped.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:127
onAudioOutputStarted()?
optional
onAudioOutputStarted: (payload
) =>void
A callback function that gets invoked when an AudioOutput was started.
Parameters
• payload: AudioOutputPayload
An object containing the AudioOutput that was started.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:133
onAudioOutputStopped()?
optional
onAudioOutputStopped: (payload
) =>void
A callback function that gets invoked when an AudioOutput was stopped.
Parameters
• payload: AudioOutputPayload
An object containing the AudioOutput that was stopped.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:139
onAudioPowerLevel()?
optional
onAudioPowerLevel: (payload
) =>void
A callback function invoked when there is an update to the audio power level in rmsDBFS. This function can be used to handle or process audio activity, such as monitoring sound levels or visualizing audio input.
Parameters
• payload: AudioActivityPayload
An object containing the AudioMedia.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:90
onAudioStats()?
optional
onAudioStats: (payload
) =>void
Parameters
• payload: JitterStats
Returns
void
Defined in
ari/lib/api/room/index.d.ts:97
onConnectionStats()?
optional
onConnectionStats: (payload
) =>void
A callback function invoked to handle connection statistics.
Parameters
• payload: ConnectionStats
An object containing the connection statistics details.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:103
onDataChanged()?
optional
onDataChanged: (payload
) =>void
A callback function that is invoked whenever the data of the room changed. This can only be done via admin tokens.
Parameters
• payload: RoomDataChangedPayload
An object containing the room.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:58
onJoined()?
optional
onJoined: (payload
) =>void
A callback function that is invoked when this room was joined. Also gets called after a reconnect was successfully performed.
Parameters
• payload: JoinedPayload
An object containing the peer and the room.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:38
onLeft()?
optional
onLeft: (payload
) =>void
A callback function that is invoked, when the room was disconnected by the server.
Parameters
• payload: LeftPayload
An object containing the room and the reason.
Returns
void
TODO
Check if it makes sense to call this method also by user disconnects.
Defined in
ari/lib/api/room/index.d.ts:45
onMediaStarted()?
optional
onMediaStarted: (payload
) =>void
A callback function that gets invoked when a new audio or video media was started.
Parameters
• payload: MediaPayload
An object containing the media that was started.
Returns
void
Defined in
ari/lib/api/room/index.d.ts:109
onMediaStopped()?
optional
onMediaStopped: (payload
) =>void
A callback function that gets invoked when an audio or video media was stopped.
Parameters
• payload: MediaPayload
An object containing the media that was stopped.