image_receiver_native.h

Overview

The image_receiver_native.h file declares the APIs used to obtain image data from the native layer.

Library: libimage_receiver.so

File to include: <multimedia/image_framework/image/image_receiver_native.h>

System capability: SystemCapability.Multimedia.Image.ImageReceiver

Since: 12

Related module: Image_NativeModule

Summary

Types

Name	Description
typedef struct OH_ImageReceiverNative OH_ImageReceiverNative	Defines the data type name of the image receiver at the native layer.
typedef struct OH_ImageReceiverOptions OH_ImageReceiverOptions	Defines the data type name of the image receiver options.
typedef void(* OH_ImageReceiver_OnCallback) (OH_ImageReceiverNative *receiver)	Defines the callbacks for the image receiver at the native layer.

Functions

Name	Description
Image_ErrorCode OH_ImageReceiverOptions_Create (OH_ImageReceiverOptions **options)	Creates an OH_ImageReceiverOptions object at the application layer.
Image_ErrorCode OH_ImageReceiverOptions_GetSize (OH_ImageReceiverOptions options, Image_Size size)	Obtains the Image_Size information of an OH_ImageReceiverOptions object.
Image_ErrorCode OH_ImageReceiverOptions_SetSize (OH_ImageReceiverOptions *options, Image_Size size)	Sets the Image_Size information for an OH_ImageReceiverOptions object.
Image_ErrorCode OH_ImageReceiverOptions_GetCapacity (OH_ImageReceiverOptions options, int32_t capacity)	Obtains the capacity of an OH_ImageReceiverOptions object.
Image_ErrorCode OH_ImageReceiverOptions_SetCapacity (OH_ImageReceiverOptions *options, int32_t capacity)	Sets the capacity for an OH_ImageReceiverOptions object.
Image_ErrorCode OH_ImageReceiverOptions_Release (OH_ImageReceiverOptions *options)	Releases an OH_ImageReceiverOptions object.
Image_ErrorCode OH_ImageReceiverNative_Create (OH_ImageReceiverOptions options, OH_ImageReceiverNative *receiver)	Creates an OH_ImageReceiverNative object at the application layer.
Image_ErrorCode OH_ImageReceiverNative_GetReceivingSurfaceId (OH_ImageReceiverNative receiver, uint64_t surfaceId)	Obtains the surface ID through an OH_ImageReceiverNative object.
Image_ErrorCode OH_ImageReceiverNative_ReadLatestImage (OH_ImageReceiverNative receiver, OH_ImageNative *image)	Obtains the latest image through an OH_ImageReceiverNative object.
Image_ErrorCode OH_ImageReceiverNative_ReadNextImage (OH_ImageReceiverNative receiver, OH_ImageNative *image)	Obtains the next image through an OH_ImageReceiverNative object.
Image_ErrorCode OH_ImageReceiverNative_On (OH_ImageReceiverNative *receiver, OH_ImageReceiver_OnCallback callback)	Registers a callback, which is an OH_ImageReceiver_OnCallback object.
Image_ErrorCode OH_ImageReceiverNative_Off (OH_ImageReceiverNative *receiver)	Unregisters a callback, which is an OH_ImageReceiver_OnCallback object.
Image_ErrorCode OH_ImageReceiverNative_GetSize (OH_ImageReceiverNative receiver, Image_Size size)	Obtains the size of an image receiver, which is an OH_ImageReceiverNative object.
Image_ErrorCode OH_ImageReceiverNative_GetCapacity (OH_ImageReceiverNative receiver, int32_t capacity)	Obtains the capacity of an image receiver, which is an OH_ImageReceiverNative object.
Image_ErrorCode OH_ImageReceiverNative_Release (OH_ImageReceiverNative *receiver)	Releases an OH_ImageReceiverNative object.