Skip to main content

@rtorcato/browser-common / mediadevices

mediadevices

Functions​

isMediaDevicesAvailable()​

isMediaDevicesAvailable(): boolean

Defined in: mediadevices/index.ts:10

Checks if the MediaDevices API is available in the browser.

Example​

import { isMediaDevicesAvailable } from '@rtorcato/browser-common/mediadevices'
if (isMediaDevicesAvailable()) startCamera()

Returns​

boolean

True if MediaDevices is available, false otherwise.

getMediaDevices()​

getMediaDevices(): Promise<MediaDeviceInfo[]>

Defined in: mediadevices/index.ts:24

Gets a list of available media input and output devices.

Example​

import { getMediaDevices } from '@rtorcato/browser-common/mediadevices'
const devices = await getMediaDevices()
const cams = devices.filter((d) => d.kind === 'videoinput')

Returns​

Promise<MediaDeviceInfo[]>

A promise that resolves to an array of MediaDeviceInfo objects.

getUserMedia()​

getUserMedia(constraints): Promise<MediaStream>

Defined in: mediadevices/index.ts:42

Requests access to the user's camera and/or microphone.

Example​

import { getUserMedia, stopMediaStream } from '@rtorcato/browser-common/mediadevices'
const stream = await getUserMedia({ video: true, audio: true })
stopMediaStream(stream)

Parameters​

constraints​

MediaStreamConstraints

MediaStreamConstraints for audio/video.

Returns​

Promise<MediaStream>

A promise that resolves to a MediaStream.

Remarks​

Requires HTTPS, user permission, and a user gesture.

stopMediaStream()​

stopMediaStream(stream): void

Defined in: mediadevices/index.ts:56

Stops all tracks in a given MediaStream.

Example​

import { stopMediaStream } from '@rtorcato/browser-common/mediadevices'
stopMediaStream(stream)

Parameters​

stream​

MediaStream

The MediaStream to stop.

Returns​

void

isPermissionsApiAvailable()​

isPermissionsApiAvailable(): boolean

Defined in: mediadevices/index.ts:71

Checks if the browser supports media device permissions API.

Example​

import { isPermissionsApiAvailable } from '@rtorcato/browser-common/mediadevices'
if (isPermissionsApiAvailable()) checkCameraPerm()

Returns​

boolean

True if permissions API is available, false otherwise.

getMediaPermissionStatus()​

getMediaPermissionStatus(name): Promise<PermissionStatus | undefined>

Defined in: mediadevices/index.ts:86

Checks the permission status for a given media device (e.g., 'camera', 'microphone').

Example​

import { getMediaPermissionStatus } from '@rtorcato/browser-common/mediadevices'
const status = await getMediaPermissionStatus('camera')
console.log(status?.state)

Parameters​

name​

"camera" | "microphone"

The permission name ('camera' | 'microphone').

Returns​

Promise<PermissionStatus | undefined>

The permission status, or undefined if not available.