Skip to main content

Interface: PeerEvents

Interface describing possible peer events.

Extends

Properties

AudioActivity

AudioActivity: AudioActivityEventHandler

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

Defined in

ari/lib/api/peer/types.d.ts:16


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/peer/types.d.ts:20


ConnectionStats

ConnectionStats: ConnectionStatsEventHandler

Gets invoked in an interval to provide connection stats.

Inherited from

MediaSharedEvents.ConnectionStats

Defined in

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


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/peer/types.d.ts:24


UserDataChanged

UserDataChanged: PeerDataChangedEventHandler

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

Defined in

ari/lib/api/peer/types.d.ts:12


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