1# preview_output.h
2
3
4## Overview
5
6The **preview_output.h** file declares the preview output concepts.
7
8**Library**: libohcamera.so
9
10**File to include**: <ohcamera/preview_output.h>
11
12**System capability**: SystemCapability.Multimedia.Camera.Core
13
14**Since**: 11
15
16**Related module**: [OH_Camera](_o_h___camera.md)
17
18
19## Summary
20
21
22### Structs
23
24| Name| Description|
25| -------- | -------- |
26| struct  [PreviewOutput_Callbacks](_preview_output___callbacks.md) | Describes the callbacks related to preview output.|
27
28
29### Types
30
31| Name| Description|
32| -------- | -------- |
33| typedef struct [Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) [Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) | Defines a struct for the preview output object.|
34| typedef void(\* [OH_PreviewOutput_OnFrameStart](_o_h___camera.md#oh_previewoutput_onframestart)) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput) | Defines the callback defined in the [PreviewOutput_Callbacks](_preview_output___callbacks.md) struct and used to report preview output frame start events.|
35| typedef void(\* [OH_PreviewOutput_OnFrameEnd](_o_h___camera.md#oh_previewoutput_onframeend)) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, int32_t frameCount) | Defines the callback defined in the [PreviewOutput_Callbacks](_preview_output___callbacks.md) struct and used to report preview output frame end events.|
36| typedef void(\* [OH_PreviewOutput_OnError](_o_h___camera.md#oh_previewoutput_onerror)) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) errorCode) | Defines the callback defined in the [PreviewOutput_Callbacks](_preview_output___callbacks.md) struct and used to report preview output errors.|
37| typedef struct [PreviewOutput_Callbacks](_preview_output___callbacks.md) [PreviewOutput_Callbacks](_o_h___camera.md#previewoutput_callbacks) | Defines a struct for the callbacks related to preview output.|
38
39
40### Functions
41
42| Name| Description|
43| -------- | -------- |
44| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_RegisterCallback](_o_h___camera.md#oh_previewoutput_registercallback) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, [PreviewOutput_Callbacks](_preview_output___callbacks.md) \*callback) | Registers a callback to listen for preview output events.|
45| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_UnregisterCallback](_o_h___camera.md#oh_previewoutput_unregistercallback) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, [PreviewOutput_Callbacks](_preview_output___callbacks.md) \*callback) | Unregisters the callback used to listen for preview output events.|
46| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_Start](_o_h___camera.md#oh_previewoutput_start) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput) | Starts preview output.|
47| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_Stop](_o_h___camera.md#oh_previewoutput_stop) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput) | Stops preview output.|
48| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_Release](_o_h___camera.md#oh_previewoutput_release) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput) | Releases a **PreviewOutput** instance.|
49| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_GetActiveProfile](_o_h___camera.md#oh_previewoutput_getactiveprofile) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, [Camera_Profile](_camera___profile.md) \*\*profile) | Obtains the profile of a **PreviewOutput** instance.|
50| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_DeleteProfile](_o_h___camera.md#oh_previewoutput_deleteprofile) ([Camera_Profile](_camera___profile.md) \*profile) | Deletes the profile of this **PreviewOutput** instance.|
51| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_GetSupportedFrameRates](_o_h___camera.md#oh_previewoutput_getsupportedframerates) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, [Camera_FrameRateRange](_camera___frame_rate_range.md) \*\*frameRateRange, uint32_t \*size) | Obtains the list of frame rates supported by a **PreviewOutput** instance.|
52| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_DeleteFrameRates](_o_h___camera.md#oh_previewoutput_deleteframerates) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, [Camera_FrameRateRange](_camera___frame_rate_range.md) \*frameRateRange) | Deletes the frame rate list.|
53| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_SetFrameRate](_o_h___camera.md#oh_previewoutput_setframerate) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, int32_t minFps, int32_t maxFps) | Sets the frame rates for a **PreviewOutput** instance.|
54| [Camera_ErrorCode](_o_h___camera.md#camera_errorcode) [OH_PreviewOutput_GetActiveFrameRate](_o_h___camera.md#oh_previewoutput_getactiveframerate) ([Camera_PreviewOutput](_o_h___camera.md#camera_previewoutput) \*previewOutput, [Camera_FrameRateRange](_camera___frame_rate_range.md) \*frameRateRange) | Obtains the active frame rates of a **PreviewOutput** instance.|
55