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