VideoEncoder

概述

VideoEncoder模块提供用于视频编码功能的函数。

@syscap SystemCapability.Multimedia.Avcodec.VideoEncoder

起始版本：

9

汇总

文件

类型定义

枚举

函数

类型定义说明

OH_VideoEncodeBitrateMode

typedef enum OH_VideoEncodeBitrateMode OH_VideoEncodeBitrateMode

描述：

视频编码器的比特率模式。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

起始版本：

9

枚举类型说明

OH_VideoEncodeBitrateMode

enum OH_VideoEncodeBitrateMode

描述：

视频编码器的比特率模式。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

起始版本：

9

函数说明

OH_VideoEncoder_Configure()

OH_AVErrCode OH_VideoEncoder_Configure (OH_AVCodec *codec, OH_AVFormat *format)

描述：

配置视频编码器，通常需要配置要编码的视频轨的描述信息。

必须在调用Prepare之前，调用此接口。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_CreateByMime()

OH_AVCodec* OH_VideoEncoder_CreateByMime (const char *mime)

描述：

多数情况下，推荐从MIME类型创建视频编码器实例。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

返回一个指向OH_AVCodec实例的指针, 需要调用OH_VideoEncoder_Destroy销毁。

起始版本：

9

OH_VideoEncoder_CreateByName()

OH_AVCodec* OH_VideoEncoder_CreateByName (const char *name)

描述：

通过视频编码器名称创建一个视频编码器实例。使用此接口的前提是知道编码器的确切名称。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

返回指向OH_AVCodec实例的指针。

起始版本：

9

OH_VideoEncoder_Destroy()

OH_AVErrCode OH_VideoEncoder_Destroy (OH_AVCodec *codec)

描述：

清除编码器的内部资源并销毁编码器实例。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_Flush()

OH_AVErrCode OH_VideoEncoder_Flush (OH_AVCodec *codec)

描述：

清除编码器中缓冲的输入和输出数据。

调用此接口后，之前通过异步回调函数报告的索引将无效，请确保不要访问与这些索引相对应的缓冲区。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_FreeOutputData()

OH_AVErrCode OH_VideoEncoder_FreeOutputData (OH_AVCodec *codec, uint32_t index)

描述：

将处理后的输出缓冲区返回给编码器。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_GetInputDescription()

OH_AVFormat* OH_VideoEncoder_GetInputDescription (OH_AVCodec *codec)

描述：

获取视频编码器接收的描述信息，调用Configure后调用此接口，请参阅 OH_AVFormat 获取详细信息。

应该注意的是，返回指针所指向的OH_AVFormat实例的生命周期需要由调用者手动释放。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

返回指向OH_AVFormat实例的指针。

起始版本：

10

OH_VideoEncoder_GetOutputDescription()

OH_AVFormat* OH_VideoEncoder_GetOutputDescription (OH_AVCodec *codec)

描述：

获取编码器输出数据的描述信息，详细信息请参阅 OH_AVFormat。

需要注意的是，返回值指针指向的OH_AVFormat实例的生命周期需要由调用者手动释放。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

返回指向OH_AVFormat实例的指针。

起始版本：

9

OH_VideoEncoder_GetSurface()

OH_AVErrCode OH_VideoEncoder_GetSurface (OH_AVCodec *codec, OHNativeWindow **window)

描述：

从视频编码器获取输入Surface，必须在调用Prepare之前调用此接口。 应用负责管理window的生命周期，结束时调用OH_NativeWindow_DestroyNativeWindow()释放。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_IsValid()

OH_AVErrCode OH_VideoEncoder_IsValid (OH_AVCodec *codec, bool *isValid)

描述：

检查当前编解码器实例是否有效。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

10

OH_VideoEncoder_NotifyEndOfStream()

OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream (OH_AVCodec *codec)

描述：

通知视频编码器输入流已结束。建议使用此接口进行通知。

编码器surface模式下，输入流的结束通知。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_Prepare()

OH_AVErrCode OH_VideoEncoder_Prepare (OH_AVCodec *codec)

描述：

若要准备编码器的内部资源，必须先调用Configure接口，再调用此接口。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_PushInputData()

OH_AVErrCode OH_VideoEncoder_PushInputData (OH_AVCodec *codec, uint32_t index, OH_AVCodecBufferAttr attr)

描述：

将填入数据的输入缓冲区提交给视频编码器。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

10

OH_VideoEncoder_Reset()

OH_AVErrCode OH_VideoEncoder_Reset (OH_AVCodec *codec)

描述：

重置编码器。要继续编码，您需要再次调用Configure接口配置编码器实例。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_SetCallback()

OH_AVErrCode OH_VideoEncoder_SetCallback (OH_AVCodec *codec, OH_AVCodecAsyncCallback callback, void *userData)

描述：

设置异步回调函数，以便您的应用程序能够响应视频编码器事件。

必须在调用Prepare之前，调用此接口。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_SetParameter()

OH_AVErrCode OH_VideoEncoder_SetParameter (OH_AVCodec *codec, OH_AVFormat *format)

描述：

为编码器设置动态参数。

注意，此接口只有在编码器启动后才能调用。 同时，不正确的参数设置可能会导致编码失败。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_Start()

OH_AVErrCode OH_VideoEncoder_Start (OH_AVCodec *codec)

描述：

启动编码器, 这个接口必须要在Prepare接口执行成功后调用。

在成功启动编码器之后，编码器将开始报告NeedInputData事件。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9

OH_VideoEncoder_Stop()

OH_AVErrCode OH_VideoEncoder_Stop (OH_AVCodec *codec)

描述：

停止编码器。停止之后，你可以通过Start接口进入Started状态。

@syscap SystemCapability.Multimedia.Media.VideoEncoder

参数：

返回：

如果执行成功，返回AV_ERR_OK 否则，返回特定的错误代码，请参阅OH_AVErrCode。

起始版本：

9