harmony 鸿蒙preview_output.h

2025-06-16
浏览 (2)

preview_output.h

概述

声明预览输出概念。

引用文件：

库： libohcamera.so

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

起始版本： 11

相关模块： OH_Camera

汇总

结构体

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

函数

函数说明

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_ErrorCode|CAMERA_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_ErrorCode|CAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。|

OH_PreviewOutput_Start()

Camera_ErrorCode OH_PreviewOutput_Start(Camera_PreviewOutput* previewOutput)

描述

开始预览输出。

起始版本： 11

参数：

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

返回：

|类型|说明| |–|–| |Camera_ErrorCode|CAMERA_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_ErrorCode|CAMERA_OK：方法调用成功。
CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。
CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。|

OH_PreviewOutput_Release()

Camera_ErrorCode OH_PreviewOutput_Release(Camera_PreviewOutput* previewOutput)

描述

释放预览输出实例。

起始版本： 11

参数：

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

返回：

OH_PreviewOutput_GetActiveProfile()

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

描述

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

起始版本： 12

参数：

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

返回：

OH_PreviewOutput_DeleteProfile()

Camera_ErrorCode OH_PreviewOutput_DeleteProfile(Camera_Profile* profile)

描述

删除预览配置文件实例。

起始版本： 12

参数：

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

返回：

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

OH_PreviewOutput_GetPreviewRotation()

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

描述

获取相机预览旋转角度。

起始版本： 12

参数：

返回：

OH_PreviewOutput_SetPreviewRotation()

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

描述

设置相机预览旋转角度。

起始版本： 12

参数：

返回：

OH_PreviewOutput_GetSupportedFrameRates()

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

描述

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

起始版本： 12

参数：

返回：

OH_PreviewOutput_DeleteFrameRates()

Camera_ErrorCode OH_PreviewOutput_DeleteFrameRates(Camera_PreviewOutput* previewOutput,Camera_FrameRateRange* frameRateRange)

描述

删除帧率列表。

起始版本： 12

参数：

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

返回：

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

OH_PreviewOutput_SetFrameRate()

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

描述

设置预览输出帧率。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |Camera_ErrorCode|CAMERA_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。|

返回：