IVideoDeviceManager

Video device management methods.

enumerateVideoDevices

Enumerates the video devices.

abstract enumerateVideoDevices(): VideoDeviceInfo[];

Details

Returns

  • Success: A VideoDeviceInfo array including all video devices in the system.
  • Failure: An empty array.

getCapability

Gets the detailed video frame information of the video capture device in the specified video format.

abstract getCapability(
    deviceIdUTF8: string,
    deviceCapabilityNumber: number
  ): VideoFormat;

Details

After calling numberOfCapabilities to get the number of video formats supported by the video capture device, you can call this method to get the specific video frame information supported by the specified index number.

Parameters

deviceIdUTF8
The ID of the video capture device.
deviceCapabilityNumber
The index number of the video format. If the return value of numberOfCapabilities is i, the value range of this parameter is [0,i).

Returns

The specific information of the specified video format, including width (px), height (px), and frame rate (fps). See VideoFormat.

getDevice

Retrieves the current video capture device.

abstract getDevice(): string;

Details

Returns

The video capture device.

numberOfCapabilities

Gets the number of video formats supported by the specified video capture device.

abstract numberOfCapabilities(deviceIdUTF8: string): number;

Details

Video capture devices may support multiple video formats, and each format supports different combinations of video frame width, video frame height, and frame rate.

You can call this method to get how many video formats the specified video capture device can support, and then call getCapability to get the specific video frame information in the specified video format.

Parameters

deviceIdUTF8
The ID of the video capture device.

Returns

  • > 0: Success. Returns the number of video formats supported by this device. For example: If the specified camera supports 10 different video formats, the return value is 10.
  • ≤ 0: Failure.

setDevice

Specifies the video capture device with the device ID.

abstract setDevice(deviceIdUTF8: string): number;

Details

Attention:
  • Plugging or unplugging a device does not change its device ID.

Parameters

deviceIdUTF8

The device ID. You can get the device ID by calling enumerateVideoDevices.

The maximum length is MaxDeviceIdLengthType.

Returns

  • 0: Success.
  • < 0: Failure.