harmony 鸿蒙Interface (AVRecorder)

2025-06-16
浏览 (3)

Interface (AVRecorder)

说明： 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

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

说明：

使用相机进行视频录制时，需要与相机模块配合，相机模块接口的使用详情见相机管理。

属性

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

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

prepare⁹⁺

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

异步方式进行音视频录制的参数设置。通过注册回调函数获取返回值。

需要权限： ohos.permission.MICROPHONE

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

使用相机视频录制还需要与相机模块配合，相机模块接口的使用详情见相机管理。

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

参数：

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

错误码：

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

错误码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 avRecorderConfig: media.AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : avRecorderProfile,
  url : 'fd://', // 文件需先由调用者创建，赋予读写权限，将文件fd传给此参数，eg.fd://45
  rotation : 0, // 合理值0、90、180、270，非合理值prepare接口将报错。
  location : { latitude : 30, longitude : 130 }
};

avRecorder.prepare(avRecorderConfig, (err: BusinessError) => {
  if (err) {
    console.error('Failed to prepare and error is ' + 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>	异步音视频录制prepare方法的Promise返回值。

错误码：

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

错误码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 avRecorderConfig: media.AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : avRecorderProfile,
  url : 'fd://',  // 文件需先由调用者创建，赋予读写权限，将文件fd传给此参数，eg.fd://45
  rotation : 0, // 合理值0、90、180、270，非合理值prepare接口报错。
  location : { latitude : 30, longitude : 130 }
};

avRecorder.prepare(avRecorderConfig).then(() => {
  console.info('Succeeded in preparing');
}).catch((err: BusinessError) => {
  console.error('Failed to prepare and catch error is ' + err.message);
});

getInputSurface⁹⁺

getInputSurface(callback: AsyncCallback<string>): void

异步方式获得录制需要的surface。通过注册回调函数获取返回值。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的视频数据。

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

需在prepare()事件成功触发后，才能调用getInputSurface()方法。

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

参数：

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

错误码：

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

错误码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 ' + err.message);
  } else {
    console.info('Succeeded in doing getInputSurface');
    surfaceID = surfaceId;
  }
});

getInputSurface⁹⁺

getInputSurface(): Promise<string>

异步方式获得录制需要的surface。通过Promise获取返回值。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的视频数据。

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

需在prepare()事件成功触发后，才能调用getInputSurface方法。

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

返回值：

类型	说明
Promise<string>	异步获得surface的Promise返回值。

错误码：

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

错误码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: BusinessError) => {
  console.error('Failed to get InputSurface and catch error is ' + err.message);
});

updateRotation¹²⁺

updateRotation(rotation: number): Promise<void>

更新视频旋转角度。通过Promise获取返回值。

当且仅当prepare()事件成功触发后，且在start()之前，才能调用updateRotation方法。

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

参数：

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

返回值：

类型	说明
Promise<void>	异步返回函数执行结果。

错误码：

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

错误码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 updateRotation');
}).catch((err: BusinessError) => {
  console.error('Failed to updateRotation and catch error is ' + err.message);
});

setWillMuteWhenInterrupted²⁰⁺

setWillMuteWhenInterrupted(muteWhenInterrupted: boolean): Promise<void>

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

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

参数：

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

返回值：

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

错误码：

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

错误码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('setWillMuteWhenInterrupted Success!');
}).catch((err: BusinessError) => {
  console.error(`setWillMuteWhenInterrupted Fail: ${err}`);
});

start⁹⁺

start(callback: AsyncCallback<void>): void

异步方式开始视频录制。通过注册回调函数获取返回值。

纯音频录制需在prepare()事件成功触发后，才能调用start方法。纯视频录制，音视频录制需在getInputSurface()事件成功触发后，才能调用start方法。

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

参数：

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

错误码：

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

错误码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 ' + 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返回值。

错误码：

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

错误码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: BusinessError) => {
  console.error('Failed to start AVRecorder and catch error is ' + err.message);
});

pause⁹⁺

pause(callback: AsyncCallback<void>): void

异步方式暂停视频录制。通过注册回调函数获取返回值。

需要start()事件成功触发后，才能调用pause方法，可以通过调用resume()接口来恢复录制。

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

参数：

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

错误码：

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

错误码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 ' + 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返回值。

错误码：

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

错误码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: BusinessError) => {
  console.error('Failed to pause AVRecorder and catch error is ' + err.message);
});

resume⁹⁺

resume(callback: AsyncCallback<void>): void

异步方式恢复视频录制。通过注册回调函数获取返回值。

需要在pause()事件成功触发后，才能调用resume方法。

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

参数：

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

错误码：

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

错误码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 ' + 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返回值。

错误码：

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

错误码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: BusinessError) => {
  console.error('Failed to resume  AVRecorder failed and catch error is ' + err.message);
});

stop⁹⁺

stop(callback: AsyncCallback<void>): void

异步方式停止视频录制。通过注册回调函数获取返回值。

需要在start()或pause()事件成功触发后，才能调用stop方法。

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

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

参数：

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

错误码：

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

错误码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 ' + 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返回值。

错误码：

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

错误码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: BusinessError) => {
  console.error('Failed to stop AVRecorder and catch error is ' + err.message);
});

reset⁹⁺

reset(callback: AsyncCallback<void>): void

异步方式重置音视频录制。通过注册回调函数获取返回值。

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

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

参数：

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

错误码：

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

错误码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 ' + err.message);
  } else {
    console.info('Succeeded in resetting AVRecorder');
  }
});

reset⁹⁺

reset(): Promise<void>

异步方式重置音视频录制。通过Promise获取返回值。

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

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

返回值：

类型	说明
Promise<void>	异步重置音视频录制方法的Promise返回值。

错误码：

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

错误码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: BusinessError) => {
  console.error('Failed to reset and catch error is ' + err.message);
});

release⁹⁺

release(callback: AsyncCallback<void>): void

异步方式释放音视频录制资源。通过注册回调函数获取返回值。

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

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

参数：

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

错误码：

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

错误码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 ' + 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返回值。

错误码：

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

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

示例：

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

avRecorder.release().then(() => {
  console.info('Succeeded in releasing AVRecorder');
}).catch((err: BusinessError) => {
  console.error('Failed to release AVRecorder and catch error is ' + err.message);
});

getCurrentAudioCapturerInfo¹¹⁺

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

异步方式获取当前音频采集参数。通过注册回调函数获取返回值。

在prepare()成功触发后，才能调用此方法。在stop()成功触发后，调用此方法会报错。

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

参数：

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

错误码：

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

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

示例：

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 ' + 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对象，返回获取的当前音频采集参数。

错误码：

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

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

示例：

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: BusinessError) => {
  console.error('Failed to get CurrentAudioCapturerInfo and catch error is ' + err.message);
});

getAudioCapturerMaxAmplitude¹¹⁺

getAudioCapturerMaxAmplitude(callback: AsyncCallback<number>): void

异步方式获取当前音频最大振幅。通过注册回调函数获取返回值。

在prepare()成功触发后，才能调用此方法。在stop()成功触发后，调用此方法会报错。

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

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

参数：

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

错误码：

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

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

示例：

let maxAmplitude: number;

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

getAudioCapturerMaxAmplitude¹¹⁺

getAudioCapturerMaxAmplitude(): Promise<number>

异步方式获取当前音频最大振幅参数。通过Promise获取返回值。

在prepare()成功触发后，才能调用此方法。在stop()成功触发后，调用此方法会报错。

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

返回值：

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

错误码：

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

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

示例：

let maxAmplitude: number;

avRecorder.getAudioCapturerMaxAmplitude().then((amplitude: number) => {
  console.info('Succeeded in getting AudioCapturerMaxAmplitude');
  maxAmplitude = amplitude;
}).catch((err: BusinessError) => {
  console.error('Failed to get AudioCapturerMaxAmplitude and catch error is ' + err.message);
});

getAvailableEncoder¹¹⁺

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

异步方式获取可用的编码器参数。通过注册回调函数获取返回值。

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

参数：

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

错误码：

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

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

示例：

let encoderInfo: media.EncoderInfo;

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

getAvailableEncoder¹¹⁺

getAvailableEncoder(): Promise<Array<EncoderInfo>>

异步方式获取可用的编码器参数。通过注册回调函数获取返回值。

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

返回值：

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

错误码：

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

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

示例：

let encoderInfo: media.EncoderInfo;

avRecorder.getAvailableEncoder().then((info: media.EncoderInfo[]) => {
  console.info('Succeeded in getting AvailableEncoder');
  encoderInfo = info[0];
}).catch((err: BusinessError) => {
  console.error('Failed to get AvailableEncoder and catch error is ' + err.message);
});

getAVRecorderConfig¹¹⁺

getAVRecorderConfig(callback: AsyncCallback<AVRecorderConfig>): void

异步方式获取实时的配置参数。通过注册回调函数获取返回值。

只能在prepare()接口调用后调用。

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

参数：

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

错误码：

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

错误码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 ' + err.message);
  } else {
    console.info('Succeeded in getting AVRecorderConfig');
    avConfig = config;
  }
});

getAVRecorderConfig¹¹⁺

getAVRecorderConfig(): Promise<AVRecorderConfig>;

异步方式获取实时的配置参数。通过Promise获取返回值。

只能在prepare()接口调用后调用。

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

返回值：

类型	说明
Promise<AVRecorderConfig>	异步获得实时配置参数的回调方法。

错误码：

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

错误码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: BusinessError) => {
  console.error('Failed to get AVRecorderConfig and catch error is ' + err.message);
});

on(‘stateChange’)⁹⁺

on(type: ‘stateChange’, callback: OnAVRecorderStateChangeHandler): void

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

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

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

参数：

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

错误码：

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

错误码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 new reason is : ' + reason);
});

off(‘stateChange’)⁹⁺

off(type: ‘stateChange’, callback?: OnAVRecorderStateChangeHandler): void

取消订阅播放状态机AVRecorderState切换的事件。

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

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

参数：

参数名	类型	必填	说明
type	string	是	状态机切换事件回调类型，支持的事件：’stateChange’，用户操作和系统都会触发此事件。
callback	OnAVRecorderStateChangeHandler	否	状态机切换事件回调方法。从API version 12开始支持此参数。

示例：

avRecorder.off('stateChange');

on(‘error’)⁹⁺

on(type: ‘error’, callback: ErrorCallback): void

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

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

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

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

参数：

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

错误码：

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

错误码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.info('case avRecorder.on(error) called, errMessage is ' + err.message);
});

off(‘error’)⁹⁺

off(type: ‘error’, callback?: ErrorCallback): void

取消订阅录制错误事件，取消后不再接收到AVRecorder的错误事件。

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

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

参数：

参数名	类型	必填	说明
type	string	是	录制错误事件回调类型’error’。 - ‘error’：录制过程中发生错误，触发该事件。
callback	ErrorCallback	否	录制错误事件回调方法。从API version 12开始支持此参数。

示例：

avRecorder.off('error');

on(‘audioCapturerChange’)¹¹⁺

on(type: ‘audioCapturerChange’, callback: Callback): void

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

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

系统能力： 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): void

取消订阅录音变化的回调事件。

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

参数：

参数名	类型	必填	说明
type	string	是	录音配置变化的回调类型，支持的事件：’audioCapturerChange’。
callback	Callback<audio.AudioCapturerChangeInfo>	否	变化后的录音配置全量信息。从API version 12开始支持此参数。

示例：

avRecorder.off('audioCapturerChange');

on(‘photoAssetAvailable’)¹²⁺

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

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

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

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

参数：

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

错误码：

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

示例：

import { photoAccessHelper } from '@kit.MediaLibraryKit';
import { common } from '@kit.AbilityKit'
let photoAsset: photoAccessHelper.PhotoAsset;
private context: Context|undefined;
constructor(context: Context) {
  this.context = context; // this.getUIContext().getHostContext();
}

// 例:处理photoAsset回调，保存video。
async function saveVideo(asset: photoAccessHelper.PhotoAsset) {
  console.info("saveVideo called");
  try {
    let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(this.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(asset);
  } else {
    console.error('photoAsset is undefined');
  }
});

off(‘photoAssetAvailable’)¹²⁺

off(type: ‘photoAssetAvailable’, callback?: Callback): void

取消订阅媒体资源的回调类型。

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

参数：

参数名	类型	必填	说明
type	string	是	录音配置变化的回调类型，支持的事件：’photoAssetAvailable’。
callback	Callback<photoAccessHelper.PhotoAsset>	否	系统创建的资源文件对应的PhotoAsset对象。

示例：

avRecorder.off('photoAssetAvailable');

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Media Kit（媒体服务）

harmony 鸿蒙Interface (AVImageGenerator)

harmony 鸿蒙Interface (AVMetadataExtractor)

harmony 鸿蒙Interface (AVPlayer)

harmony 鸿蒙Interface (AVScreenCaptureRecorder)

harmony 鸿蒙Interface (AVTranscoder)

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

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

harmony 鸿蒙Interface (MediaSource)

harmony 鸿蒙Interface (MediaSourceLoadingRequest)

0 赞

所属分类： 后端技术
本文标签： 软件鸿蒙
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/Ou6Jay

harmony 鸿蒙Interface (AVRecorder)

Interface (AVRecorder)

属性

prepare9+

prepare9+

getInputSurface9+

getInputSurface9+

updateRotation12+

setWillMuteWhenInterrupted20+

start9+

start9+

pause9+

pause9+

resume9+

resume9+

stop9+

stop9+

reset9+

reset9+

release9+

release9+

getCurrentAudioCapturerInfo11+

getCurrentAudioCapturerInfo11+

getAudioCapturerMaxAmplitude11+

getAudioCapturerMaxAmplitude11+

getAvailableEncoder11+

getAvailableEncoder11+

getAVRecorderConfig11+

getAVRecorderConfig11+

on(‘stateChange’)9+

off(‘stateChange’)9+

on(‘error’)9+

off(‘error’)9+

on(‘audioCapturerChange’)11+

off(‘audioCapturerChange’)11+

on(‘photoAssetAvailable’)12+

off(‘photoAssetAvailable’)12+

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

prepare⁹⁺

prepare⁹⁺

getInputSurface⁹⁺

getInputSurface⁹⁺

updateRotation¹²⁺

setWillMuteWhenInterrupted²⁰⁺

start⁹⁺

start⁹⁺

pause⁹⁺

pause⁹⁺

resume⁹⁺

resume⁹⁺

stop⁹⁺

stop⁹⁺

reset⁹⁺

reset⁹⁺

release⁹⁺

release⁹⁺

getCurrentAudioCapturerInfo¹¹⁺

getCurrentAudioCapturerInfo¹¹⁺

getAudioCapturerMaxAmplitude¹¹⁺

getAudioCapturerMaxAmplitude¹¹⁺

getAvailableEncoder¹¹⁺

getAvailableEncoder¹¹⁺

getAVRecorderConfig¹¹⁺

getAVRecorderConfig¹¹⁺

on(‘stateChange’)⁹⁺

off(‘stateChange’)⁹⁺

on(‘error’)⁹⁺

off(‘error’)⁹⁺

on(‘audioCapturerChange’)¹¹⁺

off(‘audioCapturerChange’)¹¹⁺

on(‘photoAssetAvailable’)¹²⁺

off(‘photoAssetAvailable’)¹²⁺