桌面端视频设备管理

enumerateVideoDevices

获取系统中所有的视频设备列表。

C++

virtual IVideoDeviceCollection* enumerateVideoDevices() = 0;

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

返回值

• 方法调用成功: 返回一个 IVideoDeviceCollection 对象，其中包含系统中所有视频设备。

所属接口类

• IVideoDeviceManager

getCapability

获取视频采集设备在指定的视频格式下的详细视频帧信息。

C++

virtual int getCapability(const char* deviceIdUTF8, const uint32_t deviceCapabilityNumber, VideoFormat& capability) = 0;

注意： 该方法仅适用于 Windows 和 macOS。 在调用 numberOfCapabilities 获取视频采集设备支持的视频格式数量后，你可以调用该方法获取指定索引号支持的具体视频帧信息。

参数

参数名	描述
deviceIdUTF8	视频采集设备的 ID。
deviceCapabilityNumber	视频格式的索引号。如果 numberOfCapabilities 的返回值为 i，则该参数取值范围为[0,i)。
capability	输出参数。表示指定视频格式的具体信息，包括宽度（px），高度（px）和帧率（fps）。详见 VideoFormat。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoDeviceManager

onVideoDeviceStateChanged

视频设备变化回调。

C++

virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
     (void)deviceId;
     (void)deviceType;
     (void)deviceState;
     }

该回调提示系统视频设备状态发生改变，比如被拔出或移除。如果设备已使用外接摄像头采集，外接摄像头被拔开后，视频会中断。

注： 该回调仅适用于 Windows 和 macOS。

参数

参数名	描述
deviceId	设备 ID。
deviceType	设备类型。详见 MEDIA_DEVICE_TYPE。
deviceState	设备状态。

所属接口类

• IRtcEngineEventHandler

getCount

获取系统中被索引的视频采集或播放设备的总数。

C++

virtual int getCount() = 0;

返回值

被索引的视频采集或播放设备的总数。

所属接口类

• IVideoDeviceCollection

getDevice

获取某个被索引的视频采集设备的指定信息。

C++

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

参数

参数名	描述
index	指定的索引值，必须小于 getCount 方法的返回值。
deviceName	设备名称。最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。
deviceId	视频设备的设备 ID。最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoDeviceCollection

getDevice

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

C++

virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;

注意： 该方法仅适用于 Windows 和 macOS。

参数

参数名	描述
deviceIdUTF8	输出参数。设备 ID。最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoDeviceManager

numberOfCapabilities

获取指定视频采集设备支持的视频格式数量。

C++

virtual int numberOfCapabilities(const char* deviceIdUTF8) = 0;

注意： 该方法仅适用于 Windows 和 macOS。 视频采集设备可能支持多种视频格式，每一种格式都支持不同的视频帧宽度、视频帧高度、帧率组合。

你可以通过调用该方法，获取指定的视频采集设备可支持多少种视频格式，然后调用 getCapability 获取指定视频格式下的具体视频帧信息。

参数

参数名	描述
deviceIdUTF8	视频采集设备的 ID。

返回值

• > 0: 方法调用成功。返回该设备支持的视频格式数量。例如：如果指定的摄像头支持 10 种不同的视频格式，则返回值为 10。

• ≤ 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoDeviceManager

queryCodecCapability

查询当前设备支持的视频编解码能力。

C++

virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0;

自从

v4.2.0

参数

参数名	描述
codecInfo	输入和输出参数，表示设备视频编码能力的数组。详见 CodecCapInfo。 输入值：用户执行该方法时定义的 CodecCapInfo，表示待查询的视频编解码能力。 输出值：方法执行完毕后输出的 CodecCapInfo，表示设备实际支持的视频编解码能力。
size	输入和输出参数，表示 CodecCapInfo 数组的大小。 输入值：用户执行该方法时定义的 CodecCapInfo 的大小。 输出值：方法执行完毕后输出的 CodecCapInfo 的大小。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

release

释放 IVideoDeviceCollection 对象占用的所有资源。

C++

virtual void release() = 0;

所属接口类

• IVideoDeviceCollection

release

释放 IVideoDeviceManager 对象占用的所有资源。

C++

virtual void release() = 0;

注意： 该方法仅适用于 Windows 和 macOS。

所属接口类

• IVideoDeviceManager

setCameraDeviceOrientation

设置采集视频的旋转角度。

C++

virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;

注意：

• 该方法仅适用于 Windows。

• 该方法必须在 enableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。

• 当视频采集设备不带重力感应功能时，你可以调用该方法手动调整采集到的视频画面的旋转角度。

参数

参数名	描述
type	视频源类型，详见 VIDEO_SOURCE_TYPE。
orientation	顺时针旋转角度，详见 VIDEO_ORIENTATION。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

setDevice

指定设备。

C++

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

参数

参数名	描述
deviceId	设备 ID。最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。插拔设备不会影响 deviceId。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoDeviceCollection

setDevice

通过设备 ID 指定视频采集设备。

C++

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

注意：

• 插拔设备不会改变设备 ID。

• 该方法仅适用于 Windows 和 macOS。

参数

参数名	描述
deviceId	设备 ID。可通过调用 enumerateVideoDevices 方法获取。 最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IVideoDeviceManager