1# native_avcodec_videoencoder.h 2<!--Kit: AVCodec Kit--> 3<!--Subsystem: Multimedia--> 4<!--Owner: @zhanghongran--> 5<!--Designer: @dpy2650---> 6<!--Tester: @cyakee--> 7<!--Adviser: @zengyawen--> 8 9## 概述 10 11声明用于视频编码的接口。 12 13**引用文件：** <multimedia/player_framework/native_avcodec_videoencoder.h> 14 15**库：** libnative_media_venc.so 16 17**系统能力：** SystemCapability.Multimedia.VideoEncoder 18 19**起始版本：** 9 20 21**相关模块：** [VideoEncoder](capi-videoencoder.md) 22 23**相关示例：** [AVCodec](https://gitcode.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/Media/AVCodec) 24 25接口在每个版本，对每种模式的支持情况说明，如下图所示。 26 27 28 29 30 31## 汇总 32 33### 枚举 34 35| 名称 | typedef关键字 | 描述 | 36| -- | -- | -- | 37| [OH_VideoEncodeBitrateMode](#oh_videoencodebitratemode) | OH_VideoEncodeBitrateMode | 视频编码器的码率控制模式。 | 38 39### 函数 40 41| 名称 | typedef关键字 | 描述 | 42| -- | -- | -- | 43| [typedef void (\*OH_VideoEncoder_OnNeedInputParameter)(OH_AVCodec *codec, uint32_t index, OH_AVFormat *parameter,void *userData)](#oh_videoencoder_onneedinputparameter) | OH_VideoEncoder_OnNeedInputParameter | 配置随帧参数，当需要设置index对应帧的编码参数时，可以通过该接口设置。只在Surface模式生效。 | 44| [OH_AVCodec *OH_VideoEncoder_CreateByMime(const char *mime)](#oh_videoencoder_createbymime) | - | 根据MIME类型创建视频编码器实例，推荐使用。 | 45| [OH_AVCodec *OH_VideoEncoder_CreateByName(const char *name)](#oh_videoencoder_createbyname) | - | 根据视频编码器名称创建视频编码器实例。使用此接口的前提是知道编码器的确切名称，编码器的名称可以通过能力查询获取。 | 46| [OH_AVErrCode OH_VideoEncoder_Destroy(OH_AVCodec *codec)](#oh_videoencoder_destroy) | - | 清理编码器内部资源，销毁编码器实例。不能重复销毁。 | 47| [OH_AVErrCode OH_VideoEncoder_SetCallback(OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData)](#oh_videoencoder_setcallback) | - | 设置OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 | 48| [OH_AVErrCode OH_VideoEncoder_RegisterCallback(OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData)](#oh_videoencoder_registercallback) | - | 注册OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 | 49| [OH_AVErrCode OH_VideoEncoder_RegisterParameterCallback(OH_AVCodec *codec,OH_VideoEncoder_OnNeedInputParameter onInputParameter,void *userData)](#oh_videoencoder_registerparametercallback) | - | 注册OH_AVCodecCallback输入参数回调函数，让应用可以响应视频编码器生成的事件。编码Surface模式，需要设置随帧参数时，须使用该接口。如果使用该接口，必须在[OH_VideoEncoder_Configure](#oh_videoencoder_configure)之前调用该接口。 | 50| [OH_AVErrCode OH_VideoEncoder_Configure(OH_AVCodec *codec, OH_AVFormat *format)](#oh_videoencoder_configure) | - | 配置视频编码器的编码参数，通常需要配置要编码的视频轨的描述信息，如宽、高、像素格式等。必须在调用OH_VideoEncoder_Prepare接口之前，调用此接口。 | 51| [OH_AVErrCode OH_VideoEncoder_Prepare(OH_AVCodec *codec)](#oh_videoencoder_prepare) | - | 准备编码器的内部资源，在OH_VideoEncoder_Configure接口后调用。 | 52| [OH_AVErrCode OH_VideoEncoder_Start(OH_AVCodec *codec)](#oh_videoencoder_start) | - | 调用[OH_VideoEncoder_Prepare](#oh_videoencoder_prepare)接口成功后调用此接口启动编码器。成功启动后，编码器将开始报告注册的回调事件。 | 53| [OH_AVErrCode OH_VideoEncoder_Stop(OH_AVCodec *codec)](#oh_videoencoder_stop) | - | 停止编码器，释放输入输出buffer。停止之后，可以通过调用OH_VideoEncoder_Start接口重新进入Running状态。 | 54| [OH_AVErrCode OH_VideoEncoder_Flush(OH_AVCodec *codec)](#oh_videoencoder_flush) | - | 清除编码器中缓存的输入和输出数据及参数集如H264格式的PPS/SPS。调用此接口后，以前通过异步回调上报的所有缓冲区index都将失效，请确保不要访问这些index对应的缓冲区。该接口不能连续调用。 | 55| [OH_AVErrCode OH_VideoEncoder_Reset(OH_AVCodec *codec)](#oh_videoencoder_reset) | - | 重置编码器，编码器回到初始化状态。如果要继续编码，需要再次调用OH_VideoEncoder_Configure接口配置编码器实例。 | 56| [OH_AVFormat *OH_VideoEncoder_GetOutputDescription(OH_AVCodec *codec)](#oh_videoencoder_getoutputdescription) | - | 获取编码器输出数据的OH_AVFormat信息。请参阅{@link OH_AVFormat}。需要注意的是，返回值指向的OH_AVFormat实例的生命周期需要开发者通过调用接口OH_AVFormat_Destroy()释放。 | 57| [OH_AVErrCode OH_VideoEncoder_SetParameter(OH_AVCodec *codec, OH_AVFormat *format)](#oh_videoencoder_setparameter) | - | 在编码器运行时设置编码器参数。注意，此接口只有在编码器启动后才能调用。 同时，不正确的参数设置可能会导致编码失败。 | 58| [OH_AVErrCode OH_VideoEncoder_GetSurface(OH_AVCodec *codec, OHNativeWindow **window)](#oh_videoencoder_getsurface) | - | 从视频编码器获取输入surface，必须在调用OH_VideoEncoder_Prepare接口之前调用此接口。 | 59| [OH_AVErrCode OH_VideoEncoder_FreeOutputData(OH_AVCodec *codec, uint32_t index)](#oh_videoencoder_freeoutputdata) | - | 将处理后的输出缓冲区返回给编码器。 | 60| [OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream(OH_AVCodec *codec)](#oh_videoencoder_notifyendofstream) | - | 通知视频编码器输入流已结束。建议使用此接口进行通知。该接口只在Surface模式下使用，Buffer模式通过OH_AVBuffer携带EOS信息，通知输入流的结束。 | 61| [OH_AVErrCode OH_VideoEncoder_PushInputData(OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr)](#oh_videoencoder_pushinputdata) | - | 将填入数据的输入缓冲区提交给视频编码器。 | 62| [OH_AVErrCode OH_VideoEncoder_PushInputBuffer(OH_AVCodec *codec, uint32_t index)](#oh_videoencoder_pushinputbuffer) | - | Buffer模式下，将index对应的OH_AVBuffer送入编码器编码。 | 63| [OH_AVErrCode OH_VideoEncoder_PushInputParameter(OH_AVCodec *codec, uint32_t index)](#oh_videoencoder_pushinputparameter) | - | Surface模式下，将index对应帧的编码参数送入编码器编码。 | 64| [OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer(OH_AVCodec *codec, uint32_t index)](#oh_videoencoder_freeoutputbuffer) | - | 将处理后的index对应的OH_AVBuffer返回给编码器。开发者使用完需要及时调用此接口释放输出缓存区，否则会阻塞编码流程。 | 65| [OH_AVFormat *OH_VideoEncoder_GetInputDescription(OH_AVCodec *codec)](#oh_videoencoder_getinputdescription) | - | 编码器接收到的图像的描述信息，调用{@OH_VideoEncoder_Configure}后调用此接口，请参阅{@link OH_AVFormat}获取详细信息。需要注意的是，返回指针所指向的OH_AVFormat实例的生命周期需要由开发者通过调用OH_AVFormat_Destroy接口释放，请参阅{@link OH_AVFormat_Destory}。 | 66| [OH_AVErrCode OH_VideoEncoder_IsValid(OH_AVCodec *codec, bool *isValid)](#oh_videoencoder_isvalid) | - | 检查当前编码实例是否有效。 | 67| [OH_AVErrCode OH_VideoEncoder_QueryInputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs)](#oh_videoencoder_queryinputbuffer) | - | 查询下一个可用输入缓冲区的索引。调用此接口后需要接着调用[OH_VideoEncoder_GetInputBuffer](#oh_videoencoder_getinputbuffer)接口获取缓冲区实例，并通过[OH_VideoEncoder_PushInputBuffer](#oh_videoencoder_pushinputbuffer)接口传递给编码器。<br> 需要注意的是，上述操作仅在同步模式下支持。 | 68| [OH_AVBuffer *OH_VideoEncoder_GetInputBuffer(struct OH_AVCodec *codec, uint32_t index)](#oh_videoencoder_getinputbuffer) | - | 获取可用输入缓冲区的实例。需要注意的是，此接口仅适用于同步模式。 | 69| [OH_AVErrCode OH_VideoEncoder_QueryOutputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs)](#oh_videoencoder_queryoutputbuffer) | - | 查询下一个可用输出缓冲区的索引。通过[OH_VideoEncoder_GetOutputBuffer](#oh_videoencoder_getoutputbuffer)接口获取的缓冲区实例可以通过[OH_VideoEncoder_FreeOutputBuffer](#oh_videoencoder_freeoutputbuffer)接口将处理后的输出缓冲区返回到编码器。<br> 需要注意的是，上述操作仅在同步模式下支持。 | 70| [OH_AVBuffer *OH_VideoEncoder_GetOutputBuffer(struct OH_AVCodec *codec, uint32_t index)](#oh_videoencoder_getoutputbuffer) | - | 获取可用输出缓冲区的实例。需要注意的是，此接口仅适用于同步模式。 | 71 72## 枚举类型说明 73 74### OH_VideoEncodeBitrateMode 75 76``` 77enum OH_VideoEncodeBitrateMode 78``` 79 80**描述** 81 82视频编码器的码率控制模式。 83 84**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 85 86**起始版本：** 9 87 88**废弃版本：** 14 89 90**替代接口：** [OH_BitrateMode](capi-native-avcodec-base-h.md#oh_bitratemode) 91 92| 枚举项 | 描述 | 93| -- | -- | 94| CBR = 0 | 恒定码率模式。<br>**废弃版本：** 14<br>**替代接口：** [BITRATE_MODE_CBR](capi-native-avcodec-base-h.md#oh_bitratemode) | 95| VBR = 1 | 可变码率模式。<br>**废弃版本：** 14<br>**替代接口：** [BITRATE_MODE_VBR](capi-native-avcodec-base-h.md#oh_bitratemode) | 96| CQ = 2 | 恒定QP模式。<br>**废弃版本：** 14<br>**替代接口：** [BITRATE_MODE_CQ](capi-native-avcodec-base-h.md#oh_bitratemode) | 97 98 99## 函数说明 100 101### OH_VideoEncoder_OnNeedInputParameter() 102 103``` 104typedef void (*OH_VideoEncoder_OnNeedInputParameter)(OH_AVCodec *codec, uint32_t index, OH_AVFormat *parameter,void *userData) 105``` 106 107**描述** 108 109配置随帧参数，当需要设置index对应帧的编码参数时，可以通过该接口设置。只在Surface模式生效。<br>该接口只能在Surface模式下使用，使用前需要调用OH_VideoEncoder_RegisterParameterCallback接口注册。<br>在Buffer模式下，OH_AVBuffer可以直接携带帧的编码参数，当前可以支持的随帧参数有帧级QPMin/QPMax，指定LTR设置参考帧。 110 111**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 112 113**起始版本：** 12 114 115 116**参数：** 117 118| 参数项 | 描述 | 119| -- | -- | 120| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 121| uint32_t index | 对应编码帧的index。 | 122| [OH_AVFormat](capi-core-oh-avformat.md) *parameter | 编码参数。 | 123| void *userData | 开发者执行回调所依赖的数据。 | 124 125### OH_VideoEncoder_CreateByMime() 126 127``` 128OH_AVCodec *OH_VideoEncoder_CreateByMime(const char *mime) 129``` 130 131**描述** 132 133根据MIME类型创建视频编码器实例，推荐使用。 134 135**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 136 137**起始版本：** 9 138 139 140**参数：** 141 142| 参数项 | 描述 | 143| -- | -- | 144| const char *mime | MIME类型描述字符串，请参阅[AVCODEC_MIME_TYPE](capi-native-avcodec-base-h.md#变量)。 | 145 146**返回：** 147 148| 类型 | 说明 | 149| -- | -- | 150| [OH_AVCodec](capi-codecbase-oh-avcodec.md) * | 成功则返回一个指向视频编码实例的指针。<br> 如果输入为不支持的编码器类型或内存不足时，则返回NULL。 | 151 152### OH_VideoEncoder_CreateByName() 153 154``` 155OH_AVCodec *OH_VideoEncoder_CreateByName(const char *name) 156``` 157 158**描述** 159 160根据视频编码器名称创建视频编码器实例。使用此接口的前提是知道编码器的确切名称，编码器的名称可以通过能力查询获取。<br>详情请参见：[获取支持的编解码能力](../../media/avcodec/obtain-supported-codecs.md#创建指定名称的编解码器)。 161 162**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 163 164**起始版本：** 9 165 166 167**参数：** 168 169| 参数项 | 描述 | 170| -- | -- | 171| const char *name | 视频编码器名称。 | 172 173**返回：** 174 175| 类型 | 说明 | 176| -- | -- | 177| [OH_AVCodec](capi-codecbase-oh-avcodec.md) * | 成功则返回一个指向视频编码实例的指针。<br> 如果输入是不支持编码器名称或者内存资源不足，则返回NULL。 | 178 179### OH_VideoEncoder_Destroy() 180 181``` 182OH_AVErrCode OH_VideoEncoder_Destroy(OH_AVCodec *codec) 183``` 184 185**描述** 186 187清理编码器内部资源，销毁编码器实例。不能重复销毁。 188 189**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 190 191**起始版本：** 9 192 193 194**参数：** 195 196| 参数项 | 描述 | 197| -- | -- | 198| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 199 200**返回：** 201 202| 类型 | 说明 | 203| -- | -- | 204| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 | 205 206### OH_VideoEncoder_SetCallback() 207 208``` 209OH_AVErrCode OH_VideoEncoder_SetCallback(OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData) 210``` 211 212**描述** 213 214设置OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 215 216**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 217 218**起始版本：** 9 219 220**废弃版本：** 11 221 222**替代接口：** [OH_VideoEncoder_RegisterCallback](#oh_videoencoder_registercallback) 223 224 225**参数：** 226 227| 参数项 | 描述 | 228| -- | -- | 229| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 230| [OH_AVCodecAsyncCallback](capi-codecbase-oh-avcodecasynccallback.md) callback | 所有回调函数的集合。 | 231| void *userData | 开发者执行回调所依赖的数据。 | 232 233**返回：** 234 235| 类型 | 说明 | 236| -- | -- | 237| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 | 238 239### OH_VideoEncoder_RegisterCallback() 240 241``` 242OH_AVErrCode OH_VideoEncoder_RegisterCallback(OH_AVCodec *codec, OH_AVCodecCallback callback, void *userData) 243``` 244 245**描述** 246 247注册OH_AVCodecCallback回调函数，让应用可以响应视频编码器生成的事件。在调用OH_VideoEncoder_Prepare接口之前，必须调用此接口。 248 249**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 250 251**起始版本：** 11 252 253 254**参数：** 255 256| 参数项 | 描述 | 257| -- | -- | 258| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 259| [OH_AVCodecCallback](capi-codecbase-oh-avcodeccallback.md) callback | 所有回调函数的集合。 | 260| void *userData | 开发者执行回调所依赖的数据。 | 261 262**返回：** 263 264| 类型 | 说明 | 265| -- | -- | 266| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 | 267 268### OH_VideoEncoder_RegisterParameterCallback() 269 270``` 271OH_AVErrCode OH_VideoEncoder_RegisterParameterCallback(OH_AVCodec *codec,OH_VideoEncoder_OnNeedInputParameter onInputParameter,void *userData) 272``` 273 274**描述** 275 276注册OH_AVCodecCallback输入参数回调函数，让应用可以响应视频编码器生成的事件。编码Surface模式，需要设置随帧参数时，须使用该接口。<br>如果使用该接口，必须在[OH_VideoEncoder_Configure](#oh_videoencoder_configure)之前调用该接口。 277 278**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 279 280**起始版本：** 12 281 282 283**参数：** 284 285| 参数项 | 描述 | 286| -- | -- | 287| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 288| [OH_VideoEncoder_OnNeedInputParameter](#oh_videoencoder_onneedinputparameter) onInputParameter | 输入参数回调指针。 | 289| void *userData | 开发者执行回调所依赖的数据。 | 290 291**返回：** 292 293| 类型 | 说明 | 294| -- | -- | 295| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 | 296 297### OH_VideoEncoder_Configure() 298 299``` 300OH_AVErrCode OH_VideoEncoder_Configure(OH_AVCodec *codec, OH_AVFormat *format) 301``` 302 303**描述** 304 305配置视频编码器的编码参数，通常需要配置要编码的视频轨的描述信息，如宽、高、像素格式等。必须在调用OH_VideoEncoder_Prepare接口之前，调用此接口。<br>该接口对配置参数进行合法性校验，部分非法参数不会强校验，使用默认值或直接丢弃。部分非法参数会强校验，具体规则如下：<br>以下参数的配置范围可通过[能力查询](../../media/avcodec/obtain-supported-codecs.md)获取，OH_MD_KEY_I_FRAME_INTERVAL暂不支持。<br>设置OH_MD_KEY_VIDEO_ENCODER_ENABLE_TEMPORAL_SCALABILITY、OH_MD_KEY_VIDEO_ENCODER_LTR_FRAME_COUNT接口时如果当前平台不支持，不报错，走正常编码流程。<br>参数校验： 306 307| Key | 配置正常范围的值 | 配置超出范围的值 | 不配置该参数 | 308| ------- | -------- | -------- | ------ | 309| OH_MD_KEY_WIDTH | AV_ERR_OK | AV_ERR_INVALID_VAL | AV_ERR_INVALID_VAL | 310| OH_MD_KEY_HEIGHT | AV_ERR_OK | AV_ERR_INVALID_VAL | AV_ERR_INVALID_VAL | 311| OH_MD_KEY_PIXEL_FORMAT 请参阅[OH_AVPixelFormat](_core.md#oh_avpixelformat-1) | AV_ERR_OK | AV_ERR_UNSUPPORT | AV_ERR_OK | 312| OH_MD_KEY_FRAME_RATE | AV_ERR_OK | AV_ERR_INVALID_VAL |AV_ERR_OK | 313| OH_MD_KEY_PROFILE 请参阅[OH_MD_KEY_PROFILE](_codec_base.md#oh_md_key_profile) | AV_ERR_OK | AV_ERR_INVALID_VAL |AV_ERR_OK | 314| OH_MD_KEY_I_FRAME_INTERVAL | AV_ERR_OK | \\ | AV_ERR_OK | 315 316| OH_MD_KEY_<br>BITRATE | OH_MD_KEY_<br>QUALITY | OH_MD_KEY_<br>VIDEO_ENCODER_BITRATE_MODE | 返回值 | 说明 | 317| :-------- | :---------| :---------- | ---- | ---------- | 318| \\ | \\ | \\ | AV_ERR_OK | 使用编码器默认值 | 319| 超出范围 | 超出范围 | 不支持的模式 | AV_ERR_INVALID_VAL | 异常值均报错 | 320| 正常值 | 正常值 | \\ | AV_ERR_INVALID_VAL | Bitrate 与 Quality 冲突 | 321| 正常值 | \\ | \\ | AV_ERR_OK | 使能默认码控模式 | 322| 正常值 | \\ | BITRATE_MODE_VBR、BITRATE_MODE_CBR | AV_ERR_OK | | 323| 正常值 | \\ | BITRATE_MODE_CQ | AV_ERR_INVALID_VAL | Bitrate 与 CQ 模式冲突 | 324| \\ | 正常值 | \\ | AV_ERR_OK | 使能 CQ 模式 | 325| \\ | 正常值 | BITRATE_MODE_CQ | AV_ERR_OK | | 326| \\ | 正常值 | BITRATE_MODE_VBR、BITRATE_MODE_CBR | AV_ERR_INVALID_VAL | Quality 与 VBR、CBR 模式冲突 | 327| \\ | \\ | BITRATE_MODE_VBR、BITRATE_MODE_CBR | AV_ERR_OK | 使用编码器默认码率| 328| \\ | \\ | BITRATE_MODE_CQ | AV_ERR_OK | 使用默认quality | 329 330**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 331 332**起始版本：** 9 333 334 335**参数：** 336 337| 参数项 | 描述 | 338| -- | -- | 339| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 340| [OH_AVFormat](capi-core-oh-avformat.md) *format | 指向OH_AVFormat的指针，用于给出要编码的视频轨的描述。 | 341 342**返回：** 343 344| 类型 | 说明 | 345| -- | -- | 346| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：1. 输入的codec指针为非编码器实例，或者为空指针；2. 输入format参数不支持。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：本接口必须在OH_VideoEncoder_Prepare接口前调用，如果在其他状态时调用，则返回此错误码。 | 347 348### OH_VideoEncoder_Prepare() 349 350``` 351OH_AVErrCode OH_VideoEncoder_Prepare(OH_AVCodec *codec) 352``` 353 354**描述** 355 356准备编码器的内部资源，在OH_VideoEncoder_Configure接口后调用。 357 358**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 359 360**起始版本：** 9 361 362 363**参数：** 364 365| 参数项 | 描述 | 366| -- | -- | 367| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 368 369**返回：** 370 371| 类型 | 说明 | 372| -- | -- | 373| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 | 374 375### OH_VideoEncoder_Start() 376 377``` 378OH_AVErrCode OH_VideoEncoder_Start(OH_AVCodec *codec) 379``` 380 381**描述** 382 383调用[OH_VideoEncoder_Prepare](#oh_videoencoder_prepare)接口成功后调用此接口启动编码器。成功启动后，编码器将开始报告注册的回调事件。<br>Surface模式下，在surface中有正确的输入后，每完成一帧编码会触发OnNewOutputBuffer。<br>Buffer模式下，编码器会立即触发输入回调，开发者每完成一次输入，编码器执行编码，每完成一帧编码会触发OnNewOutputBuffer。 384 385**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 386 387**起始版本：** 9 388 389 390**参数：** 391 392| 参数项 | 描述 | 393| -- | -- | 394| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 395 396**返回：** 397 398| 类型 | 说明 | 399| -- | -- | 400| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 401 402### OH_VideoEncoder_Stop() 403 404``` 405OH_AVErrCode OH_VideoEncoder_Stop(OH_AVCodec *codec) 406``` 407 408**描述** 409 410停止编码器，释放输入输出buffer。停止之后，可以通过调用OH_VideoEncoder_Start接口重新进入Running状态。 411 412**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 413 414**起始版本：** 9 415 416 417**参数：** 418 419| 参数项 | 描述 | 420| -- | -- | 421| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 422 423**返回：** 424 425| 类型 | 说明 | 426| -- | -- | 427| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 428 429### OH_VideoEncoder_Flush() 430 431``` 432OH_AVErrCode OH_VideoEncoder_Flush(OH_AVCodec *codec) 433``` 434 435**描述** 436 437清除编码器中缓存的输入和输出数据及参数集如H.264格式的PPS/SPS。<br>调用此接口后，以前通过异步回调上报的所有缓冲区index都将失效，请确保不要访问这些index对应的缓冲区。该接口不能连续调用。 438 439**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 440 441**起始版本：** 9 442 443 444**参数：** 445 446| 参数项 | 描述 | 447| -- | -- | 448| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 449 450**返回：** 451 452| 类型 | 说明 | 453| -- | -- | 454| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 455 456### OH_VideoEncoder_Reset() 457 458``` 459OH_AVErrCode OH_VideoEncoder_Reset(OH_AVCodec *codec) 460``` 461 462**描述** 463 464重置编码器，编码器回到初始化状态。如果要继续编码，需要再次调用OH_VideoEncoder_Configure接口配置编码器实例。 465 466**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 467 468**起始版本：** 9 469 470 471**参数：** 472 473| 参数项 | 描述 | 474| -- | -- | 475| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 476 477**返回：** 478 479| 类型 | 说明 | 480| -- | -- | 481| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 | 482 483### OH_VideoEncoder_GetOutputDescription() 484 485``` 486OH_AVFormat *OH_VideoEncoder_GetOutputDescription(OH_AVCodec *codec) 487``` 488 489**描述** 490 491获取编码器输出数据的OH_AVFormat信息。<br>需要注意的是，返回值指向的OH_AVFormat实例的生命周期需要开发者通过调用接口[OH_AVFormat_Destroy](capi-native-avformat-h.md#oh_avformat_destroy)释放。 492 493**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 494 495**起始版本：** 9 496 497 498**参数：** 499 500| 参数项 | 描述 | 501| -- | -- | 502| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 503 504**返回：** 505 506| 类型 | 说明 | 507| -- | -- | 508| [OH_AVFormat](capi-core-oh-avformat.md) * | 返回指向OH_AVFormat实例的指针。<br> 当输入的codec指针非编码实例，或者为空指针，则返回NULL。 | 509 510### OH_VideoEncoder_SetParameter() 511 512``` 513OH_AVErrCode OH_VideoEncoder_SetParameter(OH_AVCodec *codec, OH_AVFormat *format) 514``` 515 516**描述** 517 518在编码器运行时设置编码器参数。<br>注意，此接口只有在编码器启动后才能调用。同时，不正确的参数设置可能会导致编码失败。 519 520**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 521 522**起始版本：** 9 523 524 525**参数：** 526 527| 参数项 | 描述 | 528| -- | -- | 529| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 530| [OH_AVFormat](capi-core-oh-avformat.md) *format | 指向OH_AVFormat实例的指针。 | 531 532**返回：** 533 534| 类型 | 说明 | 535| -- | -- | 536| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：1. 输入的codec指针为非编码器实例，或者为空指针；2. 输入format参数不支持。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 537 538### OH_VideoEncoder_GetSurface() 539 540``` 541OH_AVErrCode OH_VideoEncoder_GetSurface(OH_AVCodec *codec, OHNativeWindow **window) 542``` 543 544**描述** 545 546从视频编码器获取输入surface，必须在调用OH_VideoEncoder_Configure接口之后OH_VideoEncoder_Prepare接口之前调用此接口。 547 548**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 549 550**起始版本：** 9 551 552 553**参数：** 554 555| 参数项 | 描述 | 556| -- | -- | 557| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 558| [OHNativeWindow](../apis-arkgraphics2d/capi-nativewindow-nativewindow.md) **window | 指向OHNativeWindow实例的指针。应用负责管理window的生命周期，结束时调用[OH_NativeWindow_DestroyNativeWindow](../apis-arkgraphics2d/capi-external-window-h.md#oh_nativewindow_destroynativewindow)释放。 | 559 560**返回：** 561 562| 类型 | 说明 | 563| -- | -- | 564| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。 | 565 566### OH_VideoEncoder_FreeOutputData() 567 568``` 569OH_AVErrCode OH_VideoEncoder_FreeOutputData(OH_AVCodec *codec, uint32_t index) 570``` 571 572**描述** 573 574将处理后的输出缓冲区返回给编码器。 575 576**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 577 578**起始版本：** 9 579 580**废弃版本：** 11 581 582**替代接口：** [OH_VideoEncoder_FreeOutputBuffer](#oh_videoencoder_freeoutputbuffer) 583 584 585**参数：** 586 587| 参数项 | 描述 | 588| -- | -- | 589| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 590| uint32_t index | 输出缓冲区对应的索引值。由[OH_AVCodecOnNewOutputData](capi-native-avcodec-base-h.md#oh_avcodeconnewoutputdata)给出。 | 591 592**返回：** 593 594| 类型 | 说明 | 595| -- | -- | 596| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 597 598### OH_VideoEncoder_NotifyEndOfStream() 599 600``` 601OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream(OH_AVCodec *codec) 602``` 603 604**描述** 605 606通知视频编码器输入流已结束。建议使用此接口进行通知。该接口只在Surface模式下使用，Buffer模式通过OH_AVBuffer携带EOS信息，通知输入流的结束。 607 608**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 609 610**起始版本：** 9 611 612 613**参数：** 614 615| 参数项 | 描述 | 616| -- | -- | 617| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 618 619**返回：** 620 621| 类型 | 说明 | 622| -- | -- | 623| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 624 625### OH_VideoEncoder_PushInputData() 626 627``` 628OH_AVErrCode OH_VideoEncoder_PushInputData(OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr) 629``` 630 631**描述** 632 633将填入数据的输入缓冲区提交给视频编码器。 634 635**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 636 637**起始版本：** 10 638 639**废弃版本：** 11 640 641**替代接口：** [OH_VideoEncoder_PushInputBuffer](#oh_videoencoder_pushinputbuffer) 642 643 644**参数：** 645 646| 参数项 | 描述 | 647| -- | -- | 648| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 649| uint32_t index | 输入缓冲区对应的索引值。由[OH_AVCodecOnNeedInputData](capi-native-avcodec-base-h.md#oh_avcodeconneedinputdata)给出。 | 650| [OH_AVCodecBufferAttr](capi-core-oh-avcodecbufferattr.md) attr | 缓冲区中包含数据的描述信息。 | 651 652**返回：** 653 654| 类型 | 说明 | 655| -- | -- | 656| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 657 658### OH_VideoEncoder_PushInputBuffer() 659 660``` 661OH_AVErrCode OH_VideoEncoder_PushInputBuffer(OH_AVCodec *codec, uint32_t index) 662``` 663 664**描述** 665 666Buffer模式下，将index对应的OH_AVBuffer送入编码器编码。 667 668**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 669 670**起始版本：** 11 671 672 673**参数：** 674 675| 参数项 | 描述 | 676| -- | -- | 677| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 678| uint32_t index | 输入缓冲区对应的索引值。由[OH_AVCodecOnNeedInputBuffer](capi-native-avcodec-base-h.md#oh_avcodeconneedinputbuffer)给出。 | 679 680**返回：** 681 682| 类型 | 说明 | 683| -- | -- | 684| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：1. 输入的codec指针为非编码器实例，或者为空指针；2. 输入format参数不支持。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 685 686### OH_VideoEncoder_PushInputParameter() 687 688``` 689OH_AVErrCode OH_VideoEncoder_PushInputParameter(OH_AVCodec *codec, uint32_t index) 690``` 691 692**描述** 693 694Surface模式下，将index对应帧的编码参数送入编码器编码。 695 696**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 697 698**起始版本：** 12 699 700 701**参数：** 702 703| 参数项 | 描述 | 704| -- | -- | 705| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 706| uint32_t index | 输入参数缓冲区对应的索引值。由[OH_AVCodecOnNeedInputBuffer](capi-native-avcodec-base-h.md#oh_avcodeconneedinputbuffer)给出。 | 707 708**返回：** 709 710| 类型 | 说明 | 711| -- | -- | 712| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 713 714### OH_VideoEncoder_FreeOutputBuffer() 715 716``` 717OH_AVErrCode OH_VideoEncoder_FreeOutputBuffer(OH_AVCodec *codec, uint32_t index) 718``` 719 720**描述** 721 722将处理后的index对应的OH_AVBuffer退回给编码器。开发者使用完需要及时调用此接口释放输出缓存区，否则会阻塞编码流程。<br>详情请参见：[视频编码](../../media/avcodec/video-encoding.md) “Surface模式的步骤-13或Buffer模式步骤-11”。 723 724**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 725 726**起始版本：** 11 727 728 729**参数：** 730 731| 参数项 | 描述 | 732| -- | -- | 733| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 734| uint32_t index | 输出缓冲区对应的索引值。由[OH_AVCodecOnNeedInputBuffer](capi-native-avcodec-base-h.md#oh_avcodeconneedinputbuffer)给出。 | 735 736**返回：** 737 738| 类型 | 说明 | 739| -- | -- | 740| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码实例内部异常，如内部出现异常空指针。<br> AV_ERR_INVALID_VAL：<br> 1. 输入的 codec 指针为非编码器实例，或者为空指针；2. 输入format参数不支持；3. index非法或者连续给同一个index，该错误不影响后续编码流程。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_OPERATE_NOT_PERMIT：内部执行错误。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。 | 741 742### OH_VideoEncoder_GetInputDescription() 743 744``` 745OH_AVFormat *OH_VideoEncoder_GetInputDescription(OH_AVCodec *codec) 746``` 747 748**描述** 749 750编码器接收到的图像的描述信息。调用[OH_VideoEncoder_Configure](#oh_videoencoder_configure)后调用此接口。<br>需要注意的是，返回指针所指向的OH_AVFormat实例的生命周期需要由开发者通过调用[OH_AVFormat_Destroy](capi-native-avformat-h.md#oh_avformat_destroy)接口释放。 751 752**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 753 754**起始版本：** 10 755 756 757**参数：** 758 759| 参数项 | 描述 | 760| -- | -- | 761| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 762 763**返回：** 764 765| 类型 | 说明 | 766| -- | -- | 767| [OH_AVFormat](capi-core-oh-avformat.md) * | 返回指向OH_AVFormat实例的指针。<br> 当codec指针非编码实例，或者为空指针，则返回NULL。 | 768 769### OH_VideoEncoder_IsValid() 770 771``` 772OH_AVErrCode OH_VideoEncoder_IsValid(OH_AVCodec *codec, bool *isValid) 773``` 774 775**描述** 776 777在编码器实例存在的情况下，检查当前编码器服务是否有效。 778 779**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 780 781**起始版本：** 10 782 783 784**参数：** 785 786| 参数项 | 描述 | 787| -- | -- | 788| [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 789| bool *isValid | 输出参数，指向布尔类型的指针。只有当接口返回AV_ERR_OK时，该值表示编码器服务的有效性（true为有效，false为无效）。建议开发者将isValid初始化为false。 | 790 791**返回：** 792 793| 类型 | 说明 | 794| -- | -- | 795| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。 | 796 797### OH_VideoEncoder_QueryInputBuffer() 798 799``` 800OH_AVErrCode OH_VideoEncoder_QueryInputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs) 801``` 802 803**描述** 804 805查询下一个可用输入缓冲区的索引。<br>调用此接口后需要接着调用[OH_VideoEncoder_GetInputBuffer](#oh_videoencoder_getinputbuffer)接口获取缓冲区实例，并通过[OH_VideoEncoder_PushInputBuffer](#oh_videoencoder_pushinputbuffer)接口传递给编码器。<br> 需要注意的是，上述操作仅在同步模式下支持。 806 807**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 808 809**起始版本：** 20 810 811 812**参数：** 813 814| 参数项 | 描述 | 815| -- | -- | 816| [struct OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 817| uint32_t *index | 输入buffer对应的索引值。 | 818| int64_t timeoutUs | 超时时长，单位为微秒。负值：无限等待；0：立即退出；正值：等待指定时长后退出。 | 819 820**返回：** 821 822| 类型 | 说明 | 823| -- | -- | 824| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码器实例已经销毁。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_SERVICE_DIED：编解码服务已终止。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。<br> AV_ERR_OPERATE_NOT_PERMIT：禁止异步模式下使用。<br> AV_ERR_TRY_AGAIN_LATER：查询失败，建议等待短暂间隔后重试。 | 825 826### OH_VideoEncoder_GetInputBuffer() 827 828``` 829OH_AVBuffer *OH_VideoEncoder_GetInputBuffer(struct OH_AVCodec *codec, uint32_t index) 830``` 831 832**描述** 833 834获取可用输入缓冲区的实例。<br>需要注意的是，此接口仅适用于同步模式。 835 836**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 837 838**起始版本：** 20 839 840 841**参数：** 842 843| 参数项 | 描述 | 844| -- | -- | 845| [struct OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 846| uint32_t index | 输入buffer对应的索引值，可通过[OH_VideoEncoder_QueryInputBuffer](#oh_videoencoder_queryinputbuffer)接口获取。 | 847 848**返回：** 849 850| 类型 | 说明 | 851| -- | -- | 852| [OH_AVBuffer](capi-core-oh-avbuffer.md) * | 如果执行成功，则返回一个指向OH_AVBuffer实例的指针，否则返回NULL。 | 853 854### OH_VideoEncoder_QueryOutputBuffer() 855 856``` 857OH_AVErrCode OH_VideoEncoder_QueryOutputBuffer(struct OH_AVCodec *codec, uint32_t *index, int64_t timeoutUs) 858``` 859 860**描述** 861 862查询下一个可用输出缓冲区的索引。<br>通过[OH_VideoEncoder_GetOutputBuffer](#oh_videoencoder_getoutputbuffer)接口获取的缓冲区实例可以通过[OH_VideoEncoder_FreeOutputBuffer](#oh_videoencoder_freeoutputbuffer)接口将处理后的输出缓冲区返回到编码器。<br> 需要注意的是，上述操作仅在同步模式下支持。 863 864**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 865 866**起始版本：** 20 867 868 869**参数：** 870 871| 参数项 | 描述 | 872| -- | -- | 873| [struct OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 874| uint32_t *index | 输出buffer对应的索引值。 | 875| int64_t timeoutUs | 超时时长，单位为微秒。负值：无限等待；0：立即退出；正值：等待指定时长后退出。 | 876 877**返回：** 878 879| 类型 | 说明 | 880| -- | -- | 881| [OH_AVErrCode](capi-native-averrors-h.md#oh_averrcode) | AV_ERR_OK：执行成功。<br> AV_ERR_NO_MEMORY：输入的编码器实例已经销毁。<br> AV_ERR_INVALID_VAL：输入的codec指针为非编码器实例，或者为空指针。<br> AV_ERR_UNKNOWN：未知错误。<br> AV_ERR_SERVICE_DIED：编解码服务已终止。<br> AV_ERR_INVALID_STATE：编码器状态不支持调用本接口时调用。<br> AV_ERR_OPERATE_NOT_PERMIT：禁止异步模式下使用。<br> AV_ERR_STREAM_CHANGED：流格式已变更，可以通过调用[OH_VideoEncoder_GetOutputDescription](#oh_videoencoder_getoutputdescription)接口获取新的流信息。<br> AV_ERR_TRY_AGAIN_LATER：查询失败，建议等待短暂间隔后重试。 | 882 883### OH_VideoEncoder_GetOutputBuffer() 884 885``` 886OH_AVBuffer *OH_VideoEncoder_GetOutputBuffer(struct OH_AVCodec *codec, uint32_t index) 887``` 888 889**描述** 890 891获取可用输出缓冲区的实例。<br>需要注意的是，此接口仅适用于同步模式。 892 893**系统能力：** SystemCapability.Multimedia.Media.VideoEncoder 894 895**起始版本：** 20 896 897 898**参数：** 899 900| 参数项 | 描述 | 901| -- | -- | 902| struct [OH_AVCodec](capi-codecbase-oh-avcodec.md) *codec | 指向视频编码实例的指针。 | 903| uint32_t index | 输出buffer对应的索引值，可通过[OH_VideoEncoder_QueryOutputBuffer](#oh_videoencoder_queryoutputbuffer)接口获取。 | 904 905**返回：** 906 907| 类型 | 说明 | 908| -- | -- | 909| [OH_AVBuffer](capi-core-oh-avbuffer.md) * | 如果执行成功，则返回一个指向OH_AVBuffer实例的指针，否则返回NULL。 | 910 911 912
