camera_input.h
概述
声明相机输入概念。
引用文件： <ohcamera/camera_input.h>
库： libohcamera.so
系统能力： SystemCapability.Multimedia.Camera.Core
起始版本： 11
相关模块： OH_Camera
汇总
结构体
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| CameraInput_Callbacks | CameraInput_Callbacks | 相机输入错误事件的回调。 |
| Camera_Input | Camera_Input | 相机输入对象。可以使用OH_CameraManager_CreateCameraInput方法创建指针。 |
函数
函数说明
OH_CameraInput_OnError()
typedef void (*OH_CameraInput_OnError)(const Camera_Input* cameraInput, Camera_ErrorCode errorCode)
描述
在CameraInput_Callbacks中被调用的相机输入错误回调。
起始版本： 11
参数：
| 参数项 | 描述 |
|---|---|
| const Camera_Input* cameraInput | 传递回调的Camera_Input。 |
| Camera_ErrorCode errorCode | 相机输入的Camera_ErrorCode。 |
参考：
OH_CameraInput_RegisterCallback()
Camera_ErrorCode OH_CameraInput_RegisterCallback(Camera_Input* cameraInput, CameraInput_Callbacks* callback)
描述
注册相机输入更改事件回调。
起始版本： 11
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | Camera_Input实例。 |
| CameraInput_Callbacks* callback | 要注册的相机输入更改事件回调。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 |
OH_CameraInput_UnregisterCallback()
Camera_ErrorCode OH_CameraInput_UnregisterCallback(Camera_Input* cameraInput, CameraInput_Callbacks* callback)
描述
注销相机输入更改事件回调。
起始版本： 11
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | Camera_Input实例。 |
| CameraInput_Callbacks* callback | 要注销的相机输入更改事件回调。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 |
OH_CameraInput_Open()
Camera_ErrorCode OH_CameraInput_Open(Camera_Input* cameraInput)
描述
打开相机。
起始版本： 11
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | 要打开的Camera_Input实例。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 CAMERA_CONFLICT_CAMERA：因冲突而无法使用相机。 CAMERA_DEVICE_DISABLED：由于安全原因禁用了相机。 CAMERA_SERVICE_FATAL_ERROR：相机服务异常。 |
OH_CameraInput_OpenSecureCamera()
Camera_ErrorCode OH_CameraInput_OpenSecureCamera(Camera_Input* cameraInput, uint64_t* secureSeqId)
描述
打开安全相机。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | 要打开的Camera_Input实例。 |
| uint64_t* secureSeqId | 表示安全摄像头的序列值。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 CAMERA_CONFLICT_CAMERA：因冲突而无法使用相机。 CAMERA_DEVICE_DISABLED：由于安全原因禁用了相机。 CAMERA_SERVICE_FATAL_ERROR：相机服务异常。 |
OH_CameraInput_OpenConcurrentCameras()
Camera_ErrorCode OH_CameraInput_OpenConcurrentCameras(Camera_Input* cameraInput, Camera_ConcurrentType type)
描述
根据指定并发类型打开相机。
起始版本： 18
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | 要打开的Camera_Input实例。 |
| Camera_ConcurrentType type | 指定并发类型。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK: 方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 CAMERA_CONFLICT_CAMERA：因冲突而无法使用相机。 CAMERA_DEVICE_DISABLED：由于安全原因禁用了相机。 CAMERA_SERVICE_FATAL_ERROR：相机服务异常。 |
OH_CameraInput_Close()
Camera_ErrorCode OH_CameraInput_Close(Camera_Input* cameraInput)
描述
关闭相机。
起始版本： 11
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | 要关闭的Camera_Input实例。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 CAMERA_SERVICE_FATAL_ERROR：相机服务异常。 |
OH_CameraInput_Release()
Camera_ErrorCode OH_CameraInput_Release(Camera_Input* cameraInput)
描述
释放相机输入实例。
和OH_CameraInput_Close只需要调用其中一个，调用之后无须再调用OH_CameraInput_Close。
起始版本： 11
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | 要释放的Camera_Input实例。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 CAMERA_SERVICE_FATAL_ERROR：相机服务异常。 |
OH_CameraInput_IsPhysicalCameraOrientationVariable()
Camera_ErrorCode OH_CameraInput_IsPhysicalCameraOrientationVariable(Camera_Input* cameraInput, bool* isVariable)
描述
查询设备不同折叠状态下，相机物理镜头角度是否可变。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | Camera_Input实例。 |
| bool* isVariable | 查询设备不同折叠状态下，相机物理镜头角度是否可变。true表示可变，false表示不可变。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 |
OH_CameraInput_GetPhysicalCameraOrientation()
Camera_ErrorCode OH_CameraInput_GetPhysicalCameraOrientation(Camera_Input* cameraInput, uint32_t* orientation)
描述
获取设备当前折叠状态下的物理镜头角度。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | Camera_Input实例。 |
| uint32_t* orientation | 如果方法调用成功，将返回设备当前折叠状态下的物理镜头角度。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 |
OH_CameraInput_UsePhysicalCameraOrientation()
Camera_ErrorCode OH_CameraInput_UsePhysicalCameraOrientation(Camera_Input* cameraInput, bool isUsed)
描述
选择是否使用物理镜头角度。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | Camera_Input实例。 |
| bool isUsed | 选择是否使用物理镜头角度。true表示使用，false表示不使用。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 CAMERA_OPERATION_NOT_ALLOWED：操作不允许。 CAMERA_SERVICE_FATAL_ERROR：相机服务异常。 |
OH_CameraInput_OnOcclusionDetectionCallback()
typedef void (*OH_CameraInput_OnOcclusionDetectionCallback)(const Camera_Input* cameraInput, Camera_OcclusionDetectionResult occlusionDetectionResult)
描述
相机镜头遮挡、脏污检测结果回调。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| const Camera_Input* cameraInput | 传递回调的Camera_Input。 |
| Camera_OcclusionDetectionResult occlusionDetectionResult | 相机镜头遮挡、脏污检测结果。 |
OH_CameraInput_RegisterOcclusionDetectionCallback()
Camera_ErrorCode OH_CameraInput_RegisterOcclusionDetectionCallback(Camera_Input* cameraInput, OH_CameraInput_OnOcclusionDetectionCallback occlusionDetectionCallback)
描述
注册相机镜头遮挡、脏污检测事件回调。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | Camera_Input实例。 |
| OH_CameraInput_OnOcclusionDetectionCallback occlusionDetectionCallback | 要注册的相机镜头遮挡、脏污检测事件回调。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 |
OH_CameraInput_UnregisterOcclusionDetectionCallback()
Camera_ErrorCode OH_CameraInput_UnregisterOcclusionDetectionCallback(Camera_Input* cameraInput, OH_CameraInput_OnOcclusionDetectionCallback occlusionDetectionCallback)
描述
注销相机镜头遮挡、脏污检测事件回调。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| Camera_Input* cameraInput | Camera_Input实例。 |
| OH_CameraInput_OnOcclusionDetectionCallback occlusionDetectionCallback | 要注销的相机镜头遮挡、脏污检测事件回调。 |
返回：
| 类型 | 说明 |
|---|---|
| Camera_ErrorCode | CAMERA_OK：方法调用成功。 CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 |