Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 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 @@ ...@@ -6,3 +6,8 @@
- [音频管理开发指导](audio-management.md) - [音频管理开发指导](audio-management.md)
- [音频录制开发指导](audio-recorder.md) - [音频录制开发指导](audio-recorder.md)
- 视频
- [视频开发概述](video-overview.md)
- [视频播放开发指导](video-playback.md)
- [视频录制开发指导](video-recorder.md)
zh-cn/application-dev/media/audio-recorder.md
浏览文件 @ 3fb6c598
# 音频录制开发指导 # 音频录制开发指导
- [场景介绍](#场景介绍) ## 场景介绍
- [接口说明](#接口说明)
音频录制的主要工作是捕获音频信号，完成音频编码并保存到文件中，帮助开发者轻松实现音频录制功能。它允许调用者指定音频录制的采样率、声道数、编码格式、封装格式、文件路径等参数。
## 场景介绍
**图1** 音频录制状态机
音频录制的主要工作是将音频信号记录并保存下来，同时提供包括采样率、声道数、码率、编码格式、封装格式、文件路径等设置功能。
![zh-ch_image_audio_recorder_state_machine](figures/zh-ch_image_audio_recorder_state_machine.jpg)
## 接口说明 ## 音频录制零层图
**表1** media **图2** 音频录制零层图
| 接口名 | 描述 | ![zh-ch_image_audio_recorder_zero](figures/zh-ch_image_audio_recorder_zero.jpg)
| -------- | -------- |
| media.createAudioRecorder() | 创建AudioRecorder实例。 | 音频录制零层图简单说明：
| AudioRecorder | 提供音频录制相关功能。 |
| AudioRecorderConfig | 提供音频录制相关参数设置。 | 1、JS应用，包括系统录音机等音频录制类应用。
**表2** 音频录制相关的interface **AudioRecorder** 2、表示应用可以通过调用音频录制JS层的接口与音频录制JS Framework进行交互，或者通过ACE组件调用到音频录制Native接口，与音频录制的Native Framework进行交互。
| 接口名 | 描述 | 3、媒体服务模块。
| -------- | -------- |
| prepare(config:&nbsp;AudioRecorderConfig):&nbsp;void | 准备音频录制并设置参数。 | 4、系统服务/IPC通信子系统。
| start():&nbsp;void | 开始音频录制。 |
| pause():&nbsp;void | 暂停音频录制。(暂不支持) | 5、音频录制访问文件涉及权限子系统。
| resume():&nbsp;void | 恢复音频录制。(暂不支持) |
| stop():&nbsp;void | 停止音频录制。 | 6、音频录制中涉及的系统权限校验系统。
| release():&nbsp;void | 释放音频录制资源。 |
| reset():&nbsp;void | 重置音频录制。 | 7、音频录制涉及的音频服务模块。
| on('prepare',&nbsp;function&nbsp;callback) | 订阅音频录制准备事件。 |
| on('start',&nbsp;function&nbsp;callback) | 订阅音频录制开始事件。 | ## 音频录制开发步骤
| on('pause',&nbsp;function&nbsp;callback) | 订阅音频录制暂停事件。 |
| on('resume',&nbsp;function&nbsp;callback) | 订阅音频录制恢复事件。 | 详细API含义可参考：[js-apis-media.md](../reference/apis/js-apis-media.md)
| 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** ```js
funfunction SetCallBack(audioRecorder) {
| 接口名 | 描述 | audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
| -------- | -------- | console.log('prepare success');
| audioEncoder?: AudioEncoder | 音频编码格式,默认值是AAC_LC。 | // 录制界面可切换至已准备好，可点击录制按钮进行录制
| audioEncodeBitRate?:&nbsp;number | 音频编码的比特率，默认值为48000。 | });
| audioSampleRate?:&nbsp;number | 音频编码的采样率，默认值为48000。 | audioRecorder.on('start', () => { // 设置'start'事件回调
| numberOfChannels?：number | 音频的声道数，默认值为2。 | console.log('audio recorder start success');
| format?:&nbsp;AudioOutputFormat | 音频的输出格式，默认值是MPEG_4。 | // 将录制按钮切换至可暂停状态
| uri:&nbsp;string | 音频的输出路径。（file://path&nbsp;或者&nbsp;file://fd） | });
audioRecorder.on('pause', () => { // 设置'pause'事件回调
**表4** AudioEncoder的相关参数的interface **AudioEncoder** console.log('audio recorder pause success');
// 将录制按钮切换至可录制状态
| 接口名 | 描述 | });
| -------- | -------- | audioRecorder.on('resume', () => { // 设置'resume'事件回调
| AAC_LC&nbsp;=&nbsp;3 | 表示AAC_LC编码格式。 | console.log('audio recorder resume success');
// 将录制按钮切换至可暂停状态
**表5** 音频输出格式的相关参数的interface **AudioOutputFormat** });
audioRecorder.on('stop', () => { // 设置'stop'事件回调
| 接口名 | 描述 | console.log('audio recorder stop success');
| -------- | -------- | });
| MPEG_4&nbsp;=&nbsp;2 | 表示MPEG_4编码格式。 | audioRecorder.on('release', () => { // 设置'release'事件回调
| AAC_ADTS=&nbsp;6 | 表示AAC_ADTS编码格式。 | console.log('audio recorder release success');
});
1. 创建音频录制器。 audioRecorder.on('reset', () => { // 设置'reset'事件回调
``` console.log('audio recorder reset success');
import media from '@ohos.multimedia.media'; // 需要重新设置录制参数才能再次录制
var recorder = media.createAudioRecorder(); });
``` audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, errName is ${error.name}`);
2. 准备音频录制参数。 console.info(`audio error called, errCode is ${error.code}`);
``` console.info(`audio error called, errMessage is ${error.message}`);
let audioRecorderConfig = { });
audioEncoder : AAC_LC , }
audioEncodeBitRate : 22050,
audioSampleRate : 22050, // 1.创建实例
numberOfChannels : 2, let audioRecorder = media.createAudioRecorder();
format : AAC_ADTS, // 2.设置回调
uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', SetCallBack(audioRecorder);
} // 3.设置录制参数
recorder.prepare(audioRecorderConfig); let audioRecorderConfig = {
``` audioEncoder : media.AudioEncoder.AAC_LC ,
audioEncodeBitRate : 22050,
3. 设置消息订阅事件。 audioSampleRate : 22050,
``` numberOfChannels : 2,
recorder.on('prepare', () => { format : media.AudioOutputFormat.AAC_ADTS,
console.info('setCallback prepare() case callback is called'); uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', // 文件需先由调用者创建，并给予适当的权限
recorder.start(); location : { latitude : 30, longitude : 130},
}); }
recorder.on('start', () => { audioRecorder.prepare(audioRecorderConfig)
console.info('setCallback start() case callback is called'); // 4.开始录制
setTimeout(function(){ audioRecorder.start(); // 需等待'prepare'事件回调完成后，才可调用start进行录制，触发'start'事件回调
recorder.pause(); // 5.暂停录制
}, 10000); // 开始录音10秒后，暂停录音。 audioRecorder.pause(); // 需等待'start'事件回调完成后，才可调用pause进行暂停，触发'pause'事件回调
}); // 6.恢复录制
recorder.on('pause', () => { audioRecorder.resume(); // 需等待'pause'事件回调完成后，才可调用resume进行录制，触发'resume'事件回调
console.info('setCallback pause() case callback is called'); // 7.停止录制
setTimeout(function(){ audioRecorder.stop(); // 需等待'start'或'resume'事件回调完成后，才可调用stop进行暂停，触发'stop'事件回调
recorder.resume(); // 8.重置录制
}, 10000); // 暂停录音10秒后，恢复录音。 audioRecorder.reset(); // 触发'reset'事件回调后，重新进行prepare，才可重新录制
}); // 9.释放资源
recorder.on('resume', () => { audioRecorder.release(); // audioRecorder资源被销毁
console.info('setCallback resume() case callback is called'); audioRecorder = undefined;
setTimeout(function(){ ```
recorder.stop();
}, 10000); // 恢复录音10秒后，停止录音。 ### 正常录制场景
});
recorder.on('stop', () => { 与全流程场景不同，不包括暂停录制，恢复录制的过程。
console.info('setCallback stop() case callback is called');
recorder.release(); ```js
}); function SetCallBack(audioPlayer) {
recorder.on('release', () => { audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
console.info('setCallback release() case callback is called'); console.log('prepare success');
}); // 录制界面可切换至已准备好，可点击录制按钮进行录制
recorder.on('error', (err) => { });
console.info(`case error called,errCode is ${err.code}`); audioRecorder.on('start', () => { // 设置'start'事件回调
console.info(`case error called,errMessage is ${err.message}`); console.log('audio recorder start success');
recorder.reset(); // 将录制按钮切换至可暂停状态
}); });
``` 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;
```
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 3fb6c598
...@@ -6,6 +6,7 @@ ...@@ -6,6 +6,7 @@
- 音频播放（[AudioPlayer](#audioplayer)） - 音频播放（[AudioPlayer](#audioplayer)）
- 音频录制（[AudioRecorder](#audiorecorder)） - 音频录制（[AudioRecorder](#audiorecorder)）
- 视频录制（[VideoRecorder](#VideoRecorder<sup>8+</sup>)）
后续将提供以下功能：视频播放、视频录制、DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。 后续将提供以下功能：视频播放、视频录制、DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。
...@@ -21,6 +22,8 @@ createAudioPlayer(): [AudioPlayer](#audioplayer) ...@@ -21,6 +22,8 @@ createAudioPlayer(): [AudioPlayer](#audioplayer)
同步方式创建音频播放实例。 同步方式创建音频播放实例。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -103,10 +106,128 @@ createAudioRecorder(): AudioRecorder ...@@ -103,10 +106,128 @@ createAudioRecorder(): AudioRecorder
**示例：** **示例：**
``` ```js
var audiorecorder = media.createAudioRecorder(); var audiorecorder = media.createAudioRecorder();
``` ```
## media.createAudioRecorderAsync<sup>8+</sup>
createAudioRecorderAsync(callback: AsyncCallback\<[AudioRecorder](#audiorecorder)>): void
异步方式创建音频录制实例。通过注册回调函数获取返回值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback<[AudioRecorder](#audiorecorder)> | 是 | 异步创建音频录制实例回调方法。 |
**示例：**
```js
media.createAudioRecorderAsync((error, audio) => {
if (typeof(audio) != 'undefined') {
audioRecorder = audio;
console.info('audio createAudioRecorderAsync success');
} else {
console.info(`audio createAudioRecorderAsync fail, error:${error.message}`);
}
});
```
## media.createAudioRecorderAsync<sup>8+</sup>
createAudioRecorderAsync: Promise<[AudioRecorder](#audiorecorder)>
异步方式创建音频录制实例。通过Promise获取返回值。
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ----------------------------------- |
| Promise<[AudioRecorder](#audiorecorder)> | 异步创建音频录制实例Promise返回值。 |
**示例：**
```js
function failureCallback(error) {
console.info(`audio failureCallback, error:${error.message}`);
}
function catchCallback(error) {
console.info(`audio catchCallback, error:${error.message}`);
}
await media.createAudioRecorderAsync.then((audio) => {
if (typeof(audio) != 'undefined') {
audioRecorder = audio;
console.info('audio createAudioRecorderAsync success');
} else {
console.info('audio createAudioRecorderAsync fail');
}
}, failureCallback).catch(catchCallback);
```
## media.createVideoRecorderAsync<sup>8+</sup>
createVideoRecorderAsync(callback: AsyncCallback\<[VideoRecorder](#videorecorder8)>): void
异步方式创建视频录制实例。通过注册回调函数获取返回值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback<[VideoRecorder](#videorecorder8)> | 是 | 异步创建视频录制实例回调方法。 |
**示例：**
```js
media.createVideoRecorderAsync((error, video) => {
if (typeof(video) != 'undefined') {
videoRecorder = video;
console.info('video createVideoRecorderAsync success');
} else {
console.info(`video createVideoRecorderAsync fail, error:${error.message}`);
}
});
```
## media.createVideoRecorderAsync<sup>8+</sup>
createVideoRecorderAsync: Promise<[VideoRecorder](#videorecorder8)>
异步方式创建视频录制实例。通过Promise获取返回值。
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------------- | ----------------------------------- |
| Promise<[VideoRecorder](#videorecorder8)> | 异步创建视频录制实例Promise返回值。 |
**示例：**
```js
function failureCallback(error) {
console.info(`video failureCallback, error:${error.message}`);
}
function catchCallback(error) {
console.info(`video catchCallback, error:${error.message}`);
}
await media.createVideoRecorderAsync.then((video) => {
if (typeof(video) != 'undefined') {
videoRecorder = video;
console.info('video createVideoRecorderAsync success');
} else {
console.info('video createVideoRecorderAsync fail');
}
}, failureCallback).catch(catchCallback);
```
## MediaErrorCode<sup>8+</sup> ## MediaErrorCode<sup>8+</sup>
媒体服务错误类型枚举 媒体服务错误类型枚举
...@@ -140,6 +261,7 @@ Codec MIME类型枚举 ...@@ -140,6 +261,7 @@ Codec MIME类型枚举
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------ | ----------------- | ------------------------ | | ------------ | ----------------- | ------------------------ |
| VIDEO_MPEG4 | ”video/mp4v-es“ | 表示视频/mpeg4类型。 |
| AUDIO_MPEG | "audio/mpeg" | 表示音频/mpeg类型。 | | AUDIO_MPEG | "audio/mpeg" | 表示音频/mpeg类型。 |
| AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。 | | AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。 |
| AUDIO_VORBIS | "audio/vorbis" | 表示音频/vorbis类型。 | | AUDIO_VORBIS | "audio/vorbis" | 表示音频/vorbis类型。 |
...@@ -558,9 +680,11 @@ audioPlayer.getTrackDescription((error, arrlist) => { ...@@ -558,9 +680,11 @@ audioPlayer.getTrackDescription((error, arrlist) => {
## AudioRecorder ## AudioRecorder
音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder()](#createaudiorecorder-audiorecorder)构建一个AudioRecorder实例。 音频录制管理类，用于录制音频媒体。在调用AudioRecorder的方法前，需要先通过[createAudioRecorder()](#media.createaudiorecorder) 或[createAudioRecorderAsync()](#media.createaudiorecorderasync8)构建一个[AudioRecorder](#audiorecorder)实例。
### prepare 音频录制demo可参考：[音频录制开发指导](../../media/audio-recorder.md)
### prepare<a name=audiorecorder_prepare></a>
prepare(config: AudioRecorderConfig): void prepare(config: AudioRecorderConfig): void
...@@ -570,36 +694,73 @@ prepare(config: AudioRecorderConfig): void ...@@ -570,36 +694,73 @@ prepare(config: AudioRecorderConfig): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| config | [AudioRecorderConfig](#audiorecorderconfig) | 是 | 配置录音的相关参数，包括音频输出URI、编码格式、采样率、声道数等。 | | config | [AudioRecorderConfig](#audiorecorderconfig) | 是 | 配置录音的相关参数，包括音频输出URI、[编码格式](#audioencoder)、采样率、声道数、[输出格式](#audiooutputformat)等。 |
**示例：** **示例：**
``` ```js
let audioRecorderConfig = { let audioRecorderConfig = {
audioEncoder : AAC_LC , audioEncoder : media.AudioEncoder.AAC_LC,
audioEncodeBitRate : 22050, audioEncodeBitRate : 22050,
audioSampleRate : 22050, audioSampleRate : 22050,
numberOfChannels : 2, numberOfChannels : 2,
format : AAC_ADTS, format : media.AudioOutputFormat.AAC_ADTS,
uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130},
} }
audiorecorder.prepare(audioRecorderConfig) audioRecorder.on('prepare', () => { //设置'prepare'事件回调
console.log('prepare success');
});
audioRecorder.prepare(audioRecorderConfig)
``` ```
### start ### start<a name=audiorecorder_start></a>
start(): void start(): void
开始录音。 开始录制，需在[prepare](#on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset'))事件成功触发后，才能调用start方法。
**示例：** **示例：**
```js
audioRecorder.on('start', () => { //设置'start'事件回调
console.log('audio recorder start success');
});
audioRecorder.start();
``` ```
audiorecorder.start();
### pause<a name=audiorecorder_pause></a>
pause():void
暂停录制，需要在[start](#on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset'))事件成功触发后，才能调用pause方法。
**示例：**
```js
audioRecorder.on('pause', () => { //设置'pause'事件回调
console.log('audio recorder pause success');
});
audioRecorder.pause();
```
### resume<a name=audiorecorder_resume></a>
resume():void
暂停录制，需要在[pause](#on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset'))事件成功触发后，才能调用resume方法。
**示例：**
```js
audioRecorder.on('resume', () => { //设置'resume'事件回调
console.log('audio recorder resume success');
});
audioRecorder.resume();
``` ```
### stop ### stop<a name=audiorecorder_stop></a>
stop(): void stop(): void
...@@ -607,11 +768,14 @@ stop(): void ...@@ -607,11 +768,14 @@ stop(): void
**示例：** **示例：**
``` ```js
audiorecorder.stop(); audioRecorder.on('stop', () => { //设置'stop'事件回调
console.log('audio recorder stop success');
});
audioRecorder.stop();
``` ```
### release ### release<a name=audiorecorder_release></a>
release(): void release(): void
...@@ -619,17 +783,18 @@ release(): void ...@@ -619,17 +783,18 @@ release(): void
**示例：** **示例：**
``` ```js
audiorecorder.release(); audioRecorder.release();
audioRecorder = undefined;
``` ```
### reset ### reset<a name=audiorecorder_reset></a>
reset(): void reset(): void
重置录音。 重置录音。
进行重置录音之前，需要先调用stop()停止录音。重置录音之后，需要调用prepare()设置录音配置项，才能再次进行录音。 进行重置录音之前，需要先调用[stop()](#audiorecorder_stop)停止录音。重置录音之后，需要调用[prepare()](#audiorecorder_prepare)设置录音参数项，才能再次进行录音。
**示例：** **示例：**
...@@ -637,9 +802,9 @@ reset(): void ...@@ -637,9 +802,9 @@ reset(): void
audiorecorder.reset(); audiorecorder.reset();
``` ```
### on('prepare' | 'start' | 'stop' | 'release' | 'reset') ### on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset')
on(type: 'prepare' | 'start' | 'stop' | 'release' | 'reset', callback: () => void): void on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset', callback: () => void): void
开始订阅音频录制事件。 开始订阅音频录制事件。
...@@ -647,15 +812,49 @@ on(type: 'prepare' | 'start' | 'stop' | 'release' | 'reset', callback: () => voi ...@@ -647,15 +812,49 @@ on(type: 'prepare' | 'start' | 'stop' | 'release' | 'reset', callback: () => voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ | | -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 录制事件回调类型，支持的事件包括：'prepare'&nbsp;\|&nbsp;'start'&nbsp;\|&nbsp;'stop'&nbsp;\|&nbsp;'release'&nbsp;\|&nbsp;'reset'。<br/>-&nbsp;'prepare'&nbsp;：音频录制准备完成后，触发该事件。<br/>-&nbsp;'start'&nbsp;：音频录制开始后，触发该事件。<br/>-&nbsp;'stop'&nbsp;：音频录制停止后，触发该事件。<br/>-&nbsp;'release'&nbsp;：音频录制相关资源释放后，触发该事件。<br/>-&nbsp;'reset'：音频录制重置后，触发该事件。 | | type | string | 是 | 录制事件回调类型，支持的事件包括：'prepare'&nbsp;\|&nbsp;'start'&nbsp;\| 'pause' \| ’resume‘ \|&nbsp;'stop'&nbsp;\|&nbsp;'release'&nbsp;\|&nbsp;'reset'。<br/>-&nbsp;'prepare'&nbsp;：完成[prepare](#audiorecorder_prepare)调用，音频录制参数设置完成，触发该事件。<br/>-&nbsp;'start'&nbsp;：完成[start](#audiorecorder_start)调用，音频录制开始，触发该事件。<br/>-&nbsp;'pause': 完成[pause](#audiorecorder_pause)调用，音频暂停录制，触发该事件。<br/>-&nbsp;'resume': 完成[resume](#audiorecorder_resume)调用，音频恢复录制，触发该事件。<br/>-&nbsp;'stop'&nbsp;：完成[stop](#audiorecorder_stop)调用，音频停止录制，触发该事件。<br/>-&nbsp;'release'&nbsp;：完成[release](#audiorecorder_release)调用，音频释放录制资源，触发该事件。<br/>-&nbsp;'reset'：完成[reset](#audiorecorder_reset)调用，音频重置为初始状态，触发该事件。 |
| callback | function | 是 | 录制事件回调方法。 | | callback | ()=>void | 是 | 录制事件回调方法。 |
**示例：** **示例：**
``` ```js
audiorecorder.on('prepare', () => { let audiorecorder = media.createAudioRecorder(); // 创建一个音频录制实例
console.log('Preparation succeeded.'); let audioRecorderConfig = {
audiorecorder.start(); 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.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}`);
});
audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
console.log('prepare success');
audioRecorder.start(); // 开始录制，并触发'start'事件回调
});
audioRecorder.prepare(audioRecorderConfig) // 设置录制参数 ，并触发'prepare'事件回调
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');
}); });
``` ```
...@@ -672,19 +871,30 @@ on(type: 'error', callback: ErrorCallback): void ...@@ -672,19 +871,30 @@ on(type: 'error', callback: ErrorCallback): void
| type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error'：音频录制过程中发生错误，触发该事件。 | | type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error'：音频录制过程中发生错误，触发该事件。 |
| callback | ErrorCallback | 是 | 录制错误事件回调方法。 | | callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
**示例：**
```js
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}`); // 打印错误类型详细描述
});
audioRecorder.prepare(); // prepare不设置参数，触发'error'事件
```
## AudioRecorderConfig ## AudioRecorderConfig
表示音频的录音配置。 表示音频的录音配置。
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------------ | --------------------------------------- | ---- | ------------------------------------------------------------ | | --------------------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| audioEncoder | [AudioEncoder](#audioencoder) | 否 | 音频编码格式，默认设置为AAC_LC。 | | audioEncoder | [AudioEncoder](#audioencoder) | 否 | 音频编码格式，默认设置为AAC_LC。 |
| audioEncodeBitRate | number | 否 | 音频编码比特率，默认值为48000。 | | audioEncodeBitRate | number | 否 | 音频编码比特率，默认值为48000。 |
| audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 | | audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 |
| numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 | | numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 |
| format | [AudioOutputFormat](#audiooutputformat) | 否 | 音量输出封装格式，默认设置为MPEG_4。 | | format | [AudioOutputFormat](#audiooutputformat) | 否 | 音量输出封装格式，默认设置为MPEG_4。 |
| uri | string | 是 | 音频输出URI。支持：<br/>1.&nbsp;文件的绝对路径：file:///data/data/ohos.xxx.xxx/cache/test.mp4![zh-cn_image_0000001164217678](figures/zh-cn_image_0000001164217678.png)<br/>2.&nbsp;文件的fd路径：file://1&nbsp;(fd&nbsp;number) | | location<sup>8+</sup> | [Location](#location8) | 否 | 音频采集的地理位置。 |
| uri | string | 是 | 音频输出URI。支持：<br/>1.&nbsp;文件的绝对路径：file:///data/data/ohos.xxx.xxx/cache/test.mp4![zh-cn_image_0000001164217678](figures/zh-cn_image_0000001164217678.png)<br/>2.&nbsp;文件的fd路径：file://1&nbsp;(fd&nbsp;number)<br/> 文件需要由调用者创建，并赋予适当的权限。 |
## AudioEncoder ## AudioEncoder
...@@ -703,4 +913,660 @@ on(type: 'error', callback: ErrorCallback): void ...@@ -703,4 +913,660 @@ on(type: 'error', callback: ErrorCallback): void
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | ------ | ------------------------------------------------------------ | | -------- | ------ | ------------------------------------------------------------ |
| MPEG_4 | 2 | 封装为MPEG-4格式。 | | MPEG_4 | 2 | 封装为MPEG-4格式。 |
| AAC_ADTS | 6 | 封装为ADTS（Audio&nbsp;Data&nbsp;Transport&nbsp;Stream）格式，是AAC音频的传输流格式。 | | AAC_ADTS | 6 | 封装为ADTS（Audio&nbsp;Data&nbsp;Transport&nbsp;Stream）格式，是AAC音频的传输流格式。 |
\ No newline at end of file
## VideoRecorder<sup>8+</sup>
视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorderAsync()](#media.createvideorecorderasync<sup>8+</sup>)构建一个[VideoRecorder](#videorecorder<sup>8+</sup>)实例。
视频录制demo可参考：[视频录制开发指导](../../media/video-recorder.md)
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------------------------------------- | ---- | ---- | ---------------- |
| state | [VideoRecordState](#videorecordstate) | 是 | 否 | 视频录制的状态。 |
### prepare<a name=videorecorder_prepare1></a>
prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
异步方式进行视频录制的参数设置。通过注册回调函数获取返回值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ----------------------------------- |
| config | [VideoRecorderConfig](#videorecorderconfig) | 是 | 配置视频录制的相关参数。 |
| callback | AsyncCallback\<void> | 是 | 异步视频录制prepare方法的回调方法。 |
**示例：**
```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/accounts/account_0/appdata/appdata/recorder/test.mp4', // 文件需先由调用者创建，并给予适当的权限
orientationHint : 0,
location : { latitude : 30, longitude : 130 },
}
// asyncallback
let videoRecorder = null;
let events = require('events');
let eventEmitter = new events.EventEmitter(); // prepare事件触发
eventEmitter.on('prepare', () => {
videoRecorder.prepare(videoConfig, (err) => {
if (typeof (err) == 'undefined') {
console.info('prepare success')
} else {
console.info('prepare failed and error is ' + err.message)
}
});
});
media.createVideoRecorder((err, recorder) => {
if (typeof (err) == 'undefined' && typeof (recorder) != 'undefined') {
videoRecorder = recorder
console.info('createVideoRecorder success')
eventEmitter.emit('prepare')
} else {
console.info('createVideoRecorder failed and error is ' + err.message)
}
});
```
### prepare<a name=videorecorder_prepare2></a>
prepare(config: VideoRecorderConfig): Promise\<void>;
异步方式进行视频录制的参数设置。通过Promise获取返回值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------------- | ---- | ------------------------ |
| config | [VideoRecorderConfig](#videorecorderconfig) | 是 | 配置视频录制的相关参数。 |
**返回值：**
| 类型 | 说明 |
| -------------- | ---------------------------------------- |
| Promise\<void> | 异步视频录制prepare方法的Promise返回值。 |
**示例：**
```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/accounts/account_0/appdata/appdata/recorder/test.mp4', // 文件需先由调用者创建，并给予适当的权限
orientationHint : 0,
location : { latitude : 30, longitude : 130 },
}
// promise
let videoRecorder = null;
await media.createVideoRecorder().then((recorder) => {
if (typeof (recorder) != 'undefined') {
videoRecorder = recorder;
console.info('createVideoRecorder success');
} else {
console.info('createVideoRecorder failed');
}
}, (err) => {
console.info('error hanppend message is ' + err.message);
}).catch((err) => {
console.info('catch err error message is ' + err.message);
});
await videoRecorder.prepare(videoConfig).then(() => {
console.info('prepare success');
}, (err) => {
console.info('prepare failed and error is ' + err.message);
}).catch((err) => {
console.info('prepare failed and catch error is ' + err.message);
});
```
### getInputSurface
getInputSurface(callback: AsyncCallback\<string>): void;
异步方式获得录制需要的surface。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。
应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。
只能在[prepare()](#videorecorder_prepare1)接口调用后调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------- |
| callback | AsyncCallback\<string> | 是 | 异步获得surface的回调方法。 |
**示例：**
```js
// asyncallback
let surfaceId = null;
let events = require('events');
let eventEmitter = new events.EventEmitter();
eventEmitter.on('getInputSurface', () => {
videoRecorder.getInputSurface((err, surfaceId) => {
if (typeof (err) == 'undefined') {
console.info('getInputSurface success');
} else {
console.info('getInputSurface failed and error is ' + err.message);
}
});
});
```
### getInputSurface
getInputSurface(): Promise\<string>;
异步方式获得录制需要的surface。此surface提供给调用者，调用者从此surface中获取surfaceBuffer，填入相应的数据。
应当注意，填入的视频数据需要携带时间戳（单位ns），buffersize。时间戳的起始时间请以系统启动时间为基准。
只能在[prepare()](#videorecorder_prepare1)接口调用后调用。
**返回值：**
| 类型 | 说明 |
| ---------------- | -------------------------------- |
| Promise\<string> | 异步获得surface的Promise返回值。 |
**示例：**
```js
// promise
let surfaceId = null;
await videoRecorder.getInputSurface().then((surface) => {
console.info('getInputSurface success');
surfaceId = surface;
}, (err) => {
console.info('getInputSurface failed and error is ' + err.message);
}).catch((err) => {
console.info('getInputSurface failed and catch error is ' + err.message);
});
```
### start<a name=videorecorder_start1></a>
start(callback: AsyncCallback\<void>): void;
异步方式开始视频录制。通过注册回调函数获取返回值。
在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)后调用，需要依赖数据源先给surface传递数据。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步开始视频录制的回调方法。 |
**示例：**
```js
// asyncallback
let events = require('events');
let eventEmitter = new events.EventEmitter();
eventEmitter.on('start', () => {
videoRecorder.start((err) => {
if (typeof (err) == 'undefined') {
console.info('start videorecorder success');
} else {
console.info('start videorecorder failed and error is ' + err.message);
}
});
});
```
### start<a name=videorecorder_start2></a>
start(): Promise\<void>;
异步方式开始视频录制。通过Promise获取返回值。
在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)后调用，需要依赖数据源先给surface传递数据。
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步开始视频录制方法的Promise返回值。 |
**示例：**
```js
// promise
await videoRecorder.start().then(() => {
console.info('start videorecorder success');
}, (err) => {
console.info('start videorecorder failed and error is ' + err.message);
}).catch((err) => {
console.info('start videorecorder failed and catch error is ' + err.message);
});
```
### pause<a name=videorecorder_pause1></a>
pause(callback: AsyncCallback\<void>): void;
异步方式暂停视频录制。通过注册回调函数获取返回值。
在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步暂停视频录制的回调方法。 |
**示例：**
```js
// asyncallback
let events = require('events');
let eventEmitter = new events.EventEmitter();
eventEmitter.on('pause', () => {
videoRecorder.pause((err) => {
if (typeof (err) == 'undefined') {
console.info('pause videorecorder success');
} else {
console.info('pause videorecorder failed and error is ' + err.message);
}
});
});
```
### pause<a name=videorecorder_pause2></a>
pause(): Promise\<void>;
异步方式暂停视频录制。通过Promise获取返回值。
在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步暂停视频录制方法的Promise返回值。 |
**示例：**
```js
// promise
await videoRecorder.pause().then(() => {
console.info('pause videorecorder success');
}, (err) => {
console.info('pause videorecorder failed and error is ' + err.message);
}).catch((err) => {
console.info('pause videorecorder failed and catch error is ' + err.message);
});
```
### resume<a name=videorecorder_resume1></a>
resume(callback: AsyncCallback\<void>): void;
异步方式恢复视频录制。通过注册回调函数获取返回值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步恢复视频录制的回调方法。 |
**示例：**
```js
// asyncallback
let events = require('events');
let eventEmitter = new events.EventEmitter();
eventEmitter.on('resume', () => {
videoRecorder.resume((err) => {
if (typeof (err) == 'undefined') {
console.info('resume videorecorder success');
} else {
console.info('resume videorecorder failed and error is ' + err.message);
}
});
});
```
### resume<a name=videorecorder_resume2></a>
resume(): Promise\<void>;
异步方式恢复视频录制。通过Promise获取返回值。
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步恢复视频录制方法的Promise返回值。 |
**示例：**
```js
// promise
await videoRecorder.resume().then(() => {
console.info('resume videorecorder success');
}, (err) => {
console.info('resume videorecorder failed and error is ' + err.message);
}).catch((err) => {
console.info('resume videorecorder failed and catch error is ' + err.message);
});
```
### stop<a name=videorecorder_stop1></a>
stop(callback: AsyncCallback\<void>): void;
异步方式停止视频录制。通过注册回调函数获取返回值。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步停止视频录制的回调方法。 |
**示例：**
```js
// asyncallback
let events = require('events');
let eventEmitter = new events.EventEmitter();
eventEmitter.on('stop', () => {
videoRecorder.stop((err) => {
if (typeof (err) == 'undefined') {
console.info('stop videorecorder success');
} else {
console.info('stop videorecorder failed and error is ' + err.message);
}
});
});
```
### stop<a name=videorecorder_stop2></a>
stop(): Promise\<void>;
异步方式停止视频录制。通过Promise获取返回值。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步停止视频录制方法的Promise返回值。 |
**示例：**
```js
// promise
await videoRecorder.stop().then(() => {
console.info('stop videorecorder success');
}, (err) => {
console.info('stop videorecorder failed and error is ' + err.message);
}).catch((err) => {
console.info('stop videorecorder failed and catch error is ' + err.message);
});
```
### release<a name=videorecorder_release1></a>
release(callback: AsyncCallback\<void>): void;
异步方式释放视频录制资源。通过注册回调函数获取返回值。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步释放视频录制资源的回调方法。 |
**示例：**
```js
// asyncallback
let events = require('events');
let eventEmitter = new events.EventEmitter();
eventEmitter.on('release', () => {
videoRecorder.release((err) => {
if (typeof (err) == 'undefined') {
console.info('release videorecorder success');
} else {
console.info('release videorecorder failed and error is ' + err.message);
}
});
});
```
### release<a name=videorecorder_release2></a>
release(): Promise\<void>;
异步方式释放视频录制资源。通过Promise获取返回值。
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------------------------- |
| Promise\<void> | 异步释放视频录制资源方法的Promise返回值。 |
**示例：**
```js
// promise
await videoRecorder.release().then(() => {
console.info('release videorecorder success');
}, (err) => {
console.info('release videorecorder failed and error is ' + err.message);
}).catch((err) => {
console.info('release videorecorder failed and catch error is ' + err.message);
});
```
### reset<a name=videorecorder_reset1></a>
reset(callback: AsyncCallback\<void>): void;
异步方式重置视频录制。通过注册回调函数获取返回值。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步重置视频录制的回调方法。 |
**示例：**
```js
// asyncallback
let events = require('events');
let eventEmitter = new events.EventEmitter();
eventEmitter.on('reset', () => {
videoRecorder.reset((err) => {
if (typeof (err) == 'undefined') {
console.info('reset videorecorder success');
} else {
console.info('reset videorecorder failed and error is ' + err.message);
}
});
});
```
### reset<a name=videorecorder_reset2></a>
reset(): Promise\<void>;
异步方式重置视频录制。通过Promise获取返回值。
需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------------------- |
| Promise\<void> | 异步重置视频录制方法的Promise返回值。 |
**示例：**
```js
// promise
await videoRecorder.reset().then(() => {
console.info('reset videorecorder success');
}, (err) => {
console.info('reset videorecorder failed and error is ' + err.message);
}).catch((err) => {
console.info('reset videorecorder failed and catch error is ' + err.message);
});
```
### on('error')
on(type: 'error', callback: ErrorCallback): void
开始订阅视频录制错误事件。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error'：音频录制过程中发生错误，触发该事件。 |
| callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
**示例：**
```js
videoRecorder.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}`); // 打印错误类型详细描述
});
// 当获取videoRecordState接口出错时通过此订阅事件上报
```
## VideoRecordState<sup>8+</sup>
视频录制的状态机。可通过state属性获取当前状态。
| 名称 | 类型 | 描述 |
| -------- | ------ | ---------------------- |
| idle | string | 视频录制空闲。 |
| prepared | string | 视频录制参数设置完成。 |
| playing | string | 视频正在录制。 |
| paused | string | 视频暂停录制。 |
| stopped | string | 视频录制停止。 |
| error | string | 错误状态。 |
## VideoRecorderConfig<sup>8+</sup>
表示视频录制的参数设置。
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType | [AudioSourceType](#audiosourcetype<sup>8+</sup>) | 是 | 视频录制的音频源类型。 |
| videoSourceType | [VideoSourceType](#videosourcetype<sup>8+</sup>) | 是 | 视频录制的视频源类型。 |
| profile | [VideoRecorderProfile](#videorecorderprofile<sup>8+</sup>) | 是 | 视频录制的profile。 |
| orientationHint | number | 否 | 录制视频的旋转角度。 |
| location | [Location](#location8) | 否 | 录制视频的地理位置。 |
| uri | string | 是 | 视频输出URI。支持：<br/>1.&nbsp;文件的绝对路径：file:///data/data/ohos.xxx.xxx/cache/test.mp4![zh-cn_image_0000001164217678](figures/zh-cn_image_0000001164217678.png)<br/>2.&nbsp;文件的fd路径：file://1&nbsp;(fd&nbsp;number)<br/> 文件需要由调用者创建，并赋予适当的权限。 |
## AudioSourceType<sup>8+</sup>
表示视频录制中音频源类型的枚举。
| 名称 | 值 | 说明 |
| -------------------------- | ---- | ---------------------- |
| AUDIO_SOURCE_TYPE_DEFAULT0 | 0 | 默认的音频输入源类型。 |
| AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。 |
## VideoSourceType<sup>8+</sup>
表示视频录制中视频源类型的枚举。
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------- |
| VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 |
| VIDEO_SOURCE_TYPE_SURFACE_ES | 1 | 输入surface中携带的是ES data。 |
## VideoRecorderProfile<sup>8+</sup>
视频录制的配置文件。
| 名称 | 参数类型 | 必填 | 说明 |
| ---------------- | -------------------------------------------- | ---- | ---------------- |
| audioBitrate | number | 是 | 音频编码比特率。 |
| audioChannels | number | 是 | 音频采集声道数。 |
| audioCodec | [CodecMimeType](#CodecMimeType8) | 是 | 音频编码格式。 |
| audioSampleRate | number | 是 | 音频采样率。 |
| fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 |
| videoCodec | [CodecMimeType](#CodecMimeType8) | 是 | 视频编码格式。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 |
## ContainerFormatType<sup>8+</sup>
表示容器格式类型的枚举，缩写为CFT。
| 名称 | 值 | 说明 |
| ----------- | ----- | --------------------- |
| CFT_MPEG_4 | "mp4" | 视频的容器格式，MP4。 |
| CFT_MPEG_4A | "m4a" | 音频的容器格式，M4A。 |
## Location<sup>8+</sup>
视频录制的地理位置。
| 名称 | 参数类型 | 必填 | 说明 |
| --------- | -------- | ---- | ---------------- |
| latitude | number | 是 | 地理位置的纬度。 |
| longitude | number | 是 | 地理位置的经度。 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或