Interface MediaDevices

Provides access to connected media input devices like cameras and microphones, as well as screen sharing. In essence, it lets you obtain access to any hardware source of media data. Available only in secure contexts.

Hierarchy

EventTarget
- MediaDevices

Index

Properties

ondevicechange

Methods

addEventListener dispatchEvent enumerateDevices getDisplayMedia getSupportedConstraints getUserMedia removeEventListener

Properties

ondevicechange

ondevicechange: null | ((this: <internal>.MediaDevices, ev: Event) => any)

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends "devicechange"
Parameters
- type: K
- listener: ((this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]) => any)
  - - (this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]): any
    - Parameters
      
      this: <internal>.MediaDevices
      
      ev: MediaDevicesEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9282
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:9283

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:5138

enumerateDevices

enumerateDevices(): Promise<<internal>.MediaDeviceInfo[]>
Returns Promise<<internal>.MediaDeviceInfo[]>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9278

getDisplayMedia

getDisplayMedia(constraints?: DisplayMediaStreamConstraints): Promise<<internal>.MediaStream>
Parameters
- Optional constraints: DisplayMediaStreamConstraints
Returns Promise<<internal>.MediaStream>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9279

getSupportedConstraints

getSupportedConstraints(): MediaTrackSupportedConstraints
Returns MediaTrackSupportedConstraints
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9280

getUserMedia

getUserMedia(constraints?: MediaStreamConstraints): Promise<<internal>.MediaStream>
Parameters
- Optional constraints: MediaStreamConstraints
Returns Promise<<internal>.MediaStream>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9281

removeEventListener

removeEventListener<K>(type: K, listener: ((this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Type Parameters
- K extends "devicechange"
Parameters
- type: K
- listener: ((this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]) => any)
  - - (this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]): any
    - Parameters
      
      this: <internal>.MediaDevices
      
      ev: MediaDevicesEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:9284
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:9285

Interface MediaDevices

Hierarchy

Index

Properties

Methods

Properties

ondevicechange

Methods

addEventListener

Type Parameters

K extends "devicechange"

Parameters

type: K

listener: ((this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]) => any)

Parameters

this: <internal>.MediaDevices

ev: MediaDevicesEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

enumerateDevices

Returns Promise<<internal>.MediaDeviceInfo[]>

getDisplayMedia

Parameters

Optional constraints: DisplayMediaStreamConstraints

Returns Promise<<internal>.MediaStream>

getSupportedConstraints

Returns MediaTrackSupportedConstraints

getUserMedia

Parameters

Optional constraints: MediaStreamConstraints

Returns Promise<<internal>.MediaStream>

removeEventListener

Type Parameters

K extends "devicechange"

Parameters

type: K

listener: ((this: <internal>.MediaDevices, ev: MediaDevicesEventMap[K]) => any)

Parameters

this: <internal>.MediaDevices

ev: MediaDevicesEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void

Settings

Member Visibility

Theme

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` constraints: DisplayMediaStreamConstraints

`Optional` constraints: MediaStreamConstraints

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions