Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 3fb6c598 编写于 作者: B bird_j
浏览文件
操作

add videorecorder & audiorecorder js api docs 

Signed-off-by: Nbird_j <jianghongpeng@huawei.com>
上级 f7b280be
展开全部 隐藏空白更改
内联 并排
Showing with 1195 addition and 157 deletion
zh-cn/application-dev/media/Readme-CN.md
浏览文件 @ 3fb6c598
......@@ -6,3 +6,8 @@
- [音频管理开发指导](audio-management.md)
- [音频录制开发指导](audio-recorder.md)
- 视频
- [视频开发概述](video-overview.md)
- [视频播放开发指导](video-playback.md)
- [视频录制开发指导](video-recorder.md)
zh-cn/application-dev/media/audio-recorder.md
浏览文件 @ 3fb6c598
# 音频录制开发指导
- [场景介绍](#场景介绍)
- [接口说明](#接口说明)
## 场景介绍
音频录制的主要工作是将音频信号记录并保存下来，同时提供包括采样率、声道数、码率、编码格式、封装格式、文件路径等设置功能。
## 接口说明
**表1** media
| 接口名 | 描述 |
| -------- | -------- |
| media.createAudioRecorder() | 创建AudioRecorder实例。 |
| AudioRecorder | 提供音频录制相关功能。 |
| AudioRecorderConfig | 提供音频录制相关参数设置。 |
**表2** 音频录制相关的interface **AudioRecorder**
| 接口名 | 描述 |
| -------- | -------- |
| prepare(config:&nbsp;AudioRecorderConfig):&nbsp;void | 准备音频录制并设置参数。 |
| start():&nbsp;void | 开始音频录制。 |
| pause():&nbsp;void | 暂停音频录制。(暂不支持) |
| resume():&nbsp;void | 恢复音频录制。(暂不支持) |
| stop():&nbsp;void | 停止音频录制。 |
| release():&nbsp;void | 释放音频录制资源。 |
| reset():&nbsp;void | 重置音频录制。 |
| on('prepare',&nbsp;function&nbsp;callback) | 订阅音频录制准备事件。 |
| on('start',&nbsp;function&nbsp;callback) | 订阅音频录制开始事件。 |
| on('pause',&nbsp;function&nbsp;callback) | 订阅音频录制暂停事件。 |
| on('resume',&nbsp;function&nbsp;callback) | 订阅音频录制恢复事件。 |
| on('stop',function&nbsp;callback) | 订阅音频录制结束事件。 |
| on('release',&nbsp;function&nbsp;callback) | 订阅音频录制释放资源事件。 |
| on('reset',&nbsp;function&nbsp;callback) | 订阅音频录制重置事件。 |
| on('error',&nbsp;function&nbsp;callback) | 订阅音频录制错误事件。 |
**表3** 音频录制的相关参数的interface **AudioRecorderConfig**
| 接口名 | 描述 |
| -------- | -------- |
| audioEncoder?: AudioEncoder | 音频编码格式,默认值是AAC_LC。 |
| audioEncodeBitRate?:&nbsp;number | 音频编码的比特率，默认值为48000。 |
| audioSampleRate?:&nbsp;number | 音频编码的采样率，默认值为48000。 |
| numberOfChannels?：number | 音频的声道数，默认值为2。 |
| format?:&nbsp;AudioOutputFormat | 音频的输出格式，默认值是MPEG_4。 |
| uri:&nbsp;string | 音频的输出路径。（file://path&nbsp;或者&nbsp;file://fd） |
**表4** AudioEncoder的相关参数的interface **AudioEncoder**
| 接口名 | 描述 |
| -------- | -------- |
| AAC_LC&nbsp;=&nbsp;3 | 表示AAC_LC编码格式。 |
**表5** 音频输出格式的相关参数的interface **AudioOutputFormat**
| 接口名 | 描述 |
| -------- | -------- |
| MPEG_4&nbsp;=&nbsp;2 | 表示MPEG_4编码格式。 |
| AAC_ADTS=&nbsp;6 | 表示AAC_ADTS编码格式。 |
1. 创建音频录制器。
```
import media from '@ohos.multimedia.media';
var recorder = media.createAudioRecorder();
```
2. 准备音频录制参数。
```
let audioRecorderConfig = {
audioEncoder : AAC_LC ,
audioEncodeBitRate : 22050,
audioSampleRate : 22050,
numberOfChannels : 2,
format : AAC_ADTS,
uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a',
}
recorder.prepare(audioRecorderConfig);
```
3. 设置消息订阅事件。
```
recorder.on('prepare', () => {
console.info('setCallback prepare() case callback is called');
recorder.start();
});
recorder.on('start', () => {
console.info('setCallback start() case callback is called');
setTimeout(function(){
recorder.pause();
}, 10000); // 开始录音10秒后，暂停录音。
});
recorder.on('pause', () => {
console.info('setCallback pause() case callback is called');
setTimeout(function(){
recorder.resume();
}, 10000); // 暂停录音10秒后，恢复录音。
});
recorder.on('resume', () => {
console.info('setCallback resume() case callback is called');
setTimeout(function(){
recorder.stop();
}, 10000); // 恢复录音10秒后，停止录音。
});
recorder.on('stop', () => {
console.info('setCallback stop() case callback is called');
recorder.release();
});
recorder.on('release', () => {
console.info('setCallback release() case callback is called');
});
recorder.on('error', (err) => {
console.info(`case error called,errCode is ${err.code}`);
console.info(`case error called,errMessage is ${err.message}`);
recorder.reset();
});
```
# 音频录制开发指导
## 场景介绍
音频录制的主要工作是捕获音频信号，完成音频编码并保存到文件中，帮助开发者轻松实现音频录制功能。它允许调用者指定音频录制的采样率、声道数、编码格式、封装格式、文件路径等参数。
**图1** 音频录制状态机
![zh-ch_image_audio_recorder_state_machine](figures/zh-ch_image_audio_recorder_state_machine.jpg)
## 音频录制零层图
**图2** 音频录制零层图
![zh-ch_image_audio_recorder_zero](figures/zh-ch_image_audio_recorder_zero.jpg)
音频录制零层图简单说明：
1、JS应用，包括系统录音机等音频录制类应用。
2、表示应用可以通过调用音频录制JS层的接口与音频录制JS Framework进行交互，或者通过ACE组件调用到音频录制Native接口，与音频录制的Native Framework进行交互。
3、媒体服务模块。
4、系统服务/IPC通信子系统。
5、音频录制访问文件涉及权限子系统。
6、音频录制中涉及的系统权限校验系统。
7、音频录制涉及的音频服务模块。
## 音频录制开发步骤
详细API含义可参考：[js-apis-media.md](../reference/apis/js-apis-media.md)
### 全流程场景
包含流程：创建实例，设置录制参数，录制音频，暂停录制，恢复录制，停止录制，释放资源等流程。
```js
funfunction SetCallBack(audioRecorder) {
audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
console.log('prepare success');
// 录制界面可切换至已准备好，可点击录制按钮进行录制
});
audioRecorder.on('start', () => { // 设置'start'事件回调
console.log('audio recorder start success');
// 将录制按钮切换至可暂停状态
});
audioRecorder.on('pause', () => { // 设置'pause'事件回调
console.log('audio recorder pause success');
// 将录制按钮切换至可录制状态
});
audioRecorder.on('resume', () => { // 设置'resume'事件回调
console.log('audio recorder resume success');
// 将录制按钮切换至可暂停状态
});
audioRecorder.on('stop', () => { // 设置'stop'事件回调
console.log('audio recorder stop success');
});
audioRecorder.on('release', () => { // 设置'release'事件回调
console.log('audio recorder release success');
});
audioRecorder.on('reset', () => { // 设置'reset'事件回调
console.log('audio recorder reset success');
// 需要重新设置录制参数才能再次录制
});
audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, errName is ${error.name}`);
console.info(`audio error called, errCode is ${error.code}`);
console.info(`audio error called, errMessage is ${error.message}`);
});
}
// 1.创建实例
let audioRecorder = media.createAudioRecorder();
// 2.设置回调
SetCallBack(audioRecorder);
// 3.设置录制参数
let audioRecorderConfig = {
audioEncoder : media.AudioEncoder.AAC_LC ,
audioEncodeBitRate : 22050,
audioSampleRate : 22050,
numberOfChannels : 2,
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.prepare(audioRecorderConfig)
// 4.开始录制
audioRecorder.start(); // 需等待'prepare'事件回调完成后，才可调用start进行录制，触发'start'事件回调
// 5.暂停录制
audioRecorder.pause(); // 需等待'start'事件回调完成后，才可调用pause进行暂停，触发'pause'事件回调
// 6.恢复录制
audioRecorder.resume(); // 需等待'pause'事件回调完成后，才可调用resume进行录制，触发'resume'事件回调
// 7.停止录制
audioRecorder.stop(); // 需等待'start'或'resume'事件回调完成后，才可调用stop进行暂停，触发'stop'事件回调
// 8.重置录制
audioRecorder.reset(); // 触发'reset'事件回调后，重新进行prepare，才可重新录制
// 9.释放资源
audioRecorder.release(); // audioRecorder资源被销毁
audioRecorder = undefined;
```
### 正常录制场景
与全流程场景不同，不包括暂停录制，恢复录制的过程。
```js
function SetCallBack(audioPlayer) {
audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
console.log('prepare success');
// 录制界面可切换至已准备好，可点击录制按钮进行录制
});
audioRecorder.on('start', () => { // 设置'start'事件回调
console.log('audio recorder start success');
// 将录制按钮切换至可暂停状态
});
audioRecorder.on('stop', () => { // 设置'stop'事件回调
console.log('audio recorder stop success');
});
audioRecorder.on('release', () => { // 设置'release'事件回调
console.log('audio recorder release success');
});
}
// 1.创建实例
let audioRecorder = media.createAudioRecorder();
// 2.设置回调
SetCallBack(audioRecorder);
// 3.设置录制参数
let audioRecorderConfig = {
audioEncoder : media.AudioEncoder.AAC_LC ,
audioEncodeBitRate : 22050,
audioSampleRate : 22050,
numberOfChannels : 2,
format : media.AudioOutputFormat.AAC_ADTS,
uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
}
audioRecorder.prepare(audioRecorderConfig)
// 4.开始录制
audioRecorder.start(); // 需等待'prepare'事件回调完成后，才可调用start进行录制，触发'start'事件回调
// 5.停止录制
audioRecorder.stop(); // 需等待'start'或'resume'事件回调完成后，才可调用stop进行暂停，触发'stop'事件回调
// 6.释放资源
audioRecorder.release(); // audioRecorder资源被销毁
audioRecorder = undefined;
```
zh-cn/application-dev/media/video-recorder.md 0 → 100644
浏览文件 @ 3fb6c598
# 视频录制开发指导
## 场景介绍
视频录制的主要工作是捕获音视频信号，完成音视频编码并保存到文件中，帮助开发者轻松实现音视频录制功能。它允许调用者指定录制的编码格式、封装格式、文件路径等参数。
图1 视频录制状态机
![zh-ch_image_video_recorder_state_machine](figures/zh-ch_image_video_recorder_state_machine.jpg)
## 视频录制零层图
**图2** 视频录制零层图
![zh-ch_image_video_recorder_zero](figures/zh-ch_image_video_recorder_zero.jpg)
视频录制零层图简单说明：
1、JS应用，包括系统相机等视频录制类应用。
2、表示应用可以通过调用视频录制JS层的接口与视频录制JS Framework进行交互，或者通过ACE组件调用到视频录制Native接口，与视频录制的Native Framework进行交互。
3、表示媒体服务创建Surface并将SurfaceId传递给应用，或者媒体创建Surface并将Surface的生产者端对象直接传递给ACE组件。
4、媒体服务模块。
5、系统服务/IPC通信子系统。
6、视频录制访问文件涉及权限子系统。
7、视频录制中涉及的系统权限校验系统。
8、视频录制涉及硬件编码。
9、视频录制涉及的音频服务模块。
## 视频录制开发步骤
详细API含义可参考：[js-apis-media.md](../reference/apis/js-apis-media.md)
### 全流程场景
包含流程：创建实例，设置录制参数，录制视频，暂停录制，恢复录制，停止录制，释放资源等流程。
```js
let videoProfile = {
audioBitrate : 48000,
audioChannels : 2,
audioCodec : 'audio/mp4a-latm',
audioSampleRate : 48000,
fileFormat : 'mp4',
videoBitrate : 48000,
videoCodec : 'video/mp4v-es',
videoFrameWidth : 640,
videoFrameHeight : 480,
videoFrameRate : 30
}
let videoConfig = {
audioSourceType : 1,
videoSourceType : 0,
profile : videoProfile,
url : 'file:///data/media/01.mp4',
orientationHint : 0,
location : { latitude : 30, longitude : 130 },
}
// 当发生错误上上报的错误回调接口
function failureCallback(error) {
console.info('error happened, error name is ' + error.name);
console.info('error happened, error code is ' + error.code);
console.info('error happened, error message is ' + error.message);
}
// 当发生异常时，系统调用的错误回调接口
function catchCallback(error) {
console.info('catch error happened, error name is ' + error.name);
console.info('catch error happened, error code is ' + error.code);
console.info('catch error happened, error message is ' + error.message);
}
let videoRecorder = null; // videoRecorder空对象在createVideoRecorder成功后赋值
let surfaceID = null; // 用于保存getInputSurface返回的surfaceID
// 创建videoRecorder对象
await media.createVideoRecorder().then((recorder) => {
console.info('case createVideoRecorder called');
if (typeof (recorder) != 'undefined') {
videoRecorder = recorder;
console.info('createVideoRecorder success');
} else {
console.info('createVideoRecorder failed');
}
}, failureCallback).catch(catchCallback);
// 获取surfaceID并保存下来传递给camera相关接口
await videoRecorder.getInputSurface().then((surface) => {
console.info('getInputSurface success');
surfaceID = surface;
}, failureCallback).catch(catchCallback);
// 视频录制依赖相机相关接口，以下需要先调用相机起流接口后才能继续执行
// 视频录制启动接口
await videoRecorder.start().then(() => {
console.info('start success');
}, failureCallback).catch(catchCallback);
// 调用pause接口时需要暂停camera出流
await videoRecorder.pause().then(() => {
console.info('pause success');
}, failureCallback).catch(catchCallback);
// 调用resume接口时需要恢复camera出流
await videoRecorder.resume().then(() => {
console.info('resume success');
}, failureCallback).catch(catchCallback);
// 停止camera出流后，停止视频录制
await videoRecorder.stop().then(() => {
console.info('stop success');
}, failureCallback).catch(catchCallback);
// 重置录制相关配置
await videoRecorder.reset().then(() => {
console.info('reset success');
}, failureCallback).catch(catchCallback);
// 释放视频录制相关资源并释放camera对象相关资源
await videoRecorder.release().then(() => {
console.info('release success');
}, failureCallback).catch(catchCallback);
// 相关对象置null
videoRecorder = null;
surfaceID = null;
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或