未验证 提交 54f713e6 编写于 作者: O openharmony_ci 提交者: Gitee

!11965 媒体子系统文档一致性问题修改并添加错误码介绍文档

Merge pull request !11965 from FULIZHONG/1129ziliao
...@@ -130,12 +130,22 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder9)>): ...@@ -130,12 +130,22 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder9)>):
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ | | -------- | ----------------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 回调函数。异步返回VideoRecorder实例,失败时返回null。可用于录制视频媒体。 | | callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 回调函数。异步返回VideoRecorder实例,失败时返回null。可用于录制视频媒体。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | --------- |
| 5400101 | No memory |
**示例:** **示例:**
```js ```js
...@@ -160,12 +170,22 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder9)> ...@@ -160,12 +170,22 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder9)>
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------- | ------------------------------------------------------------ | | ----------------------------------------- | ------------------------------------------------------------ |
| Promise<[VideoRecorder](#videorecorder9)> | Promise对象。异步返回VideoRecorder实例,失败时返回null。可用于录制视频媒体。 | | Promise<[VideoRecorder](#videorecorder9)> | Promise对象。异步返回VideoRecorder实例,失败时返回null。可用于录制视频媒体。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | --------- |
| 5400101 | No memory |
**示例:** **示例:**
```js ```js
...@@ -647,7 +667,7 @@ audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件 ...@@ -647,7 +667,7 @@ audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer **系统能力:** SystemCapability.Multimedia.Media.AudioPlayer
| 名称 | 类型 | 描述 | | 名称 | 类型 | 说明 |
| ------- | ------ | ---------------------------------------------- | | ------- | ------ | ---------------------------------------------- |
| idle | string | 音频播放空闲,dataload/reset成功后处于此状态。 | | idle | string | 音频播放空闲,dataload/reset成功后处于此状态。 |
| playing | string | 音频正在播放,play成功后处于此状态。 | | playing | string | 音频正在播放,play成功后处于此状态。 |
...@@ -703,9 +723,9 @@ setDisplaySurface(surfaceId: string, callback: AsyncCallback\<void>): void ...@@ -703,9 +723,9 @@ setDisplaySurface(surfaceId: string, callback: AsyncCallback\<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ------------------------- | | --------- | -------------------- | ---- | ------------------------- |
| surfaceId | string | 是 | SurfaceId | | surfaceId | string | 是 | SurfaceId |
| callback | function | 是 | 设置SurfaceId的回调方法。 | | callback | AsyncCallback\<void> | 是 | 设置SurfaceId的回调方法。 |
**示例:** **示例:**
...@@ -764,8 +784,8 @@ prepare(callback: AsyncCallback\<void>): void ...@@ -764,8 +784,8 @@ prepare(callback: AsyncCallback\<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| callback | function | 是 | 准备播放视频的回调方法。 | | callback | AsyncCallback\<void> | 是 | 准备播放视频的回调方法。 |
**示例:** **示例:**
...@@ -814,8 +834,8 @@ play(callback: AsyncCallback\<void>): void; ...@@ -814,8 +834,8 @@ play(callback: AsyncCallback\<void>): void;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| callback | function | 是 | 开始播放视频的回调方法。 | | callback | AsyncCallback\<void> | 是 | 开始播放视频的回调方法。 |
**示例:** **示例:**
...@@ -864,8 +884,8 @@ pause(callback: AsyncCallback\<void>): void ...@@ -864,8 +884,8 @@ pause(callback: AsyncCallback\<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| callback | function | 是 | 暂停播放视频的回调方法。 | | callback | AsyncCallback\<void> | 是 | 暂停播放视频的回调方法。 |
**示例:** **示例:**
...@@ -914,8 +934,8 @@ stop(callback: AsyncCallback\<void>): void ...@@ -914,8 +934,8 @@ stop(callback: AsyncCallback\<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| callback | function | 是 | 停止播放视频的回调方法。 | | callback | AsyncCallback\<void> | 是 | 停止播放视频的回调方法。 |
**示例:** **示例:**
...@@ -964,8 +984,8 @@ reset(callback: AsyncCallback\<void>): void ...@@ -964,8 +984,8 @@ reset(callback: AsyncCallback\<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| callback | function | 是 | 切换播放视频的回调方法。 | | callback | AsyncCallback\<void> | 是 | 切换播放视频的回调方法。 |
**示例:** **示例:**
...@@ -1014,9 +1034,9 @@ seek(timeMs: number, callback: AsyncCallback\<number>): void ...@@ -1014,9 +1034,9 @@ seek(timeMs: number, callback: AsyncCallback\<number>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围为[0, duration]。 | | timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围为[0, duration]。 |
| callback | function | 是 | 跳转到指定播放位置的回调方法。 | | callback | AsyncCallback\<number> | 是 | 跳转到指定播放位置的回调方法。 |
**示例:** **示例:**
...@@ -1045,7 +1065,7 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void ...@@ -1045,7 +1065,7 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
| -------- | ---------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围为[0, duration]。 | | timeMs | number | 是 | 指定的跳转时间节点,单位毫秒(ms),取值范围为[0, duration]。 |
| mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 | | mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 |
| callback | function | 是 | 跳转到指定播放位置的回调方法。 | | callback | AsyncCallback\<number> | 是 | 跳转到指定播放位置的回调方法。 |
**示例:** **示例:**
...@@ -1111,9 +1131,9 @@ setVolume(vol: number, callback: AsyncCallback\<void>): void ...@@ -1111,9 +1131,9 @@ setVolume(vol: number, callback: AsyncCallback\<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ | | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| vol | number | 是 | 指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。 | | vol | number | 是 | 指定的相对音量大小,取值范围为[0.00-1.00],1表示最大音量,即100%。 |
| callback | function | 是 | 设置音量的回调方法。 | | callback | AsyncCallback\<void> | 是 | 设置音量的回调方法。 |
**示例:** **示例:**
...@@ -1170,8 +1190,8 @@ release(callback: AsyncCallback\<void>): void ...@@ -1170,8 +1190,8 @@ release(callback: AsyncCallback\<void>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| callback | function | 是 | 释放视频资源的回调方法。 | | callback | AsyncCallback\<void> | 是 | 释放视频资源的回调方法。 |
**示例:** **示例:**
...@@ -1296,9 +1316,9 @@ setSpeed(speed:number, callback: AsyncCallback\<number>): void ...@@ -1296,9 +1316,9 @@ setSpeed(speed:number, callback: AsyncCallback\<number>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ---------------------------------------------------------- | | -------- | ---------------------- | ---- | ---------------------------------------------------------- |
| speed | number | 是 | 指定播放视频速度,具体见[PlaybackSpeed](#playbackspeed8)。 | | speed | number | 是 | 指定播放视频速度,具体见[PlaybackSpeed](#playbackspeed8)。 |
| callback | function | 是 | 设置播放速度的回调方法。 | | callback | AsyncCallback\<number> | 是 | 设置播放速度的回调方法。 |
**示例:** **示例:**
...@@ -1348,65 +1368,6 @@ videoPlayer.setSpeed(speed).then(() => { ...@@ -1348,65 +1368,6 @@ videoPlayer.setSpeed(speed).then(() => {
}); });
``` ```
### selectBitrate<sup>9+</sup>
selectBitrate(bitrate:number, callback: AsyncCallback\<number>): void
通过回调方式设置码率,通过[availableBitratesCollect](#onavailablebitratescollect9)获取当前码流支持的Bitrate。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------------------------- |
| bitrate | number | 是 | 指定码率播放,用于hls多码率场景,单位为bps。 |
| callback | AsyncCallback\<number> | 是 | 设置播放码率的回调方法,返回设置的值表示成功,其他则失败。 |
**示例:**
```js
let bitrate = 1024000;
videoPlayer.selectBitrate(bitrate, (err, result) => {
if (err == null) {
console.info('selectBitrate success!');
} else {
console.info('selectBitrate fail!');
}
});
```
### selectBitrate<sup>9+</sup>
selectBitrate(bitrate:number): Promise\<number>
通过Promise方式设置码率,通过[availableBitratesCollect](#onavailablebitratescollect9)获取当前码流支持的Bitrate。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------------------------------- |
| bitrate | number | 是 | 指定播放码率,用于hls多码率场景,单位为bps。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | --------------------------- |
| Promise\<number> | 指定播放码率Promise返回值。 |
**示例:**
```js
let bitrate = 1024000;
videoPlayer.selectBitrate(bitrate).then(() => {
console.info('selectBitrate success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
});
```
### on('playbackCompleted')<sup>8+</sup> ### on('playbackCompleted')<sup>8+</sup>
on(type: 'playbackCompleted', callback: Callback\<void>): void on(type: 'playbackCompleted', callback: Callback\<void>): void
...@@ -1556,7 +1517,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { ...@@ -1556,7 +1517,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => {
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer **系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
| 名称 | 类型 | 描述 | | 名称 | 类型 | 说明 |
| -------- | ------ | -------------- | | -------- | ------ | -------------- |
| idle | string | 视频播放空闲。 | | idle | string | 视频播放空闲。 |
| prepared | string | 视频播放准备。 | | prepared | string | 视频播放准备。 |
...@@ -1571,7 +1532,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { ...@@ -1571,7 +1532,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => {
**系统能力:** SystemCapability.Multimedia.Media.Core **系统能力:** SystemCapability.Multimedia.Media.Core
| 名称 | 值 | 描述 | | 名称 | 值 | 说明 |
| -------------- | ---- | ------------------------------------------------------------ | | -------------- | ---- | ------------------------------------------------------------ |
| SEEK_NEXT_SYNC | 0 | 表示跳转到指定时间点的下一个关键帧,建议向后快进的时候用这个枚举值。 | | SEEK_NEXT_SYNC | 0 | 表示跳转到指定时间点的下一个关键帧,建议向后快进的时候用这个枚举值。 |
| SEEK_PREV_SYNC | 1 | 表示跳转到指定时间点的上一个关键帧,建议向前快进的时候用这个枚举值。 | | SEEK_PREV_SYNC | 1 | 表示跳转到指定时间点的上一个关键帧,建议向前快进的时候用这个枚举值。 |
...@@ -1582,7 +1543,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { ...@@ -1582,7 +1543,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => {
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer **系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
| 名称 | 值 | 描述 | | 名称 | 值 | 说明 |
| -------------------- | ---- | ------------------------------ | | -------------------- | ---- | ------------------------------ |
| SPEED_FORWARD_0_75_X | 0 | 表示视频播放正常播速的0.75倍。 | | SPEED_FORWARD_0_75_X | 0 | 表示视频播放正常播速的0.75倍。 |
| SPEED_FORWARD_1_00_X | 1 | 表示视频播放正常播速。 | | SPEED_FORWARD_1_00_X | 1 | 表示视频播放正常播速。 |
...@@ -1596,7 +1557,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { ...@@ -1596,7 +1557,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => {
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer **系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
| 名称 | 默认值 | 描述 | | 名称 | 值 | 说明 |
| ---------------------------- | ------ | ---------- | | ---------------------------- | ------ | ---------- |
| VIDEO_SCALE_TYPE_FIT | 0 | 视频拉伸至与窗口等大。 | | VIDEO_SCALE_TYPE_FIT | 0 | 视频拉伸至与窗口等大。 |
| VIDEO_SCALE_TYPE_FIT_CROP| 1 | 保持视频宽高比拉伸至填满窗口,内容可能会有裁剪。 | | VIDEO_SCALE_TYPE_FIT_CROP| 1 | 保持视频宽高比拉伸至填满窗口,内容可能会有裁剪。 |
...@@ -1869,7 +1830,7 @@ audioRecorder.prepare(audioRecorderConfig); // prepar ...@@ -1869,7 +1830,7 @@ audioRecorder.prepare(audioRecorderConfig); // prepar
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder **系统能力:** SystemCapability.Multimedia.Media.AudioRecorder
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | --------------------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| audioEncoder<sup>(deprecated)</sup> | [AudioEncoder](#audioencoder) | 否 | 音频编码格式,默认设置为AAC_LC。<br/>**说明:** 从API Version 8 开始废弃,建议使用audioEncoderMime替代。 | | audioEncoder<sup>(deprecated)</sup> | [AudioEncoder](#audioencoder) | 否 | 音频编码格式,默认设置为AAC_LC。<br/>**说明:** 从API Version 8 开始废弃,建议使用audioEncoderMime替代。 |
| audioEncodeBitRate | number | 否 | 音频编码比特率,默认值为48000。 | | audioEncodeBitRate | number | 否 | 音频编码比特率,默认值为48000。 |
...@@ -1890,8 +1851,8 @@ audioRecorder.prepare(audioRecorderConfig); // prepar ...@@ -1890,8 +1851,8 @@ audioRecorder.prepare(audioRecorderConfig); // prepar
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder **系统能力:** SystemCapability.Multimedia.Media.AudioRecorder
| 名称 | 默认值 | 说明 | | 名称 | | 说明 |
| ------- | ------ | ------------------------------------------------------------ | | ------- | ---- | ------------------------------------------------------------ |
| DEFAULT | 0 | 默认编码格式。<br/>仅做接口定义,暂不支持使用。 | | DEFAULT | 0 | 默认编码格式。<br/>仅做接口定义,暂不支持使用。 |
| AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。<br/>仅做接口定义,暂不支持使用。 | | AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。<br/>仅做接口定义,暂不支持使用。 |
| AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。<br/>仅做接口定义,暂不支持使用。 | | AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。<br/>仅做接口定义,暂不支持使用。 |
...@@ -1908,8 +1869,8 @@ audioRecorder.prepare(audioRecorderConfig); // prepar ...@@ -1908,8 +1869,8 @@ audioRecorder.prepare(audioRecorderConfig); // prepar
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder **系统能力:** SystemCapability.Multimedia.Media.AudioRecorder
| 名称 | 默认值 | 说明 | | 名称 | | 说明 |
| -------- | ------ | ------------------------------------------------------------ | | -------- | ---- | ------------------------------------------------------------ |
| DEFAULT | 0 | 默认封装格式。<br/>仅做接口定义,暂不支持使用。 | | DEFAULT | 0 | 默认封装格式。<br/>仅做接口定义,暂不支持使用。 |
| MPEG_4 | 2 | 封装为MPEG-4格式。 | | MPEG_4 | 2 | 封装为MPEG-4格式。 |
| AMR_NB | 3 | 封装为AMR_NB格式。<br/>仅做接口定义,暂不支持使用。 | | AMR_NB | 3 | 封装为AMR_NB格式。<br/>仅做接口定义,暂不支持使用。 |
...@@ -1926,6 +1887,8 @@ audioRecorder.prepare(audioRecorderConfig); // prepar ...@@ -1926,6 +1887,8 @@ audioRecorder.prepare(audioRecorderConfig); // prepar
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | -------------------------------------- | ---- | ---- | ---------------- | | ------------------ | -------------------------------------- | ---- | ---- | ---------------- |
| state<sup>9+</sup> | [VideoRecordState](#videorecordstate9) | 是 | 否 | 视频录制的状态。 | | state<sup>9+</sup> | [VideoRecordState](#videorecordstate9) | 是 | 否 | 视频录制的状态。 |
...@@ -1940,6 +1903,8 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void; ...@@ -1940,6 +1903,8 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1947,6 +1912,17 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void; ...@@ -1947,6 +1912,17 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
| config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 | | config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 |
| callback | AsyncCallback\<void> | 是 | 异步视频录制prepare方法的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步视频录制prepare方法的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied |
| 401 | Parameter error |
| 5400102 | Operate not permit |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -1992,6 +1968,8 @@ prepare(config: VideoRecorderConfig): Promise\<void>; ...@@ -1992,6 +1968,8 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -2004,6 +1982,17 @@ prepare(config: VideoRecorderConfig): Promise\<void>; ...@@ -2004,6 +1982,17 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
| -------------- | ---------------------------------------- | | -------------- | ---------------------------------------- |
| Promise\<void> | 异步视频录制prepare方法的Promise返回值。 | | Promise\<void> | 异步视频录制prepare方法的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied |
| 401 | Parameter error |
| 5400102 | Operate not permit |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2049,12 +2038,24 @@ getInputSurface(callback: AsyncCallback\<string>): void; ...@@ -2049,12 +2038,24 @@ getInputSurface(callback: AsyncCallback\<string>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------- | | -------- | ---------------------- | ---- | --------------------------- |
| callback | AsyncCallback\<string> | 是 | 异步获得surface的回调方法。 | | callback | AsyncCallback\<string> | 是 | 异步获得surface的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2082,12 +2083,24 @@ getInputSurface(): Promise\<string>; ...@@ -2082,12 +2083,24 @@ getInputSurface(): Promise\<string>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | -------------------------------- | | ---------------- | -------------------------------- |
| Promise\<string> | 异步获得surface的Promise返回值。 | | Promise\<string> | 异步获得surface的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2111,12 +2124,24 @@ start(callback: AsyncCallback\<void>): void; ...@@ -2111,12 +2124,24 @@ start(callback: AsyncCallback\<void>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步开始视频录制的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步开始视频录制的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2140,12 +2165,24 @@ start(): Promise\<void>; ...@@ -2140,12 +2165,24 @@ start(): Promise\<void>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------------------- | | -------------- | ------------------------------------- |
| Promise\<void> | 异步开始视频录制方法的Promise返回值。 | | Promise\<void> | 异步开始视频录制方法的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2167,12 +2204,24 @@ pause(callback: AsyncCallback\<void>): void; ...@@ -2167,12 +2204,24 @@ pause(callback: AsyncCallback\<void>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步暂停视频录制的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步暂停视频录制的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2196,12 +2245,24 @@ pause(): Promise\<void>; ...@@ -2196,12 +2245,24 @@ pause(): Promise\<void>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------------------- | | -------------- | ------------------------------------- |
| Promise\<void> | 异步暂停视频录制方法的Promise返回值。 | | Promise\<void> | 异步暂停视频录制方法的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2221,12 +2282,24 @@ resume(callback: AsyncCallback\<void>): void; ...@@ -2221,12 +2282,24 @@ resume(callback: AsyncCallback\<void>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步恢复视频录制的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步恢复视频录制的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2248,12 +2321,24 @@ resume(): Promise\<void>; ...@@ -2248,12 +2321,24 @@ resume(): Promise\<void>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------------------- | | -------------- | ------------------------------------- |
| Promise\<void> | 异步恢复视频录制方法的Promise返回值。 | | Promise\<void> | 异步恢复视频录制方法的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2275,12 +2360,24 @@ stop(callback: AsyncCallback\<void>): void; ...@@ -2275,12 +2360,24 @@ stop(callback: AsyncCallback\<void>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步停止视频录制的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步停止视频录制的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2304,12 +2401,24 @@ stop(): Promise\<void>; ...@@ -2304,12 +2401,24 @@ stop(): Promise\<void>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------------------- | | -------------- | ------------------------------------- |
| Promise\<void> | 异步停止视频录制方法的Promise返回值。 | | Promise\<void> | 异步停止视频录制方法的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 5400102 | Operate not permit |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2329,12 +2438,22 @@ release(callback: AsyncCallback\<void>): void; ...@@ -2329,12 +2438,22 @@ release(callback: AsyncCallback\<void>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------------------- | | -------- | -------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步释放视频录制资源的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步释放视频录制资源的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------ |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2356,12 +2475,22 @@ release(): Promise\<void>; ...@@ -2356,12 +2475,22 @@ release(): Promise\<void>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ----------------------------------------- | | -------------- | ----------------------------------------- |
| Promise\<void> | 异步释放视频录制资源方法的Promise返回值。 | | Promise\<void> | 异步释放视频录制资源方法的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------ |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2383,12 +2512,23 @@ reset(callback: AsyncCallback\<void>): void; ...@@ -2383,12 +2512,23 @@ reset(callback: AsyncCallback\<void>): void;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- | | -------- | -------------------- | ---- | ---------------------------- |
| callback | AsyncCallback\<void> | 是 | 异步重置视频录制的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步重置视频录制的回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------ |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2412,12 +2552,23 @@ reset(): Promise\<void>; ...@@ -2412,12 +2552,23 @@ reset(): Promise\<void>;
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------------------- | | -------------- | ------------------------------------- |
| Promise\<void> | 异步重置视频录制方法的Promise返回值。 | | Promise\<void> | 异步重置视频录制方法的Promise返回值。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------ |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2444,6 +2595,15 @@ on(type: 'error', callback: ErrorCallback): void ...@@ -2444,6 +2595,15 @@ on(type: 'error', callback: ErrorCallback): void
| type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error':视频录制过程中发生错误,触发该事件。 | | type | string | 是 | 录制错误事件回调类型'error'。<br/>-&nbsp;'error':视频录制过程中发生错误,触发该事件。 |
| callback | ErrorCallback | 是 | 录制错误事件回调方法。 | | callback | ErrorCallback | 是 | 录制错误事件回调方法。 |
**错误码:**
以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md)
| 错误码ID | 错误信息 |
| -------- | ------------ |
| 5400103 | IO error |
| 5400105 | Service died |
**示例:** **示例:**
```js ```js
...@@ -2459,7 +2619,7 @@ videoRecorder.on('error', (error) => { // 设 ...@@ -2459,7 +2619,7 @@ videoRecorder.on('error', (error) => { // 设
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
| 名称 | 类型 | 描述 | | 名称 | 类型 | 说明 |
| -------- | ------ | ---------------------- | | -------- | ------ | ---------------------- |
| idle | string | 视频录制空闲。 | | idle | string | 视频录制空闲。 |
| prepared | string | 视频录制参数设置完成。 | | prepared | string | 视频录制参数设置完成。 |
...@@ -2474,14 +2634,16 @@ videoRecorder.on('error', (error) => { // 设 ...@@ -2474,14 +2634,16 @@ videoRecorder.on('error', (error) => { // 设
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
| 名称 | 参数类型 | 必填 | 说明 | **系统接口:** 该接口为系统接口
| 名称 | 类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ | | --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType | [AudioSourceType](#audiosourcetype9) | 是 | 视频录制的音频源类型。 | | audioSourceType | [AudioSourceType](#audiosourcetype9) | 是 | 视频录制的音频源类型。 |
| videoSourceType | [VideoSourceType](#videosourcetype9) | 是 | 视频录制的视频源类型。 | | videoSourceType | [VideoSourceType](#videosourcetype9) | 是 | 视频录制的视频源类型。 |
| profile | [VideoRecorderProfile](#videorecorderprofile9) | 是 | 视频录制的profile。 | | profile | [VideoRecorderProfile](#videorecorderprofile9) | 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 | | rotation | number | 否 | 录制视频的旋转角度。 |
| location | [Location](#location) | 否 | 录制视频的地理位置。 | | location | [Location](#location) | 否 | 录制视频的地理位置。 |
| url | string | 是 | 视频输出URL:fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png)| | url | string | 是 | 视频输出URL:fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) |
## AudioSourceType<sup>9+</sup> ## AudioSourceType<sup>9+</sup>
...@@ -2489,6 +2651,8 @@ videoRecorder.on('error', (error) => { // 设 ...@@ -2489,6 +2651,8 @@ videoRecorder.on('error', (error) => { // 设
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------------------- | ---- | ---------------------- | | ------------------------- | ---- | ---------------------- |
| AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 | | AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 |
...@@ -2500,6 +2664,8 @@ videoRecorder.on('error', (error) => { // 设 ...@@ -2500,6 +2664,8 @@ videoRecorder.on('error', (error) => { // 设
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
**系统接口:** 该接口为系统接口
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------- | | ----------------------------- | ---- | ------------------------------- |
| VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 | | VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 |
...@@ -2511,7 +2677,9 @@ videoRecorder.on('error', (error) => { // 设 ...@@ -2511,7 +2677,9 @@ videoRecorder.on('error', (error) => { // 设
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder **系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
| 名称 | 参数类型 | 必填 | 说明 | **系统接口:** 该接口为系统接口
| 名称 | 类型 | 必填 | 说明 |
| ---------------- | -------------------------------------------- | ---- | ---------------- | | ---------------- | -------------------------------------------- | ---- | ---------------- |
| audioBitrate | number | 是 | 音频编码比特率。 | | audioBitrate | number | 是 | 音频编码比特率。 |
| audioChannels | number | 是 | 音频采集声道数。 | | audioChannels | number | 是 | 音频采集声道数。 |
...@@ -2541,7 +2709,7 @@ videoRecorder.on('error', (error) => { // 设 ...@@ -2541,7 +2709,7 @@ videoRecorder.on('error', (error) => { // 设
**系统能力:** SystemCapability.Multimedia.Media.Core **系统能力:** SystemCapability.Multimedia.Media.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | ---------------- | | --------- | ------ | ---- | ---------------- |
| latitude | number | 是 | 地理位置的纬度。 | | latitude | number | 是 | 地理位置的纬度。 |
| longitude | number | 是 | 地理位置的经度。 | | longitude | number | 是 | 地理位置的经度。 |
\ No newline at end of file
# Media错误码
## 5400101 内存分配失败
**错误信息**
No memory.
**错误描述**
分配内存失败。
**可能原因**
1. 实例数量超过16个。
2. new或者malloc流程失败导致空指针。
**处理步骤**
销毁当前实例,并重新创建,如果重新创建失败,则停止相关操作。
## 5400102 当前状态机不支持此操作
**错误信息**
Operate not permit.
**错误描述**
当前操作不允许。
**可能原因**
当前状态机不支持此操作。
**处理步骤**
确认当前状态是否支持当前操作,把实例切换到正确的状态进行正确的操作。
## 5400103 出现IO错误
**错误信息**
IO error.
**错误描述**
出现IO错误。
**可能原因**
媒体与其他模块的数据交互发生问题(图形、音频、网络、HDI、相机)。
**处理步骤**
确认网络是否通畅,并销毁当前实例,并重新创建,如果重新创建失败,则停止相关操作。
## 5400104 操作超时
**错误信息**
Time out.
**错误描述**
操作超时。
**可能原因**
1. 网络超时。
2. 访问其他模块超时。
**处理步骤**
1. 确认网络是否通畅。
2. 销毁当前实例,并重新创建,如果重新创建失败,则停止相关操作。
## 5400105 播放服务死亡
**错误信息**
Service died.
**错误描述**
播放服务死亡。
**可能原因**
播放服务死亡。
**处理步骤**
销毁当前实例,并重新创建,如果重新创建失败,则停止相关操作。
## 5400106 不支持的规格
**错误信息**
Unsupport format.
**错误描述**
不支持的规格。
**可能原因**
不支持的文件或者格式。
**处理步骤**
当前使用的格式规格不支持,用户需要切换为支持的规格。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册