WebRTCMediaDevices

View as MarkdownOpen in Claude

Subset of the MediaDevices interface actually used by the SDK.

Implementations only need to provide these methods — the full browser MediaDevices type is intentionally not required so that React Native and other non-browser environments can conform without polyfilling unused APIs.

Methods

addEventListener()

addEventListener(type, listener): void

Parameters

type
stringRequired

Event type to listen for.

listener
EventListenerOrEventListenerObjectRequired

Listener invoked when the event fires.

Returns

void


enumerateDevices()

enumerateDevices(): Promise<MediaDeviceInfo[]>

Returns

Promise<MediaDeviceInfo[]>


getDisplayMedia()?

optional getDisplayMedia(options): Promise<MediaStream>

Parameters

options
DisplayMediaStreamOptionsRequired

Options to pass to getDisplayMedia.

Returns

Promise<MediaStream>


getUserMedia()

getUserMedia(constraints): Promise<MediaStream>

Parameters

constraints
MediaStreamConstraintsRequired

Media-track constraints to pass to getUserMedia.

Returns

Promise<MediaStream>


removeEventListener()

removeEventListener(type, listener): void

Parameters

type
stringRequired

Event type to listen for.

listener
EventListenerOrEventListenerObjectRequired

Listener invoked when the event fires.

Returns

void