Skip to main content

Interface: RoomEvents

Interface describing possible room events.

Extends

Properties

AudioActivity

AudioActivity: AudioActivityEventHandler

Gets called when a media in the room is processing audio data.

Defined in

ari/lib/api/room/types.d.ts:398


AudioInputStarted

AudioInputStarted: AudioInputEventHandler

Gets invoked when a new AudioInput was started.

Inherited from

MediaSharedEvents.AudioInputStarted

Defined in

ari/lib/api/room/types.d.ts:312


AudioInputStopped

AudioInputStopped: AudioInputEventHandler

Gets invoked when a new AudioInput was stopped.

Inherited from

MediaSharedEvents.AudioInputStopped

Defined in

ari/lib/api/room/types.d.ts:316


AudioOutputStarted

AudioOutputStarted: AudioOutputEventHandler

Gets invoked when a new AudioOutput was started.

Inherited from

MediaSharedEvents.AudioOutputStarted

Defined in

ari/lib/api/room/types.d.ts:330


AudioOutputStopped

AudioOutputStopped: AudioOutputEventHandler

Gets invoked when a new AudioOutput was stopped.

Inherited from

MediaSharedEvents.AudioOutputStopped

Defined in

ari/lib/api/room/types.d.ts:334


AudioPowerLevel

AudioPowerLevel: AudioActivityEventHandler

Gets called when the rmsDBFS value of Medias changes.

Defined in

ari/lib/api/room/types.d.ts:402


ConnectionStats

ConnectionStats: ConnectionStatsEventHandler

Gets called when the ConnectionStats are being updated. Multiple rooms can use the same connection.

Overrides

MediaSharedEvents.ConnectionStats

Defined in

ari/lib/api/room/types.d.ts:411


Joined

Joined: JoinedEventHandler

Gets invoked after a Room join was successfully performed.

Defined in

ari/lib/api/room/types.d.ts:370


Left

Left: LeftEventHandler

Gets called when the server disconnected the client. Provides a reason.

Defined in

ari/lib/api/room/types.d.ts:374


MediaStarted

MediaStarted: MediaEventHandler

Gets invoked when a Media was started. Current Medias are AudioInputs, AudioOutputs, VideoInput, VideoOutputs.

Inherited from

MediaSharedEvents.MediaStarted

Defined in

ari/lib/api/room/types.d.ts:352


MediaStopped

MediaStopped: MediaEventHandler

Gets invoked when a Media was stopped. Current Medias are AudioInputs, AudioOutputs, VideoInput, VideoOutputs.

Inherited from

MediaSharedEvents.MediaStopped

Defined in

ari/lib/api/room/types.d.ts:357


MessageReceived

MessageReceived: MessageReceivedEventHandler

Gets called on receiving a message with arbitrary data.

Defined in

ari/lib/api/room/types.d.ts:406


PeerJoined

PeerJoined: JoinedEventHandler

Gets called when a new peer enters the room.

Defined in

ari/lib/api/room/types.d.ts:386


PeerLeft

PeerLeft: PeerLeftEventHandler

Gets called when a peer left the room.

Defined in

ari/lib/api/room/types.d.ts:390


RoomDataChanged

RoomDataChanged: RoomDataChangedEventHandler

Gets called when the Room data was updated.

Defined in

ari/lib/api/room/types.d.ts:382


RoomStatusChanged

RoomStatusChanged: RoomStatusChangedEventHandler

Gets called when the Room status changed.

Defined in

ari/lib/api/room/types.d.ts:378


UserDataChanged

UserDataChanged: PeerDataChangedEventHandler

Gets called when a peer in the room updated its user data.

Defined in

ari/lib/api/room/types.d.ts:394


VideoInputStarted

VideoInputStarted: VideoInputEventHandler

Gets invoked when a new VideoInput was added to the room.

Inherited from

MediaSharedEvents.VideoInputStarted

Defined in

ari/lib/api/room/types.d.ts:320


VideoInputStopped

VideoInputStopped: VideoInputEventHandler

Gets invoked when a new VideoInput was stopped.

Inherited from

MediaSharedEvents.VideoInputStopped

Defined in

ari/lib/api/room/types.d.ts:324


VideoOutputAdded

VideoOutputAdded: VideoOutputEventHandler

Gets invoked when a new VideoOutput was added to the room.

Inherited from

MediaSharedEvents.VideoOutputAdded

Defined in

ari/lib/api/room/types.d.ts:338


VideoOutputRemoved

VideoOutputRemoved: VideoOutputEventHandler

Gets invoked when a new VideOutput was stopped.

Inherited from

MediaSharedEvents.VideoOutputRemoved

Defined in

ari/lib/api/room/types.d.ts:342