Home
Voice SDK for C++
IVideoDeviceCollection
You can get the information of video devices with this interface.

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
  This class is used to get raw PCM audio.
- 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.
- 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++.

IVideoDeviceCollection

You can get the information of video devices with this interface.

getCount

Gets the total number of the indexed video devices in the system.

virtual int getCount() = 0;

Returns

The total number of the indexed video devices in the system.

getDevice

Gets a specified piece of information about an indexed video device.

virtual int getDevice(int index, 
     char deviceName[MAX_DEVICE_ID_LENGTH], 
     char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;

Parameters

index: The index value of the video device. The value of this parameter must be less than the value returned in getCount.
deviceName: The device name. The maximum length is MAX_DEVICE_ID_LENGTH_TYPE.
deviceId: The device ID of the video device. The maximum length is MAX_DEVICE_ID_LENGTH_TYPE.

Returns

0: Success.
< 0: Failure.

release

Releases all the resources occupied by the IVideoDeviceCollection object.

virtual void release() = 0;

setDevice

Specifies a device with the device ID.

virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;

Parameters

deviceId: The device ID. The maximum length is MAX_DEVICE_ID_LENGTH_TYPE. Connecting or disconnecting the audio device does not change the value of deviceId.

Returns

0: Success.
< 0: Failure.