Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 2419103f 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!2529 【API兼容】支持amr格式音频编码枚举类型+删除tab 

Merge pull request !2529 from abc/amr
上级 575a09da 62513ccc
隐藏空白更改
内联 并排
Showing with 68 addition and 66 deletion
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 2419103f
...@@ -122,7 +122,7 @@ createAudioRecorder(): AudioRecorder ...@@ -122,7 +122,7 @@ createAudioRecorder(): AudioRecorder
**示例：** **示例：**
```js ```js
let audiorecorder = media.createAudioRecorder(); let audiorecorder = media.createAudioRecorder();
``` ```
## media.createVideoRecorder<sup>9+</sup> ## media.createVideoRecorder<sup>9+</sup>
...@@ -238,6 +238,8 @@ Codec MIME类型枚举。 ...@@ -238,6 +238,8 @@ Codec MIME类型枚举。
| AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。 | | AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。 |
| AUDIO_VORBIS | 'audio/vorbis' | 表示音频/vorbis类型。 | | AUDIO_VORBIS | 'audio/vorbis' | 表示音频/vorbis类型。 |
| AUDIO_FLAC | 'audio/flac' | 表示音频/flac类型。 | | AUDIO_FLAC | 'audio/flac' | 表示音频/flac类型。 |
| AUDIO_AMR_NB | 'audio/3gpp' | 表示音频/amr_nb类型。 |
| AUDIO_AMR_WB | 'audio/amr-wb' | 表示音频/amr_wb类型。 |
## MediaDescriptionKey<sup>8+</sup> ## MediaDescriptionKey<sup>8+</sup>
...@@ -545,24 +547,24 @@ on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeCh ...@@ -545,24 +547,24 @@ on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeCh
```js ```js
let audioPlayer = media.createAudioPlayer(); //创建一个音频播放实例 let audioPlayer = media.createAudioPlayer(); //创建一个音频播放实例
audioPlayer.on('dataLoad', () => { //设置'dataLoad'事件回调，src属性设置成功后，触发此回调 audioPlayer.on('dataLoad', () => { //设置'dataLoad'事件回调，src属性设置成功后，触发此回调
console.info('audio set source success'); console.info('audio set source success');
audioPlayer.play(); //开始播放，并触发'play'事件回调 audioPlayer.play(); //开始播放，并触发'play'事件回调
}); });
audioPlayer.on('play', () => { //设置'play'事件回调 audioPlayer.on('play', () => { //设置'play'事件回调
console.info('audio play success'); console.info('audio play success');
audioPlayer.seek(30000); //调用seek方法，并触发'timeUpdate'事件回调 audioPlayer.seek(30000); //调用seek方法，并触发'timeUpdate'事件回调
}); });
audioPlayer.on('pause', () => { //设置'pause'事件回调 audioPlayer.on('pause', () => { //设置'pause'事件回调
console.info('audio pause success'); console.info('audio pause success');
audioPlayer.stop(); //停止播放，并触发'stop'事件回调 audioPlayer.stop(); //停止播放，并触发'stop'事件回调
}); });
audioPlayer.on('reset', () => { //设置'reset'事件回调 audioPlayer.on('reset', () => { //设置'reset'事件回调
console.info('audio reset success'); console.info('audio reset success');
audioPlayer.release(); //释放播放实例资源 audioPlayer.release(); //释放播放实例资源
audioPlayer = undefined; audioPlayer = undefined;
}); });
audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调 audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调
if (typeof(seekDoneTime) == "undefined") { if (typeof(seekDoneTime) == "undefined") {
console.info('audio seek fail'); console.info('audio seek fail');
return; return;
} }
...@@ -570,15 +572,15 @@ audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回 ...@@ -570,15 +572,15 @@ audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回
audioPlayer.setVolume(0.5); //设置音量为50%，并触发'volumeChange'事件回调 audioPlayer.setVolume(0.5); //设置音量为50%，并触发'volumeChange'事件回调
}); });
audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调 audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调
console.info('audio volumeChange success'); console.info('audio volumeChange success');
audioPlayer.pause(); //暂停播放，并触发'pause'事件回调 audioPlayer.pause(); //暂停播放，并触发'pause'事件回调
}); });
audioPlayer.on('finish', () => { //设置'finish'事件回调 audioPlayer.on('finish', () => { //设置'finish'事件回调
console.info('audio play finish'); console.info('audio play finish');
audioPlayer.stop(); //停止播放，并触发'stop'事件回调 audioPlayer.stop(); //停止播放，并触发'stop'事件回调
}); });
audioPlayer.on('error', (error) => { //设置'error'事件回调 audioPlayer.on('error', (error) => { //设置'error'事件回调
console.info(`audio error called, errName is ${error.name}`); console.info(`audio error called, errName is ${error.name}`);
console.info(`audio error called, errCode is ${error.code}`); console.info(`audio error called, errCode is ${error.code}`);
console.info(`audio error called, errMessage is ${error.message}`); console.info(`audio error called, errMessage is ${error.message}`);
}); });
...@@ -644,7 +646,7 @@ on(type: 'error', callback: ErrorCallback): void ...@@ -644,7 +646,7 @@ on(type: 'error', callback: ErrorCallback): void
```js ```js
audioPlayer.on('error', (error) => { //设置'error'事件回调 audioPlayer.on('error', (error) => { //设置'error'事件回调
console.info(`audio error called, errName is ${error.name}`); //打印错误类型名称 console.info(`audio error called, errName is ${error.name}`); //打印错误类型名称
console.info(`audio error called, errCode is ${error.code}`); //打印错误码 console.info(`audio error called, errCode is ${error.code}`); //打印错误码
console.info(`audio error called, errMessage is ${error.message}`);//打印错误类型详细描述 console.info(`audio error called, errMessage is ${error.message}`);//打印错误类型详细描述
}); });
...@@ -704,9 +706,9 @@ setDisplaySurface(surfaceId: string, callback: AsyncCallback\<void>): void ...@@ -704,9 +706,9 @@ setDisplaySurface(surfaceId: string, callback: AsyncCallback\<void>): void
```js ```js
videoPlayer.setDisplaySurface(surfaceId, (err) => { videoPlayer.setDisplaySurface(surfaceId, (err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('setDisplaySurface success!'); console.info('setDisplaySurface success!');
} else { } else {
console.info('setDisplaySurface fail!'); console.info('setDisplaySurface fail!');
} }
}); });
...@@ -764,9 +766,9 @@ prepare(callback: AsyncCallback\<void>): void ...@@ -764,9 +766,9 @@ prepare(callback: AsyncCallback\<void>): void
```js ```js
videoPlayer.prepare((err) => { videoPlayer.prepare((err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('prepare success!'); console.info('prepare success!');
} else { } else {
console.info('prepare fail!'); console.info('prepare fail!');
} }
}); });
...@@ -818,9 +820,9 @@ play(callback: AsyncCallback\<void>): void; ...@@ -818,9 +820,9 @@ play(callback: AsyncCallback\<void>): void;
```js ```js
videoPlayer.play((err) => { videoPlayer.play((err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('play success!'); console.info('play success!');
} else { } else {
console.info('play fail!'); console.info('play fail!');
} }
}); });
...@@ -872,9 +874,9 @@ pause(callback: AsyncCallback\<void>): void ...@@ -872,9 +874,9 @@ pause(callback: AsyncCallback\<void>): void
```js ```js
videoPlayer.pause((err) => { videoPlayer.pause((err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('pause success!'); console.info('pause success!');
} else { } else {
console.info('pause fail!'); console.info('pause fail!');
} }
}); });
...@@ -926,9 +928,9 @@ stop(callback: AsyncCallback\<void>): void ...@@ -926,9 +928,9 @@ stop(callback: AsyncCallback\<void>): void
```js ```js
videoPlayer.stop((err) => { videoPlayer.stop((err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('stop success!'); console.info('stop success!');
} else { } else {
console.info('stop fail!'); console.info('stop fail!');
} }
}); });
...@@ -980,9 +982,9 @@ reset(callback: AsyncCallback\<void>): void ...@@ -980,9 +982,9 @@ reset(callback: AsyncCallback\<void>): void
```js ```js
videoPlayer.reset((err) => { videoPlayer.reset((err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('reset success!'); console.info('reset success!');
} else { } else {
console.info('reset fail!'); console.info('reset fail!');
} }
}); });
...@@ -1035,9 +1037,9 @@ seek(timeMs: number, callback: AsyncCallback\<number>): void ...@@ -1035,9 +1037,9 @@ seek(timeMs: number, callback: AsyncCallback\<number>): void
```js ```js
videoPlayer.seek((seekTime, err) => { videoPlayer.seek((seekTime, err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('seek success!'); console.info('seek success!');
} else { } else {
console.info('seek fail!'); console.info('seek fail!');
} }
}); });
...@@ -1063,9 +1065,9 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void ...@@ -1063,9 +1065,9 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
```js ```js
videoPlayer.seek((seekTime, seekMode, err) => { videoPlayer.seek((seekTime, seekMode, err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('seek success!'); console.info('seek success!');
} else { } else {
console.info('seek fail!'); console.info('seek fail!');
} }
}); });
...@@ -1129,9 +1131,9 @@ setVolume(vol: number, callback: AsyncCallback\<void>): void ...@@ -1129,9 +1131,9 @@ setVolume(vol: number, callback: AsyncCallback\<void>): void
```js ```js
videoPlayer.setVolume((vol, err) => { videoPlayer.setVolume((vol, err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('setVolume success!'); console.info('setVolume success!');
} else { } else {
console.info('setVolume fail!'); console.info('setVolume fail!');
} }
}); });
...@@ -1189,9 +1191,9 @@ release(callback: AsyncCallback\<void>): void ...@@ -1189,9 +1191,9 @@ release(callback: AsyncCallback\<void>): void
```js ```js
videoPlayer.release((err) => { videoPlayer.release((err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('release success!'); console.info('release success!');
} else { } else {
console.info('release fail!'); console.info('release fail!');
} }
}); });
...@@ -1324,9 +1326,9 @@ setSpeed(speed:number, callback: AsyncCallback\<number>): void ...@@ -1324,9 +1326,9 @@ setSpeed(speed:number, callback: AsyncCallback\<number>): void
```js ```js
videoPlayer.setSpeed((speed:number, err) => { videoPlayer.setSpeed((speed:number, err) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('setSpeed success!'); console.info('setSpeed success!');
} else { } else {
console.info('setSpeed fail!'); console.info('setSpeed fail!');
} }
}); });
...@@ -1385,7 +1387,7 @@ on(type: 'playbackCompleted', callback: Callback\<void>): void ...@@ -1385,7 +1387,7 @@ on(type: 'playbackCompleted', callback: Callback\<void>): void
```js ```js
videoPlayer.on('playbackCompleted', () => { videoPlayer.on('playbackCompleted', () => {
console.info('playbackCompleted success!'); console.info('playbackCompleted success!');
}); });
``` ```
...@@ -1432,7 +1434,7 @@ on(type: 'startRenderFrame', callback: Callback\<void>): void ...@@ -1432,7 +1434,7 @@ on(type: 'startRenderFrame', callback: Callback\<void>): void
```js ```js
videoPlayer.on('startRenderFrame', () => { videoPlayer.on('startRenderFrame', () => {
console.info('startRenderFrame success!'); console.info('startRenderFrame success!');
}); });
``` ```
...@@ -1479,7 +1481,7 @@ on(type: 'error', callback: ErrorCallback): void ...@@ -1479,7 +1481,7 @@ on(type: 'error', callback: ErrorCallback): void
```js ```js
videoPlayer.on('error', (error) => { // 设置'error'事件回调 videoPlayer.on('error', (error) => { // 设置'error'事件回调
console.info(`video error called, errName is ${error.name}`); // 打印错误类型名称 console.info(`video error called, errName is ${error.name}`); // 打印错误类型名称
console.info(`video error called, errCode is ${error.code}`); // 打印错误码 console.info(`video error called, errCode is ${error.code}`); // 打印错误码
console.info(`video error called, errMessage is ${error.message}`);// 打印错误类型详细描述 console.info(`video error called, errMessage is ${error.message}`);// 打印错误类型详细描述
}); });
...@@ -1723,7 +1725,7 @@ on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset' ...@@ -1723,7 +1725,7 @@ on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset'
**示例：** **示例：**
```js ```js
let audiorecorder = media.createAudioRecorder(); // 创建一个音频录制实例 let audiorecorder = media.createAudioRecorder(); // 创建一个音频录制实例
let audioRecorderConfig = { let audioRecorderConfig = {
audioEncoder : media.AudioEncoder.AAC_LC, , audioEncoder : media.AudioEncoder.AAC_LC, ,
audioEncodeBitRate : 22050, audioEncodeBitRate : 22050,
...@@ -1733,34 +1735,34 @@ let audioRecorderConfig = { ...@@ -1733,34 +1735,34 @@ let audioRecorderConfig = {
uri : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限 uri : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限
location : { latitude : 30, longitude : 130}, location : { latitude : 30, longitude : 130},
} }
audioRecorder.on('error', (error) => { // 设置'error'事件回调 audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, errName is ${error.name}`); console.info(`audio error called, errName is ${error.name}`);
console.info(`audio error called, errCode is ${error.code}`); console.info(`audio error called, errCode is ${error.code}`);
console.info(`audio error called, errMessage is ${error.message}`); console.info(`audio error called, errMessage is ${error.message}`);
}); });
audioRecorder.on('prepare', () => { // 设置'prepare'事件回调 audioRecorder.on('prepare', () => { // 设置'prepare'事件回调
console.log('prepare success'); console.log('prepare success');
audioRecorder.start(); // 开始录制，并触发'start'事件回调 audioRecorder.start(); // 开始录制，并触发'start'事件回调
}); });
audioRecorder.on('start', () => { // 设置'start'事件回调 audioRecorder.on('start', () => { // 设置'start'事件回调
console.log('audio recorder start success'); console.log('audio recorder start success');
}); });
audioRecorder.on('pause', () => { // 设置'pause'事件回调 audioRecorder.on('pause', () => { // 设置'pause'事件回调
console.log('audio recorder pause success'); console.log('audio recorder pause success');
}); });
audioRecorder.on('resume', () => { // 设置'resume'事件回调 audioRecorder.on('resume', () => { // 设置'resume'事件回调
console.log('audio recorder resume success'); console.log('audio recorder resume success');
}); });
audioRecorder.on('stop', () => { // 设置'stop'事件回调 audioRecorder.on('stop', () => { // 设置'stop'事件回调
console.log('audio recorder stop success'); console.log('audio recorder stop success');
}); });
audioRecorder.on('release', () => { // 设置'release'事件回调 audioRecorder.on('release', () => { // 设置'release'事件回调
console.log('audio recorder release success'); console.log('audio recorder release success');
}); });
audioRecorder.on('reset', () => { // 设置'reset'事件回调 audioRecorder.on('reset', () => { // 设置'reset'事件回调
console.log('audio recorder reset success'); console.log('audio recorder reset success');
}); });
audioRecorder.prepare(audioRecorderConfig) // 设置录制参数 ，并触发'prepare'事件回调 audioRecorder.prepare(audioRecorderConfig) // 设置录制参数 ，并触发'prepare'事件回调
``` ```
### on('error') ### on('error')
...@@ -1781,12 +1783,12 @@ on(type: 'error', callback: ErrorCallback): void ...@@ -1781,12 +1783,12 @@ on(type: 'error', callback: ErrorCallback): void
**示例：** **示例：**
```js ```js
audioRecorder.on('error', (error) => { // 设置'error'事件回调 audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, errName is ${error.name}`); // 打印错误类型名称 console.info(`audio error called, errName is ${error.name}`); // 打印错误类型名称
console.info(`audio error called, errCode is ${error.code}`); // 打印错误码 console.info(`audio error called, errCode is ${error.code}`); // 打印错误码
console.info(`audio error called, errMessage is ${error.message}`); // 打印错误类型详细描述 console.info(`audio error called, errMessage is ${error.message}`); // 打印错误类型详细描述
}); });
audioRecorder.prepare(); // prepare不设置参数，触发'error'事件 audioRecorder.prepare(); // prepare不设置参数，触发'error'事件
``` ```
## AudioRecorderConfig ## AudioRecorderConfig
...@@ -1895,7 +1897,7 @@ let videoConfig = { ...@@ -1895,7 +1897,7 @@ let videoConfig = {
// asyncallback // asyncallback
let videoRecorder = null; let videoRecorder = null;
let events = require('events'); let events = require('events');
let eventEmitter = new events.EventEmitter(); let eventEmitter = new events.EventEmitter();
eventEmitter.on('prepare', () => { eventEmitter.on('prepare', () => {
videoRecorder.prepare(videoConfig, (err) => { videoRecorder.prepare(videoConfig, (err) => {
...@@ -2011,7 +2013,7 @@ getInputSurface(callback: AsyncCallback\<string>): void; ...@@ -2011,7 +2013,7 @@ getInputSurface(callback: AsyncCallback\<string>): void;
```js ```js
// asyncallback // asyncallback
let surfaceID = null; // 传递给外界的surfaceID let surfaceID = null; // 传递给外界的surfaceID
videoRecorder.getInputSurface((err, surfaceId) => { videoRecorder.getInputSurface((err, surfaceId) => {
if (typeof (err) == 'undefined') { if (typeof (err) == 'undefined') {
console.info('getInputSurface success'); console.info('getInputSurface success');
...@@ -2044,7 +2046,7 @@ getInputSurface(): Promise\<string>; ...@@ -2044,7 +2046,7 @@ getInputSurface(): Promise\<string>;
```js ```js
// promise // promise
let surfaceID = null; // 传递给外界的surfaceID let surfaceID = null; // 传递给外界的surfaceID
await videoRecorder.getInputSurface().then((surfaceId) => { await videoRecorder.getInputSurface().then((surfaceId) => {
console.info('getInputSurface success'); console.info('getInputSurface success');
surfaceID = surfaceId; surfaceID = surfaceId;
...@@ -2413,8 +2415,8 @@ on(type: 'error', callback: ErrorCallback): void ...@@ -2413,8 +2415,8 @@ on(type: 'error', callback: ErrorCallback): void
**示例：** **示例：**
```js ```js
videoRecorder.on('error', (error) => { // 设置'error'事件回调 videoRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, errName is ${error.name}`); // 打印错误类型名称 console.info(`audio error called, errName is ${error.name}`); // 打印错误类型名称
console.info(`audio error called, errCode is ${error.code}`); // 打印错误码 console.info(`audio error called, errCode is ${error.code}`); // 打印错误码
console.info(`audio error called, errMessage is ${error.message}`); // 打印错误类型详细描述 console.info(`audio error called, errMessage is ${error.message}`); // 打印错误类型详细描述
}); });
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或