视频设备管理
介绍跟视频设备管理相关的方法和回调。
enableMultiCamera
开启或关闭多路摄像头采集。
#if defined(__APPLE__) && TARGET_OS_IOS
virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0;
#endif
详情
- 调用该方法开启多路摄像头采集。
- 调用 startPreview [2/2] 开启本地视频预览。
- 调用 startCameraCapture 并设置 sourceType 指定第二个摄像头开始采集。
- 调用 joinChannelEx 并设置 publishSecondaryCameraTrack 为
true
,在频道内发布第二路摄像头采集的视频流。
- 调用 stopCameraCapture。
- 调用该方法并将 enabled 设置为
false
。
- 如果在 startPreview [2/2] 之前开启,则本地视频预览会同时出现两个摄像头采集的画面。
- 如果在 startPreview [2/2] 之后开启,SDK 会先停止当前的摄像头采集,然后再开启原摄像头和第二个摄像头,本地视频预览会出现短暂黑屏、然后自动恢复正常。
该方法仅适用于 iOS。
使用多路摄像头采集视频时,请确保系统版本为 13.0 及以上。
- iPhone XR
- iPhone XS
- iPhone XS Max
- iPad Pro (第三代及以上)
参数
- enabled
- 是否开启多摄像头视频采集模式:
true
:开启多摄像头采集模式,SDK 使用多路摄像头采集视频。false
:关闭多摄像头采集模式,SDK 仅使用单路摄像头采集视频。
- config
- 第二个摄像头的采集配置。详见 CameraCapturerConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
enumerateVideoDevices
获取系统中所有的视频设备列表。
virtual IVideoDeviceCollection* enumerateVideoDevices() = 0;
详情
该方法返回一个 IVideoDeviceCollection 对象,包含系统中所有的视频设备。通过 IVideoDeviceCollection 对象,App 可以枚举视频设备。 App 必须调用 release 方法在使用过后释放返回的对象。
返回值
- 方法调用成功: 返回一个 IVideoDeviceCollection 对象,其中包含系统中所有视频设备。
getCameraMaxZoomFactor
获取摄像头支持最大缩放比例。
virtual float getCameraMaxZoomFactor() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
设备摄像头支持的最大缩放比例。
所属接口类getCapability
获取视频采集设备在指定的视频格式下的详细视频帧信息。
virtual int getCapability(const char* deviceIdUTF8, const uint32_t deviceCapabilityNumber, VideoFormat& capability) = 0;
详情
在调用 numberOfCapabilities 获取视频采集设备支持的视频格式数量后,你可以调用该方法获取指定索引号支持的具体视频帧信息。
参数
- deviceIdUTF8
- 视频采集设备的 ID。
- deviceCapabilityNumber
- 视频格式的索引号。如果 numberOfCapabilities 的返回值为 i,则该参数取值范围为[0,i)。
- capability
- 输出参数。表示指定视频格式的具体信息,包括宽度(px),高度(px)和帧率(fps)。详见 VideoFormat。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
getCount
getDevice
获取某个被索引的视频采集设备的指定信息。
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: 方法调用失败。详见错误码了解详情和解决建议。
getDevice
获取当前使用的视频采集设备。
virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
详情
参数
- deviceIdUTF8
- 输出参数。设备 ID。最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
isCameraAutoExposureFaceModeSupported
检测设备是否支持自动曝光功能。
virtual bool isCameraAutoExposureFaceModeSupported() = 0;
详情
- 该方法仅适用于 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
true
: 设备支持自动曝光功能。false
: 设备不支持自动曝光功能。
isCameraAutoFocusFaceModeSupported
检测设备是否支持人脸对焦功能。
virtual bool isCameraAutoFocusFaceModeSupported() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
true
: 设备支持人脸对焦功能。false
: 设备不支持人脸对焦功能。
isCameraExposurePositionSupported
检测设备是否支持手动曝光功能。
virtual bool isCameraExposurePositionSupported() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
true
: 设备支持手动曝光功能。false
: 设备不支持手动曝光功能。
isCameraFaceDetectSupported
检查设备摄像头是否支持人脸检测。
virtual bool isCameraFaceDetectSupported() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
true
: 设备摄像头支持人脸检测。false
: 设备摄像头不支持人脸检测。
isCameraFocusSupported
检测设备是否支持手动对焦功能。
virtual bool isCameraFocusSupported() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
true
: 设备支持手动对焦功能。false
: 设备不支持手动对焦功能。
isCameraTorchSupported
检测设备是否支持闪光灯常开。
virtual bool isCameraTorchSupported() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 一般情况下,App 默认开启前置摄像头,因此如果你的前置摄像头不支持闪光灯常开,直接使用该方法会返回 false。如果需要检查后置摄像头是否支持闪光灯常开,需要先使用 switchCamera 切换摄像头,再使用该方法。
- 在系统版本 15 的 iPad 上,即使 isCameraTorchSupported 返回
true
,也可能因系统问题导致你无法通过 setCameraTorchOn 成功开启闪光灯。
返回值
true
: 设备支持闪光灯常开。false
: 设备不支持闪光灯常开。
isCameraZoomSupported
检测设备是否支持摄像头缩放功能。
virtual bool isCameraZoomSupported() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
true
: 设备支持相机缩放功能。false
: 设备不支持相机缩放功能。
numberOfCapabilities
获取指定视频采集设备支持的视频格式数量。
virtual int numberOfCapabilities(const char* deviceIdUTF8) = 0;
详情
视频采集设备可能支持多种视频格式,每一种格式都支持不同的视频帧宽度、视频帧高度、帧率组合。
你可以通过调用该方法,获取指定的视频采集设备可支持多少种视频格式,然后调用 getCapability 获取指定视频格式下的具体视频帧信息。
参数
- deviceIdUTF8
- 视频采集设备的 ID。
返回值
- > 0: 方法调用成功。返回该设备支持的视频格式数量。例如:如果指定的摄像头支持 10 种不同的视频格式,则返回值为 10。
- ≤ 0: 方法调用失败。详见错误码了解详情和解决建议。
release
release
setCameraAutoExposureFaceModeEnabled
设置是否开启自动曝光功能。
virtual int setCameraAutoExposureFaceModeEnabled(bool enabled) = 0;
详情
- 该方法仅适用于 iOS。
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
参数
- enabled
- 是否开启自动曝光:
true
: 开启自动曝光。false
: 关闭自动曝光。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraAutoFocusFaceModeEnabled
设置是否开启人脸对焦功能。
virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
参数
- enabled
- 是否开启人脸对焦:
true
: 开启人脸对焦功能。false
: 关闭人脸对焦功能。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraCapturerConfiguration
设置摄像头采集配置。
virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在开启本地摄像头采集前调用,如 startPreview [2/2] 和 joinChannel [2/2] 前调用。
参数
- config
- 摄像头采集配置,详见 CameraCapturerConfiguration。信息在该方法中,不需要设置 deviceId 参数。
返回值
- >0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraDeviceOrientation
设置采集视频的旋转角度。
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: 方法调用失败。详见错误码了解详情和解决建议。
setCameraExposurePosition
设置手动曝光位置。
virtual int setCameraExposurePosition(float positionXinView, float positionYinView) = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 成功调用该方法后,本地会触发 onCameraExposureAreaChanged 回调。
参数
- positionXinView
- 触摸点相对于视图的横坐标。
- positionYinView
- 触摸点相对于视图的纵坐标。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraFocusPositionInPreview
设置手动对焦位置,并触发对焦。
virtual int setCameraFocusPositionInPreview(float positionX, float positionY) = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
- 成功调用该方法后,本地会触发 onCameraFocusAreaChanged 回调。
参数
- positionX
- 触摸点相对于视图的横坐标。
- positionY
- 触摸点相对于视图的纵坐标。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraTorchOn
设置是否打开闪光灯。
virtual int setCameraTorchOn(bool isOn) = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
参数
- isOn
- 是否打开闪光灯:
true
: 打开闪光灯。false
:(默认)关闭闪光灯。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraZoomFactor
设置摄像头缩放比例。
virtual int setCameraZoomFactor(float factor) = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
- 方法调用成功: 返回设置的 factor 值。
- 方法调用失败: 返回值 < 0。
setDevice
指定设备。
virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;
参数
- deviceId
- 设备 ID。最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。插拔设备不会影响 deviceId。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setDevice
通过设备 ID 指定视频采集设备。
virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;
详情
- 插拔设备不会改变设备 ID。
- 该方法仅适用于 Windows 和 macOS。
参数
- deviceId
设备 ID。可通过调用 enumerateVideoDevices 方法获取。
最大长度为 MAX_DEVICE_ID_LENGTH_TYPE。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
switchCamera
切换前置/后置摄像头。
virtual int switchCamera() = 0;
详情
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) 后。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
onCameraExposureAreaChanged
摄像头曝光区域已改变回调。
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) {
(void)x;
(void)y;
(void)width;
(void)height;
}
详情
该回调是由本地用户调用 setCameraExposurePosition 方法改变曝光位置触发的。
参数
- x
- 发生改变的曝光区域的 x 坐标。
- y
- 发生改变的曝光区域的 y 坐标。
- width
- 发生改变的曝光区域的宽度。
- height
- 发生改变的曝光区域的高度。
onCameraFocusAreaChanged
onCameraReady
摄像头就绪回调。
virtual void onCameraReady()
详情
请改用 onLocalVideoStateChanged 中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。
该回调提示已成功打开摄像头,可以开始捕获视频。
onVideoDeviceStateChanged
视频设备变化回调。
virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
(void)deviceId;
(void)deviceType;
(void)deviceState;
}
详情
该回调提示系统视频设备状态发生改变,比如被拔出或移除。如果设备已使用外接摄像头采集,外接摄像头被拔开后,视频会中断。
参数
- deviceId
- 设备 ID。
- deviceType
- 设备类型。详见 MEDIA_DEVICE_TYPE。
- deviceState
- 设备状态。详见 MEDIA_DEVICE_STATE_TYPE 。