Video device management methods.
The IVideoDeviceManager interface class tests the video device interfaces. Instantiate an AVideoDeviceManager class to retrieve an IVideoDeviceManager interface.
◆ ~IVideoDeviceManager()
virtual agora::rtc::IVideoDeviceManager::~IVideoDeviceManager |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ enumerateVideoDevices()
Enumerates the video devices.
This method returns an IVideoDeviceCollection object including all video devices in the system. With the IVideoDeviceCollection object, the application can enumerate the video devices. The application must call the release method to release the returned object after using it.
- Returns
-
◆ startDeviceTest()
virtual int agora::rtc::IVideoDeviceManager::startDeviceTest |
( |
view_t |
hwnd | ) |
|
|
pure virtual |
Starts the video-capture device test.
This method tests whether the video-capture device works properly. Before calling this method, ensure that you have already called the enableVideo method, and the window handle (hwnd) parameter is valid.
- Parameters
-
hwnd | The window handle used to display the screen. |
- Returns
- 0: Success.
- < 0: Failure.
◆ stopDeviceTest()
virtual int agora::rtc::IVideoDeviceManager::stopDeviceTest |
( |
| ) |
|
|
pure virtual |
Stops the video-capture device test.
- Returns
- 0: Success.
- < 0: Failure.
◆ setDevice()
virtual int agora::rtc::IVideoDeviceManager::setDevice |
( |
const char |
deviceId[MAX_DEVICE_ID_LENGTH] | ) |
|
|
pure virtual |
Sets a device with the device ID.
- Parameters
-
- Note
- Plugging or unplugging the device does not change the device ID.
- Returns
- 0: Success.
- < 0: Failure.
◆ getDevice()
virtual int agora::rtc::IVideoDeviceManager::getDevice |
( |
char |
deviceId[MAX_DEVICE_ID_LENGTH] | ) |
|
|
pure virtual |
Retrieves the video-capture device that is in use.
- Parameters
-
deviceId | Pointer to the video-capture device ID. |
- Returns
- 0: Success.
- < 0: Failure.
◆ release()
virtual void agora::rtc::IVideoDeviceManager::release |
( |
| ) |
|
|
pure virtual |