Agora Web SDK API Reference

Overview AgoraRTC Client Stream Error codes Warning Codes

Media Device Information

This interface contains information that describes a single media input or output device.

The list of devices obtained by calling AgoraRTC.getDevices is an array of MediaDeviceInfo objects, one per media device.

Hierarchy

MediaDeviceInfo

Index

Properties

Readonly deviceId

deviceId: string

Device ID

The unique ID of the device.

Note

On Chrome 81 or later, the device ID is only available after the user has granted permission to use the media device.

Readonly kind

kind: string

Device Type

Returns an enumerated value that is "videoinput", "audioinput" or "audiooutput".

Readonly label

label: string

Device Label

Returns a DOMString that is a label describing this device (for example "External USB Webcam").

Note

For security reasons, the label field is always blank unless an active media stream exists or the user has granted persistent permission for media device access.