Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaStreamCapture

Player output to MediaStream

Commonly used for integration with third parties (e.g WebRTC video call SDK)

⚠️ The functionality might not be working on iOS Safari

Track the corresponding issue on Webkit Bug Tracker for a resolution status

Hierarchy

  • MediaStreamSSR
    • MediaStreamCapture

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly active

active: boolean

Readonly id

id: string

onaddtrack

onaddtrack: null | ((ev: MediaStreamTrackEvent) => any)

onremovetrack

onremovetrack: null | ((ev: MediaStreamTrackEvent) => any)

Methods

addEventListener

  • addEventListener<K>(type: K, listener: (ev: MediaStreamEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

  • Type parameters

    • K: keyof MediaStreamEventMap

    Parameters

    • type: K
    • listener: (ev: MediaStreamEventMap[K]) => any
        • (ev: MediaStreamEventMap[K]): any

        • Parameters

          • ev: MediaStreamEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

addTrack

  • addTrack(track: MediaStreamTrack): void

  • Parameters

    • track: MediaStreamTrack

    Returns void

clone

  • clone(): MediaStream

  • Returns MediaStream

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

getAudioTrack

  • getAudioTrack(index?: number): MediaStreamTrack

getAudioTracks

  • getAudioTracks(): MediaStreamTrack[]

  • Returns MediaStreamTrack[]

getTrackById

  • getTrackById(trackId: string): null | MediaStreamTrack

  • Parameters

    • trackId: string

    Returns null | MediaStreamTrack

getTracks

  • getTracks(): MediaStreamTrack[]

  • Returns MediaStreamTrack[]

getVideoTrack

  • getVideoTrack(index?: number): MediaStreamTrack

getVideoTracks

  • getVideoTracks(): MediaStreamTrack[]

  • Returns MediaStreamTrack[]

removeEventListener

  • removeEventListener<K>(type: K, listener: (ev: MediaStreamEventMap[K]) => any, options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

  • Type parameters

    • K: keyof MediaStreamEventMap

    Parameters

    • type: K
    • listener: (ev: MediaStreamEventMap[K]) => any
        • (ev: MediaStreamEventMap[K]): any

        • Parameters

          • ev: MediaStreamEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

removeTrack

  • removeTrack(track: MediaStreamTrack): void

  • Parameters

    • track: MediaStreamTrack

    Returns void