Interface (AVRecorder)

音视频录制管理类，用于音视频媒体录制。在调用AVRecorder的方法前，需要先调用createAVRecorder接口构建一个AVRecorder实例。

音视频录制demo可参考：音频录制开发指导、视频录制开发指导。

说明：

• 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本Interface首批接口从API version 9开始支持。
• 相机视频录制功能需配合相机模块使用，相机模块接口的使用详情请参考相机管理。

导入模块

import { media } from '@kit.MediaKit';

属性

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

名称	类型	只读	可选	说明
state9+	AVRecorderState	是	否	音视频录制的状态。 原子化服务API： 从API version 12 开始，该接口支持在原子化服务中使用。

prepare⁹⁺

prepare(config: AVRecorderConfig, callback: AsyncCallback<void>): void

音视频录制的参数设置。使用callback异步回调。

需要权限： ohos.permission.MICROPHONE

不涉及音频录制时，无需获取ohos.permission.MICROPHONE权限。

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

参数：

参数名	类型	必填	说明
config	AVRecorderConfig	是	配置音视频录制的相关参数。
callback	AsyncCallback<void>	是	回调函数。当prepare接口成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Media错误码。

错误码ID	错误信息
201	Permission denied. Return by callback.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
5400102	Operate not permit. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

// 配置参数以实际硬件设备支持的范围为准。
let avRecorderProfile: media.AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_AVC,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
};
let videoMetaData: media.AVMetadata = {
  videoOrientation: '0' // 合理值0、90、180、270，非合理值prepare接口报错。
};
let avRecorderConfig: media.AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : avRecorderProfile,
  url : 'fd://', // 文件需先由调用者创建，赋予读写权限，将文件fd传给此参数。
  metadata: videoMetaData,
  location : { latitude : 30, longitude : 130 }
};

avRecorder.prepare(avRecorderConfig, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to prepare and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in preparing');
  }
});

prepare⁹⁺

prepare(config: AVRecorderConfig): Promise<void>

音视频录制的参数设置。使用Promise异步回调。

需要权限： ohos.permission.MICROPHONE

不涉及音频录制时，无需获取ohos.permission.MICROPHONE权限。

原子化服务API： 从API version 12 开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
config	AVRecorderConfig	是	配置音视频录制的相关参数。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Media错误码。

错误码ID	错误信息
201	Permission denied. Return by promise.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
5400102	Operate not permit. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

// 配置参数以实际硬件设备支持的范围为准。
let avRecorderProfile: media.AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_AVC,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
};
let videoMetaData: media.AVMetadata = {
  videoOrientation: '0' // 合理值0、90、180、270，非合理值prepare接口报错。
};
let avRecorderConfig: media.AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : avRecorderProfile,
  url : 'fd://',  // 文件需先由调用者创建，赋予读写权限，将文件fd传给此参数。
  metadata : videoMetaData,
  location : { latitude : 30, longitude : 130 }
};

avRecorder.prepare(avRecorderConfig).then(() => {
  console.info('Succeeded in preparing');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to prepare and error is: Code: ${error.code}, message: ${error.message}`);
});

addWatermark

addWatermark(watermark: image.PixelMap, config: WatermarkConfiguration): Promise<number>

在录制视频过程中添加自定义水印图像。使用Promise异步回调。

说明：

• 应用最多可添加5个水印。

• 需在prepare接口调用前调用addWatermark接口。

起始版本： 26.0.0

模型约束： 此接口仅可在Stage模型下使用。

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

参数：

参数名	类型	必填	说明
watermark	image.PixelMap	是	水印图像。
config	WatermarkConfiguration	是	配置视频录制水印的相关参数。

返回值：

类型	说明
Promise<number>	Promise对象，返回所添加水印的编号。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.
5400108	The parameter check failed, parameter value out of range.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { image } from '@kit.ImageKit';
import { media } from '@kit.MediaKit';

let watermark: image.PixelMap | undefined = undefined; // 可以通过获取本地资源文件并转换为PixelMap，水印图像不能为空。
let watermarkConfig: media.WatermarkConfiguration = { top: 100, left: 100, width: 100, height: 100 };

if (watermark) {
    avRecorder.addWatermark(watermark, watermarkConfig).then((num: number) => {
      console.info(`Succeeded in adding watermark, watermarkNum is ${num}`);
    })
    .catch((error: BusinessError) => {
      console.error(`Failed to add watermark and catch error is: Code: ${error.code}, message: ${error.message}`);
    });
}

getInputSurface⁹⁺

getInputSurface(callback: AsyncCallback<string>): void

获得录制需要的surface。使用callback异步回调。

开发者从此surface中获取surfaceBuffer，填入相应的视频数据。

应当注意，填入的视频数据需要携带时间戳（单位ns）和buffersize。时间戳的起始时间请以系统启动时间为基准。

需在prepare接口成功调用后，才能调用getInputSurface接口。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	回调函数。当获取surface成功，err为undefined，data为获取到的surfaceId，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by callback.
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let surfaceID: string; // 该surfaceID用于传递给相机接口创建videoOutput。

avRecorder.getInputSurface((err: BusinessError, surfaceId: string) => {
  if (err) {
    console.error(`Failed to do getInputSurface and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in doing getInputSurface');
    surfaceID = surfaceId;
  }
});

getInputSurface⁹⁺

getInputSurface(): Promise<string>

获得录制需要的surface。使用Promise异步回调。

开发者从此surface中获取surfaceBuffer，填入相应的视频数据。

应当注意，填入的视频数据需要携带时间戳（单位ns）和buffersize。时间戳的起始时间请以系统启动时间为基准。

需在prepare接口成功调用后，才能调用getInputSurface接口。

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

返回值：

类型	说明
Promise<string>	Promise对象，返回surface中获取的surfaceBuffer。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let surfaceID: string; // 该surfaceID用于传递给相机接口创建videoOutput。

avRecorder.getInputSurface().then((surfaceId: string) => {
  console.info('Succeeded in getting InputSurface');
  surfaceID = surfaceId;
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to get InputSurface and error is: Code: ${error.code}, message: ${error.message}`);
});

updateRotation¹²⁺

updateRotation(rotation: number): Promise<void>

更新视频旋转角度。使用Promise异步回调。

当且仅当prepare接口成功调用后，且在start接口之前，才能调用updateRotation接口。

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

参数：

参数名	类型	必填	说明
rotation	number	是	旋转角度，单位为度（°）。取值仅支持0°、90°、180°和270°。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Media错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
5400102	Operation not allowed. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let rotation = 90;

avRecorder.updateRotation(rotation).then(() => {
  console.info('Succeeded in doing updateRotation');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to do updateRotation and error is: Code: ${error.code}, message: ${error.message}`);
});

setMetadata

setMetadata(metadata: Record<string, string>): void

设置录制的元数据信息。如果这些信息的键相同，会覆盖config.metadata.customInfo（参考prepare()和AVRecorderConfig）中的值。

该方法只能在prepare()事件成功触发后，且必须在stop()之前调用。

起始版本： 26.0.0

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

参数：

参数名	类型	必填	说明
metadata	Record<string, string>	是	录制的元数据信息。 格式为字符串键值对，其中，键需要以com.openharmony.开头，且值的长度不能超过256个字节。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400101	No memory.
5400102	Operation not allowed.
5400108	Parameter check failed.

示例：

let metadata: Record<string, string> = {
  'com.openharmony.userdefine': '10',
  'com.openharmony.userdefine2': '20'
};

try {
  avRecorder.setMetadata(metadata);
  console.info('set metadata successfully');
} catch (err) {
  console.error(`set metadata failed with error: ${err.code}, ${err.message}`);
}

setWillMuteWhenInterrupted²⁰⁺

setWillMuteWhenInterrupted(muteWhenInterrupted: boolean): Promise<void>

设置当前录制音频流是否启用静音打断模式。使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
muteWhenInterrupted	boolean	是	设置当前录制音频流是否启用静音打断模式, true表示启用，false表示不启用，保持为默认打断模式。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.setWillMuteWhenInterrupted(true).then(() => {
  console.info('Succeeded in doing setWillMuteWhenInterrupted');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to do setWillMuteWhenInterrupted and error is: Code: ${error.code}, message: ${error.message}`);
});

start⁹⁺

start(callback: AsyncCallback<void>): void

开始视频录制。使用callback异步回调。

纯音频录制需在prepare接口成功调用后，才能调用start接口。纯视频录制，音视频录制需在getInputSurface接口成功调用后，才能调用start接口。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当开始录制视频成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by callback.
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.start((err: BusinessError) => {
  if (err) {
    console.error(`Failed to start AVRecorder and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in starting AVRecorder');
  }
});

start⁹⁺

start(): Promise<void>

开始视频录制。使用Promise异步回调。

纯音频录制需在prepare接口成功调用后，才能调用start接口。纯视频录制，音视频录制需在getInputSurface接口成功调用后，才能调用start接口。

原子化服务API： 从API version 12 开始，该接口支持在原子化服务中使用。

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.start().then(() => {
  console.info('Succeeded in starting AVRecorder');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to start AVRecorder and error is: Code: ${error.code}, message: ${error.message}`);
});

pause⁹⁺

pause(callback: AsyncCallback<void>): void

暂停视频录制。使用callback异步回调。

需要start接口成功调用后，才能调用pause接口，可以通过调用resume接口来恢复录制。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当暂停视频录制成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by callback.
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.pause((err: BusinessError) => {
  if (err) {
    console.error(`Failed to pause AVRecorder and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in pausing');
  }
});

pause⁹⁺

pause(): Promise<void>

暂停视频录制。使用Promise异步回调。

需要start接口成功调用后，才能调用pause接口，可以通过调用resume接口来恢复录制。

原子化服务API： 从API version 12 开始，该接口支持在原子化服务中使用。

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.pause().then(() => {
  console.info('Succeeded in pausing');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to pause AVRecorder and error is: Code: ${error.code}, message: ${error.message}`);
});

resume⁹⁺

resume(callback: AsyncCallback<void>): void

恢复视频录制。使用callback异步回调。

需要在pause接口成功调用后，才能调用resume接口。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当恢复视频录制成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by callback.
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.resume((err: BusinessError) => {
  if (err) {
    console.error(`Failed to resume AVRecorder and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in resuming AVRecorder');
  }
});

resume⁹⁺

resume(): Promise<void>

恢复视频录制。使用Promise异步回调。

需要在pause接口成功调用后，才能调用resume接口。

原子化服务API： 从API version 12 开始，该接口支持在原子化服务中使用。

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.resume().then(() => {
  console.info('Succeeded in resuming AVRecorder');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to resume AVRecorder and error is: Code: ${error.code}, message: ${error.message}`);
});

stop⁹⁺

stop(callback: AsyncCallback<void>): void

停止视频录制。使用callback异步回调。

需要在start或pause接口成功调用后，才能调用stop接口。

纯音频录制时，需要重新调用prepare接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare和getInputSurface接口才能重新录制。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当停止视频录制成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by callback.
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.stop((err: BusinessError) => {
  if (err) {
    console.error(`Failed to stop AVRecorder and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in stopping AVRecorder');
  }
});

stop⁹⁺

stop(): Promise<void>

停止视频录制。使用Promise异步回调。

需要在start或pause接口成功调用后，才能调用stop接口。

纯音频录制时，需要重新调用prepare接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare和getInputSurface接口才能重新录制。

原子化服务API： 从API version 12 开始，该接口支持在原子化服务中使用。

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.stop().then(() => {
  console.info('Succeeded in stopping AVRecorder');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to stop AVRecorder and error is: Code: ${error.code}, message: ${error.message}`);
});

reset⁹⁺

reset(callback: AsyncCallback<void>): void

重置音视频录制。使用callback异步回调。

纯音频录制时，需要重新调用prepare接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare和getInputSurface接口才能重新录制。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当重置音视频录制成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.reset((err: BusinessError) => {
  if (err) {
    console.error(`Failed to reset AVRecorder and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in resetting AVRecorder');
  }
});

reset⁹⁺

reset(): Promise<void>

重置音视频录制。使用Promise异步回调。

纯音频录制时，需要重新调用prepare接口才能重新录制。纯视频录制，音视频录制时，需要重新调用prepare和getInputSurface接口才能重新录制。

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.reset().then(() => {
  console.info('Succeeded in resetting AVRecorder');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to reset AVRecorder and error is: Code: ${error.code}, message: ${error.message}`);
});

release⁹⁺

release(callback: AsyncCallback<void>): void

释放音视频录制资源。使用callback异步回调。

释放音视频录制资源之后，该AVRecorder实例不能再进行任何操作。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当释放音视频录制资源成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.release((err: BusinessError) => {
  if (err) {
    console.error(`Failed to release AVRecorder and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in releasing AVRecorder');
  }
});

release⁹⁺

release(): Promise<void>

释放音视频录制资源。使用Promise异步回调。

释放音视频录制资源之后，该AVRecorder实例不能再进行任何操作。

原子化服务API： 从API version 12 开始，该接口支持在原子化服务中使用。

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.release().then(() => {
  console.info('Succeeded in releasing AVRecorder');
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to release AVRecorder and error is: Code: ${error.code}, message: ${error.message}`);
});

getCurrentAudioCapturerInfo¹¹⁺

getCurrentAudioCapturerInfo(callback: AsyncCallback<audio.AudioCapturerChangeInfo>): void

获取当前音频采集参数。使用callback异步回调。

在prepare接口成功调用后，才能调用此接口。在stop接口成功调用后，调用此接口会报错。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<audio.AudioCapturerChangeInfo>	是	回调函数。当获取音频采集参数成功时，err为undefined，data为获取到的audio.AudioCapturerChangeInfo，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed.
5400103	I/O error.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { audio } from '@kit.AudioKit';

let currentCapturerInfo: audio.AudioCapturerChangeInfo;

avRecorder.getCurrentAudioCapturerInfo((err: BusinessError, capturerInfo: audio.AudioCapturerChangeInfo) => {
  if (err) {
    console.error(`Failed to get CurrentAudioCapturerInfo and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in getting CurrentAudioCapturerInfo');
    currentCapturerInfo = capturerInfo;
  }
});

getCurrentAudioCapturerInfo¹¹⁺

getCurrentAudioCapturerInfo(): Promise<audio.AudioCapturerChangeInfo>

获取当前音频采集参数。使用Promise异步回调。

在prepare接口成功调用后，才能调用此接口。在stop接口成功调用后，调用此接口会报错。

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

返回值：

类型	说明
Promise<audio.AudioCapturerChangeInfo>	Promise对象，返回获取的当前音频采集参数。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed.
5400103	I/O error.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { audio } from '@kit.AudioKit';

let currentCapturerInfo: audio.AudioCapturerChangeInfo;

avRecorder.getCurrentAudioCapturerInfo().then((capturerInfo: audio.AudioCapturerChangeInfo) => {
  console.info('Succeeded in getting CurrentAudioCapturerInfo');
  currentCapturerInfo = capturerInfo;
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to get CurrentAudioCapturerInfo and error is: Code: ${error.code}, message: ${error.message}`);
});

getAudioCapturerMaxAmplitude¹¹⁺

getAudioCapturerMaxAmplitude(callback: AsyncCallback<number>): void

获取当前音频最大振幅。使用callback异步回调。

在prepare接口成功调用后，才能调用此接口。在stop接口成功调用后，调用此接口会报错。

调用接口时，获取到的返回值是上一次获取最大振幅的时刻到当前这段区间内的音频最大振幅。例如，在1s时获取了一次最大振幅，到2s时再获取到的最大振幅是1-2s这个区间里面的最大值。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数。获取当前音频最大振幅成功时，err为undefined，data为获取到的最大振幅，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let maxAmplitude: number;

avRecorder.getAudioCapturerMaxAmplitude((err: BusinessError, amplitude: number) => {
  if (err) {
    console.error(`Failed to get AudioCapturerMaxAmplitude and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in getting AudioCapturerMaxAmplitude');
    maxAmplitude = amplitude;
  }
});

getAudioCapturerMaxAmplitude¹¹⁺

getAudioCapturerMaxAmplitude(): Promise<number>

获取当前音频最大振幅。使用Promise异步回调。

在prepare接口成功调用后，才能调用此接口。在stop接口成功调用后，调用此接口会报错。

调用接口时，获取到的返回值是上一次获取最大振幅的时刻到当前这段区间内的音频最大振幅。例如，在1s时获取了一次最大振幅，到2s时再获取到的最大振幅是1-2s这个区间里面的最大值。

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

返回值：

类型	说明
Promise<number>	Promise对象，返回获取的当前音频最大振幅。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let maxAmplitude: number;

avRecorder.getAudioCapturerMaxAmplitude().then((amplitude: number) => {
  console.info('Succeeded in getting AudioCapturerMaxAmplitude');
  maxAmplitude = amplitude;
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to get AudioCapturerMaxAmplitude and error is: Code: ${error.code}, message: ${error.message}`);
});

getAvailableEncoder¹¹⁺

getAvailableEncoder(callback: AsyncCallback<Array<EncoderInfo>>): void

获取可用的编码器参数。使用callback异步回调。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<EncoderInfo>>	是	回调函数。获取可用的编码器参数成功时，err为undefined，data为获取到的编码器参数，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let encoderInfo: media.EncoderInfo;

avRecorder.getAvailableEncoder((err: BusinessError, info: media.EncoderInfo[]) => {
  if (err) {
    console.error(`Failed to get AvailableEncoder and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in getting AvailableEncoder');
    if (info.length > 0) {
      encoderInfo = info[0];
    } else {
      console.error('No available encoder');
    }
  }
});

getAvailableEncoder¹¹⁺

getAvailableEncoder(): Promise<Array<EncoderInfo>>

获取可用的编码器参数。使用Promise异步回调。

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

返回值：

类型	说明
Promise<Array<EncoderInfo>>	Promise对象，返回获取的可用的编码器参数。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operation not allowed.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let encoderInfo: media.EncoderInfo;

avRecorder.getAvailableEncoder().then((info: media.EncoderInfo[]) => {
  console.info('Succeeded in getting AvailableEncoder');
    if (info.length > 0) {
      encoderInfo = info[0];
    } else {
      console.error('No available encoder');
    }
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to get AvailableEncoder and error is: Code: ${error.code}, message: ${error.message}`);
});

getAVRecorderConfig¹¹⁺

getAVRecorderConfig(callback: AsyncCallback<AVRecorderConfig>): void

获取实时的配置参数。使用callback异步回调。

只能在prepare接口调用成功后调用。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AVRecorderConfig>	是	回调函数。获取实时配置的参数成功时，err为undefined，data为获取到的配置参数，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by callback.
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let avConfig: media.AVRecorderConfig;

avRecorder.getAVRecorderConfig((err: BusinessError, config: media.AVRecorderConfig) => {
  if (err) {
    console.error(`Failed to get avConfig and error is: Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in getting AVRecorderConfig');
    avConfig = config;
  }
});

getAVRecorderConfig¹¹⁺

getAVRecorderConfig(): Promise<AVRecorderConfig>;

获取实时的配置参数。使用Promise异步回调。

只能在prepare接口调用成功后调用。

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

返回值：

类型	说明
Promise<AVRecorderConfig>	Promise对象。返回实时配置参数。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400102	Operate not permit. Return by promise.
5400103	IO error. Return by promise.
5400105	Service died. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let avConfig: media.AVRecorderConfig;

avRecorder.getAVRecorderConfig().then((config: media.AVRecorderConfig) => {
  console.info('Succeeded in getting AVRecorderConfig');
  avConfig = config;
}).catch((err: Error) => {
  let error: BusinessError = err as BusinessError;
  console.error(`Failed to get AVRecorderConfig and error is: Code: ${error.code}, message: ${error.message}`);
});

on('stateChange')⁹⁺

on(type: 'stateChange', callback: OnAVRecorderStateChangeHandler): void

订阅录制状态机AVRecorderState切换的事件，当AVRecorderState状态机发生变化时，会通过订阅的回调方法通知用户。用户只能订阅一个录制状态机切换事件的回调方法，当用户重复订阅时，以最后一次订阅的回调接口为准。使用callback异步回调。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
type	string	是	录制状态机切换事件回调类型，支持的事件：'stateChange'，用户操作和系统都会触发此事件。
callback	OnAVRecorderStateChangeHandler	是	回调函数，返回录制状态机切换事件。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

avRecorder.on('stateChange', async (state: media.AVRecorderState, reason: media.StateChangeReason) => {
  console.info('case state has changed, new state is: ' + state + ', and reason is: ' + reason);
});

off('stateChange')⁹⁺

off(type: 'stateChange', callback?: OnAVRecorderStateChangeHandler): void

取消订阅录制状态机AVRecorderState切换的事件。使用callback异步回调。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
type	string	是	录制状态机切换事件回调类型，支持的事件：'stateChange'，用户操作和系统都会触发此事件。
callback12+	OnAVRecorderStateChangeHandler	否	回调函数，返回录制状态机切换事件。如果指定参数则取消对应callback（callback对象不能是匿名函数），否则取消所有callback。 从API version 12开始支持此参数。

示例：

avRecorder.off('stateChange');

on('error')⁹⁺

on(type: 'error', callback: ErrorCallback): void

订阅AVRecorder的错误事件，该事件仅用于错误提示，不需要用户停止播控动作。如果此时AVRecorderState也切换至error状态，用户需要通过reset或者release接口退出录制操作。使用callback异步回调。

用户只能订阅一个错误事件的回调方法，当用户重复订阅时，以最后一次订阅的回调接口为准。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
type	string	是	录制错误事件回调类型'error'。 - 'error'：录制过程中发生错误，触发该事件。
callback	ErrorCallback	是	回调函数，返回录制错误事件。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Media错误码。

错误码ID	错误信息
201	Permission denied.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
801	Capability not supported.
5400101	No memory.
5400102	Operation not allowed.
5400103	I/O error.
5400104	Time out.
5400105	Service died.
5400106	Unsupported format.
5400107	Audio interrupted.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

avRecorder.on('error', (err: BusinessError) => {
  console.error(`case avRecorder.on(error) called. Code: ${err.code}, message: ${err.message}`);
});

off('error')⁹⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅录制错误事件，取消后不再接收到AVRecorder的错误事件。使用callback异步回调。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
type	string	是	录制错误事件回调类型'error'。 - 'error'：录制过程中发生错误，触发该事件。
callback12+	ErrorCallback	否	回调函数，返回录制错误事件。如果指定参数则取消对应callback（callback对象不能是匿名函数），否则取消所有callback。 从API version 12开始支持此参数。

示例：

avRecorder.off('error');

on('audioCapturerChange')¹¹⁺

on(type: 'audioCapturerChange', callback: Callback<audio.AudioCapturerChangeInfo>): void

订阅录音配置变化的回调，任意录音配置的变化会触发变化后的录音配置全量信息回调。使用callback异步回调。

当用户重复订阅时，以最后一次订阅的回调接口为准。

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

参数：

参数名	类型	必填	说明
type	string	是	录音配置变化的回调类型，支持的事件：'audioCapturerChange'。
callback	Callback<audio.AudioCapturerChangeInfo>	是	回调函数，返回变化后的录音配置全量信息。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit'

let capturerChangeInfo: audio.AudioCapturerChangeInfo;

avRecorder.on('audioCapturerChange',  (audioCapturerChangeInfo: audio.AudioCapturerChangeInfo) => {
  console.info('audioCapturerChange called');
  capturerChangeInfo = audioCapturerChangeInfo;
});

off('audioCapturerChange')¹¹⁺

off(type: 'audioCapturerChange', callback?: Callback<audio.AudioCapturerChangeInfo>): void

取消订阅录音变化的回调事件。使用callback异步回调。

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

参数：

参数名	类型	必填	说明
type	string	是	录音配置变化的回调类型，支持的事件：'audioCapturerChange'。
callback12+	Callback<audio.AudioCapturerChangeInfo>	否	回调函数，返回变化后的录音配置全量信息。如果指定参数则取消对应callback（callback对象不能是匿名函数），否则取消所有callback。 从API version 12开始支持此参数。

示例：

avRecorder.off('audioCapturerChange');

on('photoAssetAvailable')¹²⁺

on(type: 'photoAssetAvailable', callback: Callback<photoAccessHelper.PhotoAsset>): void

订阅媒体资源回调事件，当FileGenerationMode枚举设置为系统创建媒体文件时，会在stop操作结束后把PhotoAsset对象回调给应用。使用callback异步回调。

当用户重复订阅时，以最后一次订阅的回调接口为准。

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

参数：

参数名	类型	必填	说明
type	string	是	录像资源的回调类型，支持的事件：'photoAssetAvailable'。
callback	Callback<photoAccessHelper.PhotoAsset>	是	回调函数，返回系统创建的资源文件对应的PhotoAsset对象。

错误码：

以下错误码的详细介绍请参见Media错误码。

错误码ID	错误信息
5400103	IO error. Return by callback.
5400105	Service died. Return by callback.

示例：

import { photoAccessHelper } from '@kit.MediaLibraryKit';
let photoAsset: photoAccessHelper.PhotoAsset;

// 例：处理photoAsset回调，保存video。
async function saveVideo(context: Context, asset: photoAccessHelper.PhotoAsset) {
  console.info("saveVideo called");
  try {
    let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
    let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
    assetChangeRequest.saveCameraPhoto();
    await phAccessHelper.applyChanges(assetChangeRequest);
    console.info('apply saveVideo successfully');
  } catch (err) {
    console.error(`apply saveVideo failed with error: ${err.code}, ${err.message}`);
  }
}
// 注册photoAsset监听。
avRecorder.on('photoAssetAvailable', (asset: photoAccessHelper.PhotoAsset) => {
  console.info('photoAssetAvailable called');
  if (asset != undefined) {
    photoAsset = asset;
    // 处理photoAsset回调。
    // 例：this.saveVideo(context, asset);
  } else {
    console.error('photoAsset is undefined');
  }
});

off('photoAssetAvailable')¹²⁺

off(type: 'photoAssetAvailable', callback?: Callback<photoAccessHelper.PhotoAsset>): void

取消订阅媒体资源的回调类型。使用callback异步回调。

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

参数：

参数名	类型	必填	说明
type	string	是	录音配置变化的回调类型，支持的事件：'photoAssetAvailable'。
callback	Callback<photoAccessHelper.PhotoAsset>	否	回调函数，返回系统创建的资源文件对应的PhotoAsset对象。如果指定参数则取消对应callback（callback对象不能是匿名函数），否则取消所有callback。

示例：

avRecorder.off('photoAssetAvailable');