Agora RTC Objective-C API Reference  Refactor
Public Member Functions
IVideoDeviceCollection Class Referenceabstract

Public Member Functions

virtual int getCount ()=0
 
virtual int setDevice (const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
 
virtual int getDevice (int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH], char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
 
virtual void release ()=0
 

Detailed Description

The IVideoDeviceCollection class.

Constructor & Destructor Documentation

◆ ~IVideoDeviceCollection()

virtual ~IVideoDeviceCollection ( )
inlinevirtual

Member Function Documentation

◆ getCount()

virtual int getCount ( )
pure virtual

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

Returns
The total number of the indexed video capture devices.

◆ setDevice()

virtual int setDevice ( const char  deviceIdUTF8[MAX_DEVICE_ID_LENGTH])
pure virtual

Specifies a device with the device ID.

Parameters
deviceIdUTF8The device ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getDevice()

virtual int getDevice ( int  index,
char  deviceNameUTF8[MAX_DEVICE_ID_LENGTH],
char  deviceIdUTF8[MAX_DEVICE_ID_LENGTH] 
)
pure virtual

Gets the information of a specified video capture device.

Parameters
indexAn input parameter that specifies the device. It is a specified index and must be smaller than the return value of getCount.
deviceNameUTF8An output parameter that indicates the device name.
deviceIdUTF8An output parameter that indicates the device ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ release()

virtual void release ( )
pure virtual

Releases all IVideoDeviceCollection resources.