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

2025-06-16
浏览 (3)

废弃的Interface (AudioRecorder, deprecated)

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder替代。

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

prepare^(deprecated)

prepare(config: AudioRecorderConfig): void

录音准备。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.prepare替代。

需要权限： ohos.permission.MICROPHONE

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

参数：

参数名	类型	必填	说明
config	AudioRecorderConfig	是	配置录音的相关参数，包括音频输出URI、编码格式、采样率、声道数、输出格式等。

错误码：

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

错误码ID	错误信息
201	permission denied

示例：

let audioRecorderConfig: media.AudioRecorderConfig = {
  audioEncoder : media.AudioEncoder.AAC_LC,
  audioEncodeBitRate : 22050,
  audioSampleRate : 22050,
  numberOfChannels : 2,
  format : media.AudioOutputFormat.AAC_ADTS,
  uri : 'fd://1',       // 文件需先由调用者创建，并给予适当的权限。
  location : { latitude : 30, longitude : 130},
};
audioRecorder.on('prepare', () => {    //设置'prepare'事件回调。
  console.info('prepare called');
});
audioRecorder.prepare(audioRecorderConfig);

start^(deprecated)

start(): void

开始录制，需在’prepare’事件成功触发后，才能调用start方法。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.start替代。

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

示例：

audioRecorder.on('start', () => {    //设置'start'事件回调。
  console.info('audio recorder start called');
});
audioRecorder.start();

pause^(deprecated)

pause():void

暂停录制，需要在’start’事件成功触发后，才能调用pause方法。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.pause替代。

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

示例：

audioRecorder.on('pause', () => {    //设置'pause'事件回调。
  console.info('audio recorder pause called');
});
audioRecorder.pause();

resume^(deprecated)

resume():void

恢复录制，需要在’pause’事件成功触发后，才能调用resume方法。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.resume替代。

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

示例：

audioRecorder.on('resume', () => {    //设置'resume'事件回调。
  console.info('audio recorder resume called');
});
audioRecorder.resume();

stop^(deprecated)

stop(): void

停止录音。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.stop替代。

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

示例：

audioRecorder.on('stop', () => {    //设置'stop'事件回调。
  console.info('audio recorder stop called');
});
audioRecorder.stop();

release^(deprecated)

release(): void

释放录音资源。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.release替代。

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

示例：

audioRecorder.on('release', () => {    //设置'release'事件回调。
  console.info('audio recorder release called');
});
audioRecorder.release();
audioRecorder = undefined;

reset^(deprecated)

reset(): void

重置录音。

进行重置录音之前，需要先调用stop()停止录音。重置录音之后，需要调用prepare()设置录音参数项，才能再次进行录音。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.reset替代。

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

示例：

audioRecorder.on('reset', () => {    //设置'reset'事件回调。
  console.info('audio recorder reset called');
});
audioRecorder.reset();

on(‘prepare’|‘start’|‘pause’|‘resume’|‘stop’|‘release’|‘reset’)^(deprecated)

开始订阅音频录制事件。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.on(‘stateChange’)替代。

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

参数：

参数名	类型	必填	说明
type	string	是	录制事件回调类型，支持的事件包括：’prepare’ \| ‘start’ \| ‘pause’ \|’resume‘ \| ‘stop’ \| ‘release’ \| ‘reset’。 - ‘prepare’ ：完成prepare调用，音频录制参数设置完成，触发该事件。 - ‘start’ ：完成start调用，音频录制开始，触发该事件。 - ‘pause’: 完成pause调用，音频暂停录制，触发该事件。 - ‘resume’: 完成resume调用，音频恢复录制，触发该事件。 - ‘stop’ ：完成stop调用，音频停止录制，触发该事件。 - ‘release’ ：完成release调用，音频释放录制资源，触发该事件。 - ‘reset’：完成reset调用，音频重置为初始状态，触发该事件。
callback	()=>void	是	录制事件回调方法。

示例：

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

let audioRecorder: media.AudioRecorder = media.createAudioRecorder();  // 创建一个音频录制实例。
let audioRecorderConfig: media.AudioRecorderConfig = {
  audioEncoder : media.AudioEncoder.AAC_LC,
  audioEncodeBitRate : 22050,
  audioSampleRate : 22050,
  numberOfChannels : 2,
  format : media.AudioOutputFormat.AAC_ADTS,
  uri : 'fd://xx',  // 文件需先由调用者创建，并给予适当的权限。
  location : { latitude : 30, longitude : 130}
};
audioRecorder.on('error', (error: BusinessError) => {  // 设置'error'事件回调。
  console.error(`audio error called, error: ${error}`);
});
audioRecorder.on('prepare', () => {  // 设置'prepare'事件回调。
  console.info('prepare called');
  audioRecorder.start();  // 开始录制，并触发'start'事件回调。
});
audioRecorder.on('start', () => {  // 设置'start'事件回调。
  console.info('audio recorder start called');
});
audioRecorder.on('pause', () => {  // 设置'pause'事件回调。
  console.info('audio recorder pause called');
});
audioRecorder.on('resume', () => {  // 设置'resume'事件回调。
  console.info('audio recorder resume called');
});
audioRecorder.on('stop', () => {  // 设置'stop'事件回调。
  console.info('audio recorder stop called');
});
audioRecorder.on('release', () => {  // 设置'release'事件回调。
  console.info('audio recorder release called');
});
audioRecorder.on('reset', () => {  // 设置'reset'事件回调。
  console.info('audio recorder reset called');
});
audioRecorder.prepare(audioRecorderConfig)  // 设置录制参数 ，并触发'prepare'事件回调。

on(‘error’)^(deprecated)

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

开始订阅音频录制错误事件，当上报error错误事件后，用户需处理error事件，退出录制操作。

说明： 从API version 6开始支持，从API version 9开始废弃，建议使用AVRecorder.on(‘error’)替代。

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

参数：

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

示例：

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

let audioRecorderConfig: media.AudioRecorderConfig = {
  audioEncoder : media.AudioEncoder.AAC_LC,
  audioEncodeBitRate : 22050,
  audioSampleRate : 22050,
  numberOfChannels : 2,
  format : media.AudioOutputFormat.AAC_ADTS,
  uri : 'fd://xx',   // 文件需先由调用者创建，并给予适当的权限。
  location : { latitude : 30, longitude : 130}
};
audioRecorder.on('error', (error: BusinessError) => {  // 设置'error'事件回调。
  console.error(`audio error called, error: ${error}`);
});
audioRecorder.prepare(audioRecorderConfig);  // prepare不设置参数，触发'error'事件。