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

active id onaddtrack onremovetrack

Methods

addEventListener addTrack clone dispatchEvent getAudioTrack getAudioTracks getTrackById getTracks getVideoTrack getVideoTracks removeEventListener removeTrack stop

Constructors

constructor

new MediaStreamCapture(player): MediaStreamCapture
Parameters
- player: Player
Returns MediaStreamCapture

Overrides MediaStreamSSR.constructor

Properties

`Readonly` active

active: boolean

`Readonly` id

id: string

onaddtrack

onaddtrack: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaStream
  - ev: MediaStreamTrackEvent
  Returns any

onremovetrack

onremovetrack: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: MediaStream
  - ev: MediaStreamTrackEvent
  Returns any

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: MediaStream
      
      ev: MediaStreamEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from MediaStreamSSR.addEventListener
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from MediaStreamSSR.addEventListener

addTrack

addTrack(track): void
Parameters
- track: MediaStreamTrack
Returns void

Inherited from MediaStreamSSR.addTrack

clone

clone(): MediaStream
Returns MediaStream

Inherited from MediaStreamSSR.clone

dispatchEvent

dispatchEvent(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

Inherited from MediaStreamSSR.dispatchEvent

getAudioTrack

getAudioTrack(index?): MediaStreamAudioTrack
Parameters
- index: number = 0
Returns MediaStreamAudioTrack
Audio MediaStreamTrack of given index from MediaStream.getAudioTracks() list

getAudioTracks

getAudioTracks(): MediaStreamTrack[]
Returns MediaStreamTrack[]

Inherited from MediaStreamSSR.getAudioTracks
getAudioTracks(): MediaStreamAudioTrack[]
Returns MediaStreamAudioTrack[]

Inherited from MediaStreamSSR.getAudioTracks

getTrackById

getTrackById(trackId): null | MediaStreamTrack
Parameters
- trackId: string
Returns null | MediaStreamTrack

Inherited from MediaStreamSSR.getTrackById

getTracks

getTracks(): MediaStreamTrack[]
Returns MediaStreamTrack[]

Inherited from MediaStreamSSR.getTracks

getVideoTrack

getVideoTrack(index?): MediaStreamVideoTrack
Parameters
- index: number = 0
Returns MediaStreamVideoTrack
Video MediaStreamTrack of given index from MediaStream.getVideoTracks() list

getVideoTracks

getVideoTracks(): MediaStreamTrack[]
Returns MediaStreamTrack[]

Inherited from MediaStreamSSR.getVideoTracks
getVideoTracks(): MediaStreamVideoTrack[]
Returns MediaStreamVideoTrack[]

Inherited from MediaStreamSSR.getVideoTracks

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: MediaStream
      
      ev: MediaStreamEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from MediaStreamSSR.removeEventListener
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from MediaStreamSSR.removeEventListener

removeTrack

removeTrack(track): void
Parameters
- track: MediaStreamTrack
Returns void

Inherited from MediaStreamSSR.removeTrack

stop

stop(): void
Stops the capture

Returns void