Interface MediaStreamTrack

A single media track within a stream; typically, these are audio or video tracks, but other track types may exist as well.

Hierarchy

EventTarget
- MediaStreamTrack

Index

Properties

contentHint enabled id kind label muted onended onmute onunmute readyState

Methods

addEventListener applyConstraints clone dispatchEvent getCapabilities getConstraints getSettings removeEventListener stop

Properties

contentHint

contentHint: string

enabled

enabled: boolean

`Readonly` id

id: string

`Readonly` kind

kind: string

`Readonly` label

label: string

`Readonly` muted

muted: boolean

onended

onended: ((this: MediaStreamTrack, ev: Event) => any)

Type declaration

- (this: MediaStreamTrack, ev: Event): any
- Parameters
  - this: MediaStreamTrack
  - ev: Event
  Returns any

onmute

onmute: ((this: MediaStreamTrack, ev: Event) => any)

Type declaration

- (this: MediaStreamTrack, ev: Event): any
- Parameters
  - this: MediaStreamTrack
  - ev: Event
  Returns any

onunmute

onunmute: ((this: MediaStreamTrack, ev: Event) => any)

Type declaration

- (this: MediaStreamTrack, ev: Event): any
- Parameters
  - this: MediaStreamTrack
  - ev: Event
  Returns any

`Readonly` readyState

readyState: MediaStreamTrackState

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends keyof MediaStreamTrackEventMap
Parameters
- type: K
- listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any)
  - - (this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]): any
    - Parameters
      
      this: MediaStreamTrack
      
      ev: MediaStreamTrackEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9706
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:9707

applyConstraints

applyConstraints(constraints?: MediaTrackConstraints): Promise<void>
Parameters
- Optional constraints: MediaTrackConstraints
Returns Promise<void>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9700

clone

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

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

getCapabilities

getCapabilities(): MediaTrackCapabilities
Returns MediaTrackCapabilities
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9702

getConstraints

getConstraints(): MediaTrackConstraints
Returns MediaTrackConstraints
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9703

getSettings

getSettings(): MediaTrackSettings
Returns MediaTrackSettings
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9704

removeEventListener

removeEventListener<K>(type: K, listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Type Parameters
- K extends keyof MediaStreamTrackEventMap
Parameters
- type: K
- listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any)
  - - (this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]): any
    - Parameters
      
      this: MediaStreamTrack
      
      ev: MediaStreamTrackEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9708
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:9709

stop

stop(): void
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9705

Interface MediaStreamTrack

Hierarchy

Index

Properties

Methods

Properties

contentHint

enabled

Readonly id

Readonly kind

Readonly label

Readonly muted

onended

Type declaration

Parameters

this: MediaStreamTrack

ev: Event

Returns any

onmute

Type declaration

Parameters

this: MediaStreamTrack

ev: Event

Returns any

onunmute

Type declaration

Parameters

this: MediaStreamTrack

ev: Event

Returns any

Readonly readyState

Methods

addEventListener

Type Parameters

K extends keyof MediaStreamTrackEventMap

Parameters

type: K

listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any)

Parameters

this: MediaStreamTrack

ev: MediaStreamTrackEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

applyConstraints

Parameters

Optional constraints: MediaTrackConstraints

Returns Promise<void>

clone

Returns MediaStreamTrack

dispatchEvent

Parameters

event: Event

Returns boolean

getCapabilities

Returns MediaTrackCapabilities

getConstraints

Returns MediaTrackConstraints

getSettings

Returns MediaTrackSettings

removeEventListener

Type Parameters

K extends keyof MediaStreamTrackEventMap

Parameters

type: K

listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any)

Parameters

this: MediaStreamTrack

ev: MediaStreamTrackEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

`Readonly` id

`Readonly` kind

`Readonly` label

`Readonly` muted

`Readonly` readyState

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` constraints: MediaTrackConstraints

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions