视频设备管理
- HarmonyOS
更新时间不可用
介绍跟视频设备管理相关的方法和回调。
getCameraMaxZoomFactor
获取摄像头支持最大缩放比例。
public abstract getCameraMaxZoomFactor(): number;详情
注意:
- 该方法必须在 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 ENCODING (2) 之后调用。
返回值
设备摄像头支持的最大缩放比例。
所属接口类
isCameraAutoFocusFaceModeSupported
检测设备是否支持人脸对焦功能。
public abstract isCameraAutoFocusFaceModeSupported(): boolean;详情
注意:
- 该方法必须在 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 ENCODING (2) 之后调用。
返回值
true: 设备支持人脸对焦功能。false: 设备不支持人脸对焦功能。
所属接口类
isCameraExposurePositionSupported
检测设备是否支持手动曝光功能。
public abstract isCameraExposurePositionSupported(): boolean;详情
注意:
- 该方法必须在 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 ENCODING (2) 之后调用。
返回值
true: 设备支持手动曝光功能。false: 设备不支持手动曝光功能。
所属接口类
isCameraExposureSupported
查询当前摄像头是否支持曝光调节。
public abstract isCameraExposureSupported(): boolean;详情
注意:
- 该方法必须在 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 ENCODING (2) 之后调用。
- 建议你在调用 setCameraExposureFactor 调节曝光系数前,先调用该方法查询当前摄像头是否支持曝光调节。
- 当你调用该方法时,查询的是当前正在使用的摄像头是否支持曝光调节,即调用 setCameraCapturerConfiguration 时指定的摄像头。
返回值
true:方法调用成功。false:方法调用失败。详见错误码了解详情和解决建议。
所属接口类
isCameraFaceDetectSupported
检查设备摄像头是否支持人脸检测。
public abstract isCameraFaceDetectSupported(): boolean;返回值
true: 设备摄像头支持人脸检测。false: 设备摄像头不支持人脸检测。
所属接口类
isCameraFocusSupported
检测设备是否支持手动对焦功能。
public abstract isCameraFocusSupported(): boolean;详情
注意:
- 该方法必须在 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 ENCODING (2) 之后调用。
返回值
true: 设备支持手动对焦功能。false: 设备不支持手动对焦功能。
所属接口类
isCameraZoomSupported
检测设备是否支持摄像头缩放功能。
public abstract isCameraZoomSupported(): boolean;调用时机
该方法必须在 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 ENCODING (2) 之后调用。
调用限制
无。
返回值
true: 设备支持相机缩放功能。false: 设备不支持相机缩放功能。
所属接口类
setCameraAutoFocusFaceModeEnabled
设置是否开启人脸对焦功能。
public abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number;调用时机
该方法必须在 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 ENCODING (2) 之后调用。
调用限制
无。
参数
是否开启人脸对焦:
true: 开启人脸对焦功能。false: 关闭人脸对焦功能。
返回值
所属接口类
setCameraCapturerConfiguration
设置摄像头采集配置。
public abstract setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number;调用时机
该方法必须在开启本地摄像头采集前调用,如 startPreview 和 joinChannelWithOptions 前调用。
调用限制
无。
参数
| 参数名 | 描述 |
|---|---|
config | 摄像头采集配置,详见 CameraCapturerConfiguration。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
setCameraExposurePosition
设置手动曝光位置。
public abstract setCameraExposurePosition(positionXinView: number, positionYinView: number): number;详情
注意:
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 CAPTURING (1) 后。
- 成功调用该方法后,本地会触发 onCameraExposureAreaChanged 回调。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraFocusPositionInPreview
设置手动对焦位置,并触发对焦。
public abstract setCameraFocusPositionInPreview(positionX: number, positionY: number): number;详情
注意:
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 CAPTURING (1) 后。
- 成功调用该方法后,本地会触发 onCameraFocusPointChanged 回调。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCameraZoomFactor
设置摄像头缩放比例。
public abstract setCameraZoomFactor(factor: number): number;详情
注意:
- 该方法必须在 enableVideo 后调用,设置结果在摄像头成功开启后生效,即 SDK 触发 onLocalVideoStateChanged 回调返回本地视频状态为 CAPTURING (1) 后。
参数
| 参数名 | 描述 |
|---|---|
factor | 摄像头缩放比例。对不支持超广角的设备,取值范围从 1.0 到最大缩放比例;对支持超广角的设备,取值范围从 0.5 到最大缩放比例。你可以通过 getCameraMaxZoomFactor 方法获取设备支持的最大缩放比例。 |
返回值
- 方法调用成功: 返回设置的 factor 值。
- 方法调用失败: 返回值 < 0。
switchCamera
切换前置/后置摄像头。
public abstract switchCamera(): number;你可以调用该方法在 App 运行期间基于可用摄像头的实际情况来动态切换摄像头,而无需重启视频流或重新配置视频源。
调用时机
该方法必须在摄像头成功开启后调用,即 SDK 触发 onLocalVideoStateChanged 回调,返回本地视频状态为 CAPTURING (1) 后。
调用限制
该方法仅会对第一路摄像头采集的视频流进行摄像头切换操作,即调用 startCameraCapture 时设置为 (0) 的视频源。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
onCameraExposureAreaChanged
摄像头曝光区域已改变回调。
onCameraExposureAreaChanged?:(rect:camera.Rect) => void;参数
所属接口类
onCameraFocusPointChanged
相机对焦区域已改变回调。
onCameraFocusPointChanged?:(point:camera.Point) => void;