Agora Java API Reference for Android

Public Member Functions | List of all members
agora::rtc::IVideoDeviceManager Class Referenceabstract

`#include <IAgoraRtcEngine.h>`

## Public Member Functions
virtual IVideoDeviceCollection * | enumerateVideoDevices ()=0
| Enumerates the video devices. More...
virtual int | setDevice (const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual int | getDevice (char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
| Retrieves the current video capture device. More...
virtual int | startDeviceTest (view_t hwnd)=0
virtual int | stopDeviceTest ()=0
virtual void | release ()=0
| Releases all the resources occupied by the `IVideoDeviceManager` object. More...

## Detailed Description

The IVideoDeviceManager class.

## Member Function Documentation

## ◆ enumerateVideoDevices()

virtual IVideoDeviceCollection* agora::rtc::IVideoDeviceManager::enumerateVideoDevices | ( |  | ) |
| pure virtual

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 video devices. The application must call the `release` method to release the returned object after using it.

Note
  This method is for Windows and macOS only.

Returns
  - Success: One `IVideoDeviceCollection` object including all video devices in the system.

## ◆ setDevice()

virtual int agora::rtc::IVideoDeviceManager::setDevice | ( | const char | deviceIdUTF8[MAX_DEVICE_ID_LENGTH] | ) |
| pure virtual

Specifies the video capture device with the device ID.

Parameters

  deviceIdUTF8 | he device ID. You can get the device ID by calling `enumerateVideoDevices`. The maximum length is #MAX_DEVICE_ID_LENGTH.

Returns
  - 0: Success.
  - < 0: Failure.

## ◆ getDevice()

virtual int agora::rtc::IVideoDeviceManager::getDevice | ( | char | deviceIdUTF8[MAX_DEVICE_ID_LENGTH] | ) |
| pure virtual

Retrieves the current video capture device.

Note
  This method is for Windows and macOS only.

Parameters

  deviceIdUTF8 | An output parameter. The device ID. The maximum length is `MAX_DEVICE_ID_LENGTH_TYPE`.

Returns
  - 0: Success.
  - < 0: Failure.

## ◆ 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 enableVideo, and the HWND window handle of the incoming parameter is valid.

Parameters

  hwnd | An Output parameter that specifies the window handle to display the video.

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.

## ◆ release()

virtual void agora::rtc::IVideoDeviceManager::release | ( |  | ) |
| pure virtual

Releases all the resources occupied by the `IVideoDeviceManager` object.

Note
  This method is for Windows and macOS only.