Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublisherSpeakingEvent

Defines the following events:

  • publisherStartSpeaking: dispatched by Session
  • publisherStopSpeaking: dispatched by Session

More information:

  • This events will only be triggered for remote streams that have audio tracks (Stream.hasAudio must be true)
  • Both events share the same lifecycle. That means that you can subscribe to only one of them if you want, but if you call Session.off('publisherStopSpeaking'), keep in mind that this will also internally remove any 'publisherStartSpeaking' event
  • You can further configure how the events are dispatched by setting property publisherSpeakingEventsOptions in the call of OpenVidu.setAdvancedConfiguration

Hierarchy

  • Event
    • PublisherSpeakingEvent

Index

Properties

cancelable

cancelable: boolean

Whether the event has a default behavior that may be prevented by calling Event.preventDefault

connection

connection: Connection

The client that started or stopped speaking

streamId

streamId: string

The streamId of the Stream affected by the speaking event

target

The object that dispatched the event

type

type: string

The type of event. This is the same string you pass as first parameter when calling method on() of any object implementing EventDispatcher interface

Methods

isDefaultPrevented

  • isDefaultPrevented(): boolean

preventDefault

  • preventDefault(): void
  • Prevents the default behavior of the event. The following events have a default behavior:

    • sessionDisconnected: dispatched by Session object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and also deletes any HTML video element associated to each Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method Session.subscribe or by calling Subscriber.createVideoElement). For every video removed, each Subscriber object will also dispatch a videoElementDestroyed event.

    • streamDestroyed:

      • If dispatched by a Publisher (you have unpublished): automatically stops all media tracks and deletes any HTML video element associated to it (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method OpenVidu.initPublisher or by calling Publisher.createVideoElement). For every video removed, the Publisher object will also dispatch a videoElementDestroyed event.
      • If dispatched by Session (other user has unpublished): automatically unsubscribes the proper Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and also deletes any HTML video element associated to that Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as targetElement in method Session.subscribe or by calling Subscriber.createVideoElement). For every video removed, the Subscriber object will also dispatch a videoElementDestroyed event.

    Returns void

Generated using TypeDoc