avrecorder.h

概述

定义AVRecorder接口。应用可使用媒体AVRecorder提供的接口录制媒体数据。

引用文件： <multimedia/player_framework/avrecorder.h>

库： libavrecorder.so

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

相关模块： AVRecorder

汇总

函数

名称	描述
OH_AVRecorder *OH_AVRecorder_Create(void)	创建AVRecorder实例。调用成功之后进入AVRECORDER_IDLE状态。
OH_AVErrCode OH_AVRecorder_Prepare(OH_AVRecorder *recorder, OH_AVRecorder_Config *config)	配置AVRecorder参数，准备录制。必须在OH_AVRecorder_Create成功触发之后调用，调用成功之后进入AVRECORDER_PREPARED状态。 若只录制音频，则无需配置视频相关参数；同理，若只录制视频，则无需配置音频相关参数。
OH_AVErrCode OH_AVRecorder_GetAVRecorderConfig(OH_AVRecorder *recorder, OH_AVRecorder_Config **config)	获取当前的录制参数。此接口必须在录制准备完成后调用。传入的*config必须为nullptr，由框架层统一分配和释放内存，以避免内存管理混乱，防止内存泄漏或重复释放等问题。
OH_AVErrCode OH_AVRecorder_GetInputSurface(OH_AVRecorder *recorder, OHNativeWindow **window)	获取输入Surface。必须在OH_AVRecorder_Prepare成功触发之后，OH_AVRecorder_Start之前调用。 此Surface提供给调用者，调用者从此Surface中获取Surface Buffer，填入相应的视频数据。
OH_AVErrCode OH_AVRecorder_UpdateRotation(OH_AVRecorder *recorder, int32_t rotation)	更新视频旋转角度。必须在OH_AVRecorder_Prepare成功触发之后，OH_AVRecorder_Start之前调用。
OH_AVErrCode OH_AVRecorder_Start(OH_AVRecorder *recorder)	开始录制。必须在OH_AVRecorder_Prepare成功触发之后调用，调用成功之后进入AVRECORDER_STARTED状态。
OH_AVErrCode OH_AVRecorder_Pause(OH_AVRecorder *recorder)	暂停录制。必须在OH_AVRecorder_Start成功触发之后，处于AVRECORDER_STARTED状态时调用，调用成功之后进入AVRECORDER_PAUSED状态。 之后可以通过调用OH_AVRecorder_Resume恢复录制，重新进入AVRECORDER_STARTED状态。
OH_AVErrCode OH_AVRecorder_Resume(OH_AVRecorder *recorder)	恢复录制。必须在OH_AVRecorder_Pause成功触发之后，处于PAUSED状态时调用，调用成功之后重新进入AVRECORDER_STARTED状态。
OH_AVErrCode OH_AVRecorder_Stop(OH_AVRecorder *recorder)	停止录制。必须在OH_AVRecorder_Start成功触发之后调用，调用成功之后进入AVRECORDER_STOPPED状态。 纯音频录制时，需要重新调用OH_AVRecorder_Prepare接口才能重新录制。 纯视频录制、音视频录制时，需要重新调用OH_AVRecorder_Prepare和OH_AVRecorder_GetInputSurface接口才能重新录制。
OH_AVErrCode OH_AVRecorder_Reset(OH_AVRecorder *recorder)	重置录制状态。必须在非AVRECORDER_RELEASED状态下调用，调用成功之后进入AVRECORDER_IDLE状态。 纯音频录制时，需要重新调用OH_AVRecorder_Prepare接口才能重新录制。 纯视频录制、音视频录制时，需要重新调用OH_AVRecorder_Prepare和OH_AVRecorder_GetInputSurface接口才能重新录制。
OH_AVErrCode OH_AVRecorder_Release(OH_AVRecorder *recorder)	释放录制资源。调用成功之后进入AVRECORDER_RELEASED状态。 调用此接口释放录制资源后，recorder内存将释放，应用层需要显式地将recorder指针置空，避免访问野指针。释放音视频录制资源之后，该OH_AVRecorder实例不能再进行任何操作。
OH_AVErrCode OH_AVRecorder_GetAvailableEncoder(OH_AVRecorder *recorder, OH_AVRecorder_EncoderInfo **info,int32_t *length)	获取AVRecorder可用的编码器和编码器信息。 参数*info必须为nullptr，由框架层统一分配和释放内存，以避免内存管理混乱，防止内存泄漏或重复释放等问题。
OH_AVErrCode OH_AVRecorder_SetStateCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnStateChange callback, void *userData)	设置状态回调函数，以便应用能够响应AVRecorder生成的状态变化事件。此接口必须在OH_AVRecorder_Start调用之前调用。
OH_AVErrCode OH_AVRecorder_SetErrorCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnError callback, void *userData)	设置错误回调函数，以便应用能够响应AVRecorder生成的错误事件。此接口必须在OH_AVRecorder_Start调用之前调用。
OH_AVErrCode OH_AVRecorder_SetUriCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnUri callback, void *userData)	设置URI回调函数，以便应用能够响应AVRecorder生成的URI事件。此接口必须在OH_AVRecorder_Start调用之前调用。
OH_AVErrCode OH_AVRecorder_SetWillMuteWhenInterrupted(OH_AVRecorder *recorder, bool muteWhenInterrupted)	设置是否开启静音打断模式。

函数说明

OH_AVRecorder_Create()

OH_AVRecorder *OH_AVRecorder_Create(void)

描述

创建AVRecorder实例。调用成功之后进入AVRECORDER_IDLE状态。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

返回：

类型	说明
OH_AVRecorder	成功时返回指向OH_AVRecorder实例的指针，失败时返回nullptr。

OH_AVRecorder_Prepare()

OH_AVErrCode OH_AVRecorder_Prepare(OH_AVRecorder *recorder, OH_AVRecorder_Config *config)

描述

配置AVRecorder参数，准备录制。必须在OH_AVRecorder_Create成功触发之后调用，调用成功之后进入AVRECORDER_PREPARED状态。
若只录制音频，则无需配置视频相关参数；同理，若只录制视频，则无需配置音频相关参数。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
OH_AVRecorder_Config *config	指向OH_AVRecorder_Config实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或者准备失败。

OH_AVRecorder_GetAVRecorderConfig()

OH_AVErrCode OH_AVRecorder_GetAVRecorderConfig(OH_AVRecorder *recorder, OH_AVRecorder_Config **config)

描述

获取当前的录制参数。此接口必须在录制准备完成后调用。
传入的*config必须为nullptr，由框架层统一分配和释放内存，以避免内存管理混乱，防止内存泄漏或重复释放等问题。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
OH_AVRecorder_Config **config	指向OH_AVRecorder_Config实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或*config不为nullptr。 AV_ERR_NO_MEMORY：内存不足，*config内存分配失败。

OH_AVRecorder_GetInputSurface()

OH_AVErrCode OH_AVRecorder_GetInputSurface(OH_AVRecorder *recorder, OHNativeWindow **window)

描述

获取输入Surface。必须在OH_AVRecorder_Prepare成功触发之后，OH_AVRecorder_Start之前调用。
此Surface提供给调用者，调用者从此Surface中获取Surface Buffer，填入相应的视频数据。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
OHNativeWindow **window	指向OHNativeWindow实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr。

OH_AVRecorder_UpdateRotation()

OH_AVErrCode OH_AVRecorder_UpdateRotation(OH_AVRecorder *recorder, int32_t rotation)

描述

更新视频旋转角度。必须在OH_AVRecorder_Prepare成功触发之后，OH_AVRecorder_Start之前调用。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
int32_t rotation	视频旋转角度，必须是整数 [0, 90, 180, 270] 中的一个。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或输入的rotation不符合要求或更新方向失败。

OH_AVRecorder_Start()

OH_AVErrCode OH_AVRecorder_Start(OH_AVRecorder *recorder)

描述

开始录制。必须在OH_AVRecorder_Prepare成功触发之后调用，调用成功之后进入AVRECORDER_STARTED状态。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或启动失败。

OH_AVRecorder_Pause()

OH_AVErrCode OH_AVRecorder_Pause(OH_AVRecorder *recorder)

描述

暂停录制。必须在OH_AVRecorder_Start成功触发之后，处于AVRECORDER_STARTED状态时调用，调用成功之后进入AVRECORDER_PAUSED状态。
之后可以通过调用OH_AVRecorder_Resume恢复录制，重新进入AVRECORDER_STARTED状态。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或暂停失败。

OH_AVRecorder_Resume()

OH_AVErrCode OH_AVRecorder_Resume(OH_AVRecorder *recorder)

描述

恢复录制。必须在OH_AVRecorder_Pause成功触发之后，处于PAUSED状态时调用，调用成功之后重新进入AVRECORDER_STARTED状态。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或恢复失败。

OH_AVRecorder_Stop()

OH_AVErrCode OH_AVRecorder_Stop(OH_AVRecorder *recorder)

描述

停止录制。必须在OH_AVRecorder_Start成功触发之后调用，调用成功之后进入AVRECORDER_STOPPED状态。
纯音频录制时，需要重新调用OH_AVRecorder_Prepare接口才能重新录制。
纯视频录制、音视频录制时，需要重新调用OH_AVRecorder_Prepare和OH_AVRecorder_GetInputSurface接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或停止失败。

OH_AVRecorder_Reset()

OH_AVErrCode OH_AVRecorder_Reset(OH_AVRecorder *recorder)

描述

重置录制状态。必须在非AVRECORDER_RELEASED状态下调用，调用成功之后进入AVRECORDER_IDLE状态。
纯音频录制时，需要重新调用OH_AVRecorder_Prepare接口才能重新录制。
纯视频录制、音视频录制时，需要重新调用OH_AVRecorder_Prepare和OH_AVRecorder_GetInputSurface接口才能重新录制。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或重置失败。

OH_AVRecorder_Release()

OH_AVErrCode OH_AVRecorder_Release(OH_AVRecorder *recorder)

描述

释放录制资源。调用成功之后进入AVRECORDER_RELEASED状态。
调用此接口释放录制资源后，recorder内存将释放，应用层需要显式地将recorder指针置空，避免访问野指针。释放音视频录制资源之后，该OH_AVRecorder实例不能再进行任何操作。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或释放失败。

OH_AVRecorder_GetAvailableEncoder()

OH_AVErrCode OH_AVRecorder_GetAvailableEncoder(OH_AVRecorder *recorder, OH_AVRecorder_EncoderInfo **info,int32_t *length)

描述

获取AVRecorder可用的编码器和编码器信息。
参数*info必须为nullptr，由框架层统一分配和释放内存，以避免内存管理混乱，防止内存泄漏或重复释放等问题。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
OH_AVRecorder_EncoderInfo **info	指向OH_AVRecorder_EncoderInfo实例的指针。
int32_t *length	可用编码器的长度。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的 recorder 为nullptr。 AV_ERR_NO_MEMORY：内存不足，*info内存分配失败。

OH_AVRecorder_SetStateCallback()

OH_AVErrCode OH_AVRecorder_SetStateCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnStateChange callback, void *userData)

描述

设置状态回调函数，以便应用能够响应AVRecorder生成的状态变化事件。此接口必须在OH_AVRecorder_Start调用之前调用。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
OH_AVRecorder_OnStateChange callback	状态回调函数。
void *userData	指向用户特定数据的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或回调函数为nullptr。

OH_AVRecorder_SetErrorCallback()

OH_AVErrCode OH_AVRecorder_SetErrorCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnError callback, void *userData)

描述

设置错误回调函数，以便应用能够响应AVRecorder生成的错误事件。此接口必须在OH_AVRecorder_Start调用之前调用。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
OH_AVRecorder_OnError callback	错误回调函数。
void *userData	指向用户特定数据的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或回调函数为nullptr。

OH_AVRecorder_SetUriCallback()

OH_AVErrCode OH_AVRecorder_SetUriCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnUri callback, void *userData)

描述

设置URI回调函数，以便应用能够响应AVRecorder生成的URI事件。此接口必须在OH_AVRecorder_Start调用之前调用。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 18

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
OH_AVRecorder_OnUri callback	URI回调函数。
void *userData	指向用户特定数据的指针。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或回调函数为nullptr。

OH_AVRecorder_SetWillMuteWhenInterrupted()

OH_AVErrCode OH_AVRecorder_SetWillMuteWhenInterrupted(OH_AVRecorder *recorder, bool muteWhenInterrupted)

描述

设置是否开启静音打断模式。

系统能力： SystemCapability.Multimedia.Media.AVRecorder

起始版本： 20

参数：

参数项	描述
OH_AVRecorder *recorder	指向OH_AVRecorder实例的指针。
bool muteWhenInterrupted	设置成true表示当应用需要录制时保持静音而不是被打断。

返回：

类型	说明
OH_AVErrCode	AV_ERR_OK：执行成功。 AV_ERR_INVALID_VAL：输入的recorder为nullptr或回调函数为nullptr。 AV_ERR_INVALID_STATE：函数在无效状态下调用，应先处于准备状态。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Media Kit（媒体服务）

harmony 鸿蒙Interface (AVImageGenerator)

harmony 鸿蒙Interface (AVMetadataExtractor)

harmony 鸿蒙Interface (AVPlayer)

harmony 鸿蒙Interface (AVRecorder)

harmony 鸿蒙Interface (AVScreenCaptureRecorder)

harmony 鸿蒙Interface (AVTranscoder)

harmony 鸿蒙废弃的Interface (AudioPlayer, deprecated)

harmony 鸿蒙废弃的Interface (AudioRecorder, deprecated)

harmony 鸿蒙Interface (MediaSource)