# 视频设备管理 (/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## enableMultiCamera [#enablemulticamera]
开启或关闭多路摄像头采集。
```cpp
#if defined(__APPLE__) && TARGET_OS_IOS
virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0;
#endif
```
### 详情 [#详情]
在已有摄像头采集视频的场景下,声网推荐你采用以下步骤实现多路摄像头采集、发布视频:
1. 调用该方法开启多路摄像头采集。
2. 调用 [startPreview [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_startpreview2) 开启本地视频预览。
3. 调用 [startCameraCapture](/zh-CN/api-reference/rtc/unreal-cpp/video/camera-capture#api_irtcengine_startcameracapture) 并设置 sourceType 指定第二个摄像头开始采集。
4. 调用 [joinChannelEx](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengineex_joinchannelex) 并设置 publishSecondaryCameraTrack 为 `true`,在频道内发布第二路摄像头采集的视频流。
如果要关闭多路摄像头采集,可参考以下步骤:
1. 调用 [stopCameraCapture](/zh-CN/api-reference/rtc/unreal-cpp/video/camera-capture#api_irtcengine_stopcameracapture)。
2. 调用该方法并将 enabled 设置为 `false`。
:::note
注:
你可以在 [startPreview [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_startpreview2) 前后调用该方法开启多摄像头采集:
- 如果在 startPreview [2/2] 之前开启,则本地视频预览会同时出现两个摄像头采集的画面。
- 如果在 startPreview [2/2] 之后开启,SDK 会先停止当前的摄像头采集,然后再开启原摄像头和第二个摄像头,本地视频预览会出现短暂黑屏、然后自动恢复正常。
:::
该方法仅适用于 iOS。
使用多路摄像头采集视频时,请确保系统版本为 13.0 及以上。
支持多路摄像头采集的最低 iOS 设备类型如下所示:
- iPhone XR
- iPhone XS
- iPhone XS Max
- iPad Pro (第三代及以上)
### 参数 [#参数]
是否开启多摄像头视频采集模式:
- `true`:开启多摄像头采集模式,SDK 使用多路摄像头采集视频。
- `false`:关闭多摄像头采集模式,SDK 仅使用单路摄像头采集视频。
第二个摄像头的采集配置。详见 [CameraCapturerConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/class-cameracapturerconfiguration)。
### 返回值 [#返回值]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## enumerateVideoDevices [#enumeratevideodevices]
获取系统中所有的视频设备列表。
```cpp
virtual IVideoDeviceCollection* enumerateVideoDevices() = 0;
```
### 详情 [#详情-1]
:::caution
注意: 该方法仅适用于 Windows 和 macOS。
:::
该方法返回一个 [IVideoDeviceCollection](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicecollection) 对象,包含系统中所有的视频设备。通过 IVideoDeviceCollection 对象,App 可以枚举视频设备。
App 必须调用 [release](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_ivideodevicecollection_release) 方法在使用过后释放返回的对象。
### 返回值 [#返回值-1]
- 方法调用成功: 返回一个 IVideoDeviceCollection 对象,其中包含系统中所有视频设备。
### 所属接口类 [#所属接口类-1]
- [IVideoDeviceManager](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicemanager)
## getCameraMaxZoomFactor [#getcameramaxzoomfactor]
获取摄像头支持最大缩放比例。
```cpp
virtual float getCameraMaxZoomFactor() = 0;
```
### 详情 [#详情-2]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
:::
### 返回值 [#返回值-2]
设备摄像头支持的最大缩放比例。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## getCapability [#getcapability]
获取视频采集设备在指定的视频格式下的详细视频帧信息。
```cpp
virtual int getCapability(const char* deviceIdUTF8, const uint32_t deviceCapabilityNumber, VideoFormat& capability) = 0;
```
### 详情 [#详情-3]
:::caution
注意: 该方法仅适用于 Windows 和 macOS。
:::
在调用 [numberOfCapabilities](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_ivideodevicemanager_numberofcapabilities) 获取视频采集设备支持的视频格式数量后,你可以调用该方法获取指定索引号支持的具体视频帧信息。
### 参数 [#参数-1]
视频采集设备的 ID。
视频格式的索引号。如果 numberOfCapabilities 的返回值为 i,则该参数取值范围为[0,i)。
输出参数。表示指定视频格式的具体信息,包括宽度(px),高度(px)和帧率(fps)。详见 [VideoFormat](/zh-CN/api-reference/rtc/unreal-cpp/class-videoformat)。
### 返回值 [#返回值-3]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IVideoDeviceManager](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicemanager)
## getCount [#getcount]
获取系统中被索引的视频采集或播放设备的总数。
```cpp
virtual int getCount() = 0;
```
### 返回值 [#返回值-4]
被索引的视频采集或播放设备的总数。
### 所属接口类 [#所属接口类-4]
- [IVideoDeviceCollection](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicecollection)
## getDevice [#getdevice]
获取某个被索引的视频采集设备的指定信息。
```cpp
virtual int getDevice(int index,
char deviceName[MAX_DEVICE_ID_LENGTH],
char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;
```
### 参数 [#参数-2]
指定的索引值,必须小于 [getCount](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_ivideodevicecollection_getcount) 方法的返回值。
设备名称。最大长度为 [MAX_DEVICE_ID_LENGTH_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-maxdeviceidlengthtype)。
视频设备的设备 ID。最大长度为 [MAX_DEVICE_ID_LENGTH_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-maxdeviceidlengthtype)。
### 返回值 [#返回值-5]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [IVideoDeviceCollection](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicecollection)
## getDevice [#getdevice-1]
获取当前使用的视频采集设备。
```cpp
virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
```
### 详情 [#详情-4]
:::caution
注意: 该方法仅适用于 Windows 和 macOS。
:::
### 参数 [#参数-3]
输出参数。设备 ID。最大长度为 [MAX_DEVICE_ID_LENGTH_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-maxdeviceidlengthtype)。
### 返回值 [#返回值-6]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-6]
- [IVideoDeviceManager](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicemanager)
## isCameraAutoExposureFaceModeSupported [#iscameraautoexposurefacemodesupported]
检测设备是否支持自动曝光功能。
```cpp
virtual bool isCameraAutoExposureFaceModeSupported() = 0;
```
### 详情 [#详情-5]
:::caution
注意:
- 该方法仅适用于 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
:::
### 返回值 [#返回值-7]
- `true`: 设备支持自动曝光功能。
- `false`: 设备不支持自动曝光功能。
### 所属接口类 [#所属接口类-7]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## isCameraAutoFocusFaceModeSupported [#iscameraautofocusfacemodesupported]
检测设备是否支持人脸对焦功能。
```cpp
virtual bool isCameraAutoFocusFaceModeSupported() = 0;
```
### 详情 [#详情-6]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
:::
### 返回值 [#返回值-8]
- `true`: 设备支持人脸对焦功能。
- `false`: 设备不支持人脸对焦功能。
### 所属接口类 [#所属接口类-8]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## isCameraExposurePositionSupported [#iscameraexposurepositionsupported]
检测设备是否支持手动曝光功能。
```cpp
virtual bool isCameraExposurePositionSupported() = 0;
```
### 详情 [#详情-7]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
:::
### 返回值 [#返回值-9]
- `true`: 设备支持手动曝光功能。
- `false`: 设备不支持手动曝光功能。
### 所属接口类 [#所属接口类-9]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## isCameraExposureSupported [#iscameraexposuresupported]
查询当前摄像头是否支持曝光调节。
```cpp
virtual bool isCameraExposureSupported() = 0;
```
### 详情 [#详情-8]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
- 建议你在调用 [setCameraExposureFactor](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_setcameraexposurefactor) 调节曝光系数前,先调用该方法查询当前摄像头是否支持曝光调节。
- 当你调用该方法时,查询的是当前正在使用的摄像头是否支持曝光调节,即调用 [setCameraCapturerConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_setcameracapturerconfiguration) 时指定的摄像头。
:::
### 返回值 [#返回值-10]
- `true`:方法调用成功。
- `false`:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-10]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## isCameraFaceDetectSupported [#iscamerafacedetectsupported]
检查设备摄像头是否支持人脸检测。
```cpp
virtual bool isCameraFaceDetectSupported() = 0;
```
### 详情 [#详情-9]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
:::
### 返回值 [#返回值-11]
- `true`: 设备摄像头支持人脸检测。
- `false`: 设备摄像头不支持人脸检测。
### 所属接口类 [#所属接口类-11]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## isCameraFocusSupported [#iscamerafocussupported]
检测设备是否支持手动对焦功能。
```cpp
virtual bool isCameraFocusSupported() = 0;
```
### 详情 [#详情-10]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
:::
### 返回值 [#返回值-12]
- `true`: 设备支持手动对焦功能。
- `false`: 设备不支持手动对焦功能。
### 所属接口类 [#所属接口类-12]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## isCameraTorchSupported [#iscameratorchsupported]
检测设备是否支持闪光灯常开。
```cpp
virtual bool isCameraTorchSupported() = 0;
```
### 详情 [#详情-11]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
- 一般情况下,App 默认开启前置摄像头,因此如果你的前置摄像头不支持闪光灯常开,直接使用该方法会返回 false。如果需要检查后置摄像头是否支持闪光灯常开,需要先使用 [switchCamera](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_switchcamera) 切换摄像头,再使用该方法。
- 在系统版本 15 的 iPad 上,即使 [isCameraTorchSupported](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_iscameratorchsupported) 返回 `true`,也可能因系统问题导致你无法通过 [setCameraTorchOn](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_setcameratorchon) 成功开启闪光灯。
:::
### 返回值 [#返回值-13]
- `true`: 设备支持闪光灯常开。
- `false`: 设备不支持闪光灯常开。
### 所属接口类 [#所属接口类-13]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## isCameraZoomSupported [#iscamerazoomsupported]
检测设备是否支持摄像头缩放功能。
```cpp
virtual bool isCameraZoomSupported() = 0;
```
:::caution
注意: 该方法仅适用于 Android 和 iOS。
:::
### 调用时机 [#调用时机]
该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
### 调用限制 [#调用限制]
无。
### 返回值 [#返回值-14]
- `true`: 设备支持相机缩放功能。
- `false`: 设备不支持相机缩放功能。
### 所属接口类 [#所属接口类-14]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## numberOfCapabilities [#numberofcapabilities]
获取指定视频采集设备支持的视频格式数量。
```cpp
virtual int numberOfCapabilities(const char* deviceIdUTF8) = 0;
```
### 详情 [#详情-12]
:::caution
注意: 该方法仅适用于 Windows 和 macOS。
:::
视频采集设备可能支持多种视频格式,每一种格式都支持不同的视频帧宽度、视频帧高度、帧率组合。
你可以通过调用该方法,获取指定的视频采集设备可支持多少种视频格式,然后调用 [getCapability](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_ivideodevicemanager_getcapability) 获取指定视频格式下的具体视频帧信息。
### 参数 [#参数-4]
视频采集设备的 ID。
### 返回值 [#返回值-15]
- > 0: 方法调用成功。返回该设备支持的视频格式数量。例如:如果指定的摄像头支持 10 种不同的视频格式,则返回值为 10。
- ≤ 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-15]
- [IVideoDeviceManager](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicemanager)
## queryCameraFocalLengthCapability [#querycamerafocallengthcapability]
查询摄像头支持的焦距能力。
```cpp
virtual int queryCameraFocalLengthCapability(agora::rtc::FocalLengthInfo* focalLengthInfos, int& size) = 0;
```
### 详情 [#详情-13]
如需开启摄像头广角、超广角拍摄模式,建议你先调用该方法查询设备是否具备相应的焦距能力,再根据查询结果调用 [setCameraCapturerConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_setcameracapturerconfiguration) 调整摄像头的焦距配置,以达到最佳的摄像头采集效果。
:::caution
注意: 该方法仅适用于 Android 和 iOS。
:::
### 参数 [#参数-5]
输入和输出参数。指向 [FocalLengthInfo](/zh-CN/api-reference/rtc/unreal-cpp/class-focallengthinfo) 对象数组的指针:
- 输入值:指向一个 [FocalLengthInfo](/zh-CN/api-reference/rtc/unreal-cpp/class-focallengthinfo) 对象数组,用于存储焦距信息。
- 输出值:方法执行后,输出查询到的焦距信息。
输入和输出参数。焦距信息数量:
- 输入值:指定 focalLengthInfos 数组可以容纳的最大焦距信息数量。请确保该值不小于 8,即 focalLengthInfos 至少有空间存储 8 个焦距信息。
- 输出值:方法执行后,输出查询到的焦距信息数量。
### 返回值 [#返回值-16]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-16]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## queryCodecCapability [#querycodeccapability]
查询 SDK 支持的视频编解码能力。
```cpp
virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0;
```
### 详情 [#详情-14]
### 参数 [#参数-6]
输入和输出参数,表示 SDK 的视频编码能力数组。详见 [CodecCapInfo](/zh-CN/api-reference/rtc/unreal-cpp/class-codeccapinfo)。
- 输入值:用户执行该方法时定义的 CodecCapInfo,表示待查询的视频编解码能力。
- 输出值:方法执行完毕后输出的 CodecCapInfo,表示 SDK 实际支持的视频编解码能力。
输入和输出参数,表示 CodecCapInfo 数组的大小。
- 输入值:用户执行该方法时定义的 CodecCapInfo 的大小。
- 输出值:方法执行完毕后输出的 CodecCapInfo 的大小。
### 返回值 [#返回值-17]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-17]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## release [#release]
释放 [IVideoDeviceCollection](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicecollection) 对象占用的所有资源。
```cpp
virtual void release() = 0;
```
### 所属接口类 [#所属接口类-18]
- [IVideoDeviceCollection](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicecollection)
## release [#release-1]
释放 [IVideoDeviceManager](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicemanager) 对象占用的所有资源。
```cpp
virtual void release() = 0;
```
### 详情 [#详情-15]
:::caution
注意: 该方法仅适用于 Windows 和 macOS。
:::
### 所属接口类 [#所属接口类-19]
- [IVideoDeviceManager](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicemanager)
## setCameraAutoExposureFaceModeEnabled [#setcameraautoexposurefacemodeenabled]
设置是否开启自动曝光功能。
```cpp
virtual int setCameraAutoExposureFaceModeEnabled(bool enabled) = 0;
```
### 详情 [#详情-16]
:::caution
注意:
- 该方法仅适用于 iOS。
- 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
:::
### 参数 [#参数-7]
是否开启自动曝光:
- `true`: 开启自动曝光。
- `false`: 关闭自动曝光。
### 返回值 [#返回值-18]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-20]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraAutoFocusFaceModeEnabled [#setcameraautofocusfacemodeenabled]
设置是否开启人脸对焦功能。
```cpp
virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;
```
SDK 默认在 Android 平台关闭人脸自动对焦,在 iOS 平台开启人脸自动对焦。如需自行设置人脸自动对焦,请调用该方法。
:::caution
注意: 该方法仅适用于 Android 和 iOS。
:::
### 调用时机 [#调用时机-1]
该方法必须在 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
### 调用限制 [#调用限制-1]
无。
### 参数 [#参数-8]
是否开启人脸对焦:
- `true`: 开启人脸对焦功能。
- `false`: 关闭人脸对焦功能。
### 返回值 [#返回值-19]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-21]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraCapturerConfiguration [#setcameracapturerconfiguration]
设置摄像头采集配置。
```cpp
virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0;
```
### 调用时机 [#调用时机-2]
该方法必须在开启本地摄像头采集前调用,如 [startPreview [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_startpreview2) 和 [joinChannel [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengine_joinchannel2) 前调用。
### 调用限制 [#调用限制-2]
在调整摄像头的焦距配置前,建议先调用 [queryCameraFocalLengthCapability](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_querycamerafocallengthcapability) 查询设备支持的焦距能力,再根据查询结果进行配置。
由于部分 Android 设备的限制,即使根据 queryCameraFocalLengthCapability 的查询结果设置焦距类型,设置结果也可能不生效。
### 参数 [#参数-9]
摄像头采集配置,详见 [CameraCapturerConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/class-cameracapturerconfiguration)。
:::caution
注意: 在该方法中,不需要设置 deviceId 参数。
:::
### 返回值 [#返回值-20]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-22]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraDeviceOrientation [#setcameradeviceorientation]
设置采集视频的旋转角度。
```cpp
virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
```
### 详情 [#详情-17]
:::caution
注意:
- 该方法仅适用于 Windows。
- 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 当视频采集设备不带重力感应功能时,你可以调用该方法手动调整采集到的视频画面的旋转角度。
:::
### 参数 [#参数-10]
视频源类型,详见 [VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-videosourcetype)。
顺时针旋转角度,详见 [VIDEO_ORIENTATION](/zh-CN/api-reference/rtc/unreal-cpp/enum-videoorientation)。
### 返回值 [#返回值-21]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-23]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraExposureFactor [#setcameraexposurefactor]
设置当前摄像头的曝光系数。
```cpp
virtual int setCameraExposureFactor(float factor) = 0;
```
### 详情 [#详情-18]
当拍摄环境光线不足或过于明亮时,会影响视频采集的画质。为了获得更好的视频效果,你可以使用该方法调节摄像头的曝光系数。
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 建议你在调用该方法前,先调用 [isCameraExposureSupported](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_iscameraexposuresupported) 查询当前摄像头是否支持调节曝光系数。
- 当你调用该方法时,设置的是当前正在使用的摄像头的曝光系数,即调用 [setCameraCapturerConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_setcameracapturerconfiguration) 时指定的摄像头。
:::
### 参数 [#参数-11]
摄像头的曝光系数。默认值为 0,表示使用摄像头的默认曝光量。取值越大,曝光量越大。视频图像过曝时,你可以降低曝光系数;视频图像欠曝且暗部细节丢失时,你可以增加曝光系数。如果你指定的曝光系数超出设备支持的范围,SDK 会自动调节为设备实际支持的范围。
在 Android 平台上,取值范围为 [-20.0,20.0];在 iOS 平台上,取值范围为 [-8.0,8.0]。
### 返回值 [#返回值-22]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-24]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraExposurePosition [#setcameraexposureposition]
设置手动曝光位置。
```cpp
virtual int setCameraExposurePosition(float positionXinView, float positionYinView) = 0;
```
### 详情 [#详情-19]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 成功调用该方法后,本地会触发 [onCameraExposureAreaChanged](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#callback_irtcengineeventhandler_oncameraexposureareachanged) 回调。
:::
### 参数 [#参数-12]
触摸点相对于视图的横坐标。
触摸点相对于视图的纵坐标。
### 返回值 [#返回值-23]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-25]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraFocusPositionInPreview [#setcamerafocuspositioninpreview]
设置手动对焦位置,并触发对焦。
```cpp
virtual int setCameraFocusPositionInPreview(float positionX, float positionY) = 0;
```
### 详情 [#详情-20]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 成功调用该方法后,本地会触发 [onCameraFocusAreaChanged](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#callback_irtcengineeventhandler_oncamerafocusareachanged) 回调。
:::
### 参数 [#参数-13]
触摸点相对于视图的横坐标。
触摸点相对于视图的纵坐标。
### 返回值 [#返回值-24]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-26]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraTorchOn [#setcameratorchon]
设置是否打开闪光灯。
```cpp
virtual int setCameraTorchOn(bool isOn) = 0;
```
### 详情 [#详情-21]
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
:::
### 参数 [#参数-14]
是否打开闪光灯:
- `true`: 打开闪光灯。
- `false`:(默认)关闭闪光灯。
### 返回值 [#返回值-25]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-27]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setCameraZoomFactor [#setcamerazoomfactor]
设置摄像头缩放比例。
```cpp
virtual int setCameraZoomFactor(float factor) = 0;
```
### 详情 [#详情-22]
部分 iOS 设备的后置摄像头为多个摄像头组成的融合镜头,如双摄(广角和超广角)或三摄(广角、超广角和长焦),对于这种具备超广角能力的融合镜头,你可以调用 [setCameraCapturerConfiguration](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_setcameracapturerconfiguration) 将 cameraFocalLengthType 设置为 CAMERA_FOCAL_LENGTH_DEFAULT (0)(标准镜头),然后调用该方法将摄像头缩放比例设置为小于 1.0 的数值,从而实现超广角的拍摄效果。
:::caution
注意:
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 [enableVideo](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#api_irtcengine_enablevideo) 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
:::
### 参数 [#参数-15]
摄像头缩放比例。对不支持超广角的设备,取值范围从 1.0 到最大缩放比例;对支持超广角的设备,取值范围从 0.5 到最大缩放比例。你可以通过 [getCameraMaxZoomFactor](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_getcameramaxzoomfactor) 方法获取设备支持的最大缩放比例。
### 返回值 [#返回值-26]
- 方法调用成功: 返回设置的 factor 值。
- 方法调用失败: 返回值 < 0。
### 所属接口类 [#所属接口类-28]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## setDevice [#setdevice]
指定设备。
```cpp
virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;
```
### 参数 [#参数-16]
设备 ID。最大长度为 [MAX_DEVICE_ID_LENGTH_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-maxdeviceidlengthtype)。插拔设备不会影响 deviceId。
### 返回值 [#返回值-27]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-29]
- [IVideoDeviceCollection](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicecollection)
## setDevice [#setdevice-1]
通过设备 ID 指定视频采集设备。
```cpp
virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;
```
### 详情 [#详情-23]
:::caution
注意:
- 插拔设备不会改变设备 ID。
- 该方法仅适用于 Windows 和 macOS。
:::
### 参数 [#参数-17]
设备 ID。可通过调用 [enumerateVideoDevices](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_ivideodevicemanager_enumeratevideodevices) 方法获取。
最大长度为 [MAX_DEVICE_ID_LENGTH_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-maxdeviceidlengthtype)。
### 返回值 [#返回值-28]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-30]
- [IVideoDeviceManager](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_ivideodevicemanager)
## switchCamera [#switchcamera]
切换前置/后置摄像头。
```cpp
virtual int switchCamera() = 0;
```
你可以调用该方法在 App 运行期间基于可用摄像头的实际情况来动态切换摄像头,而无需重启视频流或重新配置视频源。
:::caution
注意: 该方法仅适用于 Android 和 iOS。
:::
### 调用时机 [#调用时机-3]
该方法必须在摄像头成功开启后调用,即 SDK 触发 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
### 调用限制 [#调用限制-3]
该方法仅会对第一路摄像头采集的视频流进行摄像头切换操作,即调用 [startCameraCapture](/zh-CN/api-reference/rtc/unreal-cpp/video/camera-capture#api_irtcengine_startcameracapture) 时设置为 VIDEO_SOURCE_CAMERA (0) 的视频源。
### 返回值 [#返回值-29]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-31]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine)
## onCameraExposureAreaChanged [#oncameraexposureareachanged]
摄像头曝光区域已改变回调。
```cpp
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) {
(void)x;
(void)y;
(void)width;
(void)height;
}
```
### 详情 [#详情-24]
该回调是由本地用户调用 [setCameraExposurePosition](/zh-CN/api-reference/rtc/unreal-cpp/device-management/video-device#api_irtcengine_setcameraexposureposition) 方法改变曝光位置触发的。
:::caution
注意: 该回调仅适用于 Android 和 iOS。
:::
### 参数 [#参数-18]
发生改变的曝光区域的 x 坐标。
发生改变的曝光区域的 y 坐标。
发生改变的曝光区域的宽度。
发生改变的曝光区域的高度。
### 所属接口类 [#所属接口类-32]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)
## onCameraFocusAreaChanged [#oncamerafocusareachanged]
相机对焦区域已改变回调。
```cpp
virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) {
(void)x;
(void)y;
(void)width;
(void)height;
}
```
### 详情 [#详情-25]
:::caution
注意: 该回调仅适用于 Android 和 iOS。
:::
### 参数 [#参数-19]
发生改变的对焦区域的 x 坐标。
发生改变的对焦区域的 y 坐标。
发生改变的对焦区域的宽度。
发生改变的对焦区域的高度。
### 所属接口类 [#所属接口类-33]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)
## onCameraReady [#oncameraready]
摄像头就绪回调。
```cpp
virtual void onCameraReady()
```
### 详情 [#详情-26]
:::error[弃用:]
请改用 [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/unreal-cpp/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) 中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。
:::
该回调提示已成功打开摄像头,可以开始捕获视频。
### 所属接口类 [#所属接口类-34]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)
## onVideoDeviceStateChanged [#onvideodevicestatechanged]
视频设备变化回调。
```cpp
virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
(void)deviceId;
(void)deviceType;
(void)deviceState;
}
```
### 详情 [#详情-27]
该回调提示系统视频设备状态发生改变,比如被拔出或移除。如果设备已使用外接摄像头采集,外接摄像头被拔开后,视频会中断。
:::note
注: 该回调仅适用于 Windows 和 macOS。
:::
### 参数 [#参数-20]
设备 ID。
设备类型。详见 [MEDIA_DEVICE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-mediadevicetype)。
设备状态。详见 [MEDIA_DEVICE_STATE_TYPE](/zh-CN/api-reference/rtc/unreal-cpp/enum-mediadevicestatetype) 。
### 所属接口类 [#所属接口类-35]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)