视频设备管理
- Unreal Blueprint
更新时间不可用
介绍跟视频设备管理相关的方法和回调。
EnableMultiCamera
开启或关闭多路摄像头采集。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int EnableMultiCamera(bool enabled, const FCameraCapturerConfiguration& config);详情
在已有摄像头采集视频的场景下，声网推荐你采用以下步骤实现多路摄像头采集、发布视频：
- 调用该方法开启多路摄像头采集。
- 调用 StartPreview 开启本地视频预览。
- 调用 StartCameraCapture 并设置 sourceType 指定第二个摄像头开始采集。
- 调用 JoinChannelEx 并设置 publishSecondaryCameraTrack 为
true，在频道内发布第二路摄像头采集的视频流。
如果要关闭多路摄像头采集，可参考以下步骤：
- 调用 StopCameraCapture。
- 调用该方法并将 enabled 设置为
false。
注：
你可以在 StartPreview 前后调用该方法开启多摄像头采集：
- 如果在 StartPreview 之前开启，则本地视频预览会同时出现两个摄像头采集的画面。
- 如果在 StartPreview 之后开启，SDK 会先停止当前的摄像头采集，然后再开启原摄像头和第二个摄像头，本地视频预览会出现短暂黑屏、然后自动恢复正常。
该方法仅适用于 iOS。
使用多路摄像头采集视频时，请确保系统版本为 13.0 及以上。
支持多路摄像头采集的最低 iOS 设备类型如下所示：
- iPhone XR
- iPhone XS
- iPhone XS Max
- iPad Pro (第三代及以上)
参数
| 参数名 | 描述 |
|---|---|
enabled | |
config | 第二个摄像头的采集配置。详见 FCameraCapturerConfiguration。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
EnumerateVideoDevices
获取系统中所有的视频设备列表。
UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceManager")
UVideoDeviceCollection* EnumerateVideoDevices();详情
注意： 该方法仅适用于 Windows 和 macOS。
该方法返回一个 IVideoDeviceCollection 对象，包含系统中所有的视频设备。通过 IVideoDeviceCollection 对象，App 可以枚举视频设备。 App 必须调用 Release 方法在使用过后释放返回的对象。
返回值
- 方法调用成功: 返回一个 IVideoDeviceCollection 对象，其中包含系统中所有视频设备。
所属接口类
GetCameraMaxZoomFactor
获取摄像头支持最大缩放比例。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
float GetCameraMaxZoomFactor();详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
返回值
设备摄像头支持的最大缩放比例。
所属接口类
GetCapability
获取视频采集设备在指定的视频格式下的详细视频帧信息。
UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceManager")
int GetCapability(const FString & deviceIdUTF8, int deviceCapabilityNumber, FVideoFormat& capability);详情
注意： 该方法仅适用于 Windows 和 macOS。
在调用 NumberOfCapabilities 获取视频采集设备支持的视频格式数量后，你可以调用该方法获取指定索引号支持的具体视频帧信息。
参数
| 参数名 | 描述 |
|---|---|
deviceIdUTF8 | |
deviceCapabilityNumber | |
capability | 输出参数。表示指定视频格式的具体信息，包括宽度（px），高度（px）和帧率（fps）。详见 FVideoFormat。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
GetCount
获取系统中被索引的视频采集或播放设备的总数。
UFUNCTION(BlueprintPure, Category = "Agora|IVideoDeviceCollection")
int GetCount();返回值
被索引的视频采集或播放设备的总数。
所属接口类
GetDevice
获取某个被索引的视频采集设备的指定信息。
UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceCollection")
int GetDevice(int index, FString& deviceName, FString& deviceId);参数
| 参数名 | 描述 |
|---|---|
index | 指定的索引值，必须小于 GetCount 方法的返回值。 |
deviceName | |
deviceId |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
GetAgoraVideoDeviceManager
获取 IVideoDeviceManager 对象，以管理视频设备。
UFUNCTION(BlueprintPure, Category = "Agora|IVideoDeviceManager")
static UAgoraBPuVideoDeviceManager* GetAgoraVideoDeviceManager();返回值
一个 IVideoDeviceManager 对象。
IsCameraAutoExposureFaceModeSupported
检测设备是否支持自动曝光功能。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraAutoExposureFaceModeSupported();详情
注意：
- 该方法仅适用于 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
返回值
true: 设备支持自动曝光功能。false: 设备不支持自动曝光功能。
所属接口类
IsCameraAutoFocusFaceModeSupported
检测设备是否支持人脸对焦功能。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraAutoFocusFaceModeSupported();详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
返回值
true: 设备支持人脸对焦功能。false: 设备不支持人脸对焦功能。
所属接口类
IsCameraExposurePositionSupported
检测设备是否支持手动曝光功能。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraExposurePositionSupported();详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
返回值
true: 设备支持手动曝光功能。false: 设备不支持手动曝光功能。
所属接口类
IsCameraExposureSupported
查询当前摄像头是否支持曝光调节。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraExposureSupported();详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
- 建议你在调用 SetCameraExposureFactor 调节曝光系数前，先调用该方法查询当前摄像头是否支持曝光调节。
- 当你调用该方法时，查询的是当前正在使用的摄像头是否支持曝光调节，即调用 SetCameraCapturerConfiguration 时指定的摄像头。
返回值
true：方法调用成功。false：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
IsCameraFaceDetectSupported
检查设备摄像头是否支持人脸检测。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraFaceDetectSupported();详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
返回值
true: 设备摄像头支持人脸检测。false: 设备摄像头不支持人脸检测。
所属接口类
IsCameraFocusSupported
检测设备是否支持手动对焦功能。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraFocusSupported();详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
返回值
true: 设备支持手动对焦功能。false: 设备不支持手动对焦功能。
所属接口类
IsCameraTorchSupported
检测设备是否支持闪光灯常开。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraTorchSupported();详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
- 一般情况下，App 默认开启前置摄像头，因此如果你的前置摄像头不支持闪光灯常开，直接使用该方法会返回 false。如果需要检查后置摄像头是否支持闪光灯常开，需要先使用 SwitchCamera 切换摄像头，再使用该方法。
- 在系统版本 15 的 iPad 上，即使 IsCameraTorchSupported 返回
true，也可能因系统问题导致你无法通过 SetCameraTorchOn 成功开启闪光灯。
返回值
true: 设备支持闪光灯常开。false: 设备不支持闪光灯常开。
所属接口类
IsCameraZoomSupported
检测设备是否支持摄像头缩放功能。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
bool IsCameraZoomSupported();注意： 该方法仅适用于 Android 和 iOS。
调用时机
该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
调用限制
无。
返回值
true: 设备支持相机缩放功能。false: 设备不支持相机缩放功能。
所属接口类
NumberOfCapabilities
获取指定视频采集设备支持的视频格式数量。
UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceManager")
int NumberOfCapabilities(const FString & deviceIdUTF8);详情
注意： 该方法仅适用于 Windows 和 macOS。
视频采集设备可能支持多种视频格式，每一种格式都支持不同的视频帧宽度、视频帧高度、帧率组合。
你可以通过调用该方法，获取指定的视频采集设备可支持多少种视频格式，然后调用 GetCapability 获取指定视频格式下的具体视频帧信息。
参数
返回值
- > 0: 方法调用成功。返回该设备支持的视频格式数量。例如：如果指定的摄像头支持 10 种不同的视频格式，则返回值为 10。
- ≤ 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
QueryCameraFocalLengthCapability
查询摄像头支持的焦距能力。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int QueryCameraFocalLengthCapability(const TArray<FFocalLengthInfo> & focalLengthInfos);详情
如需开启摄像头广角、超广角拍摄模式，建议你先调用该方法查询设备是否具备相应的焦距能力，再根据查询结果调用 SetCameraCapturerConfiguration 调整摄像头的焦距配置，以达到最佳的摄像头采集效果。
注意： 该方法仅适用于 Android 和 iOS。
参数
| 参数名 | 描述 |
|---|---|
focalLengthInfos |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
QueryCodecCapability
查询 SDK 支持的视频编解码能力。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int QueryCodecCapability(TArray<FCodecCapInfo> & codecInfo, int QuerySize = 10);详情
参数
| 参数名 | 描述 |
|---|---|
codecInfo | 输入和输出参数，表示 SDK 的视频编码能力数组。详见 FCodecCapInfo。
|
size |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
Release
释放 IVideoDeviceCollection 对象占用的所有资源。
UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceCollection")
void Release();所属接口类
Release
释放 IVideoDeviceManager 对象占用的所有资源。
UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceManager")
void Release();详情
注意： 该方法仅适用于 Windows 和 macOS。
所属接口类
SetCameraAutoExposureFaceModeEnabled
设置是否开启自动曝光功能。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraAutoExposureFaceModeEnabled(bool enabled);详情
注意：
- 该方法仅适用于 iOS。
- 该方法必须在 EnableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 OnLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraAutoFocusFaceModeEnabled
设置是否开启人脸对焦功能。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraAutoFocusFaceModeEnabled(bool enabled);SDK 默认在 Android 平台关闭人脸自动对焦，在 iOS 平台开启人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。
注意： 该方法仅适用于 Android 和 iOS。
调用时机
该方法必须在 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 之后调用。
调用限制
无。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraCapturerConfiguration
设置摄像头采集配置。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraCapturerConfiguration(const FCameraCapturerConfiguration& config);调用时机
该方法必须在开启本地摄像头采集前调用，如 StartPreview 和 JoinChannelWithOptions 前调用。
调用限制
在调整摄像头的焦距配置前，建议先调用 QueryCameraFocalLengthCapability 查询设备支持的焦距能力，再根据查询结果进行配置。
由于部分 Android 设备的限制，即使根据 QueryCameraFocalLengthCapability 的查询结果设置焦距类型，设置结果也可能不生效。
参数
| 参数名 | 描述 |
|---|---|
config |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraDeviceOrientation
设置采集视频的旋转角度。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraDeviceOrientation(EVIDEO_SOURCE_TYPE type, FENUMWRAP_VIDEO_ORIENTATION orientation);详情
注意：
- 该方法仅适用于 Windows。
- 该方法必须在 EnableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 OnLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 当视频采集设备不带重力感应功能时，你可以调用该方法手动调整采集到的视频画面的旋转角度。
参数
| 参数名 | 描述 |
|---|---|
type | 视频源类型，详见 EUABT_VIDEO_SOURCE_TYPE。 |
| 参数名 | 描述 |
|---|---|
orientation | 顺时针旋转角度，详见 FENUMWRAP_VIDEO_ORIENTATION。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraExposureFactor
设置当前摄像头的曝光系数。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraExposureFactor(float factor);详情
当拍摄环境光线不足或过于明亮时，会影响视频采集的画质。为了获得更好的视频效果，你可以使用该方法调节摄像头的曝光系数。
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 EnableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 OnLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 建议你在调用该方法前，先调用 IsCameraExposureSupported 查询当前摄像头是否支持调节曝光系数。
- 当你调用该方法时，设置的是当前正在使用的摄像头的曝光系数，即调用 SetCameraCapturerConfiguration 时指定的摄像头。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraExposurePosition
设置手动曝光位置。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraExposurePosition(float positionXinView, float positionYinView);详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 EnableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 OnLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 成功调用该方法后，本地会触发 OnCameraExposureAreaChanged 回调。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraFocusPositionInPreview
设置手动对焦位置，并触发对焦。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraFocusPositionInPreview(float positionX, float positionY);详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 EnableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 OnLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 成功调用该方法后，本地会触发 OnCameraFocusAreaChanged 回调。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraTorchOn
设置是否打开闪光灯。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraTorchOn(bool isOn);详情
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 EnableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 OnLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SetCameraZoomFactor
设置摄像头缩放比例。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetCameraZoomFactor(float factor);详情
部分 iOS 设备的后置摄像头为多个摄像头组成的融合镜头，如双摄（广角和超广角）或三摄（广角、超广角和长焦），对于这种具备超广角能力的融合镜头，你可以调用 SetCameraCapturerConfiguration 将 cameraFocalLengthType 设置为 CAMERA_FOCAL_LENGTH_DEFAULT (0)（标准镜头），然后调用该方法将摄像头缩放比例设置为小于 1.0 的数值，从而实现超广角的拍摄效果。
注意：
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 EnableVideo 后调用，设置结果在摄像头成功开启后生效，即 SDK 触发 OnLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
参数
| 参数名 | 描述 |
|---|---|
factor | 摄像头缩放比例。对不支持超广角的设备，取值范围从 1.0 到最大缩放比例；对支持超广角的设备，取值范围从 0.5 到最大缩放比例。你可以通过 GetCameraMaxZoomFactor 方法获取设备支持的最大缩放比例。 |
返回值
- 方法调用成功: 返回设置的 factor 值。
- 方法调用失败: 返回值 < 0。
所属接口类
SetDevice
指定设备。
UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceCollection")
int SetDevice(FString& deviceIdUTF8);参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SwitchCamera
切换前置/后置摄像头。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SwitchCamera();你可以调用该方法在 App 运行期间基于可用摄像头的实际情况来动态切换摄像头，而无需重启视频流或重新配置视频源。
注意： 该方法仅适用于 Android 和 iOS。
调用时机
该方法必须在摄像头成功开启后调用，即 SDK 触发 OnLocalVideoStateChanged 回调，返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
调用限制
该方法仅会对第一路摄像头采集的视频流进行摄像头切换操作，即调用 StartCameraCapture 时设置为 VIDEO_SOURCE_CAMERA (0) 的视频源。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
OnCameraExposureAreaChanged
摄像头曝光区域已改变回调。
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnCameraExposureAreaChanged(int x, int y, int width, int height);详情
该回调是由本地用户调用 SetCameraExposurePosition 方法改变曝光位置触发的。
注意： 该回调仅适用于 Android 和 iOS。
参数
所属接口类
OnCameraFocusAreaChanged
相机对焦区域已改变回调。
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnCameraFocusAreaChanged(int x, int y, int width, int height);详情
注意： 该回调仅适用于 Android 和 iOS。
参数
所属接口类
OnCameraReady
摄像头就绪回调。
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnCameraReady();详情
弃用:
请改用 OnLocalVideoStateChanged 中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。
该回调提示已成功打开摄像头，可以开始捕获视频。
所属接口类
OnVideoDeviceStateChanged
视频设备变化回调。
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnVideoDeviceStateChanged(const FString& deviceId, int deviceType, int deviceState);详情
该回调提示系统视频设备状态发生改变，比如被拔出或移除。如果设备已使用外接摄像头采集，外接摄像头被拔开后，视频会中断。
注： 该回调仅适用于 Windows 和 macOS。
参数
| 参数名 | 描述 |
|---|---|
deviceId | |
deviceType | 设备类型。详见 FENUMWRAP_MEDIA_DEVICE_TYPE。 |
deviceState | 设备状态。详见 EMEDIA_DEVICE_STATE_TYPE 。 |