Interface StreamManagerEventMap

Events dispatched by StreamManager object. Manage event listeners with on, once and off methods.

Example:

streamManager.on('videoElementCreated', (event) => {
     console.log('New video element created:', event.element);
}

streamManager.off('videoElementCreated');

Hierarchy

Properties

publisherStartSpeaking publisherStopSpeaking streamAudioVolumeChange streamPlaying streamPropertyChanged videoElementCreated videoElementDestroyed

Properties

publisherStartSpeaking

publisherStartSpeaking: PublisherSpeakingEvent

Event dispatched when the user owning the stream has started speaking.

Extra information:

  • This event will only be triggered for streams that have audio tracks (hasAudio must be true).
  • Further configuration can be applied on how the event is dispatched by setting property publisherSpeakingEventsOptions in the call of setAdvancedConfiguration.

publisherStopSpeaking

publisherStopSpeaking: PublisherSpeakingEvent

Event dispatched when the user owning the stream has stopped speaking.

Extra information:

  • This event will only be triggered for streams that have audio tracks (hasAudio must be true).
  • Further configuration can be applied on how the event is dispatched by setting property publisherSpeakingEventsOptions in the call of setAdvancedConfiguration.

streamAudioVolumeChange

streamAudioVolumeChange: StreamManagerEvent

Event dispatched when the volume of the media stream's audio track changes. Only applies if hasAudio is true. The frequency this event is fired with is defined by property interval of publisherSpeakingEventsOptions (default 100ms)

streamPlaying

streamPlaying: StreamManagerEvent

Event dispatched when the media stream starts playing (one of its videos has media and has begun to play). This event will be dispatched when these 3 conditions are met:

  1. The StreamManager has no video associated in the DOM.
  2. It is associated to one video.
  3. That video starts playing. Internally the expected Web API event is HTMLMediaElement.canplay.

streamPropertyChanged

streamPropertyChanged: StreamPropertyChangedEvent

Event dispatched when a Stream undergoes any change in any of its mutable properties (see changedProperty).

videoElementCreated

videoElementCreated: VideoElementEvent

Event dispatched when a new HTML video element has been inserted into DOM by OpenVidu Browser library. See Manage video players section.

videoElementDestroyed

videoElementDestroyed: VideoElementEvent

Event dispatched when an HTML video element has been removed from DOM by OpenVidu Browser library. See Manage video players section.

Settings

Member Visibility

Theme

Generated using TypeDoc