MediaStream | @foxy.io/sdk

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

Methods

Properties

Readonly active

active: boolean

Readonly id

id: string

onaddtrack

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

onremovetrack

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

Methods

addEventListener

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

Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10284
Type Parameters
- K extends "addtrack" | "removetrack"
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:10285
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

addTrack

addTrack(track: MediaStreamTrack): void

- Defined in node_modules/typescript/lib/lib.dom.d.ts:10277
Parameters
- track: MediaStreamTrack
Returns void

clone

clone(): MediaStream

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

dispatchEvent

dispatchEvent(event: Event): boolean

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

getAudioTracks

getAudioTracks(): MediaStreamTrack[]

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

getTrackById

getTrackById(trackId: string): null | MediaStreamTrack

- Defined in node_modules/typescript/lib/lib.dom.d.ts:10280
Parameters
- trackId: string
Returns null | MediaStreamTrack

getTracks

getTracks(): MediaStreamTrack[]

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

getVideoTracks

getVideoTracks(): MediaStreamTrack[]

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

removeEventListener

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

Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10286
Type Parameters
- K extends "addtrack" | "removetrack"
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:10287
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

removeTrack

removeTrack(track: MediaStreamTrack): void

- Defined in node_modules/typescript/lib/lib.dom.d.ts:10283
Parameters
- track: MediaStreamTrack
Returns void

Hierarchy

Index

Properties

Methods

Properties

Readonly active

Readonly id

onaddtrack

onremovetrack

Methods

addEventListener

Type Parameters

K extends "addtrack" | "removetrack"

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 null | MediaStreamTrack

getTracks

Returns MediaStreamTrack[]

getVideoTracks

Returns MediaStreamTrack[]

removeEventListener

Type Parameters

K extends "addtrack" | "removetrack"

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