Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 4ffdf6b4 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!2773 Done! 2588:补充AudioEncoder和AudioOutputFormat的deprecated说明 

Merge pull request !2773 from wusongqing/TR2588
上级 68b05bc1 e624379e
隐藏空白更改
内联 并排
Showing with 113 addition and 107 deletion
en/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 4ffdf6b4
...@@ -122,7 +122,7 @@ Creates an **AudioRecorder** instance to control audio recording. ...@@ -122,7 +122,7 @@ Creates an **AudioRecorder** instance to control audio recording.
**Example** **Example**
```js ```js
let audiorecorder = media.createAudioRecorder(); let audiorecorder = media.createAudioRecorder();
``` ```
## media.createVideoRecorder<sup>9+</sup> ## media.createVideoRecorder<sup>9+</sup>
...@@ -250,13 +250,13 @@ Enumerates the media description keys. ...@@ -250,13 +250,13 @@ Enumerates the media description keys.
| MD_KEY_TRACK_INDEX | "track_index" | Track index, which is a number. | | MD_KEY_TRACK_INDEX | "track_index" | Track index, which is a number. |
| MD_KEY_TRACK_TYPE | "track_type" | Track type, which is a number. For details, see [MediaType](#mediatype8).| | MD_KEY_TRACK_TYPE | "track_type" | Track type, which is a number. For details, see [MediaType](#mediatype8).|
| MD_KEY_CODEC_MIME | "codec_mime" | Codec MIME type, which is a string. | | MD_KEY_CODEC_MIME | "codec_mime" | Codec MIME type, which is a string. |
| MD_KEY_DURATION | "duration" | Media duration, which is a number, in units of ms. | | MD_KEY_DURATION | "duration" | Media duration, which is a number, in units of ms. |
| MD_KEY_BITRATE | "bitrate" | Bit rate, which is a number, in units of bit/s. | | MD_KEY_BITRATE | "bitrate" | Bit rate, which is a number, in units of bit/s. |
| MD_KEY_WIDTH | "width" | Video width, which is a number, in units of pixel. | | MD_KEY_WIDTH | "width" | Video width, which is a number, in units of pixel. |
| MD_KEY_HEIGHT | "height" | Video height, which is a number, in units of pixel. | | MD_KEY_HEIGHT | "height" | Video height, which is a number, in units of pixel. |
| MD_KEY_FRAME_RATE | "frame_rate" | Video frame rate, which is a number, in units of 100 fps. | | MD_KEY_FRAME_RATE | "frame_rate" | Video frame rate, which is a number, in units of 100 fps.|
| MD_KEY_AUD_CHANNEL_COUNT | "channel_count" | Number of audio channels, which is a number. | | MD_KEY_AUD_CHANNEL_COUNT | "channel_count" | Number of audio channels, which is a number. |
| MD_KEY_AUD_SAMPLE_RATE | "sample_rate" | Sampling rate, which is a number, in units of Hz. | | MD_KEY_AUD_SAMPLE_RATE | "sample_rate" | Sampling rate, which is a number, in units of Hz. |
## BufferingInfoType<sup>8+</sup> ## BufferingInfoType<sup>8+</sup>
...@@ -264,11 +264,11 @@ Enumerates the buffering event types. ...@@ -264,11 +264,11 @@ Enumerates the buffering event types.
**System capability**: SystemCapability.Multimedia.Media.Core **System capability**: SystemCapability.Multimedia.Media.Core
| Name | Value | Description | | Name | Value | Description |
| ----------------- | ---- | -------------------------- | | ----------------- | ---- | -------------------------------- |
| BUFFERING_START | 1 | Buffering starts. | | BUFFERING_START | 1 | Buffering starts. |
| BUFFERING_END | 2 | Buffering ends. | | BUFFERING_END | 2 | Buffering ends. |
| BUFFERING_PERCENT | 3 | Buffering progress, in percent. | | BUFFERING_PERCENT | 3 | Buffering progress, in percent. |
| CACHED_DURATION | 4 | Cache duration, in milliseconds.| | CACHED_DURATION | 4 | Cache duration, in milliseconds.|
## AudioPlayer ## AudioPlayer
...@@ -283,7 +283,7 @@ For details about the audio playback demo, see [Audio Playback Development](../. ...@@ -283,7 +283,7 @@ For details about the audio playback demo, see [Audio Playback Development](../.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ | | ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| src | string | Yes | Yes | Audio media URI. The mainstream audio formats (MPEG-4, AAC, MPEG-3, OGG, and WAV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly. | | src | string | Yes | Yes | Audio media URI. The mainstream audio formats (MPEG-4, AAC, MPEG-3, OGG, and WAV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.|
| loop | boolean | Yes | Yes | Whether to loop audio playback. The value **true** means to loop audio playback, and **false** means the opposite. | | loop | boolean | Yes | Yes | Whether to loop audio playback. The value **true** means to loop audio playback, and **false** means the opposite. |
| currentTime | number | Yes | No | Current audio playback position. | | currentTime | number | Yes | No | Current audio playback position. |
| duration | number | Yes | No | Audio duration. | | duration | number | Yes | No | Audio duration. |
...@@ -367,8 +367,8 @@ Seeks to the specified playback position. ...@@ -367,8 +367,8 @@ Seeks to the specified playback position.
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------------------------------ | | ------ | ------ | ---- | ------------------------------------ |
| timeMs | number | Yes | Position to seek to, in milliseconds.| | timeMs | number | Yes | Position to seek to, in milliseconds.|
**Example** **Example**
...@@ -545,24 +545,24 @@ Subscribes to the audio playback events. ...@@ -545,24 +545,24 @@ Subscribes to the audio playback events.
```js ```js
let audioPlayer = media.createAudioPlayer(); // Create an AudioPlayer instance. let audioPlayer = media.createAudioPlayer(); // Create an AudioPlayer instance.
audioPlayer.on('dataLoad', () => { // Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully. audioPlayer.on('dataLoad', () => { // Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
console.info('audio set source success'); console.info('audio set source success');
audioPlayer.play(); // Start the playback and trigger the 'play' event callback. audioPlayer.play(); // Start the playback and trigger the 'play' event callback.
}); });
audioPlayer.on('play', () => { // Set the 'play' event callback. audioPlayer.on('play', () => { // Set the 'play' event callback.
console.info('audio play success'); console.info('audio play success');
audioPlayer.seek(30000); // Call the seek() API and trigger the 'timeUpdate' event callback. audioPlayer.seek(30000); // Call the seek() API and trigger the 'timeUpdate' event callback.
}); });
audioPlayer.on('pause', () => { // Set the 'pause' event callback. audioPlayer.on('pause', () => { // Set the 'pause' event callback.
console.info('audio pause success'); console.info('audio pause success');
audioPlayer.stop(); // Stop the playback and trigger the 'stop' event callback. audioPlayer.stop(); // Stop the playback and trigger the 'stop' event callback.
}); });
audioPlayer.on('reset', () => { // Set the 'reset' event callback. audioPlayer.on('reset', () => { // Set the 'reset' event callback.
console.info('audio reset success'); console.info('audio reset success');
audioPlayer.release(); // Release the AudioPlayer instance. audioPlayer.release(); // Release the AudioPlayer instance.
audioPlayer = undefined; audioPlayer = undefined;
}); });
audioPlayer.on('timeUpdate', (seekDoneTime) => { // Set the 'timeUpdate' event callback. audioPlayer.on('timeUpdate', (seekDoneTime) => { // Set the 'timeUpdate' event callback.
if (typeof(seekDoneTime) == "undefined") { if (typeof(seekDoneTime) == "undefined") {
console.info('audio seek fail'); console.info('audio seek fail');
return; return;
} }
...@@ -570,15 +570,15 @@ audioPlayer.on('timeUpdate', (seekDoneTime) => { // Set the 'timeUpdate' event ...@@ -570,15 +570,15 @@ audioPlayer.on('timeUpdate', (seekDoneTime) => { // Set the 'timeUpdate' event
audioPlayer.setVolume(0.5); // Set the volume to 50% and trigger the 'volumeChange' event callback. audioPlayer.setVolume(0.5); // Set the volume to 50% and trigger the 'volumeChange' event callback.
}); });
audioPlayer.on('volumeChange', () => { // Set the 'volumeChange' event callback. audioPlayer.on('volumeChange', () => { // Set the 'volumeChange' event callback.
console.info('audio volumeChange success'); console.info('audio volumeChange success');
audioPlayer.pause(); // Pause the playback and trigger the 'pause' event callback. audioPlayer.pause(); // Pause the playback and trigger the 'pause' event callback.
}); });
audioPlayer.on('finish', () => { // Set the 'finish' event callback. audioPlayer.on('finish', () => { // Set the 'finish' event callback.
console.info('audio play finish'); console.info('audio play finish');
audioPlayer.stop(); // Stop the playback and trigger the 'stop' event callback. audioPlayer.stop(); // Stop the playback and trigger the 'stop' event callback.
}); });
audioPlayer.on('error', (error) => { // Set the 'error' event callback. audioPlayer.on('error', (error) => { // Set the 'error' event callback.
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 +644,7 @@ Subscribes to the audio playback error event. ...@@ -644,7 +644,7 @@ Subscribes to the audio playback error event.
```js ```js
audioPlayer.on('error', (error) => { // Set the error event callback. audioPlayer.on('error', (error) => { // Set the error event callback.
console.info(`audio error called, errName is ${error.name}`); // Print the error name. console.info(`audio error called, errName is ${error.name}`); // Print the error name.
console.info(`audio error called, errCode is ${error.code}`); // Print the error code. console.info(`audio error called, errCode is ${error.code}`); // Print the error code.
console.info(`audio error called, errMessage is ${error.message}`);// Print the detailed description of the error type. console.info(`audio error called, errMessage is ${error.message}`);// Print the detailed description of the error type.
}); });
...@@ -677,7 +677,7 @@ For details about the video playback demo, see [Video Playback Development](../. ...@@ -677,7 +677,7 @@ For details about the video playback demo, see [Video Playback Development](../.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ | | ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| url<sup>8+</sup> | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly. | | url<sup>8+</sup> | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.|
| loop<sup>8+</sup> | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. | | loop<sup>8+</sup> | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. |
| currentTime<sup>8+</sup> | number | Yes | No | Current video playback position. | | currentTime<sup>8+</sup> | number | Yes | No | Current video playback position. |
| duration<sup>8+</sup> | number | Yes | No | Video duration. The value **-1** indicates the live streaming mode. | | duration<sup>8+</sup> | number | Yes | No | Video duration. The value **-1** indicates the live streaming mode. |
...@@ -698,15 +698,15 @@ Sets **SurfaceId**. This API uses a callback to return the result. ...@@ -698,15 +698,15 @@ Sets **SurfaceId**. This API uses a callback to return the result.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------- | -------- | ---- | ------------------------- | | --------- | -------- | ---- | ------------------------- |
| surfaceId | string | Yes | Surface ID to set. | | surfaceId | string | Yes | Surface ID to set. |
| callback | function | Yes | Callback used to set **SurfaceId**.| | callback | function | Yes | Callback used to return the result.|
**Example** **Example**
```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!');
} }
}); });
...@@ -730,7 +730,7 @@ Sets **SurfaceId**. This API uses a promise to return the result. ...@@ -730,7 +730,7 @@ Sets **SurfaceId**. This API uses a promise to return the result.
| Type | Description | | Type | Description |
| ------------- | ------------------------------ | | ------------- | ------------------------------ |
| Promise<void> | Promise used to set **SurfaceId**.| | Promise<void> | Promise used to return the result.|
**Example** **Example**
...@@ -764,9 +764,9 @@ Prepares for video playback. This API uses a callback to return the result. ...@@ -764,9 +764,9 @@ Prepares for video playback. This API uses a callback to return the result.
```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 +818,9 @@ Starts to play video resources. This API uses a callback to return the result. ...@@ -818,9 +818,9 @@ Starts to play video resources. This API uses a callback to return the result.
```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 +872,9 @@ Pauses video playback. This API uses a callback to return the result. ...@@ -872,9 +872,9 @@ Pauses video playback. This API uses a callback to return the result.
```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 +926,9 @@ Stops video playback. This API uses a callback to return the result. ...@@ -926,9 +926,9 @@ Stops video playback. This API uses a callback to return the result.
```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 +980,9 @@ Switches the video resource to be played. This API uses a callback to return the ...@@ -980,9 +980,9 @@ Switches the video resource to be played. This API uses a callback to return the
```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!');
} }
}); });
...@@ -1026,18 +1026,18 @@ Seeks to the specified playback position. The next key frame at the specified po ...@@ -1026,18 +1026,18 @@ Seeks to the specified playback position. The next key frame at the specified po
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | -------- | ---- | ------------------------------ | | -------- | -------- | ---- | ------------------------------------ |
| timeMs | number | Yes | Position to seek to, in milliseconds.| | timeMs | number | Yes | Position to seek to, in milliseconds.|
| callback | function | Yes | Callback used to return the result.| | callback | function | Yes | Callback used to return the result. |
**Example** **Example**
```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!');
} }
}); });
...@@ -1053,19 +1053,19 @@ Seeks to the specified playback position. This API uses a callback to return the ...@@ -1053,19 +1053,19 @@ Seeks to the specified playback position. This API uses a callback to return the
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ---------------------- | ---- | ------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------ |
| timeMs | number | Yes | Position to seek to, in milliseconds.| | timeMs | number | Yes | Position to seek to, in milliseconds.|
| mode | [SeekMode](#seekmode8) | Yes | Seek mode. | | mode | [SeekMode](#seekmode8) | Yes | Seek mode. |
| callback | function | Yes | Callback used to return the result.| | callback | function | Yes | Callback used to return the result. |
**Example** **Example**
```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!');
} }
}); });
...@@ -1081,10 +1081,10 @@ Seeks to the specified playback position. If **mode** is not specified, the next ...@@ -1081,10 +1081,10 @@ Seeks to the specified playback position. If **mode** is not specified, the next
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ---------------------- | ---- | ------------------------------ | | ------ | ---------------------- | ---- | ------------------------------------ |
| timeMs | number | Yes | Position to seek to, in milliseconds.| | timeMs | number | Yes | Position to seek to, in milliseconds.|
| mode | [SeekMode](#seekmode8) | No | Seek mode. | | mode | [SeekMode](#seekmode8) | No | Seek mode. |
**Return value** **Return value**
...@@ -1129,9 +1129,9 @@ Sets the volume. This API uses a callback to return the result. ...@@ -1129,9 +1129,9 @@ Sets the volume. This API uses a callback to return the result.
```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 +1189,9 @@ Releases the video playback resource. This API uses a callback to return the res ...@@ -1189,9 +1189,9 @@ Releases the video playback resource. This API uses a callback to return the res
```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 +1324,9 @@ Sets the video playback speed. This API uses a callback to return the result. ...@@ -1324,9 +1324,9 @@ Sets the video playback speed. This API uses a callback to return the result.
```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 +1385,7 @@ Subscribes to the video playback completion event. ...@@ -1385,7 +1385,7 @@ Subscribes to the video playback completion event.
```js ```js
videoPlayer.on('playbackCompleted', () => { videoPlayer.on('playbackCompleted', () => {
console.info('playbackCompleted success!'); console.info('playbackCompleted success!');
}); });
``` ```
...@@ -1432,7 +1432,7 @@ Subscribes to the frame rendering start event. ...@@ -1432,7 +1432,7 @@ Subscribes to the frame rendering start event.
```js ```js
videoPlayer.on('startRenderFrame', () => { videoPlayer.on('startRenderFrame', () => {
console.info('startRenderFrame success!'); console.info('startRenderFrame success!');
}); });
``` ```
...@@ -1479,7 +1479,7 @@ Subscribes to the video playback error event. ...@@ -1479,7 +1479,7 @@ Subscribes to the video playback error event.
```js ```js
videoPlayer.on('error', (error) => { // Set the 'error' event callback. videoPlayer.on('error', (error) => { // Set the 'error' event callback.
console.info(`video error called, errName is ${error.name}`); // Print the error name. console.info(`video error called, errName is ${error.name}`); // Print the error name.
console.info(`video error called, errCode is ${error.code}`); // Print the error code. console.info(`video error called, errCode is ${error.code}`); // Print the error code.
console.info(`video error called, errMessage is ${error.message}`);// Print the detailed description of the error type. console.info(`video error called, errMessage is ${error.message}`);// Print the detailed description of the error type.
}); });
...@@ -1723,7 +1723,7 @@ Subscribes to the audio recording events. ...@@ -1723,7 +1723,7 @@ Subscribes to the audio recording events.
**Example** **Example**
```js ```js
let audiorecorder = media.createAudioRecorder(); // Create an AudioRecorder instance. let audiorecorder = media.createAudioRecorder(); // Create an AudioRecorder instance.
let audioRecorderConfig = { let audioRecorderConfig = {
audioEncoder : media.AudioEncoder.AAC_LC, , audioEncoder : media.AudioEncoder.AAC_LC, ,
audioEncodeBitRate : 22050, audioEncodeBitRate : 22050,
...@@ -1733,34 +1733,34 @@ let audioRecorderConfig = { ...@@ -1733,34 +1733,34 @@ let audioRecorderConfig = {
uri : 'fd://xx', // The file must be created by the caller and granted with proper permissions. uri : 'fd://xx', // The file must be created by the caller and granted with proper permissions.
location : { latitude : 30, longitude : 130}, location : { latitude : 30, longitude : 130},
} }
audioRecorder.on('error', (error) => { // Set the 'error' event callback. audioRecorder.on('error', (error) => { // Set the 'error' event callback.
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', () => { // Set the 'prepare' event callback. audioRecorder.on('prepare', () => { // Set the 'prepare' event callback.
console.log('prepare success'); console.log('prepare success');
audioRecorder.start(); // Start recording and trigger the 'start' event callback. audioRecorder.start(); // Start recording and trigger the 'start' event callback.
}); });
audioRecorder.on('start', () => { // Set the 'start' event callback. audioRecorder.on('start', () => { // Set the 'start' event callback.
console.log('audio recorder start success'); console.log('audio recorder start success');
}); });
audioRecorder.on('pause', () => { // Set the 'pause' event callback. audioRecorder.on('pause', () => { // Set the 'pause' event callback.
console.log('audio recorder pause success'); console.log('audio recorder pause success');
}); });
audioRecorder.on('resume', () => { // Set the 'resume' event callback. audioRecorder.on('resume', () => { // Set the 'resume' event callback.
console.log('audio recorder resume success'); console.log('audio recorder resume success');
}); });
audioRecorder.on('stop', () => { // Set the 'stop' event callback. audioRecorder.on('stop', () => { // Set the 'stop' event callback.
console.log('audio recorder stop success'); console.log('audio recorder stop success');
}); });
audioRecorder.on('release', () => { // Set the 'release' event callback. audioRecorder.on('release', () => { // Set the 'release' event callback.
console.log('audio recorder release success'); console.log('audio recorder release success');
}); });
audioRecorder.on('reset', () => { // Set the 'reset' event callback. audioRecorder.on('reset', () => { // Set the 'reset' event callback.
console.log('audio recorder reset success'); console.log('audio recorder reset success');
}); });
audioRecorder.prepare(audioRecorderConfig) // Set recording parameters and trigger the 'prepare' event callback. audioRecorder.prepare(audioRecorderConfig) // Set recording parameters and trigger the 'prepare' event callback.
``` ```
### on('error') ### on('error')
...@@ -1781,12 +1781,12 @@ Subscribes to the audio recording error event. ...@@ -1781,12 +1781,12 @@ Subscribes to the audio recording error event.
**Example** **Example**
```js ```js
audioRecorder.on('error', (error) => { // Set the 'error' event callback. audioRecorder.on('error', (error) => { // Set the 'error' event callback.
console.info(`audio error called, errName is ${error.name}`); // Print the error name. console.info(`audio error called, errName is ${error.name}`); // Print the error name.
console.info(`audio error called, errCode is ${error.code}`); // Print the error code. console.info(`audio error called, errCode is ${error.code}`); // Print the error code.
console.info(`audio error called, errMessage is ${error.message}`); // Print the detailed description of the error type. console.info(`audio error called, errMessage is ${error.message}`); // Print the detailed description of the error type.
}); });
audioRecorder.prepare(); // Do no set any parameter in prepare and trigger the 'error' event callback. audioRecorder.prepare(); // Do no set any parameter in prepare and trigger the 'error' event callback.
``` ```
## AudioRecorderConfig ## AudioRecorderConfig
...@@ -1803,11 +1803,14 @@ Describes audio recording configurations. ...@@ -1803,11 +1803,14 @@ Describes audio recording configurations.
| numberOfChannels | number | No | Number of audio channels. The default value is **2**. | | numberOfChannels | number | No | Number of audio channels. The default value is **2**. |
| format | [AudioOutputFormat](#audiooutputformat) | No | Audio output format. The default value is **MPEG_4**. | | format | [AudioOutputFormat](#audiooutputformat) | No | Audio output format. The default value is **MPEG_4**. |
| location | [Location](#location) | No | Geographical location of the recorded audio. | | location | [Location](#location) | No | Geographical location of the recorded audio. |
| uri | string | Yes | Audio output URI. Supported: fd://xx&nbsp;(fd&nbsp;number)<br>![en-us_image_0000001164217678](figures/en-us_image_url.png)<br>The file must be created by the caller and granted with proper permissions.| | uri | string | Yes | Audio output URI. Supported: fd://xx&nbsp;(fd&nbsp;number)<br>![en-us_image_0000001164217678](figures/en-us_image_url.png) <br>The file must be created by the caller and granted with proper permissions.|
| audioEncoderMime | [CodecMimeType](#codecmimetype8) | No | Audio encoding format. | | audioEncoderMime | [CodecMimeType](#codecmimetype8) | No | Audio encoding format. |
## AudioEncoder ## AudioEncoder<sup>(deprecated)</sup>
> **NOTE**
> This API is deprecated since API version 8. You are advised to use [CodecMimeType](#codecmimetype8) instead.
Enumerates the audio encoding formats. Enumerates the audio encoding formats.
...@@ -1815,14 +1818,17 @@ Enumerates the audio encoding formats. ...@@ -1815,14 +1818,17 @@ Enumerates the audio encoding formats.
| Name | Default Value| Description | | Name | Default Value| Description |
| ------- | ------ | ------------------------------------------------------------ | | ------- | ------ | ------------------------------------------------------------ |
| DEFAULT | 0 | Default audio encoding format, which is Adaptive Multi Rate-Narrow Band Speech Codec (AMR-NB).<br>This API is merely defined in OpenHarmony 3.1 Release and cannot be used currently. It can be used in OpenHarmony 3.1 MR.| | DEFAULT | 0 | Default audio encoding format, which is Adaptive Multi Rate-Narrow Band Speech Codec (AMR-NB).<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
| AMR_NB | 1 | AMR-NB.<br>This API is merely defined in OpenHarmony 3.1 Release and cannot be used currently. It can be used in OpenHarmony 3.1 MR.| | AMR_NB | 1 | AMR-NB.<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
| AMR_WB | 2 | Adaptive Multi Rate-Wide Band Speech Codec (AMR-WB).<br>This API is merely defined in OpenHarmony 3.1 Release and cannot be used currently. It can be used in OpenHarmony 3.1 MR.| | AMR_WB | 2 | Adaptive Multi Rate-Wide Band Speech Codec (AMR-WB).<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
| AAC_LC | 3 | Advanced Audio Coding Low Complexity (AAC-LC).| | AAC_LC | 3 | Advanced Audio Coding Low Complexity (AAC-LC).|
| HE_AAC | 4 | High-Efficiency Advanced&nbsp;Audio&nbsp;Coding (HE_AAC).<br>This API is merely defined in OpenHarmony 3.1 Release and cannot be used currently. It can be used in OpenHarmony 3.1 MR.| | HE_AAC | 4 | High-Efficiency Advanced&nbsp;Audio&nbsp;Coding (HE_AAC).<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
## AudioOutputFormat ## AudioOutputFormat<sup>(deprecated)</sup>
> **NOTE**
> This API is deprecated since API version 8. You are advised to use [ContainerFormatType ](#containerformattype8) instead.
Enumerates the audio output formats. Enumerates the audio output formats.
...@@ -1830,10 +1836,10 @@ Enumerates the audio output formats. ...@@ -1830,10 +1836,10 @@ Enumerates the audio output formats.
| Name | Default Value| Description | | Name | Default Value| Description |
| -------- | ------ | ------------------------------------------------------------ | | -------- | ------ | ------------------------------------------------------------ |
| DEFAULT | 0 | Default encapsulation format, which is MPEG-4.<br>This API is merely defined in OpenHarmony 3.1 Release and cannot be used currently. It can be used in OpenHarmony 3.1 MR.| | DEFAULT | 0 | Default encapsulation format, which is MPEG-4.<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
| MPEG_4 | 2 | MPEG-4. | | MPEG_4 | 2 | MPEG-4. |
| AMR_NB | 3 | AMR_NB.<br>This API is merely defined in OpenHarmony 3.1 Release and cannot be used currently. It can be used in OpenHarmony 3.1 MR.| | AMR_NB | 3 | AMR_NB.<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
| AMR_WB | 4 | AMR_WB.<br>This API is merely defined in OpenHarmony 3.1 Release and cannot be used currently. It can be used in OpenHarmony 3.1 MR.| | AMR_WB | 4 | AMR_WB.<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
| AAC_ADTS | 6 | Audio Data Transport Stream (ADTS), which is a transport stream format of AAC-based audio.| | AAC_ADTS | 6 | Audio Data Transport Stream (ADTS), which is a transport stream format of AAC-based audio.|
## VideoRecorder<sup>9+</sup> ## VideoRecorder<sup>9+</sup>
...@@ -1856,7 +1862,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void; ...@@ -1856,7 +1862,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
Sets video recording parameters in asynchronous mode. This API uses a callback to return the result. Sets video recording parameters in asynchronous mode. This API uses a callback to return the result.
**Required permissions:** ohos.permission.MICROPHONE and ohos.permission.CAMERA **Required permissions:** ohos.permission.MICROPHONE
**System capability**: SystemCapability.Multimedia.Media.VideoRecorder **System capability**: SystemCapability.Multimedia.Media.VideoRecorder
...@@ -1895,7 +1901,7 @@ let videoConfig = { ...@@ -1895,7 +1901,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 +2017,7 @@ This API can be called only after [prepare()](#videorecorder_prepare1) is called ...@@ -2011,7 +2017,7 @@ This API can be called only after [prepare()](#videorecorder_prepare1) is called
```js ```js
// asyncallback // asyncallback
let surfaceID = null; // Surface ID passed to the external system. let surfaceID = null; // Surface ID passed to the external system.
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 +2050,7 @@ This API can be called only after [prepare()](#videorecorder_prepare1) is called ...@@ -2044,7 +2050,7 @@ This API can be called only after [prepare()](#videorecorder_prepare1) is called
```js ```js
// promise // promise
let surfaceID = null; // Surface ID passed to the external system. let surfaceID = null; // Surface ID passed to the external system.
await videoRecorder.getInputSurface().then((surfaceId) => { await videoRecorder.getInputSurface().then((surfaceId) => {
console.info('getInputSurface success'); console.info('getInputSurface success');
surfaceID = surfaceId; surfaceID = surfaceId;
...@@ -2413,8 +2419,8 @@ Subscribes to the video recording error event. ...@@ -2413,8 +2419,8 @@ Subscribes to the video recording error event.
**Example** **Example**
```js ```js
videoRecorder.on('error', (error) => { // Set the 'error' event callback. videoRecorder.on('error', (error) => { // Set the 'error' event callback.
console.info(`audio error called, errName is ${error.name}`); // Print the error name. console.info(`audio error called, errName is ${error.name}`); // Print the error name.
console.info(`audio error called, errCode is ${error.code}`); // Print the error code. console.info(`audio error called, errCode is ${error.code}`); // Print the error code.
console.info(`audio error called, errMessage is ${error.message}`); // Print the detailed description of the error type. console.info(`audio error called, errMessage is ${error.message}`); // Print the detailed description of the error type.
}); });
...@@ -2434,7 +2440,7 @@ Enumerates the video recording states. You can obtain the state through the **st ...@@ -2434,7 +2440,7 @@ Enumerates the video recording states. You can obtain the state through the **st
| playing | string | Video recording is in progress. | | playing | string | Video recording is in progress. |
| paused | string | Video recording is paused. | | paused | string | Video recording is paused. |
| stopped | string | Video recording is stopped. | | stopped | string | Video recording is stopped. |
| error | string | Audio playback is in the error state. | | error | string | Video recording is in the error state. |
## VideoRecorderConfig<sup>9+</sup> ## VideoRecorderConfig<sup>9+</sup>
...@@ -2449,7 +2455,7 @@ Describes the video recording parameters. ...@@ -2449,7 +2455,7 @@ Describes the video recording parameters.
| profile | [VideoRecorderProfile](#videorecorderprofile9) | Yes | Video recording profile. | | profile | [VideoRecorderProfile](#videorecorderprofile9) | Yes | Video recording profile. |
| rotation | number | No | Rotation angle of the recorded video. | | rotation | number | No | Rotation angle of the recorded video. |
| location | [Location](#location) | No | Geographical location of the recorded video. | | location | [Location](#location) | No | Geographical location of the recorded video. |
| url | string | Yes | Video output URL. Supported: fd://xx&nbsp;(fd&nbsp;number)<br>![](figures/en-us_image_url.png) <br>The file must be created by the caller and granted with proper permissions.| | url | string | Yes | Video output URL. Supported: fd://xx&nbsp;(fd&nbsp;number)<br>![](figures/zh-cn_image_url.png) <br>The file must be created by the caller and granted with proper permissions.|
## AudioSourceType<sup>9+</sup> ## AudioSourceType<sup>9+</sup>
...@@ -2500,7 +2506,7 @@ Enumerates the container format types (CFTs). ...@@ -2500,7 +2506,7 @@ Enumerates the container format types (CFTs).
| Name | Value | Description | | Name | Value | Description |
| ----------- | ----- | --------------------- | | ----------- | ----- | --------------------- |
| CFT_MPEG_4 | "mp4" | Video container format MP4.| | CFT_MPEG_4 | "mp4" | Video container format MPEG-4 .|
| CFT_MPEG_4A | "m4a" | Audio container format M4A.| | CFT_MPEG_4A | "m4a" | Audio container format M4A.|
## Location ## Location
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或