image_packer_native.h

Overview

The image_packer_native.h file declares the APIs for image encoding.

Library: libimage_packer.so

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

System capability: SystemCapability.Multimedia.Image.ImagePacker

Since: 12

Related module: Image_NativeModule

Summary

Types

Name	Description
typedef struct OH_ImagePackerNative OH_ImagePackerNative	Defines a struct for the image packer, which is used to perform operations related to an image packer.
typedef struct OH_PackingOptions OH_PackingOptions	Defines a struct for image encoding parameters.

Enums

Name	Description
IMAGE_PACKER_DYNAMIC_RANGE { IMAGE_PACKER_DYNAMIC_RANGE_AUTO = 0, IMAGE_PACKER_DYNAMIC_RANGE_SDR = 1 }	Enumerates the dynamic range for encoding.

Functions

Name	Description
Image_ErrorCode OH_PackingOptions_Create (OH_PackingOptions **options)	Creates the pointer to an OH_PackingOptions struct.
Image_ErrorCode OH_PackingOptions_GetMimeType (OH_PackingOptions *options, Image_MimeType *format)	Obtains the MIME type.
Image_ErrorCode OH_PackingOptions_SetMimeType (OH_PackingOptions *options, Image_MimeType *format)	Sets the MIME type.
Image_ErrorCode OH_PackingOptions_GetQuality (OH_PackingOptions *options, uint32_t *quality)	Obtains the encoding quality.
Image_ErrorCode OH_PackingOptions_SetQuality (OH_PackingOptions *options, uint32_t quality)	Sets the encoding quality.
Image_ErrorCode OH_PackingOptions_GetDesiredDynamicRange (OH_PackingOptions *options, int32_t *desiredDynamicRange)	Obtains the desired dynamic range during encoding.
Image_ErrorCode OH_PackingOptions_SetDesiredDynamicRange (OH_PackingOptions *options, int32_t desiredDynamicRange)	Sets the desired dynamic range during encoding.
Image_ErrorCode OH_PackingOptions_Release (OH_PackingOptions *options)	Releases the pointer to an OH_PackingOptions struct.
Image_ErrorCode OH_ImagePackerNative_Create (OH_ImagePackerNative **imagePacker)	Creates the pointer to an OH_ImagePackerNative struct.
Image_ErrorCode OH_ImagePackerNative_PackToDataFromImageSource (OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_ImageSourceNative *imageSource, uint8_t *outData, size_t *size)	Encodes an image source into data in a given format.
Image_ErrorCode OH_ImagePackerNative_PackToDataFromPixelmap (OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_PixelmapNative *pixelmap, uint8_t *outData, size_t *size)	Encodes a PixelMap into data in a given format.
Image_ErrorCode OH_ImagePackerNative_PackToDataFromPicture (OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_PictureNative *picture, uint8_t *outData, size_t *size)	Encodes a picture into data in a given format.
Image_ErrorCode OH_ImagePackerNative_PackToFileFromImageSource (OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_ImageSourceNative *imageSource, int32_t fd)	Encodes an image source into a file.
Image_ErrorCode OH_ImagePackerNative_PackToFileFromPixelmap (OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_PixelmapNative *pixelmap, int32_t fd)	Encodes a PixelMap into a file.
Image_ErrorCode OH_ImagePackerNative_PackToFileFromPicture (OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_PictureNative *picture, int32_t fd)	Encodes a picture into a file.
Image_ErrorCode OH_ImagePackerNative_Release (OH_ImagePackerNative *imagePacker)	Releases the pointer to an OH_ImagePackerNative struct.