harmony 鸿蒙avrecorder.h

2025-06-12
浏览 (4)

avrecorder.h

Overview

The avrecorder.h file declares the AVRecorder APIs. Applications can use the APIs to record media data.

File to include: avrecorder.h

Library: libavrecorder.so

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Related module: AVRecorder

Summary

Functions

|Name|Description| |–|–| |OH_AVRecorder *OH_AVRecorder_Create(void)|Creates an AVRecorder instance. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_IDLE state.| |OH_AVErrCode OH_AVRecorder_Prepare(OH_AVRecorder *recorder, OH_AVRecorder_Config *config)|Sets AVRecorder parameters to prepare for recording. This function must be called after OH_AVRecorder_Create is successfully triggered. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_PREPARED state.
To record only audio, you do not need to set video parameters. Similarly, to record only video, you do not need to set audio parameters.| |OH_AVErrCode OH_AVRecorder_GetAVRecorderConfig(OH_AVRecorder *recorder, OH_AVRecorder_Config **config)|Obtains the AVRecorder configuration. This function must be called after the recording preparation is complete. config must be set to a null pointer. The framework layer allocates and releases the memory in a unified manner to avoid issues with memory management, such as leaks or double freeing.| |OH_AVErrCode OH_AVRecorder_GetInputSurface(OH_AVRecorder *recorder, OHNativeWindow **window)|Obtains an input surface. This function must be called after OH_AVRecorder_Prepare is successfully triggered and before OH_AVRecorder_Start is called.
The caller obtains the surfaceBuffer from this surface and fills in the corresponding video data.| |OH_AVErrCode OH_AVRecorder_UpdateRotation(OH_AVRecorder *recorder, int32_t rotation)|Updates the video rotation angle. This function must be called after OH_AVRecorder_Prepare is successfully triggered and before OH_AVRecorder_Start is called.| |OH_AVErrCode OH_AVRecorder_Start(OH_AVRecorder *recorder)|Starts recording. This function must be called after OH_AVRecorder_Prepare is successfully triggered. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_STARTED state.| |OH_AVErrCode OH_AVRecorder_Pause(OH_AVRecorder *recorder)|Pauses recording. This function must be called after OH_AVRecorder_Start is successfully triggered and the AVRecorder is in the AVRECORDER_STARTED state. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_PAUSED state.
Then, you can call OH_AVRecorder_Resume to resume recording, and the AVRecorder transitions the AVRECORDER_STARTED state again.| |OH_AVErrCode OH_AVRecorder_Resume(OH_AVRecorder *recorder)|Resumes recording. This function must be called after OH_AVRecorder_Pause is successfully triggered and the AVRecorder is in the AVRECORDER_PAUSED state. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_STARTED state.| |OH_AVErrCode OH_AVRecorder_Stop(OH_AVRecorder *recorder)|Stops recording. This function must be called after OH_AVRecorder_Start is successfully triggered. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_STOPPED state.
For audio-only recording, you can call OH_AVRecorder_Prepare again for re-recording.
For video-only recording or audio and video recording, you can call OH_AVRecorder_Prepare and OH_AVRecorder_GetInputSurface again for re-recording.| |OH_AVErrCode OH_AVRecorder_Reset(OH_AVRecorder *recorder)|Resets the recording state. This function must be called when the AVRecorder is not in the AVRECORDER_RELEASED state. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_IDLE state.
For audio-only recording, you can call OH_AVRecorder_Prepare again for re-recording.
For video-only recording or audio and video recording, you can call OH_AVRecorder_Prepare and OH_AVRecorder_GetInputSurface again for re-recording.| |OH_AVErrCode OH_AVRecorder_Release(OH_AVRecorder *recorder)|Releases recording resources. After this API is successfully called, the AVRecorder transitions to the AVRECORDER_RELEASED state.
The recorder memory will be released. The application layer must explicitly set the recorder to a null pointer to avoid access to wild pointers. After the resources are released, you can no longer perform any operation on the OH_AVRecorder instance.| |OH_AVErrCode OH_AVRecorder_GetAvailableEncoder(OH_AVRecorder *recorder, OH_AVRecorder_EncoderInfo **info,int32_t *length)|Obtains the available encoders and encoder information of the AVRecorder.
info must be set to a null pointer. The framework layer allocates and releases the memory in a unified manner to avoid issues with memory management, such as leaks or double freeing.| |OH_AVErrCode OH_AVRecorder_SetStateCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnStateChange callback, void *userData)|Sets a state callback so that the application can respond to state change events generated by the AVRecorder. This function must be called before OH_AVRecorder_Start is called.| |OH_AVErrCode OH_AVRecorder_SetErrorCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnError callback, void *userData)|Sets an error callback so that the application can respond to error events generated by the AVRecorder. This function must be called before OH_AVRecorder_Start is called.| |OH_AVErrCode OH_AVRecorder_SetUriCallback(OH_AVRecorder *recorder, OH_AVRecorder_OnUri callback, void *userData)|Sets a URI callback so that the application can respond to URI events generated by the AVRecorder. This function must be called before OH_AVRecorder_Start is called.|

Function Description

OH_AVRecorder_Create()

OH_AVRecorder *OH_AVRecorder_Create(void)

Description

Creates an AVRecorder instance. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_IDLE state.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Returns

OH_AVRecorder_Prepare()

OH_AVErrCode OH_AVRecorder_Prepare(OH_AVRecorder *recorder, OH_AVRecorder_Config *config)

Description

Sets AVRecorder parameters to prepare for recording. This function must be called after OH_AVRecorder_Create is successfully triggered. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_PREPARED state.

To record only audio, you do not need to set video parameters. Similarly, to record only video, you do not need to set audio parameters.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_GetAVRecorderConfig()

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

Description

Obtains the AVRecorder configuration. This function must be called after the recording preparation is complete.

config must be set to a null pointer. The framework layer allocates and releases the memory in a unified manner to avoid issues with memory management, such as leaks or double freeing.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

|Type|Description| |–|–| |OH_AVErrCode|AV_ERR_OK: The operation is successful.
AV_ERR_INVALID_VAL: The input parameter recorder is a null pointer or config is not a null pointer.
AV_ERR_NO_MEMORY: The memory fails to be allocated due to insufficient memory.|

OH_AVRecorder_GetInputSurface()

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

Description

Obtains an input surface. This function must be called after OH_AVRecorder_Prepare is successfully triggered and before OH_AVRecorder_Start is called.

The caller obtains the surfaceBuffer from this surface and fills in the corresponding video data.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_UpdateRotation()

OH_AVErrCode OH_AVRecorder_UpdateRotation(OH_AVRecorder *recorder, int32_t rotation)

Description

Updates the video rotation angle. This function must be called after OH_AVRecorder_Prepare is successfully triggered and before OH_AVRecorder_Start is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_Start()

OH_AVErrCode OH_AVRecorder_Start(OH_AVRecorder *recorder)

Description

Starts recording. This function must be called after OH_AVRecorder_Prepare is successfully triggered. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_STARTED state.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_Pause()

OH_AVErrCode OH_AVRecorder_Pause(OH_AVRecorder *recorder)

Description

Pauses recording. This function must be called after OH_AVRecorder_Start is successfully triggered and the AVRecorder is in the AVRECORDER_STARTED state. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_PAUSED state.

Then, you can call OH_AVRecorder_Resume to resume recording, and the AVRecorder transitions the AVRECORDER_STARTED state again.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_Resume()

OH_AVErrCode OH_AVRecorder_Resume(OH_AVRecorder *recorder)

Description

Resumes recording. This function must be called after OH_AVRecorder_Pause is successfully triggered and the AVRecorder is in the AVRECORDER_PAUSED state. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_STARTED state.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_Stop()

OH_AVErrCode OH_AVRecorder_Stop(OH_AVRecorder *recorder)

Description

Stops recording. This function must be called after OH_AVRecorder_Start is successfully triggered. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_STOPPED state.

For audio-only recording, you can call OH_AVRecorder_Prepare again for re-recording.

For video-only recording or audio and video recording, you can call OH_AVRecorder_Prepare and OH_AVRecorder_GetInputSurface again for re-recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_Reset()

OH_AVErrCode OH_AVRecorder_Reset(OH_AVRecorder *recorder)

Description

Resets the recording state. This function must be called when the AVRecorder is not in the AVRECORDER_RELEASED state. After this function is successfully called, the AVRecorder transitions to the AVRECORDER_IDLE state.

For audio-only recording, you can call OH_AVRecorder_Prepare again for re-recording.

For video-only recording or audio and video recording, you can call OH_AVRecorder_Prepare and OH_AVRecorder_GetInputSurface again for re-recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_Release()

OH_AVErrCode OH_AVRecorder_Release(OH_AVRecorder *recorder)

Description

Releases recording resources. After this API is successfully called, the AVRecorder transitions to the AVRECORDER_RELEASED state.

The recorder memory will be released. The application layer must explicitly set the recorder to a null pointer to avoid access to wild pointers. After the resources are released, you can no longer perform any operation on the OH_AVRecorder instance.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_GetAvailableEncoder()

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

Description

Obtains the available encoders and encoder information of the AVRecorder.

info must be set to a null pointer. The framework layer allocates and releases the memory in a unified manner to avoid issues with memory management, such as leaks or double freeing.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_SetStateCallback()

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

Description

Sets a state callback so that the application can respond to state change events generated by the AVRecorder. This function must be called before OH_AVRecorder_Start is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_SetErrorCallback()

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

Description

Sets an error callback so that the application can respond to error events generated by the AVRecorder. This function must be called before OH_AVRecorder_Start is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns

OH_AVRecorder_SetUriCallback()

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

Description

Sets a URI callback so that the application can respond to URI events generated by the AVRecorder. This function must be called before OH_AVRecorder_Start is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Since: 18

Parameters

Returns