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.

MDN Reference

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

MDN Reference

`Readonly` id

id: string

MDN Reference

onaddtrack

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

MDN Reference

Type declaration

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

onremovetrack

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

MDN Reference

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
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15273
addEventListener(type, listener, options?): 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:15274

addTrack

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

clone

clone(): MediaStream
MDN Reference

Returns MediaStream
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15262

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.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8215

getAudioTracks

getAudioTracks(): MediaStreamTrack[]
MDN Reference

Returns MediaStreamTrack[]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15264

getTrackById

getTrackById(trackId): null | MediaStreamTrack
MDN Reference
Parameters
- trackId: string
Returns null | MediaStreamTrack
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15266

getTracks

getTracks(): MediaStreamTrack[]
MDN Reference

Returns MediaStreamTrack[]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15268

getVideoTracks

getVideoTracks(): MediaStreamTrack[]
MDN Reference

Returns MediaStreamTrack[]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15270

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
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:15275
removeEventListener(type, listener, options?): 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:15276

removeTrack

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

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, ev) => 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 null | MediaStreamTrack

getTracks

Returns MediaStreamTrack[]

getVideoTracks

Returns MediaStreamTrack[]

removeEventListener

Type Parameters

K extends keyof MediaStreamEventMap

Parameters

type: K

listener: ((this, ev) => 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