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:401
AudioInputStarted
AudioInputStarted:
AudioInputEventHandler
Gets invoked when a new AudioInput was started.
Inherited from
MediaSharedEvents.AudioInputStarted
Defined in
ari/lib/api/room/types.d.ts:315
AudioInputStopped
AudioInputStopped:
AudioInputEventHandler
Gets invoked when a new AudioInput was stopped.
Inherited from
MediaSharedEvents.AudioInputStopped
Defined in
ari/lib/api/room/types.d.ts:319
AudioOutputStarted
AudioOutputStarted:
AudioOutputEventHandler
Gets invoked when a new AudioOutput was started.
Inherited from
MediaSharedEvents.AudioOutputStarted
Defined in
ari/lib/api/room/types.d.ts:333
AudioOutputStopped
AudioOutputStopped:
AudioOutputEventHandler
Gets invoked when a new AudioOutput was stopped.
Inherited from
MediaSharedEvents.AudioOutputStopped
Defined in
ari/lib/api/room/types.d.ts:337
AudioPowerLevel
AudioPowerLevel:
AudioActivityEventHandler
Gets called when the rmsDBFS value of Medias changes.
Defined in
ari/lib/api/room/types.d.ts:405
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:414
Joined
Joined:
JoinedEventHandler
Gets invoked after a Room join was successfully performed.
Defined in
ari/lib/api/room/types.d.ts:373
Left
Left:
LeftEventHandler
Gets called when the server disconnected the client. Provides a reason.
Defined in
ari/lib/api/room/types.d.ts:377
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:355
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:360
MessageReceived
MessageReceived:
MessageReceivedEventHandler
Gets called on receiving a message with arbitrary data.
Defined in
ari/lib/api/room/types.d.ts:409
PeerJoined
PeerJoined:
JoinedEventHandler
Gets called when a new peer enters the room.
Defined in
ari/lib/api/room/types.d.ts:389
PeerLeft
PeerLeft:
PeerLeftEventHandler
Gets called when a peer left the room.
Defined in
ari/lib/api/room/types.d.ts:393
RoomDataChanged
RoomDataChanged:
RoomDataChangedEventHandler
Gets called when the Room data was updated.
Defined in
ari/lib/api/room/types.d.ts:385
RoomStatusChanged
RoomStatusChanged:
RoomStatusChangedEventHandler
Gets called when the Room status changed.
Defined in
ari/lib/api/room/types.d.ts:381
UserDataChanged
UserDataChanged:
PeerDataChangedEventHandler
Gets called when a peer in the room updated its user data.
Defined in
ari/lib/api/room/types.d.ts:397
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:323
VideoInputStopped
VideoInputStopped:
VideoInputEventHandler
Gets invoked when a new VideoInput was stopped.
Inherited from
MediaSharedEvents.VideoInputStopped
Defined in
ari/lib/api/room/types.d.ts:327
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:341
VideoOutputRemoved
VideoOutputRemoved:
VideoOutputEventHandler
Gets invoked when a new VideOutput was stopped.
Inherited from
MediaSharedEvents.VideoOutputRemoved
Defined in
ari/lib/api/room/types.d.ts:345