MediaDevices

Types

displayMediaStreamOptions

type displayMediaStreamOptions = MediaCaptureAndStreamsTypes.displayMediaStreamOptions = {
  mutable video?: unknown,
  mutable audio?: unknown,
}

Record fields

video

option< unknown >

audio

option< unknown >

mediaStreamConstraints

type mediaStreamConstraints = MediaCaptureAndStreamsTypes.mediaStreamConstraints = {
  mutable video?: unknown,
  mutable audio?: unknown,
  mutable preferCurrentTab?: bool,
  mutable peerIdentity?: string,
}

Record fields

video

option< unknown >

audio

option< unknown >

preferCurrentTab

option< bool >

peerIdentity

option< string >

mediaTrackSupportedConstraints

type mediaTrackSupportedConstraints = MediaCaptureAndStreamsTypes.mediaTrackSupportedConstraints = {
  mutable width?: bool,
  mutable height?: bool,
  mutable aspectRatio?: bool,
  mutable frameRate?: bool,
  mutable facingMode?: bool,
  mutable sampleRate?: bool,
  mutable sampleSize?: bool,
  mutable echoCancellation?: bool,
  mutable autoGainControl?: bool,
  mutable noiseSuppression?: bool,
  mutable channelCount?: bool,
  mutable deviceId?: bool,
  mutable groupId?: bool,
  mutable backgroundBlur?: bool,
  mutable displaySurface?: bool,
}

Record fields

width

option< bool >

height

option< bool >

aspectRatio

option< bool >

frameRate

option< bool >

facingMode

option< bool >

sampleRate

option< bool >

sampleSize

option< bool >

echoCancellation

option< bool >

autoGainControl

option< bool >

noiseSuppression

option< bool >

channelCount

option< bool >

deviceId

option< bool >

groupId

option< bool >

backgroundBlur

option< bool >

displaySurface

option< bool >

t

type t = MediaCaptureAndStreamsTypes.mediaDevices = {}

Values

addEventListener

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListener: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.addEventListenerOptions=?,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener option< EventTypes.addEventListenerOptions >

Return type

unit

addEventListenerWithCapture

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListenerWithCapture: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener

Return type

unit

asEventTarget

let asEventTarget: t => EventTypes.eventTarget

Parameters

t

Return type

EventTypes.eventTarget

dispatchEvent

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. Read more on MDN

let dispatchEvent: (t, EventTypes.event) => bool

Parameters

t EventTypes.event

Return type

bool

enumerateDevices

Read more on MDN

let enumerateDevices: t => promise<array<MediaDeviceInfo.t>>

Parameters

t

Return type

promise< array< MediaDeviceInfo.t > >

getDisplayMedia

Read more on MDN

let getDisplayMedia: (
  t,
  ~options: displayMediaStreamOptions=?,
) => promise<MediaStream.t>

Parameters

t option< displayMediaStreamOptions >

Return type

promise< MediaStream.t >

getSupportedConstraints

Read more on MDN

let getSupportedConstraints: t => mediaTrackSupportedConstraints

Parameters

t

Return type

mediaTrackSupportedConstraints

getUserMedia

Read more on MDN

let getUserMedia: (
  t,
  ~constraints: mediaStreamConstraints=?,
) => promise<MediaStream.t>

Parameters

t option< mediaStreamConstraints >

Return type

promise< MediaStream.t >

removeEventListener

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListener: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.eventListenerOptions=?,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener option< EventTypes.eventListenerOptions >

Return type

unit

removeEventListenerUseCapture

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListenerUseCapture: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener

Return type

unit