Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Subscriber

Packs remote media streams. Participants automatically receive them when others publish their streams. Initialized with Session.subscribe method

Hierarchy

Implements

Index

Properties

id

id: string

id attribute of the DOM video element displaying the Publisher/Subscriber's stream. This property is only defined if:

remote

remote: boolean

Whether the Stream represented in the DOM is local or remote

stream

stream: Stream

The Stream represented in the DOM by the Publisher/Subscriber

targetElement

targetElement: HTMLElement

The DOM HTMLElement assigned as target element when creating the video for the Publisher/Subscriber. This property is only defined if:

videos

videos: StreamManagerVideo[] = []

All the videos displaying the Stream of this Publisher/Subscriber

Methods

addVideoElement

  • addVideoElement(video: HTMLVideoElement): number
  • Makes video element parameter display this stream. This is useful when you are managing the video elements on your own

    Calling this method with a video already added to other Publisher/Subscriber will cause the video element to be disassociated from that previous Publisher/Subscriber and to be associated to this one.

    Parameters

    • video: HTMLVideoElement

    Returns number

    1 if the video wasn't associated to any other Publisher/Subscriber and has been successfully added to this one. 0 if the video was already added to this Publisher/Subscriber. -1 if the video was previously associated to any other Publisher/Subscriber and has been successfully disassociated from that one and properly added to this one.

createVideoElement

  • createVideoElement(targetElement?: string | HTMLElement, insertMode?: VideoInsertMode): HTMLVideoElement
  • Creates a new video element displaying this stream. This allows you to have multiple video elements displaying the same media stream.

    Events dispatched

    The Publisher/Subscriber object will dispatch a videoElementCreated event once the HTML video element has been added to DOM. See VideoElementEvent

    Parameters

    • Optional targetElement: string | HTMLElement

      HTML DOM element (or its id attribute) in which the video element of the Publisher/Subscriber will be inserted

    • Optional insertMode: VideoInsertMode

      How the video element will be inserted accordingly to targetElemet

    Returns HTMLVideoElement

    The created HTMLVideoElement

off

  • off(type: string, handler?: undefined | function): StreamManager

on

once

subscribeToAudio

  • Subscribe or unsubscribe from the audio stream (if available). Calling this method twice in a row passing same value will have no effect

    Parameters

    • value: boolean

      true to subscribe to the audio stream, false to unsubscribe from it

    Returns Subscriber

subscribeToVideo

  • Subscribe or unsubscribe from the video stream (if available). Calling this method twice in a row passing same value will have no effect

    Parameters

    • value: boolean

      true to subscribe to the video stream, false to unsubscribe from it

    Returns Subscriber

Generated using TypeDoc