视频设备管理
介绍跟视频设备管理相关的方法和回调。
getCameraMaxZoomFactor
获取摄像头支持最大缩放比例。
abstract getCameraMaxZoomFactor(): number;
详情
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则无法查询到摄像头属性。
返回值
设备摄像头支持的最大缩放比例。
getVideoDeviceManager
isCameraAutoExposureFaceModeSupported
检测设备是否支持自动曝光功能。
abstract isCameraAutoExposureFaceModeSupported(): boolean;
详情
- 该方法仅适用于 iOS。
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则会因为无法查询到摄像头的属性而返回
false
。
返回值
true
: 设备支持自动曝光功能。false
: 设备不支持自动曝光功能。
isCameraAutoFocusFaceModeSupported
检测设备是否支持人脸对焦功能。
abstract isCameraAutoFocusFaceModeSupported(): boolean;
详情
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则会因为无法查询到摄像头的属性而返回
false
。
返回值
true
: 设备支持人脸对焦功能。false
: 设备不支持人脸对焦功能。
isCameraExposurePositionSupported
检测设备是否支持手动曝光功能。
abstract isCameraExposurePositionSupported(): boolean;
详情
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则会因为无法查询到摄像头的属性而返回
false
。
返回值
true
: 设备支持手动曝光功能。false
: 设备不支持手动曝光功能。
isCameraFaceDetectSupported
检查设备摄像头是否支持人脸检测。
abstract isCameraFaceDetectSupported(): boolean;
- 该方法仅适用于 Android 和 iOS。
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则会因为无法查询到摄像头的属性而返回
false
。
返回值
true
: 设备摄像头支持人脸检测。false
: 设备摄像头不支持人脸检测。
isCameraFocusSupported
检测设备是否支持手动对焦功能。
abstract isCameraFocusSupported(): boolean;
详情
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则会因为无法查询到摄像头的属性而返回
false
。
返回值
true
: 设备支持手动对焦功能。false
: 设备不支持手动对焦功能。
isCameraTorchSupported
检测设备是否支持闪光灯常开。
abstract isCameraTorchSupported(): boolean;
详情
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则会因为无法查询到摄像头的属性而返回
false
。 - 一般情况下,app 默认开启前置摄像头,因此如果你的前置摄像头不支持闪光灯常开,直接使用该方法会返回 false。如果需要检查后置摄像头是否支持闪光灯常开,需要先使用 switchCamera 切换摄像头,再使用该方法。
- 在系统版本 15 的 iPad 上,即使 isCameraTorchSupported 返回
true
,也可能因系统问题导致你无法通过 setCameraTorchOn 成功开启闪光灯。
返回值
true
: 设备支持闪光灯常开。false
: 设备不支持闪光灯常开。
isCameraZoomSupported
检测设备是否支持摄像头缩放功能。
abstract isCameraZoomSupported(): boolean;
详情
- 该方法必须在摄像头开启后调用,即 和 joinChannel 后,否则会因为无法查询到摄像头的属性而返回
false
。
返回值
true
: 设备支持相机缩放功能。false
: 设备不支持相机缩放功能。
setCameraAutoExposureFaceModeEnabled
设置是否开启自动曝光功能。
abstract setCameraAutoExposureFaceModeEnabled(enabled: boolean): number;
详情
- 该方法仅适用于 iOS。
- 该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。
参数
- enabled
-
是否开启自动曝光:
true
: 开启自动曝光。false
: 关闭自动曝光。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setCameraAutoFocusFaceModeEnabled
设置是否开启人脸对焦功能。
abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number;
详情
SDK 默认在 Android 平台关闭人脸自动对焦,在 iOS 平台开启人脸自动对焦。如需自行设置人脸自动对焦,请调用该方法。
- 该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。
参数
- enabled
-
是否开启人脸对焦:
true
: 开启人脸对焦功能。false
: 关闭人脸对焦功能。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setCameraCapturerConfiguration
设置摄像头采集配置。
abstract setCameraCapturerConfiguration( config: CameraCapturerConfiguration ): number;
详情
- 该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。
参数
- config
- 摄像头采集配置,详见 CameraCapturerConfiguration。
返回值
- >0: 方法调用成功。
- < 0: 方法调用失败。
setCameraDeviceOrientation
设置采集视频的旋转角度。
abstract setCameraDeviceOrientation( type: VideoSourceType, orientation: VideoOrientation ): number;
详情
该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。
当视频采集设备不带重力感应功能时,你可以调用该方法手动调整采集到的视频画面的旋转角度。
参数
- type
- 视频源类型,详见 VideoSourceType。
- orientation
- 顺时针旋转角度,详见 VideoOrientation。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
setCameraExposurePosition
设置手动曝光位置。
abstract setCameraExposurePosition( positionXinView: number, positionYinView: number ): number;
详情
该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。
成功调用该方法后,本地会触发 onCameraExposureAreaChanged 回调。
参数
- positionXinView
- 触摸点相对于视图的横坐标。
- positionYinView
- 触摸点相对于视图的纵坐标。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setCameraFocusPositionInPreview
设置手动对焦位置,并触发对焦。
abstract setCameraFocusPositionInPreview( positionX: number, positionY: number ): number;
详情
该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。成功调用该方法后,本地会触发 onCameraFocusAreaChanged 回调。
参数
- positionX
- 触摸点相对于视图的横坐标。
- positionY
- 触摸点相对于视图的纵坐标。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setCameraTorchOn
设置是否打开闪光灯。
abstract setCameraTorchOn(isOn: boolean): number;
详情
- 该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。
参数
- isOn
-
是否打开闪光灯:
true
: 打开闪光灯。false
:(默认)关闭闪光灯。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setCameraZoomFactor
设置摄像头缩放比例。
abstract setCameraZoomFactor(factor: number): number;
详情
- 该方法必须在开启摄像头后调用,如 startPreview 和 enableVideo 后调用。
参数
- factor
- 相机缩放比例,有效范围从 1.0 到最大缩放比例。你可以通过 getCameraMaxZoomFactor 方法获取设备支持的最大缩放比例。
返回值
- 方法调用成功: 返回设置的 factor 值。
- 方法调用失败: 返回值 < 0。
switchCamera
切换前置/后置摄像头。
abstract switchCamera(): number;
详情
- 该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 LocalVideoStreamStateCapturing (1) 后。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
onCameraExposureAreaChanged
摄像头曝光区域已改变回调。
onCameraExposureAreaChanged?( x: number, y: number, width: number, height: number ): void;
该回调是由本地用户调用 setCameraExposurePosition 方法改变曝光位置触发的。
参数
- x
- 发生改变的曝光区域的 x 坐标。
- y
- 发生改变的曝光区域的 y 坐标。
- width
- 发生改变的曝光区域的宽度。
- height
- 发生改变的曝光区域的高度。
onCameraFocusAreaChanged
相机对焦区域已改变回调。
onCameraFocusAreaChanged?( x: number, y: number, width: number, height: number ): void;
该回调是由本地用户调用 setCameraFocusPositionInPreview 方法改变对焦位置触发的。
参数
- x
- 发生改变的对焦区域的 x 坐标。
- y
- 发生改变的对焦区域的 y 坐标。
- width
- 发生改变的对焦区域的宽度。
- height
- 发生改变的对焦区域的高度。
onCameraReady
摄像头就绪回调。
onCameraReady?(): void;
- 弃用:
-
请改用 onLocalVideoStateChanged 中的 LocalVideoStreamStateCapturing(1)。
该回调提示已成功打开摄像头,可以开始捕获视频。