openharmony 鸿蒙 capi-preview-output-h

2025-06-16 浏览 (1)

preview_output.h

概述

声明预览输出概念。

引用文件： <ohcamera/preview_output.h>

库： libohcamera.so

系统能力： SystemCapability.Multimedia.Camera.Core

起始版本： 11

相关模块： OH_Camera

汇总

结构体

名称typedef关键字描述
PreviewOutput_CallbacksPreviewOutput_Callbacks用于预览输出的回调。
Camera_PreviewOutputCamera_PreviewOutput预览输出对象。
可以使用OH_CameraManager_CreatePreviewOutput方法创建指针。

函数

名称typedef关键字描述
typedef void (*OH_PreviewOutput_OnFrameStart)(Camera_PreviewOutput* previewOutput)OH_PreviewOutput_OnFrameStart在PreviewOutput_Callbacks中被调用的预览输出帧开始回调。
typedef void (*OH_PreviewOutput_OnFrameEnd)(Camera_PreviewOutput* previewOutput, int32_t frameCount)OH_PreviewOutput_OnFrameEnd在PreviewOutput_Callbacks中被调用的预览输出帧结束回调。
typedef void (*OH_PreviewOutput_OnError)(Camera_PreviewOutput* previewOutput, Camera_ErrorCode errorCode)OH_PreviewOutput_OnError在PreviewOutput_Callbacks中被调用的预览输出帧错误回调。
Camera_ErrorCode OH_PreviewOutput_RegisterCallback(Camera_PreviewOutput* previewOutput,PreviewOutput_Callbacks* callback)-注册预览输出更改事件回调。
Camera_ErrorCode OH_PreviewOutput_UnregisterCallback(Camera_PreviewOutput* previewOutput,PreviewOutput_Callbacks* callback)-注销预览输出更改事件回调。
Camera_ErrorCode OH_PreviewOutput_Start(Camera_PreviewOutput* previewOutput)-开始预览输出。
Camera_ErrorCode OH_PreviewOutput_Stop(Camera_PreviewOutput* previewOutput)-停止预览输出。
Camera_ErrorCode OH_PreviewOutput_Release(Camera_PreviewOutput* previewOutput)-释放预览输出实例。
Camera_ErrorCode OH_PreviewOutput_GetActiveProfile(Camera_PreviewOutput* previewOutput, Camera_Profile** profile)-获取当前预览输出配置文件。
Camera_ErrorCode OH_PreviewOutput_DeleteProfile(Camera_Profile* profile)-删除预览配置文件实例。
Camera_ErrorCode OH_PreviewOutput_GetPreviewRotation(Camera_PreviewOutput* previewOutput, int displayRotation,Camera_ImageRotation* imageRotation)-获取相机预览旋转角度。
Camera_ErrorCode OH_PreviewOutput_SetPreviewRotation(Camera_PreviewOutput* previewOutput,Camera_ImageRotation previewRotation, bool isDisplayLocked)-设置相机预览旋转角度。
Camera_ErrorCode OH_PreviewOutput_GetSupportedFrameRates(Camera_PreviewOutput* previewOutput,Camera_FrameRateRange** frameRateRange, uint32_t* size)-获取支持的预览输出帧率列表。
Camera_ErrorCode OH_PreviewOutput_DeleteFrameRates(Camera_PreviewOutput* previewOutput,Camera_FrameRateRange* frameRateRange)-删除帧率列表。
Camera_ErrorCode OH_PreviewOutput_SetFrameRate(Camera_PreviewOutput* previewOutput,int32_t minFps, int32_t maxFps)-设置预览输出帧率。
Camera_ErrorCode OH_PreviewOutput_GetActiveFrameRate(Camera_PreviewOutput* previewOutput,Camera_FrameRateRange* frameRateRange)-获取当前预览输出帧率。

函数说明

OH_PreviewOutput_OnFrameStart()

typedef void (*OH_PreviewOutput_OnFrameStart)(Camera_PreviewOutput* previewOutput)

描述

在PreviewOutput_Callbacks中被调用的预览输出帧开始回调。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput传递回调的预览输出实例。

OH_PreviewOutput_OnFrameEnd()

typedef void (*OH_PreviewOutput_OnFrameEnd)(Camera_PreviewOutput* previewOutput, int32_t frameCount)

描述

在PreviewOutput_Callbacks中被调用的预览输出帧结束回调。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput传递回调的预览输出实例。
int32_t frameCount回调传递的帧计数。

OH_PreviewOutput_OnError()

typedef void (*OH_PreviewOutput_OnError)(Camera_PreviewOutput* previewOutput, Camera_ErrorCode errorCode)

描述

在PreviewOutput_Callbacks中被调用的预览输出帧错误回调。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput传递回调的预览输出实例。
Camera_ErrorCode errorCode预览输出的错误码。

参考：

CAMERA_SERVICE_FATAL_ERROR

OH_PreviewOutput_RegisterCallback()

Camera_ErrorCode OH_PreviewOutput_RegisterCallback(Camera_PreviewOutput* previewOutput,PreviewOutput_Callbacks* callback)

描述

注册预览输出更改事件回调。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput预览输出实例。
PreviewOutput_Callbacks* callback要注册的预览输出更改事件回调。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。

OH_PreviewOutput_UnregisterCallback()

Camera_ErrorCode OH_PreviewOutput_UnregisterCallback(Camera_PreviewOutput* previewOutput,PreviewOutput_Callbacks* callback)

描述

注销预览输出更改事件回调。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput预览输出实例。
PreviewOutput_Callbacks* callback要注销的预览输出更改事件回调。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。

OH_PreviewOutput_Start()

Camera_ErrorCode OH_PreviewOutput_Start(Camera_PreviewOutput* previewOutput)

描述

开始预览输出。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput要启动的预览输出实例。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SESSION_NOT_CONFIG：捕获会话未配置。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

OH_PreviewOutput_Stop()

Camera_ErrorCode OH_PreviewOutput_Stop(Camera_PreviewOutput* previewOutput)

描述

停止预览输出。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput要停止的预览输出实例。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

OH_PreviewOutput_Release()

Camera_ErrorCode OH_PreviewOutput_Release(Camera_PreviewOutput* previewOutput)

描述

释放预览输出实例。

起始版本： 11

参数：

参数项描述
Camera_PreviewOutput* previewOutput要释放的预览输出实例。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

OH_PreviewOutput_GetActiveProfile()

Camera_ErrorCode OH_PreviewOutput_GetActiveProfile(Camera_PreviewOutput* previewOutput, Camera_Profile** profile)

描述

获取当前预览输出配置文件。

起始版本： 12

参数：

参数项描述
Camera_PreviewOutput* previewOutput提供当前预览输出配置文件的预览输出实例。
Camera_Profile** profile如果方法调用成功，将记录当前的预览输出配置文件。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

OH_PreviewOutput_DeleteProfile()

Camera_ErrorCode OH_PreviewOutput_DeleteProfile(Camera_Profile* profile)

描述

删除预览配置文件实例。

起始版本： 12

参数：

参数项描述
Camera_Profile* profile要被删除的预览配置文件实例。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。

OH_PreviewOutput_GetPreviewRotation()

Camera_ErrorCode OH_PreviewOutput_GetPreviewRotation(Camera_PreviewOutput* previewOutput, int displayRotation,Camera_ImageRotation* imageRotation)

描述

获取相机预览旋转角度。

起始版本： 12

参数：

参数项描述
Camera_PreviewOutput* previewOutput用于获取预览旋转角度的预览输出实例。
int displayRotation当前显示的旋转角度。
Camera_ImageRotation* imageRotation预览旋转角度结果。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

OH_PreviewOutput_SetPreviewRotation()

Camera_ErrorCode OH_PreviewOutput_SetPreviewRotation(Camera_PreviewOutput* previewOutput,Camera_ImageRotation previewRotation, bool isDisplayLocked)

描述

设置相机预览旋转角度。

起始版本： 12

参数：

参数项描述
Camera_PreviewOutput* previewOutput用于设置预览旋转角度的预览输出实例。
Camera_ImageRotation previewRotation预览的显示旋转角度。
bool isDisplayLocked显示器状态，true表示显示器被锁定。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

OH_PreviewOutput_GetSupportedFrameRates()

Camera_ErrorCode OH_PreviewOutput_GetSupportedFrameRates(Camera_PreviewOutput* previewOutput,Camera_FrameRateRange** frameRateRange, uint32_t* size)

描述

获取支持的预览输出帧率列表。

起始版本： 12

参数：

参数项描述
Camera_PreviewOutput* previewOutput传递支持的帧率列表的预览输出实例。
Camera_FrameRateRange** frameRateRange如果方法调用成功，将记录支持的预览输出帧率列表。
uint32_t* size如果方法调用成功，将记录支持的预览输出帧率列表大小。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

OH_PreviewOutput_DeleteFrameRates()

Camera_ErrorCode OH_PreviewOutput_DeleteFrameRates(Camera_PreviewOutput* previewOutput,Camera_FrameRateRange* frameRateRange)

描述

删除帧率列表。

起始版本： 12

参数：

参数项描述
Camera_PreviewOutput* previewOutput预览输出实例。
Camera_FrameRateRange* frameRateRange要删除的帧率列表。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。

OH_PreviewOutput_SetFrameRate()

Camera_ErrorCode OH_PreviewOutput_SetFrameRate(Camera_PreviewOutput* previewOutput,int32_t minFps, int32_t maxFps)

描述

设置预览输出帧率。

起始版本： 12

参数：

参数项描述
Camera_PreviewOutput* previewOutput要设置帧率的预览输出实例。
int32_t minFps要设置的最小值。
int32_t maxFps要设置的最大值。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。

OH_PreviewOutput_GetActiveFrameRate()

Camera_ErrorCode OH_PreviewOutput_GetActiveFrameRate(Camera_PreviewOutput* previewOutput,Camera_FrameRateRange* frameRateRange)

描述

获取当前预览输出帧率。

起始版本： 12

参数：

参数项描述
Camera_PreviewOutput* previewOutput传递当前预览输出帧率的预览输出实例。
Camera_FrameRateRange* frameRateRange如果方法调用成功，则将记录当前的Camera_FrameRateRange。

返回：

类型说明
Camera_ErrorCodeCAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Camera Kit（相机服务）

harmony 鸿蒙Interface (AutoDeviceSwitch)

harmony 鸿蒙Interface (AutoDeviceSwitchQuery)

harmony 鸿蒙Interface (AutoExposure)

harmony 鸿蒙Interface (AutoExposureQuery)

harmony 鸿蒙Interface (CameraInput)

harmony 鸿蒙Interface (CameraManager)

harmony 鸿蒙Interface (CameraOutput)

harmony 鸿蒙废弃的Interface (CaptureSession, deprecated)

harmony 鸿蒙Interface (ColorManagement)

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/tk8jtW