1# Core 2 3 4## 概述 5 6Core模块提供用于媒体框架的基础骨干能力，包含内存、错误码、媒体数据结构等相关函数。 7 8**系统能力：** SystemCapability.Multimedia.Media.Core 9 10**起始版本：** 9 11 12 13## 汇总 14 15 16### 文件 17 18| 名称 | 描述 | 19| -------- | -------- | 20| [native_audio_channel_layout.h](native__audio__channel__layout_8h.md) | 在录制和播放时的扬声器布局。 | 21| [native_avbuffer.h](native__avbuffer_8h.md) | 声明了媒体数据结构AVBuffer的函数接口。 | 22| [native_avbuffer_info.h](native__avbuffer__info_8h.md) | 声明了媒体数据结构AVBuffer属性的定义。 | 23| [native_averrors.h](native__averrors_8h.md) | 媒体框架错误码。 | 24| [native_avformat.h](native__avformat_8h.md) | 声明了OH_AVFormat相关的函数和枚举。 | 25| [native_avmemory.h](native__avmemory_8h.md) | 声明了媒体数据结构AVMemory的定义。 | 26 27 28### 结构体 29 30| 名称 | 描述 | 31| -------- | -------- | 32| struct [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) | 定义OH_AVCodec的缓冲区描述信息。 | 33 34 35### 类型定义 36 37| 名称 | 描述 | 38| -------- | -------- | 39| typedef enum [OH_AudioChannelSet](#oh_audiochannelset-1) [OH_AudioChannelSet](#oh_audiochannelset) | 音频声道集合。 | 40| typedef enum [OH_AmbAttributeSet](#oh_ambattributeset-1) [OH_AmbAttributeSet](#oh_ambattributeset) | 高保真立体声混响设置。 | 41| typedef enum [OH_AudioChannelLayout](#oh_audiochannellayout-1) [OH_AudioChannelLayout](#oh_audiochannellayout) | 音频声道布局。 | 42| typedef struct [OH_AVBuffer](#oh_avbuffer) [OH_AVBuffer](#oh_avbuffer) | 为媒体内存接口定义native层对象。 | 43| typedef struct [OH_NativeBuffer](#oh_nativebuffer) [OH_NativeBuffer](#oh_nativebuffer) | 为图形内存接口定义native层对象。 | 44| typedef enum [OH_AVCodecBufferFlags](#oh_avcodecbufferflags-1) [OH_AVCodecBufferFlags](#oh_avcodecbufferflags) | 枚举OH_AVCodec缓冲区标记的类别。 | 45| typedef struct [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) [OH_AVCodecBufferAttr](#oh_avcodecbufferattr) | 定义OH_AVCodec的缓冲区描述信息。 | 46| typedef enum [OH_AVErrCode](#oh_averrcode-1) [OH_AVErrCode](#oh_averrcode) | 媒体框架错误码。 | 47| typedef struct [OH_AVFormat](#oh_avformat) [OH_AVFormat](#oh_avformat) | 为OH_AVFormat接口定义native层对象。 | 48| typedef enum [OH_AVPixelFormat](#oh_avpixelformat-1) [OH_AVPixelFormat](#oh_avpixelformat) | 视频像素格式的枚举类。 | 49| typedef struct [OH_AVMemory](#oh_avmemory) [OH_AVMemory](#oh_avmemory) | 为音视频内存接口定义native层对象。 | 50 51 52### 枚举 53 54| 名称 | 描述 | 55| -------- | -------- | 56| [OH_AudioChannelSet](#oh_audiochannelset-1) {<br/>CH_SET_FRONT_LEFT = 1ULL << 0U,<br/>CH_SET_FRONT_RIGHT = 1ULL << 1U,<br/>CH_SET_FRONT_CENTER = 1ULL << 2U,<br/>CH_SET_LOW_FREQUENCY = 1ULL << 3U,<br/>CH_SET_BACK_LEFT = 1ULL << 4U,<br/>CH_SET_BACK_RIGHT = 1ULL << 5U,<br/>CH_SET_FRONT_LEFT_OF_CENTER = 1ULL << 6U,<br/>CH_SET_FRONT_RIGHT_OF_CENTER = 1ULL << 7U,<br/>CH_SET_BACK_CENTER = 1ULL << 8U,<br/>CH_SET_SIDE_LEFT = 1ULL << 9U,<br/>CH_SET_SIDE_RIGHT = 1ULL << 10U,<br/>CH_SET_TOP_CENTER = 1ULL << 11U,<br/>CH_SET_TOP_FRONT_LEFT = 1ULL << 12U,<br/>CH_SET_TOP_FRONT_CENTER = 1ULL << 13U,<br/>CH_SET_TOP_FRONT_RIGHT = 1ULL << 14U,<br/>CH_SET_TOP_BACK_LEFT = 1ULL << 15U,<br/>CH_SET_TOP_BACK_CENTER = 1ULL << 16U,<br/>CH_SET_TOP_BACK_RIGHT = 1ULL << 17U,<br/>CH_SET_STEREO_LEFT = 1ULL << 29U,<br/>CH_SET_STEREO_RIGHT = 1ULL << 30U,<br/>CH_SET_WIDE_LEFT = 1ULL << 31U,<br/>CH_SET_WIDE_RIGHT = 1ULL << 32U,<br/>CH_SET_SURROUND_DIRECT_LEFT = 1ULL << 33U,<br/>CH_SET_SURROUND_DIRECT_RIGHT = 1ULL << 34U,<br/>CH_SET_LOW_FREQUENCY_2 = 1ULL << 35U,<br/>CH_SET_TOP_SIDE_LEFT = 1ULL << 36U,<br/>CH_SET_TOP_SIDE_RIGHT = 1ULL << 37U,<br/>CH_SET_BOTTOM_FRONT_CENTER = 1ULL << 38U,<br/>CH_SET_BOTTOM_FRONT_LEFT = 1ULL << 39U,<br/>CH_SET_BOTTOM_FRONT_RIGHT = 1ULL << 40U<br/>} | 音频声道集合。 | 57| [OH_AmbAttributeSet](#oh_ambattributeset-1) {<br/>AMB_ORD_1 = 1ULL << 0U,<br/>AMB_ORD_2 = 2ULL << 0U,<br/>AMB_ORD_3 = 3ULL << 0U,<br/>AMB_COM_ACN = 0ULL << 8U,<br/>AMB_COM_FUMA = 1ULL << 8U,<br/>AMB_NOR_N3D = 0ULL << 12U,<br/>AMB_NOR_SN3D = 1ULL << 12U,<br/>AMB_MODE = 1ULL << 44U<br/>} | 高保真立体声混响设置。 | 58| [OH_AudioChannelLayout](#oh_audiochannellayout-1) {<br/>CH_LAYOUT_UNKNOWN = 0ULL,<br/>CH_LAYOUT_MONO = CH_SET_FRONT_CENTER,<br/>CH_LAYOUT_STEREO = CH_SET_FRONT_LEFT \| CH_SET_FRONT_RIGHT,<br/>CH_LAYOUT_STEREO_DOWNMIX = CH_SET_STEREO_LEFT \| CH_SET_STEREO_RIGHT,<br/>CH_LAYOUT_2POINT1 = CH_LAYOUT_STEREO \| CH_SET_LOW_FREQUENCY,<br/>CH_LAYOUT_3POINT0 = CH_LAYOUT_STEREO \| CH_SET_BACK_CENTER,<br/>CH_LAYOUT_SURROUND = CH_LAYOUT_STEREO \| CH_SET_FRONT_CENTER,<br/>CH_LAYOUT_3POINT1 = CH_LAYOUT_SURROUND \| CH_SET_LOW_FREQUENCY,<br/>CH_LAYOUT_4POINT0 = CH_LAYOUT_SURROUND \| CH_SET_BACK_CENTER,<br/>CH_LAYOUT_QUAD_SIDE = CH_LAYOUT_STEREO \| CH_SET_SIDE_LEFT \| CH_SET_SIDE_RIGHT,<br/>CH_LAYOUT_QUAD = CH_LAYOUT_STEREO \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT,<br/>CH_LAYOUT_2POINT0POINT2 = CH_LAYOUT_STEREO \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT,<br/>CH_LAYOUT_AMB_ORDER1_ACN_N3D = AMB_MODE \| AMB_ORD_1 \| AMB_COM_ACN \| AMB_NOR_N3D, CH_LAYOUT_AMB_ORDER1_ACN_SN3D = AMB_MODE \| AMB_ORD_1 \| AMB_COM_ACN \| AMB_NOR_SN3D,<br/>CH_LAYOUT_AMB_ORDER1_FUMA = AMB_MODE \| AMB_ORD_1 \| AMB_COM_FUMA,<br/>CH_LAYOUT_4POINT1 = CH_LAYOUT_4POINT0 \| CH_SET_LOW_FREQUENCY,<br/>CH_LAYOUT_5POINT0 = CH_LAYOUT_SURROUND \| CH_SET_SIDE_LEFT \| CH_SET_SIDE_RIGHT,<br/>CH_LAYOUT_5POINT0_BACK = CH_LAYOUT_SURROUND \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT,<br/>CH_LAYOUT_2POINT1POINT2 = CH_LAYOUT_2POINT0POINT2 \| CH_SET_LOW_FREQUENCY,<br/>CH_LAYOUT_3POINT0POINT2 = CH_LAYOUT_2POINT0POINT2 \| CH_SET_FRONT_CENTER,<br/>CH_LAYOUT_5POINT1 = CH_LAYOUT_5POINT0 \| CH_SET_LOW_FREQUENCY,<br/>CH_LAYOUT_5POINT1_BACK = CH_LAYOUT_5POINT0_BACK \| CH_SET_LOW_FREQUENCY,<br/>CH_LAYOUT_6POINT0 = CH_LAYOUT_5POINT0 \| CH_SET_BACK_CENTER,<br/>CH_LAYOUT_3POINT1POINT2 = CH_LAYOUT_3POINT1 \| CH_SET_TOP_FRONT_LEFT \| CH_SET_TOP_FRONT_RIGHT,<br/>CH_LAYOUT_6POINT0_FRONT = CH_LAYOUT_QUAD_SIDE \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER,<br/>CH_LAYOUT_HEXAGONAL = CH_LAYOUT_5POINT0_BACK \| CH_SET_BACK_CENTER,<br/>CH_LAYOUT_6POINT1 = CH_LAYOUT_5POINT1 \| CH_SET_BACK_CENTER,<br/>CH_LAYOUT_6POINT1_BACK = CH_LAYOUT_5POINT1_BACK \| CH_SET_BACK_CENTER,<br/>CH_LAYOUT_6POINT1_FRONT = CH_LAYOUT_6POINT0_FRONT \| CH_SET_LOW_FREQUENCY,<br/>CH_LAYOUT_7POINT0 = CH_LAYOUT_5POINT0 \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT,<br/>CH_LAYOUT_7POINT0_FRONT = CH_LAYOUT_5POINT0 \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER,<br/>CH_LAYOUT_7POINT1 = CH_LAYOUT_5POINT1 \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT,<br/>CH_LAYOUT_OCTAGONAL = CH_LAYOUT_5POINT0 \| CH_SET_BACK_LEFT \| CH_SET_BACK_CENTER \| CH_SET_BACK_RIGHT,<br/>CH_LAYOUT_5POINT1POINT2 = CH_LAYOUT_5POINT1 \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT,<br/>CH_LAYOUT_7POINT1_WIDE = CH_LAYOUT_5POINT1 \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER,<br/>CH_LAYOUT_7POINT1_WIDE_BACK = CH_LAYOUT_5POINT1_BACK \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER,<br/>CH_LAYOUT_AMB_ORDER2_ACN_N3D = AMB_MODE \| AMB_ORD_2 \| AMB_COM_ACN \| AMB_NOR_N3D,<br/>CH_LAYOUT_AMB_ORDER2_ACN_SN3D = AMB_MODE \| AMB_ORD_2 \| AMB_COM_ACN \| AMB_NOR_SN3D,<br/>CH_LAYOUT_AMB_ORDER2_FUMA = AMB_MODE \| AMB_ORD_2 \| AMB_COM_FUMA,<br/>CH_LAYOUT_5POINT1POINT4,<br/>CH_LAYOUT_7POINT1POINT2 = CH_LAYOUT_7POINT1 \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT,<br/>CH_LAYOUT_7POINT1POINT4,<br/>CH_LAYOUT_10POINT2,<br/>CH_LAYOUT_9POINT1POINT4 = CH_LAYOUT_7POINT1POINT4 \| CH_SET_WIDE_LEFT \| CH_SET_WIDE_RIGHT,<br/>CH_LAYOUT_9POINT1POINT6 = CH_LAYOUT_9POINT1POINT4 \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT,<br/>CH_LAYOUT_HEXADECAGONAL,<br/>CH_LAYOUT_AMB_ORDER3_ACN_N3D = AMB_MODE \| AMB_ORD_3 \| AMB_COM_ACN \| AMB_NOR_N3D,<br/>CH_LAYOUT_AMB_ORDER3_ACN_SN3D = AMB_MODE \| AMB_ORD_3 \| AMB_COM_ACN \| AMB_NOR_SN3D,<br/>CH_LAYOUT_AMB_ORDER3_FUMA = AMB_MODE \| AMB_ORD_3 \| AMB_COM_FUMA,<br/>CH_LAYOUT_22POINT2<br/>} | 音频声道布局。 | 59| [OH_AVCodecBufferFlags](#oh_avcodecbufferflags-1) {<br/>AVCODEC_BUFFER_FLAGS_NONE = 0,<br/>AVCODEC_BUFFER_FLAGS_EOS = 1 << 0, AVCODEC_BUFFER_FLAGS_SYNC_FRAME = 1 << 1, AVCODEC_BUFFER_FLAGS_INCOMPLETE_FRAME = 1 << 2,<br/>AVCODEC_BUFFER_FLAGS_CODEC_DATA = 1 << 3, <br/>AVCODEC_BUFFER_FLAGS_DISCARD = 1 << 4, <br/>AVCODEC_BUFFER_FLAGS_DISPOSABLE = 1 << 5<br/>} | 枚举OH_AVCodec缓冲区标记的类别。 | 60| [OH_AVErrCode](#oh_averrcode-1) {<br/>AV_ERR_OK = 0,<br/>AV_ERR_NO_MEMORY = 1,<br/>AV_ERR_OPERATE_NOT_PERMIT = 2,<br/>AV_ERR_INVALID_VAL = 3,<br/>AV_ERR_IO = 4,<br/>AV_ERR_TIMEOUT = 5,<br/>AV_ERR_UNKNOWN = 6,<br/>AV_ERR_SERVICE_DIED = 7,<br/>AV_ERR_INVALID_STATE = 8,<br/>AV_ERR_UNSUPPORT = 9,<br/>AV_ERR_EXTEND_START = 100,<br/>AV_ERR_DRM_BASE = 200,<br/>AV_ERR_DRM_DECRYPT_FAILED = 201,<br/>AV_ERR_VIDEO_BASE = 300,<br/>AV_ERR_VIDEO_UNSUPPORTED_COLOR_SPACE_CONVERSION = 301<br/>} | 媒体框架错误码。 | 61| [OH_AVPixelFormat](#oh_avpixelformat-1) {<br/>AV_PIXEL_FORMAT_YUVI420 = 1,<br/>AV_PIXEL_FORMAT_NV12 = 2,<br/>AV_PIXEL_FORMAT_NV21 = 3,<br/>AV_PIXEL_FORMAT_SURFACE_FORMAT = 4,<br/>AV_PIXEL_FORMAT_RGBA = 5<br/>} | 视频像素格式的枚举类。 | 62 63 64### 函数 65 66| 名称 | 描述 | 67| -------- | -------- | 68| [OH_AVBuffer](#oh_avbuffer) \* [OH_AVBuffer_Create](#oh_avbuffer_create) (int32_t capacity) | 创建OH_AVBuffer实例。 需要注意的是，返回值指向的创建OH_AVBuffer的实例需要调用者主动调用接口释放，请参阅[OH_AVBuffer_Destroy](#oh_avbuffer_destroy)。 | 69| [OH_AVErrCode](#oh_averrcode) [OH_AVBuffer_Destroy](#oh_avbuffer_destroy) ([OH_AVBuffer](#oh_avbuffer) \*buffer) | 释放OH_AVBuffer实例指针的资源。 | 70| [OH_AVErrCode](#oh_averrcode) [OH_AVBuffer_GetBufferAttr](#oh_avbuffer_getbufferattr) ([OH_AVBuffer](#oh_avbuffer) \*buffer, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) \*attr) | 获取数据缓冲区的pts、size、offset、flags高频属性参数。 | 71| [OH_AVErrCode](#oh_averrcode) [OH_AVBuffer_SetBufferAttr](#oh_avbuffer_setbufferattr) ([OH_AVBuffer](#oh_avbuffer) \*buffer, const [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) \*attr) | 设置数据缓冲区的pts、size、offset、flags高频属性参数。 | 72| [OH_AVFormat](#oh_avformat) \* [OH_AVBuffer_GetParameter](#oh_avbuffer_getparameter) ([OH_AVBuffer](#oh_avbuffer) \*buffer) | 获取除基础属性外的其他参数，信息在OH_AVFormat中承载。 | 73| [OH_AVErrCode](#oh_averrcode) [OH_AVBuffer_SetParameter](#oh_avbuffer_setparameter) ([OH_AVBuffer](#oh_avbuffer) \*buffer, const [OH_AVFormat](#oh_avformat) \*format) | 设置除基础属性外的其他参数，信息在OH_AVFormat中承载。 | 74| uint8_t \* [OH_AVBuffer_GetAddr](#oh_avbuffer_getaddr) ([OH_AVBuffer](#oh_avbuffer) \*buffer) | 获取数据缓冲区的虚拟地址。 | 75| int32_t [OH_AVBuffer_GetCapacity](#oh_avbuffer_getcapacity) ([OH_AVBuffer](#oh_avbuffer) \*buffer) | 获取数据缓冲区的容量（字节数）。 | 76| [OH_NativeBuffer](#oh_nativebuffer) \* [OH_AVBuffer_GetNativeBuffer](#oh_avbuffer_getnativebuffer) ([OH_AVBuffer](#oh_avbuffer) \*buffer) | 获取OH_NativeBuffer实例的指针。 | 77| struct [OH_AVFormat](#oh_avformat) \* [OH_AVFormat_Create](#oh_avformat_create) (void) | 创建OH_AVFormat实例，用于读写数据。 | 78| struct [OH_AVFormat](#oh_avformat) \* [OH_AVFormat_CreateAudioFormat](#oh_avformat_createaudioformat) (const char \*mimeType, int32_t sampleRate, int32_t channelCount) | 创建音频OH_AVFormat实例指针并预设置指定参数，用于读写数据。 | 79| struct [OH_AVFormat](#oh_avformat) \* [OH_AVFormat_CreateVideoFormat](#oh_avformat_createvideoformat) (const char \*mimeType, int32_t width, int32_t height) | 创建视频OH_AVFormat实例指针并预设置指定参数，用于读写数据。 | 80| void [OH_AVFormat_Destroy](#oh_avformat_destroy) (struct [OH_AVFormat](#oh_avformat) \*format) | 销毁OH_AVFormat实例。 | 81| bool [OH_AVFormat_Copy](#oh_avformat_copy) (struct [OH_AVFormat](#oh_avformat) \*to, struct [OH_AVFormat](#oh_avformat) \*from) | 复制OH_AVFormat实例。 | 82| bool [OH_AVFormat_SetIntValue](#oh_avformat_setintvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, int32_t value) | 对OH_AVFormat的key赋int类型的值。 | 83| bool [OH_AVFormat_SetLongValue](#oh_avformat_setlongvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, int64_t value) | 对OH_AVFormat的key赋long类型的值。 | 84| bool [OH_AVFormat_SetFloatValue](#oh_avformat_setfloatvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, float value) | 对OH_AVFormat的key赋float类型的值。 | 85| bool [OH_AVFormat_SetDoubleValue](#oh_avformat_setdoublevalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, double value) | 对OH_AVFormat的key赋double类型的值 | 86| bool [OH_AVFormat_SetStringValue](#oh_avformat_setstringvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, const char \*value) | 对OH_AVFormat的key赋string类型的值。 | 87| bool [OH_AVFormat_SetBuffer](#oh_avformat_setbuffer) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, const uint8_t \*addr, size_t size) | 将指定长度的数据块写入OH_AVFormat。 | 88| bool [OH_AVFormat_GetIntValue](#oh_avformat_getintvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, int32_t \*out) | 从OH_AVFormat的key获取int类型的值 | 89| bool [OH_AVFormat_GetLongValue](#oh_avformat_getlongvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, int64_t \*out) | 从OH_AVFormat的key获取long类型的值。 | 90| bool [OH_AVFormat_GetFloatValue](#oh_avformat_getfloatvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, float \*out) | 从OH_AVFormat的key获取float类型的值。 | 91| bool [OH_AVFormat_GetDoubleValue](#oh_avformat_getdoublevalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, double \*out) | 从OH_AVFormat的key获取double类型的值。 | 92| bool [OH_AVFormat_GetStringValue](#oh_avformat_getstringvalue) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, const char \*\*out) | 从OH_AVFormat的key获取string类型的值。 | 93| bool [OH_AVFormat_GetBuffer](#oh_avformat_getbuffer) (struct [OH_AVFormat](#oh_avformat) \*format, const char \*key, uint8_t \*\*addr, size_t \*size) | 从OH_AVFormat中读取指定长度的数据块。 | 94| const char \* [OH_AVFormat_DumpInfo](#oh_avformat_dumpinfo) (struct [OH_AVFormat](#oh_avformat) \*format) | 返回OH_AVFormat中包含的key-value组成的字符串。 | 95| [OH_AVMemory](#oh_avmemory) \* [OH_AVMemory_Create](#oh_avmemory_create) (int32_t size) | 创建OH_AVMemory实例的指针。（API11废弃） | 96| uint8_t \* [OH_AVMemory_GetAddr](#oh_avmemory_getaddr) (struct [OH_AVMemory](#oh_avmemory) \*mem) | 获取内存虚拟地址。 （API11废弃）| 97| int32_t [OH_AVMemory_GetSize](#oh_avmemory_getsize) (struct [OH_AVMemory](#oh_avmemory) \*mem) | 获取内存长度。（API11废弃） | 98| [OH_AVErrCode](#oh_averrcode) [OH_AVMemory_Destroy](#oh_avmemory_destroy) (struct [OH_AVMemory](#oh_avmemory) \*mem) | 释放OH_AVMemory实例指针的资源。（API11废弃） | 99 100 101## 类型定义说明 102 103 104### OH_AmbAttributeSet 105 106``` 107typedef enum OH_AmbAttributeSet OH_AmbAttributeSet 108``` 109 110**描述** 111 112高保真立体声混响设置。 113 114用int64整数来表示高保真立体声混响属性。 115 116**系统能力：** SystemCapability.Multimedia.Media.Core 117 118**起始版本：** 11 119 120 121### OH_AudioChannelLayout 122 123``` 124typedef enum OH_AudioChannelLayout OH_AudioChannelLayout 125``` 126 127**描述** 128 129音频声道布局。 130 131用int64整数来表示在录制或播放时扬声器的外观和顺序。 132 133**系统能力：** SystemCapability.Multimedia.Media.Core 134 135**起始版本：** 11 136 137 138### OH_AudioChannelSet 139 140``` 141typedef enum OH_AudioChannelSet OH_AudioChannelSet 142``` 143 144**描述** 145 146音频声道集合。 147 148将每一个声道映射为int64的变量。 149 150**系统能力：** SystemCapability.Multimedia.Media.Core 151 152**起始版本：** 11 153 154 155### OH_AVBuffer 156 157``` 158typedef struct OH_AVBuffer OH_AVBuffer 159``` 160**描述** 161 162为媒体内存接口定义native层对象。 163 164**起始版本：** 11 165 166 167### OH_AVCodecBufferAttr 168 169``` 170typedef struct OH_AVCodecBufferAttr OH_AVCodecBufferAttr 171``` 172 173**描述** 174 175定义OH_AVCodec的缓冲区描述信息。 176 177**系统能力：** SystemCapability.Multimedia.Media.Core 178 179**起始版本：** 9 180 181 182### OH_AVCodecBufferFlags 183 184``` 185typedef enum OH_AVCodecBufferFlags OH_AVCodecBufferFlags 186``` 187 188**描述** 189 190枚举OH_AVCodec缓冲区标记的类别。 191 192**系统能力：** SystemCapability.Multimedia.Media.Core 193 194**起始版本：** 9 195 196 197### OH_AVErrCode 198 199``` 200typedef enum OH_AVErrCode OH_AVErrCode 201``` 202 203**描述** 204 205媒体框架错误码。 206 207**系统能力：** SystemCapability.Multimedia.Media.Core 208 209**起始版本：** 9 210 211 212### OH_AVFormat 213 214``` 215typedef struct OH_AVFormat OH_AVFormat 216``` 217**描述** 218 219为OH_AVFormat接口定义native层对象。 220 221**起始版本：** 9 222 223 224### OH_AVMemory 225 226``` 227typedef struct OH_AVMemory OH_AVMemory 228``` 229**描述** 230 231为音视频内存接口定义native层对象。 232 233**起始版本：** 9 234 235 236### OH_AVPixelFormat 237 238``` 239typedef enum OH_AVPixelFormat OH_AVPixelFormat 240``` 241 242**描述** 243 244视频像素格式的枚举类。 245 246**系统能力：** SystemCapability.Multimedia.Media.Core 247 248**起始版本：** 9 249 250 251### OH_NativeBuffer 252 253``` 254typedef struct OH_NativeBuffer OH_NativeBuffer 255``` 256**描述** 257 258为图形内存接口定义native层对象。 259 260**起始版本：** 11 261 262 263## 枚举类型说明 264 265 266### OH_AmbAttributeSet 267 268``` 269enum OH_AmbAttributeSet 270``` 271 272**描述** 273 274高保真立体声混响设置。 275 276用int64整数来表示高保真立体声混响属性。 277 278**系统能力：** SystemCapability.Multimedia.Media.Core 279 280**起始版本：** 11 281 282| 枚举值 | 描述 | 283| -------- | -------- | 284| AMB_ORD_1 | 一阶高保真立体声混响 | 285| AMB_ORD_2 | 二阶高保真立体声混响 | 286| AMB_ORD_3 | 三阶高保真立体声混响 | 287| AMB_COM_ACN | ACN通道排序的高保真立体声混响 | 288| AMB_COM_FUMA | FUMA通道排序的高保真立体声混响 | 289| AMB_NOR_N3D | N3D归一化的高保真立体声混响 | 290| AMB_NOR_SN3D | SN3D归一化的高保真立体声混响 | 291| AMB_MODE | 高保真立体声混响的声道布局 | 292 293 294### OH_AudioChannelLayout 295 296``` 297enum OH_AudioChannelLayout 298``` 299 300**描述** 301 302音频声道布局。 303 304用int64整数来表示在录制或播放时扬声器的外观和顺序。 305 306**系统能力：** SystemCapability.Multimedia.Media.Core 307 308**起始版本：** 11 309 310| 枚举值 | 描述 | 311| -------- | -------- | 312| CH_LAYOUT_UNKNOWN | 未知声道布局 | 313| CH_LAYOUT_MONO | 单声道布局， 共1个声道 | 314| CH_LAYOUT_STEREO | 立体声布局，共2个声道 | 315| CH_LAYOUT_STEREO_DOWNMIX | 立体声下混布局，共2个声道 | 316| CH_LAYOUT_2POINT1 | 2.1布局，共3个声道 | 317| CH_LAYOUT_3POINT0 | 3.0布局，共3个声道 | 318| CH_LAYOUT_SURROUND | 环绕布局，共3个声道 | 319| CH_LAYOUT_3POINT1 | 3.1布局，共4个声道 | 320| CH_LAYOUT_4POINT0 | 4.0布局，共4个声道 | 321| CH_LAYOUT_QUAD_SIDE | QUAD_SIDE布局，共4个声道 | 322| CH_LAYOUT_QUAD | QUAD布局，共4个声道 | 323| CH_LAYOUT_2POINT0POINT2 | 2.0.2布局，共4个声道 | 324| CH_LAYOUT_AMB_ORDER1_ACN_N3D | ACN_N3D（根据ITU标准）的一阶FOA布局，共4个声道 | 325| CH_LAYOUT_AMB_ORDER1_ACN_SN3D | ACN_SN3D（根据ITU标准）的一阶FOA布局，共4个声道 | 326| CH_LAYOUT_AMB_ORDER1_FUMA | FUMA（根据ITU标准）的一阶FOA布局，共4个声道 | 327| CH_LAYOUT_4POINT1 | 4.1布局，共5个声道 | 328| CH_LAYOUT_5POINT0 | 5.0布局，共5个声道 | 329| CH_LAYOUT_5POINT0_BACK | 5.0-后置布局，共5个声道 | 330| CH_LAYOUT_2POINT1POINT2 | 2.1.2布局，共5个声道 | 331| CH_LAYOUT_3POINT0POINT2 | 3.0.2布局，共5个声道 | 332| CH_LAYOUT_5POINT1 | 5.1布局，共6个声道 | 333| CH_LAYOUT_5POINT1_BACK | 5.1-后置布局，共6个声道 | 334| CH_LAYOUT_6POINT0 | 6.0布局，共6个声道 | 335| CH_LAYOUT_3POINT1POINT2 | 3.1.2布局，共6个声道 | 336| CH_LAYOUT_6POINT0_FRONT | 6.0-Front布局，共6个声道 | 337| CH_LAYOUT_HEXAGONAL | HEXAGONAL布局，共6个声道 | 338| CH_LAYOUT_6POINT1 | 6.1布局，共7个声道 | 339| CH_LAYOUT_6POINT1_BACK | 6.1-后置布局，共7个声道 | 340| CH_LAYOUT_6POINT1_FRONT | 6.1-前置布局，共7个声道 | 341| CH_LAYOUT_7POINT0 | 7.0布局，共7个声道 | 342| CH_LAYOUT_7POINT0_FRONT | 7.0-前置布局，共7个声道 | 343| CH_LAYOUT_7POINT1 | 7.1布局，共8个声道 | 344| CH_LAYOUT_OCTAGONAL | OCTAGONAL布局，共8个声道 | 345| CH_LAYOUT_5POINT1POINT2 | 5.1.2布局，共8个声道 | 346| CH_LAYOUT_7POINT1_WIDE | 7.1-宽布局，共8个声道 | 347| CH_LAYOUT_7POINT1_WIDE_BACK | 7.1-后置宽布局，共8个声道 | 348| CH_LAYOUT_AMB_ORDER2_ACN_N3D | ACN_N3D（根据ITU标准）的二阶HOA布局，共9个声道 | 349| CH_LAYOUT_AMB_ORDER2_ACN_SN3D | ACN_SN3D（根据ITU标准）的二阶HOA布局，共9个声道 | 350| CH_LAYOUT_AMB_ORDER2_FUMA | FUMA（根据ITU标准）的二阶HOA布局，共9个声道 | 351| CH_LAYOUT_5POINT1POINT4 | 5.1.4布局，共10个声道 | 352| CH_LAYOUT_7POINT1POINT2 | 7.1.2布局，共10个声道 | 353| CH_LAYOUT_7POINT1POINT4 | 7.1.4布局，共12个声道 | 354| CH_LAYOUT_10POINT2 | 10.2布局，共12个声道 | 355| CH_LAYOUT_9POINT1POINT4 | 9.1.4布局，共14个声道 | 356| CH_LAYOUT_9POINT1POINT6 | 9.1.6布局，共16个声道 | 357| CH_LAYOUT_HEXADECAGONAL | HEXADECAGONAL布局，共16个声道 | 358| CH_LAYOUT_AMB_ORDER3_ACN_N3D | ACN_N3D（根据ITU标准）的三阶HOA布局，共16个声道 | 359| CH_LAYOUT_AMB_ORDER3_ACN_SN3D | ACN_SN3D（根据ITU标准）的三阶HOA布局，共16个声道 | 360| CH_LAYOUT_AMB_ORDER3_FUMA | FUMA（根据ITU标准）的三阶HOA布局，共16个声道 | 361| CH_LAYOUT_22POINT2 | 22.2布局，共24个声道 | 362 363 364### OH_AudioChannelSet 365 366``` 367enum OH_AudioChannelSet 368``` 369 370**描述** 371 372音频声道集合。 373 374将每一个声道映射为int64的变量。 375 376**系统能力：** SystemCapability.Multimedia.Media.Core 377 378**起始版本：** 11 379 380| 枚举值 | 描述 | 381| -------- | -------- | 382| CH_SET_FRONT_LEFT | 左前声道 | 383| CH_SET_FRONT_RIGHT | 右前声道 | 384| CH_SET_FRONT_CENTER | 中前声道 | 385| CH_SET_LOW_FREQUENCY | 低频声道 | 386| CH_SET_BACK_LEFT | 左后声道 | 387| CH_SET_BACK_RIGHT | 右后声道 | 388| CH_SET_FRONT_LEFT_OF_CENTER | 左前中置声道 | 389| CH_SET_FRONT_RIGHT_OF_CENTER | 右前中置声道 | 390| CH_SET_BACK_CENTER | 后方中置声道 | 391| CH_SET_SIDE_LEFT | 左侧声道 | 392| CH_SET_SIDE_RIGHT | 右侧声道 | 393| CH_SET_TOP_CENTER | 上方中置声道 | 394| CH_SET_TOP_FRONT_LEFT | 上方左前声道 | 395| CH_SET_TOP_FRONT_CENTER | 上方中前声道 | 396| CH_SET_TOP_FRONT_RIGHT | 上方右前声道 | 397| CH_SET_TOP_BACK_LEFT | 上方左后声道 | 398| CH_SET_TOP_BACK_CENTER | 上方中后声道 | 399| CH_SET_TOP_BACK_RIGHT | 上方右后声道 | 400| CH_SET_STEREO_LEFT | 立体声左声道 | 401| CH_SET_STEREO_RIGHT | 立体声右声道 | 402| CH_SET_WIDE_LEFT | 宽左声道 | 403| CH_SET_WIDE_RIGHT | 宽右声道 | 404| CH_SET_SURROUND_DIRECT_LEFT | 左环绕声道 | 405| CH_SET_SURROUND_DIRECT_RIGHT | 右环绕声道 | 406| CH_SET_LOW_FREQUENCY_2 | 低频声道2 | 407| CH_SET_TOP_SIDE_LEFT | 上方左侧声道 | 408| CH_SET_TOP_SIDE_RIGHT | 上方右侧声道 | 409| CH_SET_BOTTOM_FRONT_CENTER | 下方中前声道 | 410| CH_SET_BOTTOM_FRONT_LEFT | 下方左前声道 | 411| CH_SET_BOTTOM_FRONT_RIGHT | 下方右前声道 | 412 413 414### OH_AVCodecBufferFlags 415 416``` 417enum OH_AVCodecBufferFlags 418``` 419 420**描述** 421 422枚举OH_AVCodec缓冲区标记的类别。 423 424**系统能力：** SystemCapability.Multimedia.Media.Core 425 426**起始版本：** 9 427 428| 枚举值 | 描述 | 429| -------- | -------- | 430| AVCODEC_BUFFER_FLAGS_NONE | 表示为普通帧。 | 431| AVCODEC_BUFFER_FLAGS_EOS | 表示缓冲区是流结束帧。 | 432| AVCODEC_BUFFER_FLAGS_SYNC_FRAME | 表示缓冲区包含关键帧。 | 433| AVCODEC_BUFFER_FLAGS_INCOMPLETE_FRAME | 表示缓冲区中的数据只是帧的一部分。 | 434| AVCODEC_BUFFER_FLAGS_CODEC_DATA | 表示缓冲区包含编解码特定数据。 | 435| AVCODEC_BUFFER_FLAGS_DISCARD | 表示缓冲区被解码依赖，解码之后的数据可丢弃。<br/>**起始版本：** 12 | 436| AVCODEC_BUFFER_FLAGS_DISPOSABLE | 表示缓冲区不被参考可直接丢弃。<br/>**起始版本：** 12 | 437 438 439### OH_AVErrCode 440 441``` 442enum OH_AVErrCode 443``` 444 445**描述** 446 447媒体框架错误码。 448 449**系统能力：** SystemCapability.Multimedia.Media.Core 450 451**起始版本：** 9 452 453| 枚举值 | 描述 | 454| -------- | -------- | 455| AV_ERR_OK | 操作成功。 | 456| AV_ERR_NO_MEMORY | 无内存。 | 457| AV_ERR_OPERATE_NOT_PERMIT | 操作不允许。 | 458| AV_ERR_INVALID_VAL | 无效值。 | 459| AV_ERR_IO | IO错误。 | 460| AV_ERR_TIMEOUT | 超时错误。 | 461| AV_ERR_UNKNOWN | 未知错误。 | 462| AV_ERR_SERVICE_DIED | 服务死亡。 | 463| AV_ERR_INVALID_STATE | 当前状态不支持此操作。 | 464| AV_ERR_UNSUPPORT | 未支持的功能。 | 465| AV_ERR_EXTEND_START | 扩展错误码初始值。 | 466| AV_ERR_DRM_BASE | DRM起始错误码。<br/>**起始版本：** 12 | 467| AV_ERR_DRM_DECRYPT_FAILED | DRM解密失败。<br/>**起始版本：** 12 | 468| AV_ERR_VIDEO_BASE | 视频起始错误码。<br/>**起始版本：** 12 | 469| AV_ERR_VIDEO_UNSUPPORTED_COLOR_SPACE_CONVERSION | 视频不支持色彩空间转换。<br/>**起始版本：** 12 | 470 471### OH_AVPixelFormat 472 473``` 474enum OH_AVPixelFormat 475``` 476 477**描述** 478 479视频像素格式的枚举类。 480 481**系统能力：** SystemCapability.Multimedia.Media.Core 482 483**起始版本：** 9 484 485| 枚举值 | 描述 | 486| -------- | -------- | 487| AV_PIXEL_FORMAT_YUVI420 | yuv 420 planar。 | 488| AV_PIXEL_FORMAT_NV12 | NV12. yuv 420 semiplanar。 | 489| AV_PIXEL_FORMAT_NV21 | NV21. yuv 420 semiplanar。 | 490| AV_PIXEL_FORMAT_SURFACE_FORMAT | 像素格式从surface获取。 | 491| AV_PIXEL_FORMAT_RGBA | RGBA8888。 | 492 493 494## 函数说明 495 496 497### OH_AVBuffer_Create() 498 499``` 500OH_AVBuffer* OH_AVBuffer_Create (int32_t capacity) 501``` 502 503**描述** 504 505创建OH_AVBuffer实例。 需要注意的是，返回值指向的创建OH_AVBuffer的实例需要调用者主动调用接口释放，请参阅[OH_AVBuffer_Destroy](#oh_avbuffer_destroy)。 506 507**系统能力：** SystemCapability.Multimedia.Media.Core 508 509**起始版本：** 11 510 511**参数:** 512 513| 名称 | 描述 | 514| -------- | -------- | 515| capacity | 创建内存的大小，单位字节。 | 516 517**返回：** 518 519如果创建成功，则返回OH_AVBuffer实例的指针，如果失败，则返回NULL。 520 521可能失败的原因： 522 5231. capacity <=0； 5242. 出现内部错误，系统没有资源等。 525 526 527### OH_AVBuffer_Destroy() 528 529``` 530OH_AVErrCode OH_AVBuffer_Destroy (OH_AVBuffer *buffer) 531``` 532 533**描述** 534 535释放OH_AVBuffer实例指针的资源，同一个buffer不允许重复销毁。 536 537**系统能力：** SystemCapability.Multimedia.Media.Core 538 539**起始版本：** 11 540 541**参数:** 542 543| 名称 | 描述 | 544| -------- | -------- | 545| buffer | 指向OH_AVBuffer实例的指针。 | 546 547**返回：** 548 549返回函数结果： 550 551AV_ERR_OK：操作成功。 552 553AV_ERR_INVALID_VAL：输入的buffer为空指针或者buffer结构校验失败。 554 555AV_ERR_OPERATE_NOT_PERMIT：输入的buffer不是用户创建的。 556 557 558### OH_AVBuffer_GetAddr() 559 560``` 561uint8_t* OH_AVBuffer_GetAddr (OH_AVBuffer *buffer) 562``` 563 564**描述** 565 566获取数据缓冲区的虚拟地址。 567 568**系统能力：** SystemCapability.Multimedia.Media.Core 569 570**起始版本：** 11 571 572**参数:** 573 574| 名称 | 描述 | 575| -------- | -------- | 576| buffer | 指向OH_AVBuffer实例的指针。 | 577 578**返回：** 579 580如果成功，则返回数据缓冲区的虚拟地址，如果失败，则返回NULL。 581 582可能失败的原因： 583 5841. 输入的buffer为空指针； 5852. OH_AVBuffer结构校验失败； 5863. 出现内部错误。 587 588 589### OH_AVBuffer_GetBufferAttr() 590 591``` 592OH_AVErrCode OH_AVBuffer_GetBufferAttr (OH_AVBuffer *buffer, OH_AVCodecBufferAttr *attr) 593``` 594 595**描述** 596 597获取数据缓冲区的pts、size、offset、flags高频属性参数。 598 599**系统能力：** SystemCapability.Multimedia.Media.Core 600 601**起始版本：** 11 602 603**参数:** 604 605| 名称 | 描述 | 606| -------- | -------- | 607| buffer | 指向OH_AVBuffer实例的指针。 | 608| attr | 指向[OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md)实例的指针。 | 609 610**返回：** 611 612返回函数结果： 613 614AV_ERR_OK：操作成功。 615 616AV_ERR_INVALID_VAL： 617 618 可能的原因： 619 1. 输入的buffer或attr为空指针； 620 2. buffer结构校验失败。 621 622 623### OH_AVBuffer_GetCapacity() 624 625``` 626int32_t OH_AVBuffer_GetCapacity (OH_AVBuffer *buffer) 627``` 628 629**描述** 630 631获取数据缓冲区的容量（字节数）。 632 633**系统能力：** SystemCapability.Multimedia.Media.Core 634 635**起始版本：** 11 636 637**参数:** 638 639| 名称 | 描述 | 640| -------- | -------- | 641| buffer | 指向OH_AVBuffer实例的指针。 | 642 643**返回：** 644 645如果成功，则返回数据缓冲区的容量，如果失败，则返回-1。 646 647可能失败的原因： 648 6491. 输入的buffer为空指针； 6502. OH_AVBuffer结构校验失败； 6513. 出现内部错误。 652 653 654### OH_AVBuffer_GetNativeBuffer() 655 656``` 657OH_NativeBuffer* OH_AVBuffer_GetNativeBuffer (OH_AVBuffer *buffer) 658``` 659 660**描述** 661 662获取OH_NativeBuffer实例的指针。 需要注意的是，返回值指向的创建OH_NativeBuffer的实例需要调用者主动调用接口释放，请参阅[OH_NativeBuffer_Unreference](../apis-arkgraphics2d/_o_h___native_buffer.md#oh_nativebuffer_unreference)。 663 664**系统能力：** SystemCapability.Multimedia.Media.Core 665 666**起始版本：** 11 667 668**参数:** 669 670| 名称 | 描述 | 671| -------- | -------- | 672| buffer | 指向OH_AVBuffer实例的指针。 | 673 674**返回：** 675 676如果成功，则返回OH_NativeBuffer实例的指针，如果失败，则返回NULL。 677 678可能失败的原因： 679 6801. 输入的buffer为空指针； 6812. OH_AVBuffer结构校验失败； 6823. 出现内部错误。 683 684 685### OH_AVBuffer_GetParameter() 686 687``` 688OH_AVFormat* OH_AVBuffer_GetParameter (OH_AVBuffer *buffer) 689``` 690 691**描述** 692 693获取除基础属性外的其他参数，信息在OH_AVFormat中承载。 需要注意的是，返回值指向的创建OH_AVFormat的实例需要调用者主动释放，请参阅[OH_AVFormat_Destroy](#oh_avformat_destroy)。 694 695**系统能力：** SystemCapability.Multimedia.Media.Core 696 697**起始版本：** 11 698 699**参数:** 700 701| 名称 | 描述 | 702| -------- | -------- | 703| buffer | 指向OH_AVBuffer实例的指针。 | 704 705**返回：** 706 707返回函数结果： 708 709AV_ERR_OK：操作成功。 710 711AV_ERR_INVALID_VAL： 712 713 可能的原因： 714 1. 输入的buffer为空指针； 715 2. 输入buffer的meta为空指针； 716 3. buffer结构校验失败。 717 718 719### OH_AVBuffer_SetBufferAttr() 720 721``` 722OH_AVErrCode OH_AVBuffer_SetBufferAttr (OH_AVBuffer *buffer, const OH_AVCodecBufferAttr *attr) 723``` 724 725**描述** 726 727设置数据缓冲区的pts、size、offset、flags高频属性参数。 728 729**系统能力：** SystemCapability.Multimedia.Media.Core 730 731**起始版本：** 11 732 733**参数:** 734 735| 名称 | 描述 | 736| -------- | -------- | 737| buffer | 指向OH_AVBuffer实例的指针。 | 738| attr | 指向[OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md)实例的指针。 | 739 740**返回：** 741 742返回函数结果： 743 744AV_ERR_OK：操作成功。 745 746AV_ERR_INVALID_VAL： 747 748 可能的原因： 749 1. 输入的buffer或attr为空指针； 750 2. buffer结构校验失败； 751 3. 输入buffer中内存的size或offset是无效值。 752 753 754### OH_AVBuffer_SetParameter() 755 756``` 757OH_AVErrCode OH_AVBuffer_SetParameter (OH_AVBuffer *buffer, const OH_AVFormat *format) 758``` 759 760**描述** 761 762设置除基础属性外的其他参数，信息在OH_AVFormat中承载。 763 764**系统能力：** SystemCapability.Multimedia.Media.Core 765 766**起始版本：** 11 767 768**参数:** 769 770| 名称 | 描述 | 771| -------- | -------- | 772| buffer | 指向OH_AVBuffer实例的指针。 | 773| format | 指向OH_AVFormat实例的指针。 | 774 775**返回：** 776 777返回函数结果： 778 779AV_ERR_OK：操作成功。 780 781AV_ERR_INVALID_VAL： 782 783 可能的原因： 784 1. 输入的buffer或format为空指针； 785 2. 输入buffer的meta为空指针； 786 3. buffer结构校验失败。 787 788 789### OH_AVFormat_Copy() 790 791``` 792bool OH_AVFormat_Copy (struct OH_AVFormat *to, struct OH_AVFormat *from) 793``` 794 795**描述** 796 797复制OH_AVFormat实例。 798 799**系统能力：** SystemCapability.Multimedia.Media.Core 800 801**起始版本：** 9 802 803**参数:** 804 805| 名称 | 描述 | 806| -------- | -------- | 807| to | OH_AVFormat实例，用于接收数据。 | 808| from | 指向复制数据的OH_AVFormat实例的指针。 | 809 810**返回：** 811 812返回值为TRUE表示成功，返回值为FALSE表示失败。 813 814可能的失败原因： 815 8161. 输入参数为空指针； 8172. 输入的OH_AVFormat参数结构校验失败。 818 819 820### OH_AVFormat_Create() 821 822``` 823struct OH_AVFormat* OH_AVFormat_Create (void) 824``` 825 826**描述** 827 828创建OH_AVFormat实例，用于读写数据。 829 830**系统能力：** SystemCapability.Multimedia.Media.Core 831 832**起始版本：** 9 833 834**返回：** 835 836返回指向OH_AVFormat实例的指针。系统资源不足时返回NULL。 837 838 839### OH_AVFormat_CreateAudioFormat() 840 841``` 842struct OH_AVFormat* OH_AVFormat_CreateAudioFormat (const char *mimeType, int32_t sampleRate, int32_t channelCount) 843``` 844 845**描述** 846 847创建音频OH_AVFormat实例指针并预设置指定参数，用于读写数据。 848 849**系统能力：** SystemCapability.Multimedia.Media.Core 850 851**起始版本：** 10 852 853**参数:** 854 855| 名称 | 描述 | 856| -------- | -------- | 857| mimeType | MIME类型描述字符串，请参阅[AVCODEC_MIMETYPE](_codec_base.md#变量)。 | 858| sampleRate | 采样率，单位Hz。 | 859| channelCount | 声道个数，如1为单声道，2为双声道。 | 860 861**返回：** 862 863返回指向OH_AVFormat实例的指针。传入的mimeType为NULL或系统资源不足时返回NULL。 864 865 866### OH_AVFormat_CreateVideoFormat() 867 868``` 869struct OH_AVFormat* OH_AVFormat_CreateVideoFormat (const char *mimeType, int32_t width, int32_t height) 870``` 871 872**描述** 873 874创建视频OH_AVFormat实例指针并预设置指定参数，用于读写数据。 875 876**系统能力：** SystemCapability.Multimedia.Media.Core 877 878**起始版本：** 10 879 880**参数:** 881 882| 名称 | 描述 | 883| -------- | -------- | 884| mimeType | MIME类型描述字符串，请参阅[AVCODEC_MIMETYPE](_codec_base.md#变量)。 | 885| width | 亮度的宽度，单位为pixel。 | 886| height | 亮度的高度，单位为pixel。 | 887 888**返回：** 889 890返回指向OH_AVFormat实例的指针。传入的mimeType为NULL或系统资源不足时返回NULL。 891 892 893### OH_AVFormat_Destroy() 894 895``` 896void OH_AVFormat_Destroy (struct OH_AVFormat *format) 897``` 898 899**描述** 900 901销毁OH_AVFormat实例，不允许重复销毁。 902 903**系统能力：** SystemCapability.Multimedia.Media.Core 904 905**起始版本：** 9 906 907**参数:** 908 909| 名称 | 描述 | 910| -------- | -------- | 911| format | 指向OH_AVFormat实例的指针。 | 912 913**返回：** 914 915无返回值。 916 917### OH_AVFormat_DumpInfo() 918 919``` 920const char* OH_AVFormat_DumpInfo (struct OH_AVFormat *format) 921``` 922 923**描述** 924 925返回OH_AVFormat中包含的key-value组成的字符串。最大可返回1024字节的字符串，销毁format时释放字符串指针。 926 927**系统能力：** SystemCapability.Multimedia.Media.Core 928 929**起始版本：** 9 930 931**参数:** 932 933| 名称 | 描述 | 934| -------- | -------- | 935| format | 指向OH_AVFormat实例的指针。 | 936 937**返回：** 938 939返回一个由key-value组成的字符串。传入的format为NULL或系统资源不足时返回NULL。 940 941 942### OH_AVFormat_GetBuffer() 943 944``` 945bool OH_AVFormat_GetBuffer (struct OH_AVFormat *format, const char *key, uint8_t ** addr, size_t *size) 946``` 947 948**描述** 949 950从OH_AVFormat中读取指定长度的数据块。 951 952**系统能力：** SystemCapability.Multimedia.Media.Core 953 954**起始版本：** 9 955 956**参数:** 957 958| 名称 | 描述 | 959| -------- | -------- | 960| format | 指向OH_AVFormat实例的指针。 | 961| key | 要读取数据的键。 | 962| addr | 生命周期与format相同，与format一同销毁。 如果调用者需要长时间保持它，必须进行内存拷贝。 | 963| size | 读到数据的长度。 | 964 965**返回：** 966 967返回值为TRUE表示成功，返回值为FALSE表示失败。 968 969可能的失败原因： 970 9711. 输入format为空指针； 9722. 输入format参数结构校验失败； 9733. 输入key为空指针； 9744. 输入addr为空指针； 9755. size为空指针； 9766. 获取的key不存在或者未设置。 977 978 979### OH_AVFormat_GetDoubleValue() 980 981``` 982bool OH_AVFormat_GetDoubleValue (struct OH_AVFormat *format, const char *key, double *out) 983``` 984 985**描述** 986 987从OH_AVFormat的key获取double类型的值。 988 989**系统能力：** SystemCapability.Multimedia.Media.Core 990 991**起始版本：** 9 992 993**参数:** 994 995| 名称 | 描述 | 996| -------- | -------- | 997| format | 指向OH_AVFormat实例的指针。 | 998| key | 读取数据的键。 | 999| out | 读取数据的值。 | 1000 1001**返回：** 1002 1003返回值为TRUE表示成功，返回值为FALSE表示失败。 1004 1005可能的失败原因： 1006 10071. 输入format为空指针； 10082. 输入format参数结构校验失败； 10093. 输入key为空指针； 10104. 输入out为空指针； 10115. 获取的key不存在或者未设置。 1012 1013 1014### OH_AVFormat_GetFloatValue() 1015 1016``` 1017bool OH_AVFormat_GetFloatValue (struct OH_AVFormat *format, const char *key, float *out) 1018``` 1019 1020**描述** 1021 1022从OH_AVFormat的key获取float类型的值。 1023 1024**系统能力：** SystemCapability.Multimedia.Media.Core 1025 1026**起始版本：** 9 1027 1028**参数:** 1029 1030| 名称 | 描述 | 1031| -------- | -------- | 1032| format | 指向OH_AVFormat实例的指针。 | 1033| key | 读取数据的键。 | 1034| out | 读取数据的值。 | 1035 1036**返回：** 1037 1038返回值为TRUE表示成功，返回值为FALSE表示失败。 1039 1040可能的失败原因： 1041 10421. 输入format为空指针； 10432. 输入format参数结构校验失败； 10443. 输入key为空指针； 10454. 输入out为空指针； 10465. 获取的key不存在或者未设置。 1047 1048 1049### OH_AVFormat_GetIntValue() 1050 1051``` 1052bool OH_AVFormat_GetIntValue (struct OH_AVFormat *format, const char *key, int32_t *out) 1053``` 1054 1055**描述** 1056 1057从OH_AVFormat的key获取int类型的值。 1058 1059**系统能力：** SystemCapability.Multimedia.Media.Core 1060 1061**起始版本：** 9 1062 1063**参数:** 1064 1065| 名称 | 描述 | 1066| -------- | -------- | 1067| format | 指向OH_AVFormat实例的指针。 | 1068| key | 读取数据的键。 | 1069| out | 读取数据的值。 | 1070 1071**返回：** 1072 1073返回值为TRUE表示成功，返回值为FALSE表示失败。 1074 1075可能的失败原因： 1076 10771. 输入format为空指针； 10782. 输入format参数结构校验失败； 10793. 输入key为空指针； 10804. 输入out为空指针； 10815. 获取的key不存在或者未设置。 1082 1083 1084### OH_AVFormat_GetLongValue() 1085 1086``` 1087bool OH_AVFormat_GetLongValue (struct OH_AVFormat *format, const char *key, int64_t *out) 1088``` 1089 1090**描述** 1091 1092从OH_AVFormat的key获取long类型的值。 1093 1094**系统能力：** SystemCapability.Multimedia.Media.Core 1095 1096**起始版本：** 9 1097 1098**参数:** 1099 1100| 名称 | 描述 | 1101| -------- | -------- | 1102| format | 指向OH_AVFormat实例的指针。 | 1103| key | 读取数据的键。 | 1104| out | 读取数据的值。 | 1105 1106**返回：** 1107 1108返回值为TRUE表示成功，返回值为FALSE表示失败。 1109 1110可能的失败原因： 1111 11121. 输入format为空指针； 11132. 输入format参数结构校验失败； 11143. 输入key为空指针； 11154. 输入out为空指针； 11165. 获取的key不存在或者未设置。 1117 1118 1119### OH_AVFormat_GetStringValue() 1120 1121``` 1122bool OH_AVFormat_GetStringValue (struct OH_AVFormat *format, const char *key, const char ** out) 1123``` 1124 1125**描述** 1126 1127从OH_AVFormat的key获取string类型的值。 1128 1129**系统能力：** SystemCapability.Multimedia.Media.Core 1130 1131**起始版本：** 9 1132 1133**参数:** 1134 1135| 名称 | 描述 | 1136| -------- | -------- | 1137| format | 指向OH_AVFormat实例的指针。 | 1138| key | 读取数据的键。 | 1139| out | 读取string指针，out数据的生命周期与format内string对应，out最大输出字符串长度为256字节。 如果调用者需要长时间保持它，必须进行拷贝内存。 | 1140 1141**返回：** 1142 1143返回值为TRUE表示成功，返回值为FALSE表示失败。 1144 1145可能的失败原因： 1146 11471. 输入format为空指针； 11482. 输入format参数结构校验失败； 11493. 输入key为空指针； 11504. 输入out为空指针； 11515. malloc出的out字符串资源不足； 11526. 获取的key不存在或者未设置。 1153 1154 1155### OH_AVFormat_SetBuffer() 1156 1157``` 1158bool OH_AVFormat_SetBuffer (struct OH_AVFormat *format, const char *key, const uint8_t *addr, size_t size) 1159``` 1160 1161**描述** 1162 1163将指定长度的数据块写入OH_AVFormat。该接口仅能设置buffer类型的参数，参数类型定义详见[CodecBase](_codec_base.md)。 1164 1165**系统能力：** SystemCapability.Multimedia.Media.Core 1166 1167**起始版本：** 9 1168 1169**参数:** 1170 1171| 名称 | 描述 | 1172| -------- | -------- | 1173| format | 指向OH_AVFormat实例的指针。 | 1174| key | 写入数据的键。 | 1175| addr | 写入数据的地址，生命周期由开发者管理。 | 1176| size | 写入数据的长度，范围为(0, 1)MB。 | 1177 1178**返回：** 1179 1180返回值为TRUE表示成功，返回值为FALSE表示失败。 1181 1182可能的失败原因： 1183 11841. 输入format为空指针； 11852. 输入format参数结构校验失败； 11863. 输入key为空指针； 11874. 输入addr为空指针； 11885. size为0或超过限制1MB； 11896. 设置的key对应的value类型错误。 1190 1191 1192### OH_AVFormat_SetDoubleValue() 1193 1194``` 1195bool OH_AVFormat_SetDoubleValue (struct OH_AVFormat *format, const char *key, double value) 1196``` 1197 1198**描述** 1199 1200对OH_AVFormat的key赋double类型的值。该接口仅能设置double类型的参数，参数类型定义详见[CodecBase](_codec_base.md)。 1201 1202**系统能力：** SystemCapability.Multimedia.Media.Core 1203 1204**起始版本：** 9 1205 1206**参数:** 1207 1208| 名称 | 描述 | 1209| -------- | -------- | 1210| format | 指向OH_AVFormat实例的指针。 | 1211| key | 写入数据的键。 | 1212| value | 写入数据的值。 | 1213 1214**返回：** 1215 1216返回值为TRUE表示成功，返回值为FALSE表示失败。 1217 1218可能的失败原因： 1219 12201. 输入format为空指针； 12212. 输入format参数结构校验失败； 12223. 输入key为空指针； 12234. 设置的key对应的value类型错误。 1224 1225 1226### OH_AVFormat_SetFloatValue() 1227 1228``` 1229bool OH_AVFormat_SetFloatValue (struct OH_AVFormat *format, const char *key, float value) 1230``` 1231 1232**描述** 1233 1234对OH_AVFormat的key赋float类型的值。该接口仅能设置float类型的参数，参数类型定义详见[CodecBase](_codec_base.md)。 1235 1236**系统能力：** SystemCapability.Multimedia.Media.Core 1237 1238**起始版本：** 9 1239 1240**参数:** 1241 1242| 名称 | 描述 | 1243| -------- | -------- | 1244| format | 指向OH_AVFormat实例的指针。 | 1245| key | 写入数据的键。 | 1246| value | 写入数据的值。 | 1247 1248**返回：** 1249 1250返回值为TRUE表示成功，返回值为FALSE表示失败。 1251 1252可能的失败原因： 1253 12541. 输入format为空指针； 12552. 输入format参数结构校验失败； 12563. 输入key为空指针； 12574. 设置的key对应的value类型错误。 1258 1259### OH_AVFormat_SetIntValue() 1260 1261``` 1262bool OH_AVFormat_SetIntValue (struct OH_AVFormat *format, const char *key, int32_t value) 1263``` 1264 1265**描述** 1266 1267对OH_AVFormat的key赋int类型的值。该接口仅能设置int类型的参数，参数类型定义详见[CodecBase](_codec_base.md)。 1268 1269**系统能力：** SystemCapability.Multimedia.Media.Core 1270 1271**起始版本：** 9 1272 1273**参数:** 1274 1275| 名称 | 描述 | 1276| -------- | -------- | 1277| format | 指向OH_AVFormat实例的指针。 | 1278| key | 写入数据的键。 | 1279| value | 写入数据的值。 | 1280 1281**返回：** 1282 1283返回值为TRUE表示成功，返回值为FALSE表示失败。 1284 1285可能的失败原因： 1286 12871. 输入format为空指针； 12882. 输入format参数结构校验失败； 12893. 输入key为空指针； 12904. 设置的key对应的value类型错误。 1291 1292 1293### OH_AVFormat_SetLongValue() 1294 1295``` 1296bool OH_AVFormat_SetLongValue (struct OH_AVFormat *format, const char *key, int64_t value) 1297``` 1298 1299**描述** 1300 1301对OH_AVFormat的key赋long类型的值。该接口仅能设置long类型的参数，参数类型定义详见[CodecBase](_codec_base.md)。 1302 1303**系统能力：** SystemCapability.Multimedia.Media.Core 1304 1305**起始版本：** 9 1306 1307**参数:** 1308 1309| 名称 | 描述 | 1310| -------- | -------- | 1311| format | 指向OH_AVFormat实例的指针。 | 1312| key | 写入数据的键。 | 1313| value | 写入数据的值。 | 1314 1315**返回：** 1316 1317返回值为TRUE表示成功，返回值为FALSE表示失败。 1318 1319可能的失败原因： 1320 13211. 输入format为空指针； 13222. 输入format参数结构校验失败； 13233. 输入key为空指针； 13244. 设置的key对应的value类型错误。 1325 1326 1327### OH_AVFormat_SetStringValue() 1328 1329``` 1330bool OH_AVFormat_SetStringValue (struct OH_AVFormat *format, const char *key, const char *value) 1331``` 1332 1333**描述** 1334 1335对OH_AVFormat的key赋string类型的值。该接口仅能设置string类型的参数，参数类型定义详见[CodecBase](_codec_base.md)。 1336 1337**系统能力：** SystemCapability.Multimedia.Media.Core 1338 1339**起始版本：** 9 1340 1341**参数:** 1342 1343| 名称 | 描述 | 1344| -------- | -------- | 1345| format | 指向OH_AVFormat实例的指针。 | 1346| key | 写入数据的键。 | 1347| value | 写入字符串数据（长度超出256字节系统做截断处理）。 | 1348 1349**返回：** 1350 1351返回值为TRUE表示成功，返回值为FALSE表示失败。 1352 1353可能的失败原因： 1354 13551. 输入format为空指针； 13562. 输入format参数结构校验失败； 13573. 输入key为空指针； 13584. 输入value为空指针； 13595. 设置的key对应的value类型错误。 1360 1361 1362### OH_AVMemory_Create() 1363 1364``` 1365OH_AVMemory* OH_AVMemory_Create (int32_t size) 1366``` 1367 1368**描述** 1369 1370创建OH_AVMemory实例的指针。 1371 1372**系统能力：** SystemCapability.Multimedia.Media.Core 1373 1374**起始版本：** 10 1375 1376**废弃版本：** 11 1377 1378**替代接口：**[OH_AVBuffer_Create](#oh_avbuffer_create) 1379 1380**参数:** 1381 1382| 名称 | 描述 | 1383| -------- | -------- | 1384| size | 创建内存的大小，单位字节。 | 1385 1386**返回：** 1387 1388如果创建成功，返回OH_AVMemory实例的指针，如果失败，返回NULL。 使用结束后需要通过OH_AVMemory_Destroy释放内存。 1389 1390 1391### OH_AVMemory_Destroy() 1392 1393``` 1394OH_AVErrCode OH_AVMemory_Destroy (struct OH_AVMemory *mem) 1395``` 1396 1397**描述** 1398 1399释放OH_AVMemory实例指针的资源。 1400 1401**系统能力：** SystemCapability.Multimedia.Media.Core 1402 1403**起始版本：** 10 1404 1405**废弃版本：** 11 1406 1407**替代接口：**[OH_AVBuffer_Destroy](#oh_avbuffer_destroy) 1408 1409**参数:** 1410 1411| 名称 | 描述 | 1412| -------- | -------- | 1413| mem | 指向OH_AVMemory实例的指针。 | 1414 1415**返回：** 1416 1417如果释放成功返回AV_ERR_OK，如果失败返回具体错误码, 参考[OH_AVErrCode](#oh_averrcode-1)。 1418 1419 1420### OH_AVMemory_GetAddr() 1421 1422``` 1423uint8_t* OH_AVMemory_GetAddr (struct OH_AVMemory *mem) 1424``` 1425 1426**描述** 1427 1428获取内存虚拟地址。 1429 1430**系统能力：** SystemCapability.Multimedia.Media.Core 1431 1432**起始版本：** 9 1433 1434**废弃版本：** 11 1435 1436**替代接口：**[OH_AVBuffer_GetAddr](#oh_avbuffer_getaddr) 1437 1438**参数:** 1439 1440| 名称 | 描述 | 1441| -------- | -------- | 1442| mem | 指向OH_AVMemory实例的指针。 | 1443 1444**返回：** 1445 1446如果内存有效，返回内存的虚拟地址；如果内存无效，返回NULL。 1447 1448可能的失败原因： 1449 14501. 输入mem为空指针； 14512. 输入mem参数结构校验失败； 14523. 输入mem中内存为空指针。 1453 1454 1455### OH_AVMemory_GetSize() 1456 1457``` 1458int32_t OH_AVMemory_GetSize (struct OH_AVMemory *mem) 1459``` 1460 1461**描述** 1462 1463获取内存长度。 1464 1465**系统能力：** SystemCapability.Multimedia.Media.Core 1466 1467**起始版本：** 9 1468 1469**废弃版本：** 11 1470 1471**替代接口：**[OH_AVBuffer_GetCapacity](#oh_avbuffer_getcapacity) 1472 1473**参数:** 1474 1475| 名称 | 描述 | 1476| -------- | -------- | 1477| mem | 指向OH_AVMemory实例的指针。 | 1478 1479**返回：** 1480 1481如果内存有效，返回内存长度；如果内存无效，返回-1。 1482 1483可能的失败原因： 1484 14851. 输入mem为空指针； 14862. 输入mem参数结构校验失败； 14873. 输入mem中内存为空指针。 1488