提交 b11d5b4d 编写于 作者: F flz

modify doc file Signed-off-by: FULIZHONG<fulizhong1@huawei.com>

Signed-off-by: Nflz <fulizhong1@huawei.com>
上级 5884c682
......@@ -45,14 +45,14 @@ createAVPlayer(callback: AsyncCallback\<AVPlayer>): void
**示例:**
```js
let avPlayer
let avPlayer;
media.createAVPlayer((error, video) => {
if (video != null) {
avPlayer = video;
console.info('createAVPlayer success');
} else {
console.info(`createAVPlayer fail, error:${error}`);
console.error(`createAVPlayer fail, error message:${error.message}`);
}
});
```
......@@ -82,17 +82,17 @@ createAVPlayer(): Promise\<AVPlayer>
**示例:**
```js
let avPlayer
let avPlayer;
media.createAVPlayer().then((video) => {
if (video != null) {
avPlayer = video;
console.info('createAVPlayer success');
} else {
console.info('createAVPlayer fail');
console.error('createAVPlayer fail');
}
}).catch((error) => {
console.info(`AVPlayer catchCallback, error:${error}`);
console.error(`AVPlayer catchCallback, error message:${error.message}`);
});
```
......@@ -122,14 +122,14 @@ createAVRecorder(callback: AsyncCallback\<AVRecorder>): void
**示例:**
```js
let avRecorder
let avRecorder;
media.createAVRecorder((error, recorder) => {
if (recorder != null) {
avRecorder = recorder;
console.info('createAVRecorder success');
} else {
console.info(`createAVRecorder fail, error:${error}`);
console.error(`createAVRecorder fail, error message:${error.message}`);
}
});
```
......@@ -160,17 +160,17 @@ createAVRecorder(): Promise\<AVRecorder>
**示例:**
```js
let avRecorder
let avRecorder;
media.createAVRecorder().then((recorder) => {
if (recorder != null) {
avRecorder = recorder;
console.info('createAVRecorder success');
} else {
console.info('createAVRecorder fail');
console.error('createAVRecorder fail');
}
}).catch((error) => {
console.info(`createAVRecorder catchCallback, error:${error}`);
console.error(`createAVRecorder catchCallback, error message:${error.message}`);
});
```
......@@ -202,14 +202,14 @@ createVideoRecorder(callback: AsyncCallback\<VideoRecorder>): void
**示例:**
```js
let videoRecorder
let videoRecorder;
media.createVideoRecorder((error, video) => {
if (video != null) {
videoRecorder = video;
console.info('video createVideoRecorder success');
} else {
console.info(`video createVideoRecorder fail, error:${error}`);
console.error(`video createVideoRecorder fail, error message:${error.message}`);
}
});
```
......@@ -242,17 +242,17 @@ createVideoRecorder(): Promise\<VideoRecorder>
**示例:**
```js
let videoRecorder
let videoRecorder;
media.createVideoRecorder().then((video) => {
if (video != null) {
videoRecorder = video;
console.info('video createVideoRecorder success');
} else {
console.info('video createVideoRecorder fail');
console.error('video createVideoRecorder fail');
}
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error message:${error.message}`);
});
```
......@@ -483,8 +483,8 @@ AVPlayer回调的**错误分类**<a name = error_info></a>可以分为以下几
```js
avPlayer.on('error', (error) => {
console.info('error happened,and error message is :' + error.message)
console.info('error happened,and error code is :' + error.code)
console.error('error happened,and error message is :' + error.message)
console.error('error happened,and error code is :' + error.code)
})
```
......@@ -931,7 +931,7 @@ getTrackDescription(callback: AsyncCallback\<Array\<MediaDescription>>): void
**示例:**
```js
printfDescription(obj) {
function printfDescription(obj) {
for (let item in obj) {
let property = obj[item];
console.info('audio key is ' + item);
......@@ -977,7 +977,7 @@ getTrackDescription(): Promise\<Array\<MediaDescription>>
```js
let arrayDescription;
printfDescription(obj) {
function printfDescription(obj) {
for (let item in obj) {
let property = obj[item];
console.info('audio key is ' + item);
......@@ -1788,7 +1788,7 @@ avRecorder.prepare(AVRecorderConfig, (err) => {
if (err == null) {
console.info('prepare success');
} else {
console.info('prepare failed and error is ' + err.message);
console.error('prepare failed and error is ' + err.message);
}
})
```
......@@ -1858,7 +1858,7 @@ let AVRecorderConfig = {
avRecorder.prepare(AVRecorderConfig).then(() => {
console.info('prepare success');
}).catch((err) => {
console.info('prepare failed and catch error is ' + err.message);
console.error('prepare failed and catch error is ' + err.message);
});
```
......@@ -1901,7 +1901,7 @@ avRecorder.getInputSurface((err, surfaceId) => {
console.info('getInputSurface success');
surfaceID = surfaceId;
} else {
console.info('getInputSurface failed and error is ' + err.message);
console.error('getInputSurface failed and error is ' + err.message);
}
});
......@@ -1944,7 +1944,7 @@ avRecorder.getInputSurface().then((surfaceId) => {
console.info('getInputSurface success');
surfaceID = surfaceId;
}).catch((err) => {
console.info('getInputSurface failed and catch error is ' + err.message);
console.error('getInputSurface failed and catch error is ' + err.message);
});
```
......@@ -1981,7 +1981,7 @@ avRecorder.start((err) => {
if (err == null) {
console.info('start AVRecorder success');
} else {
console.info('start AVRecorder failed and error is ' + err.message);
console.error('start AVRecorder failed and error is ' + err.message);
}
});
```
......@@ -2018,7 +2018,7 @@ start(): Promise\<void>
avRecorder.start().then(() => {
console.info('start AVRecorder success');
}).catch((err) => {
console.info('start AVRecorder failed and catch error is ' + err.message);
console.error('start AVRecorder failed and catch error is ' + err.message);
});
```
......@@ -2055,7 +2055,7 @@ avRecorder.pause((err) => {
if (err == null) {
console.info('pause AVRecorder success');
} else {
console.info('pause AVRecorder failed and error is ' + err.message);
console.error('pause AVRecorder failed and error is ' + err.message);
}
});
```
......@@ -2092,7 +2092,7 @@ pause(): Promise\<void>
avRecorder.pause().then(() => {
console.info('pause AVRecorder success');
}).catch((err) => {
console.info('pause AVRecorder failed and catch error is ' + err.message);
console.error('pause AVRecorder failed and catch error is ' + err.message);
});
```
......@@ -2129,7 +2129,7 @@ avRecorder.resume((err) => {
if (err == null) {
console.info('resume AVRecorder success');
} else {
console.info('resume AVRecorder failed and error is ' + err.message);
console.error('resume AVRecorder failed and error is ' + err.message);
}
});
```
......@@ -2166,7 +2166,7 @@ resume(): Promise\<void>
avRecorder.resume().then(() => {
console.info('resume AVRecorder success');
}).catch((err) => {
console.info('resume AVRecorder failed and catch error is ' + err.message);
console.error('resume AVRecorder failed and catch error is ' + err.message);
});
```
......@@ -2205,7 +2205,7 @@ avRecorder.stop((err) => {
if (err == null) {
console.info('stop AVRecorder success');
} else {
console.info('stop AVRecorder failed and error is ' + err.message);
console.error('stop AVRecorder failed and error is ' + err.message);
}
});
```
......@@ -2244,7 +2244,7 @@ stop(): Promise\<void>
avRecorder.stop().then(() => {
console.info('stop AVRecorder success');
}).catch((err) => {
console.info('stop AVRecorder failed and catch error is ' + err.message);
console.error('stop AVRecorder failed and catch error is ' + err.message);
});
```
......@@ -2280,7 +2280,7 @@ avRecorder.reset((err) => {
if (err == null) {
console.info('reset AVRecorder success');
} else {
console.info('reset AVRecorder failed and error is ' + err.message);
console.error('reset AVRecorder failed and error is ' + err.message);
}
});
```
......@@ -2316,7 +2316,7 @@ reset(): Promise\<void>
avRecorder.reset().then(() => {
console.info('reset AVRecorder success');
}).catch((err) => {
console.info('reset AVRecorder failed and catch error is ' + err.message);
console.error('reset AVRecorder failed and catch error is ' + err.message);
});
```
......@@ -2351,7 +2351,7 @@ avRecorder.release((err) => {
if (err == null) {
console.info('release AVRecorder success');
} else {
console.info('release AVRecorder failed and error is ' + err.message);
console.error('release AVRecorder failed and error is ' + err.message);
}
});
```
......@@ -2386,7 +2386,7 @@ release(): Promise\<void>
avRecorder.release().then(() => {
console.info('release AVRecorder success');
}).catch((err) => {
console.info('release AVRecorder failed and catch error is ' + err.message);
console.error('release AVRecorder failed and catch error is ' + err.message);
});
```
......@@ -2463,7 +2463,7 @@ on(type: 'error', callback: ErrorCallback): void
```js
avRecorder.on('error', (err) => {
console.info('case avRecorder.on(error) called, errMessage is ' + err.message);
console.error('case avRecorder.on(error) called, errMessage is ' + err.message);
});
```
......@@ -2670,7 +2670,7 @@ videoRecorder.prepare(videoConfig, (err) => {
if (err == null) {
console.info('prepare success');
} else {
console.info('prepare failed and error is ' + err.message);
console.error('prepare failed and error is ' + err.message);
}
})
```
......@@ -2740,7 +2740,7 @@ let videoConfig = {
videoRecorder.prepare(videoConfig).then(() => {
console.info('prepare success');
}).catch((err) => {
console.info('prepare failed and catch error is ' + err.message);
console.error('prepare failed and catch error is ' + err.message);
});
```
......@@ -2784,7 +2784,7 @@ videoRecorder.getInputSurface((err, surfaceId) => {
console.info('getInputSurface success');
surfaceID = surfaceId;
} else {
console.info('getInputSurface failed and error is ' + err.message);
console.error('getInputSurface failed and error is ' + err.message);
}
});
```
......@@ -2828,7 +2828,7 @@ videoRecorder.getInputSurface().then((surfaceId) => {
console.info('getInputSurface success');
surfaceID = surfaceId;
}).catch((err) => {
console.info('getInputSurface failed and catch error is ' + err.message);
console.error('getInputSurface failed and catch error is ' + err.message);
});
```
......@@ -2868,7 +2868,7 @@ videoRecorder.start((err) => {
if (err == null) {
console.info('start videorecorder success');
} else {
console.info('start videorecorder failed and error is ' + err.message);
console.error('start videorecorder failed and error is ' + err.message);
}
});
```
......@@ -2908,7 +2908,7 @@ start(): Promise\<void>;
videoRecorder.start().then(() => {
console.info('start videorecorder success');
}).catch((err) => {
console.info('start videorecorder failed and catch error is ' + err.message);
console.error('start videorecorder failed and catch error is ' + err.message);
});
```
......@@ -2948,7 +2948,7 @@ videoRecorder.pause((err) => {
if (err == null) {
console.info('pause videorecorder success');
} else {
console.info('pause videorecorder failed and error is ' + err.message);
console.error('pause videorecorder failed and error is ' + err.message);
}
});
```
......@@ -2988,7 +2988,7 @@ pause(): Promise\<void>;
videoRecorder.pause().then(() => {
console.info('pause videorecorder success');
}).catch((err) => {
console.info('pause videorecorder failed and catch error is ' + err.message);
console.error('pause videorecorder failed and catch error is ' + err.message);
});
```
......@@ -3026,7 +3026,7 @@ videoRecorder.resume((err) => {
if (err == null) {
console.info('resume videorecorder success');
} else {
console.info('resume videorecorder failed and error is ' + err.message);
console.error('resume videorecorder failed and error is ' + err.message);
}
});
```
......@@ -3064,7 +3064,7 @@ resume(): Promise\<void>;
videoRecorder.resume().then(() => {
console.info('resume videorecorder success');
}).catch((err) => {
console.info('resume videorecorder failed and catch error is ' + err.message);
console.error('resume videorecorder failed and catch error is ' + err.message);
});
```
......@@ -3104,7 +3104,7 @@ videoRecorder.stop((err) => {
if (err == null) {
console.info('stop videorecorder success');
} else {
console.info('stop videorecorder failed and error is ' + err.message);
console.error('stop videorecorder failed and error is ' + err.message);
}
});
```
......@@ -3144,7 +3144,7 @@ stop(): Promise\<void>;
videoRecorder.stop().then(() => {
console.info('stop videorecorder success');
}).catch((err) => {
console.info('stop videorecorder failed and catch error is ' + err.message);
console.error('stop videorecorder failed and catch error is ' + err.message);
});
```
......@@ -3180,7 +3180,7 @@ videoRecorder.release((err) => {
if (err == null) {
console.info('release videorecorder success');
} else {
console.info('release videorecorder failed and error is ' + err.message);
console.error('release videorecorder failed and error is ' + err.message);
}
});
```
......@@ -3216,7 +3216,7 @@ release(): Promise\<void>;
videoRecorder.release().then(() => {
console.info('release videorecorder success');
}).catch((err) => {
console.info('release videorecorder failed and catch error is ' + err.message);
console.error('release videorecorder failed and catch error is ' + err.message);
});
```
......@@ -3255,7 +3255,7 @@ videoRecorder.reset((err) => {
if (err == null) {
console.info('reset videorecorder success');
} else {
console.info('reset videorecorder failed and error is ' + err.message);
console.error('reset videorecorder failed and error is ' + err.message);
}
});
```
......@@ -3294,7 +3294,7 @@ reset(): Promise\<void>;
videoRecorder.reset().then(() => {
console.info('reset videorecorder success');
}).catch((err) => {
console.info('reset videorecorder failed and catch error is ' + err.message);
console.error('reset videorecorder failed and catch error is ' + err.message);
});
```
......@@ -3327,7 +3327,7 @@ on(type: 'error', callback: ErrorCallback): void
```js
// 当获取videoRecordState接口出错时通过此订阅事件上报
videoRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, error: ${error}`);
console.error(`audio error called, error: ${error}`);
})
```
......@@ -3429,14 +3429,14 @@ createVideoPlayer(callback: AsyncCallback\<VideoPlayer>): void
**示例:**
```js
let videoPlayer
let videoPlayer;
media.createVideoPlayer((error, video) => {
if (video != null) {
videoPlayer = video;
console.info('video createVideoPlayer success');
} else {
console.info(`video createVideoPlayer fail, error:${error}`);
console.error(`video createVideoPlayer fail, error:${error}`);
}
});
```
......@@ -3461,17 +3461,17 @@ createVideoPlayer(): Promise\<VideoPlayer>
**示例:**
```js
let videoPlayer
let videoPlayer;
media.createVideoPlayer().then((video) => {
if (video != null) {
videoPlayer = video;
console.info('video createVideoPlayer success');
} else {
console.info('video createVideoPlayer fail');
console.error('video createVideoPlayer fail');
}
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -3830,7 +3830,7 @@ audioPlayer.on('finish', () => { //设置'finish'事件回调
audioPlayer.stop(); //停止播放,并触发'stop'事件回调
});
audioPlayer.on('error', (error) => { //设置'error'事件回调
console.info(`audio error called, error: ${error}`);
console.error(`audio error called, error: ${error}`);
});
// 用户选择音频设置fd(本地播放)
......@@ -3895,7 +3895,7 @@ on(type: 'error', callback: ErrorCallback): void
```js
audioPlayer.on('error', (error) => { //设置'error'事件回调
console.info(`audio error called, error: ${error}`);
console.error(`audio error called, error: ${error}`);
});
audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
```
......@@ -3966,7 +3966,7 @@ videoPlayer.setDisplaySurface(surfaceId, (err) => {
if (err == null) {
console.info('setDisplaySurface success!');
} else {
console.info('setDisplaySurface fail!');
console.error('setDisplaySurface fail!');
}
});
```
......@@ -4000,7 +4000,7 @@ let surfaceId = null;
videoPlayer.setDisplaySurface(surfaceId).then(() => {
console.info('setDisplaySurface success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4025,7 +4025,7 @@ videoPlayer.prepare((err) => {
if (err == null) {
console.info('prepare success!');
} else {
console.info('prepare fail!');
console.error('prepare fail!');
}
});
```
......@@ -4050,7 +4050,7 @@ prepare(): Promise\<void>
videoPlayer.prepare().then(() => {
console.info('prepare success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4075,7 +4075,7 @@ videoPlayer.play((err) => {
if (err == null) {
console.info('play success!');
} else {
console.info('play fail!');
console.error('play fail!');
}
});
```
......@@ -4100,7 +4100,7 @@ play(): Promise\<void>;
videoPlayer.play().then(() => {
console.info('play success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4150,7 +4150,7 @@ pause(): Promise\<void>
videoPlayer.pause().then(() => {
console.info('pause success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4175,7 +4175,7 @@ videoPlayer.stop((err) => {
if (err == null) {
console.info('stop success!');
} else {
console.info('stop fail!');
console.error('stop fail!');
}
});
```
......@@ -4200,7 +4200,7 @@ stop(): Promise\<void>
videoPlayer.stop().then(() => {
console.info('stop success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4225,7 +4225,7 @@ videoPlayer.reset((err) => {
if (err == null) {
console.info('reset success!');
} else {
console.info('reset fail!');
console.error('reset fail!');
}
});
```
......@@ -4250,7 +4250,7 @@ reset(): Promise\<void>
videoPlayer.reset().then(() => {
console.info('reset success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4277,7 +4277,7 @@ videoPlayer.seek(seekTime, (err, result) => {
if (err == null) {
console.info('seek success!');
} else {
console.info('seek fail!');
console.error('seek fail!');
}
});
```
......@@ -4307,7 +4307,7 @@ videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC, (err, result) => {
if (err == null) {
console.info('seek success!');
} else {
console.info('seek fail!');
console.error('seek fail!');
}
});
```
......@@ -4341,13 +4341,13 @@ let seekTime = 5000;
videoPlayer.seek(seekTime).then((seekDoneTime) => { // seekDoneTime表示seek完成后的时间点
console.info('seek success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC).then((seekDoneTime) => {
console.info('seek success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4374,7 +4374,7 @@ videoPlayer.setVolume(vol, (err, result) => {
if (err == null) {
console.info('setVolume success!');
} else {
console.info('setVolume fail!');
console.error('setVolume fail!');
}
});
```
......@@ -4406,7 +4406,7 @@ let vol = 0.5;
videoPlayer.setVolume(vol).then(() => {
console.info('setVolume success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4431,7 +4431,7 @@ videoPlayer.release((err) => {
if (err == null) {
console.info('release success!');
} else {
console.info('release fail!');
console.error('release fail!');
}
});
```
......@@ -4456,7 +4456,7 @@ release(): Promise\<void>
videoPlayer.release().then(() => {
console.info('release success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4561,7 +4561,7 @@ videoPlayer.setSpeed(speed, (err, result) => {
if (err == null) {
console.info('setSpeed success!');
} else {
console.info('setSpeed fail!');
console.error('setSpeed fail!');
}
});
```
......@@ -4595,7 +4595,7 @@ let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
videoPlayer.setSpeed(speed).then(() => {
console.info('setSpeed success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
console.error(`video catchCallback, error:${error}`);
});
```
......@@ -4712,7 +4712,7 @@ on(type: 'error', callback: ErrorCallback): void
```js
videoPlayer.on('error', (error) => { // 设置'error'事件回调
console.info(`video error called, error: ${error}`);
console.error(`video error called, error: ${error}`);
});
videoPlayer.url = 'fd://error'; //设置错误的播放地址,触发'error'事件
```
......@@ -4966,7 +4966,7 @@ let audioRecorderConfig = {
location : { latitude : 30, longitude : 130},
}
audioRecorder.on('error', (error) => { // 设置'error'事件回调
console.info(`audio error called, error: ${error}`);
console.error(`audio error called, error: ${error}`);
});
audioRecorder.prepare(audioRecorderConfig); // prepare不设置参数,触发'error'事件
```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册