Home
Voice SDK for C++
IVideoDeviceManager
Video device management methods.

Voice SDK for C++
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- IRtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- IRtcEngineEx
  This interface class contains multi-channel methods.
- IRtcEngineEventHandler
  The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
- IMediaPlayer
  This class provides media player functions and supports multiple instances.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IAudioDeviceManager
  Audio device management methods.
- IAudioDeviceCollection
  The IAudioDeviceCollection interface. You can get the information of audio devices with this interface.
- IVideoDeviceManager
  Video device management methods.
- IVideoDeviceCollection
  You can get the information of video devices with this interface.
- IMediaEngine
  The IMediaEngine class.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaPlayerCustomDataProvider
  The callback for custom media resource files.
- IMediaPlayerSourceObserver
  Provides callbacks for media players.
- IAudioPcmFrameSink
- IAudioFrameObserverBase
  The audio frame observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IPacketObserver
  The definition of IPacketObserver.
- IMetadataObserver
  The metadata observer.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- IFaceInfoObserver
  Facial information observer.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- IScreenCaptureSourceList
  The IScreenCaptureSourceList class. This class is returned in the getScreenCaptureSources method.
- Struct and Enum
  This page lists all the definitions of Struct and the enums for C++.
- API Sunset Notice
  This page introduces the deprecated and deleted APIs in the SDK.

IVideoDeviceManager

Video device management methods.

IVideoDeviceManager provides methods related to video device testing. You can call the queryInterface method to get the IVideoDeviceManager interface.

enumerateVideoDevices

Enumerates the video devices.

Details

Returns

getCapability

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

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

getDevice

Retrieves the current video capture device.

Details

Returns

numberOfCapabilities

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

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: Failure.

release

Releases all the resources occupied by the IVideoDeviceManager object.

Details

setDevice

Specifies the video capture device with the device ID.

Details

Attention:

Plugging or unplugging a device does not change its device ID.

Parameters

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

Returns

0: Success.
< 0: Failure.