文档中心
互动直播 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

C++ API Reference for All Platforms

概览 IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager

#include <IAgoraRtcEngine.h>

Public 成员函数

virtual IVideoDeviceCollection * enumerateVideoDevices ()=0
 
virtual int startDeviceTest (view_t hwnd)=0
 
virtual int stopDeviceTest ()=0
 
virtual int setDevice (const char deviceId[MAX_DEVICE_ID_LENGTH])=0
 
virtual int getDevice (char deviceId[MAX_DEVICE_ID_LENGTH])=0
 
virtual void release ()=0
 

Protected 成员函数

virtual ~IVideoDeviceManager ()
 

详细描述

视频设备管理方法。

IVideoDeviceManager 接口类提供用于测试视频设备的相关接口。 初始化一个 AVideoDeviceManager 类以获得一个 IVideoDeviceManager 接口。

构造及析构函数说明

◆ ~IVideoDeviceManager()

virtual agora::rtc::IVideoDeviceManager::~IVideoDeviceManager ( )
inlineprotectedvirtual

成员函数说明

◆ enumerateVideoDevices()

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

获取系统中所有的视频设备列表。（仅适用于 macOS 和 Windows）

该方法返回一个 IVideoDeviceCollection 对象，包含系统中所有的视频设备。通过 IVideoDeviceCollection 对象，App 可以枚举视频设备。 App 必须调用 release 方法在使用过后释放返回的对象。

返回
Returns
  • 一个包含系统中所有视频设备的 IVideoDeviceCollection 对象（方法调用成功）。
  • NULL：方法调用失败

◆ startDeviceTest()

virtual int agora::rtc::IVideoDeviceManager::startDeviceTest ( view_t  hwnd)
pure virtual

开启视频采集设备测试。（仅适用于 macOS 和 Windows）

用于测试当前视频采集设备是否工作正常，使用前需保证已调用过 enableVideo，且传入参数的 hwnd 窗口句柄有效。

参数
hwnd输入参数，用于显示图像的窗口句柄。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ stopDeviceTest()

virtual int agora::rtc::IVideoDeviceManager::stopDeviceTest ( )
pure virtual

停止视频设备测试。（仅适用于 macOS 和 Windows）

返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setDevice()

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

指定设备。（仅适用于 macOS 和 Windows）

参数
deviceId设备 ID。可通过调用 enumerateVideoDevices 方法获取
注解
插拔设备并不会改变设备 ID。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getDevice()

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

获取指定 index 的设备信息。（仅适用于 macOS 和 Windows）

获取当前正在使用的视频采集设备。

参数
deviceId输出参数。设备 ID。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ release()

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

释放 IVideoDeviceManager 对象占用的所有资源。（仅适用于 macOS 和 Windows）