• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用AVRecorder开发音频录制功能
2
3使用AVRecorder可以实现音频录制功能，本开发指导将以“开始录制-暂停录制-恢复录制-停止录制”的一次流程为示例，向开发者讲解AVRecorder音频录制相关功能。
4
5在进行应用开发的过程中，开发者可以通过AVRecorder的state属性，主动获取当前状态或使用on('stateChange')方法监听状态变化。开发过程中应该严格遵循状态机要求，例如只能在started状态下调用pause()接口，只能在paused状态下调用resume()接口。
6
7**图1** 录制状态变化示意图  
8
9![Recording status change](figures/recording-status-change.png)
10
11状态的详细说明请参考[AVRecorderState](../reference/apis/js-apis-media.md#avrecorderstate9)。
12
13
14## 开发步骤及注意事项
15
16详细的API说明请参考[AVRecorder API参考](../reference/apis/js-apis-media.md#avrecorder9)。
17
181. 创建AVRecorder实例，实例创建完成进入idle状态。
19
20   ```ts
21   import media from '@ohos.multimedia.media';
22
23   let avRecorder = undefined;
24   media.createAVRecorder().then((recorder) => {
25     avRecorder = recorder;
26   }, (err) => {
27     console.error(`Invoke createAVRecorder failed, code is ${err.code}, message is ${err.message}`);
28   })
29   ```
30
312. 设置业务需要的监听事件，监听状态变化及错误上报。
32   | 事件类型 | 说明 |
33   | -------- | -------- |
34   | stateChange | 必要事件，监听AVRecorder的state属性改变 |
35   | error | 必要事件，监听AVRecorder的错误信息 |
36
37
38   ```ts
39   // 状态上报回调函数
40   avRecorder.on('stateChange', (state, reason) => {
41     console.log(`current state is ${state}`);
42     // 用户可以在此补充状态发生切换后想要进行的动作
43   })
44
45   // 错误上报回调函数
46   avRecorder.on('error', (err) => {
47     console.error(`avRecorder failed, code is ${err.code}, message is ${err.message}`);
48   })
49   ```
50
513. 配置音频录制参数，调用prepare()接口，此时进入prepared状态。
52   > **说明：**
53   > 配置参数需要注意：
54   >
55   > - prepare接口的入参avConfig中仅设置音频相关的配置参数，如示例代码所示。
56   >   如果只需要录制音频，请不要设置视频相关配置参数；如果需要录制视频，可以参考[视频录制开发指导](video-recording.md)进行开发。直接设置视频相关参数会导致后续步骤报错。
57   >
58   > - 需要使用支持的[录制规格](avplayer-avrecorder-overview.md#支持的格式)。
59   >
60   > - 录制输出的url地址（即示例里avConfig中的url），形式为fd://xx (fd number)。需要基础文件操作接口（[ohos.file.fs](../reference/apis/js-apis-file-fs.md)）实现应用文件访问能力，获取方式参考[应用文件访问与管理](../file-management/app-file-access.md)。
61
62
63   ```ts
64   let avProfile = {
65     audioBitrate: 100000, // 音频比特率
66     audioChannels: 2, // 音频声道数
67     audioCodec: media.CodecMimeType.AUDIO_AAC, // 音频编码格式，当前只支持aac
68     audioSampleRate: 48000, // 音频采样率
69     fileFormat: media.ContainerFormatType.CFT_MPEG_4A, // 封装格式，当前只支持m4a
70   }
71   let avConfig = {
72     audioSourceType: media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC, // 音频输入源，这里设置为麦克风
73     profile: avProfile,
74     url: 'fd://35', // 参考应用文件访问与管理中的开发示例获取创建的音频文件fd填入此处
75   }
76   avRecorder.prepare(avConfig).then(() => {
77     console.log('Invoke prepare succeeded.');
78   }, (err) => {
79     console.error(`Invoke prepare failed, code is ${err.code}, message is ${err.message}`);
80   })
81   ```
82
834. 开始录制，调用start()接口，此时进入started状态。
84
855. 暂停录制，调用pause()接口，此时进入paused状态。
86
876. 恢复录制，调用resume()接口，此时再次进入started状态。
88
897. 停止录制，调用stop()接口，此时进入stopped状态。
90
918. 重置资源，调用reset()重新进入idle状态，允许重新配置录制参数。
92
939. 销毁实例，调用release()进入released状态，退出录制。
94
95
96## 完整示例
97
98  参考以下示例，完成“开始录制-暂停录制-恢复录制-停止录制”的完整流程。
99
100```ts
101import media from '@ohos.multimedia.media';
102
103export class AudioRecorderDemo {
104  private avRecorder;
105  private avProfile = {
106    audioBitrate: 100000, // 音频比特率
107    audioChannels: 2, // 音频声道数
108    audioCodec: media.CodecMimeType.AUDIO_AAC, // 音频编码格式，当前只支持aac
109    audioSampleRate: 48000, // 音频采样率
110    fileFormat: media.ContainerFormatType.CFT_MPEG_4A, // 封装格式，当前只支持m4a
111  };
112  private avConfig = {
113    audioSourceType: media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC, // 音频输入源，这里设置为麦克风
114    profile: this.avProfile,
115    url: 'fd://35', // 参考应用文件访问与管理开发示例新建并读写一个文件
116  };
117
118  // 注册audioRecorder回调函数
119  setAudioRecorderCallback() {
120    // 状态机变化回调函数
121    this.avRecorder.on('stateChange', (state, reason) => {
122      console.log(`AudioRecorder current state is ${state}`);
123    })
124    // 错误上报回调函数
125    this.avRecorder.on('error', (err) => {
126      console.error(`AudioRecorder failed, code is ${err.code}, message is ${err.message}`);
127    })
128  }
129
130  // 开始录制对应的流程
131  async startRecordingProcess() {
132    // 1.创建录制实例
133    this.avRecorder = await media.createAVRecorder();
134    this.setAudioRecorderCallback();
135    // 2.获取录制文件fd赋予avConfig里的url；参考FilePicker文档
136    // 3.配置录制参数完成准备工作
137    await this.avRecorder.prepare(this.avConfig);
138    // 4.开始录制
139    await this.avRecorder.start();
140  }
141
142  // 暂停录制对应的流程
143  async pauseRecordingProcess() {
144    if (this.avRecorder.state === 'started') { // 仅在started状态下调用pause为合理状态切换
145      await this.avRecorder.pause();
146    }
147  }
148
149  // 恢复录制对应的流程
150  async resumeRecordingProcess() {
151    if (this.avRecorder.state === 'paused') { // 仅在paused状态下调用resume为合理状态切换
152      await this.avRecorder.resume();
153    }
154  }
155
156  // 停止录制对应的流程
157  async stopRecordingProcess() {
158    // 1. 停止录制
159    if (this.avRecorder.state === 'started'
160    || this.avRecorder.state === 'paused') { // 仅在started或者paused状态下调用stop为合理状态切换
161      await this.avRecorder.stop();
162    }
163    // 2.重置
164    await this.avRecorder.reset();
165    // 3.释放录制实例
166    await this.avRecorder.release();
167    // 4.关闭录制文件fd
168  }
169
170  // 一个完整的【开始录制-暂停录制-恢复录制-停止录制】示例
171  async audioRecorderDemo() {
172    await this.startRecordingProcess(); // 开始录制
173    // 用户此处可以自行设置录制时长，例如通过设置休眠阻止代码执行
174    await this.pauseRecordingProcess(); //暂停录制
175    await this.resumeRecordingProcess(); // 恢复录制
176    await this.stopRecordingProcess(); // 停止录制
177  }
178}
179```
180