diff --git a/zh-cn/application-dev/reference/apis/js-apis-media.md b/zh-cn/application-dev/reference/apis/js-apis-media.md index 4b41804aafd43fc5c79737f408ac776bfc464189..317b8822ae82c963ef482dea8956478a857ca925 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-media.md +++ b/zh-cn/application-dev/reference/apis/js-apis-media.md @@ -122,7 +122,7 @@ createAudioRecorder(): AudioRecorder **示例：** ```js -let audiorecorder = media.createAudioRecorder(); +let audiorecorder = media.createAudioRecorder(); ``` ## media.createVideoRecorder9+ @@ -238,6 +238,8 @@ Codec MIME类型枚举。 | AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。 | | AUDIO_VORBIS | 'audio/vorbis' | 表示音频/vorbis类型。 | | AUDIO_FLAC | 'audio/flac' | 表示音频/flac类型。 | +| AUDIO_AMR_NB | 'audio/3gpp' | 表示音频/amr_nb类型。 | +| AUDIO_AMR_WB | 'audio/amr-wb' | 表示音频/amr_wb类型。 | ## MediaDescriptionKey8+ @@ -545,24 +547,24 @@ on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeCh ```js let audioPlayer = media.createAudioPlayer(); //创建一个音频播放实例 audioPlayer.on('dataLoad', () => { //设置'dataLoad'事件回调，src属性设置成功后，触发此回调 - console.info('audio set source success'); + console.info('audio set source success'); audioPlayer.play(); //开始播放，并触发'play'事件回调 }); audioPlayer.on('play', () => { //设置'play'事件回调 - console.info('audio play success'); + console.info('audio play success'); audioPlayer.seek(30000); //调用seek方法，并触发'timeUpdate'事件回调 }); audioPlayer.on('pause', () => { //设置'pause'事件回调 - console.info('audio pause success'); + console.info('audio pause success'); audioPlayer.stop(); //停止播放，并触发'stop'事件回调 }); audioPlayer.on('reset', () => { //设置'reset'事件回调 - console.info('audio reset success'); + console.info('audio reset success'); audioPlayer.release(); //释放播放实例资源 audioPlayer = undefined; }); audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回调 - if (typeof(seekDoneTime) == "undefined") { + if (typeof(seekDoneTime) == "undefined") { console.info('audio seek fail'); return; } @@ -570,15 +572,15 @@ audioPlayer.on('timeUpdate', (seekDoneTime) => { //设置'timeUpdate'事件回 audioPlayer.setVolume(0.5); //设置音量为50%，并触发'volumeChange'事件回调 }); audioPlayer.on('volumeChange', () => { //设置'volumeChange'事件回调 - console.info('audio volumeChange success'); + console.info('audio volumeChange success'); audioPlayer.pause(); //暂停播放，并触发'pause'事件回调 }); audioPlayer.on('finish', () => { //设置'finish'事件回调 - console.info('audio play finish'); + console.info('audio play finish'); audioPlayer.stop(); //停止播放，并触发'stop'事件回调 }); 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, errMessage is ${error.message}`); }); @@ -644,7 +646,7 @@ on(type: 'error', callback: ErrorCallback): void ```js 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, errMessage is ${error.message}`);//打印错误类型详细描述 }); @@ -704,9 +706,9 @@ setDisplaySurface(surfaceId: string, callback: AsyncCallback\): void ```js videoPlayer.setDisplaySurface(surfaceId, (err) => { - if (typeof (err) == 'undefined') { - console.info('setDisplaySurface success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('setDisplaySurface success!'); + } else { console.info('setDisplaySurface fail!'); } }); @@ -764,9 +766,9 @@ prepare(callback: AsyncCallback\): void ```js videoPlayer.prepare((err) => { - if (typeof (err) == 'undefined') { - console.info('prepare success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('prepare success!'); + } else { console.info('prepare fail!'); } }); @@ -818,9 +820,9 @@ play(callback: AsyncCallback\): void; ```js videoPlayer.play((err) => { - if (typeof (err) == 'undefined') { - console.info('play success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('play success!'); + } else { console.info('play fail!'); } }); @@ -872,9 +874,9 @@ pause(callback: AsyncCallback\): void ```js videoPlayer.pause((err) => { - if (typeof (err) == 'undefined') { - console.info('pause success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('pause success!'); + } else { console.info('pause fail!'); } }); @@ -926,9 +928,9 @@ stop(callback: AsyncCallback\): void ```js videoPlayer.stop((err) => { - if (typeof (err) == 'undefined') { - console.info('stop success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('stop success!'); + } else { console.info('stop fail!'); } }); @@ -980,9 +982,9 @@ reset(callback: AsyncCallback\): void ```js videoPlayer.reset((err) => { - if (typeof (err) == 'undefined') { - console.info('reset success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('reset success!'); + } else { console.info('reset fail!'); } }); @@ -1035,9 +1037,9 @@ seek(timeMs: number, callback: AsyncCallback\): void ```js videoPlayer.seek((seekTime, err) => { - if (typeof (err) == 'undefined') { - console.info('seek success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('seek success!'); + } else { console.info('seek fail!'); } }); @@ -1063,9 +1065,9 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\): void ```js videoPlayer.seek((seekTime, seekMode, err) => { - if (typeof (err) == 'undefined') { - console.info('seek success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('seek success!'); + } else { console.info('seek fail!'); } }); @@ -1129,9 +1131,9 @@ setVolume(vol: number, callback: AsyncCallback\): void ```js videoPlayer.setVolume((vol, err) => { - if (typeof (err) == 'undefined') { - console.info('setVolume success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('setVolume success!'); + } else { console.info('setVolume fail!'); } }); @@ -1189,9 +1191,9 @@ release(callback: AsyncCallback\): void ```js videoPlayer.release((err) => { - if (typeof (err) == 'undefined') { - console.info('release success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('release success!'); + } else { console.info('release fail!'); } }); @@ -1324,9 +1326,9 @@ setSpeed(speed:number, callback: AsyncCallback\): void ```js videoPlayer.setSpeed((speed:number, err) => { - if (typeof (err) == 'undefined') { - console.info('setSpeed success!'); - } else { + if (typeof (err) == 'undefined') { + console.info('setSpeed success!'); + } else { console.info('setSpeed fail!'); } }); @@ -1385,7 +1387,7 @@ on(type: 'playbackCompleted', callback: Callback\): void ```js videoPlayer.on('playbackCompleted', () => { - console.info('playbackCompleted success!'); + console.info('playbackCompleted success!'); }); ``` @@ -1432,7 +1434,7 @@ on(type: 'startRenderFrame', callback: Callback\): void ```js videoPlayer.on('startRenderFrame', () => { - console.info('startRenderFrame success!'); + console.info('startRenderFrame success!'); }); ``` @@ -1479,7 +1481,7 @@ on(type: 'error', callback: ErrorCallback): void ```js 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, errMessage is ${error.message}`);// 打印错误类型详细描述 }); @@ -1723,7 +1725,7 @@ on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset' **示例：** ```js -let audiorecorder = media.createAudioRecorder(); // 创建一个音频录制实例 +let audiorecorder = media.createAudioRecorder(); // 创建一个音频录制实例 let audioRecorderConfig = { audioEncoder : media.AudioEncoder.AAC_LC, , audioEncodeBitRate : 22050, @@ -1733,34 +1735,34 @@ let audioRecorderConfig = { uri : 'fd://xx', // 文件需先由调用者创建，并给予适当的权限 location : { latitude : 30, longitude : 130}, } -audioRecorder.on('error', (error) => { // 设置'error'事件回调 - console.info(`audio error called, errName is ${error.name}`); +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'事件回调 +audioRecorder.on('prepare', () => { // 设置'prepare'事件回调 console.log('prepare success'); - audioRecorder.start(); // 开始录制，并触发'start'事件回调 + audioRecorder.start(); // 开始录制，并触发'start'事件回调 }); -audioRecorder.on('start', () => { // 设置'start'事件回调 +audioRecorder.on('start', () => { // 设置'start'事件回调 console.log('audio recorder start success'); }); -audioRecorder.on('pause', () => { // 设置'pause'事件回调 +audioRecorder.on('pause', () => { // 设置'pause'事件回调 console.log('audio recorder pause success'); }); -audioRecorder.on('resume', () => { // 设置'resume'事件回调 +audioRecorder.on('resume', () => { // 设置'resume'事件回调 console.log('audio recorder resume success'); }); -audioRecorder.on('stop', () => { // 设置'stop'事件回调 +audioRecorder.on('stop', () => { // 设置'stop'事件回调 console.log('audio recorder stop success'); }); -audioRecorder.on('release', () => { // 设置'release'事件回调 +audioRecorder.on('release', () => { // 设置'release'事件回调 console.log('audio recorder release success'); }); -audioRecorder.on('reset', () => { // 设置'reset'事件回调 +audioRecorder.on('reset', () => { // 设置'reset'事件回调 console.log('audio recorder reset success'); }); -audioRecorder.prepare(audioRecorderConfig) // 设置录制参数 ，并触发'prepare'事件回调 +audioRecorder.prepare(audioRecorderConfig) // 设置录制参数 ，并触发'prepare'事件回调 ``` ### on('error') @@ -1781,12 +1783,12 @@ on(type: 'error', callback: ErrorCallback): void **示例：** ```js -audioRecorder.on('error', (error) => { // 设置'error'事件回调 - console.info(`audio error called, errName is ${error.name}`); // 打印错误类型名称 +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'事件 +audioRecorder.prepare(); // prepare不设置参数，触发'error'事件 ``` ## AudioRecorderConfig @@ -1895,7 +1897,7 @@ let videoConfig = { // asyncallback let videoRecorder = null; let events = require('events'); -let eventEmitter = new events.EventEmitter(); +let eventEmitter = new events.EventEmitter(); eventEmitter.on('prepare', () => { videoRecorder.prepare(videoConfig, (err) => { @@ -2011,7 +2013,7 @@ getInputSurface(callback: AsyncCallback\): void; ```js // asyncallback -let surfaceID = null; // 传递给外界的surfaceID +let surfaceID = null; // 传递给外界的surfaceID videoRecorder.getInputSurface((err, surfaceId) => { if (typeof (err) == 'undefined') { console.info('getInputSurface success'); @@ -2044,7 +2046,7 @@ getInputSurface(): Promise\; ```js // promise -let surfaceID = null; // 传递给外界的surfaceID +let surfaceID = null; // 传递给外界的surfaceID await videoRecorder.getInputSurface().then((surfaceId) => { console.info('getInputSurface success'); surfaceID = surfaceId; @@ -2413,8 +2415,8 @@ on(type: 'error', callback: ErrorCallback): void **示例：** ```js -videoRecorder.on('error', (error) => { // 设置'error'事件回调 - console.info(`audio error called, errName is ${error.name}`); // 打印错误类型名称 +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}`); // 打印错误类型详细描述 });