Interface MediaStream

A stream of media content. A stream consists of several tracks such as video or audio tracks. Each track is specified as an instance of MediaStreamTrack.

Hierarchy

EventTarget
- MediaStream

Index

Properties

active id onaddtrack onremovetrack

Methods

addEventListener addTrack clone dispatchEvent getAudioTracks getTrackById getTracks getVideoTracks removeEventListener removeTrack

Properties

`Readonly` active

active: boolean

`Readonly` id

id: string

onaddtrack

onaddtrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any)

Type declaration

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

onremovetrack

onremovetrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any)

Type declaration

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

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
- type: K
- listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any)
  - - (this: MediaStream, ev: MediaStreamEventMap[K]): any
    - Parameters
      
      this: MediaStream
      
      ev: MediaStreamEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9650
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9651

addTrack

addTrack(track: MediaStreamTrack): void
Parameters
- track: MediaStreamTrack
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9643

clone

clone(): MediaStream
Returns MediaStream
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9644

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
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5309

getAudioTracks

getAudioTracks(): MediaStreamTrack[]
Returns MediaStreamTrack[]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9645

getTrackById

getTrackById(trackId: string): MediaStreamTrack
Parameters
- trackId: string
Returns MediaStreamTrack
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9646

getTracks

getTracks(): MediaStreamTrack[]
Returns MediaStreamTrack[]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9647

getVideoTracks

getVideoTracks(): MediaStreamTrack[]
Returns MediaStreamTrack[]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9648

removeEventListener

removeEventListener<K>(type: K, listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Type Parameters
- K extends keyof MediaStreamEventMap
Parameters
- type: K
- listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any)
  - - (this: MediaStream, ev: MediaStreamEventMap[K]): any
    - Parameters
      
      this: MediaStream
      
      ev: MediaStreamEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9652
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9653

removeTrack

removeTrack(track: MediaStreamTrack): void
Parameters
- track: MediaStreamTrack
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9649

Interface MediaStream

Hierarchy

Index

Properties

Methods

Properties

Readonly active

Readonly id

onaddtrack

Type declaration

Parameters

this: MediaStream

ev: MediaStreamTrackEvent

Returns any

onremovetrack

Type declaration

Parameters

this: MediaStream

ev: MediaStreamTrackEvent

Returns any

Methods

addEventListener

Type Parameters

K extends keyof MediaStreamEventMap

Parameters

type: K

listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any)

Parameters

this: MediaStream

ev: MediaStreamEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

addTrack

Parameters

track: MediaStreamTrack

Returns void

clone

Returns MediaStream

dispatchEvent

Parameters

event: Event

Returns boolean

getAudioTracks

Returns MediaStreamTrack[]

getTrackById

Parameters

trackId: string

Returns MediaStreamTrack

getTracks

Returns MediaStreamTrack[]

getVideoTracks

Returns MediaStreamTrack[]

removeEventListener

Type Parameters

K extends keyof MediaStreamEventMap

Parameters

type: K

listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any)

Parameters

this: MediaStream

ev: MediaStreamEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void

removeTrack

Parameters

track: MediaStreamTrack

Returns void

Settings

`Readonly` active

`Readonly` id

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions