diff --git a/zh-cn/application-dev/reference/apis/js-apis-media.md b/zh-cn/application-dev/reference/apis/js-apis-media.md index 816a9f9d80a8d811fbe66db76b64d10ad1f85415..7973a972c1d8e675f806db36c2bd818688d3a60d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-media.md +++ b/zh-cn/application-dev/reference/apis/js-apis-media.md @@ -130,12 +130,22 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder9)>): **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------- | ---- | ------------------------------ | | callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 回调函数。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | --------- | +| 5400101 | No memory | + **示例：** ```js @@ -160,12 +170,22 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder9)> **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | ----------------------------------------- | ------------------------------------------------------------ | | Promise<[VideoRecorder](#videorecorder9)> | Promise对象。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | --------- | +| 5400101 | No memory | + **示例：** ```js @@ -647,7 +667,7 @@ audioPlayer.setVolume(3); //设置volume为无效值，触发'error'事件 **系统能力：** SystemCapability.Multimedia.Media.AudioPlayer -| 名称 | 类型 | 描述 | +| 名称 | 类型 | 说明 | | ------- | ------ | ---------------------------------------------- | | idle | string | 音频播放空闲，dataload/reset成功后处于此状态。 | | playing | string | 音频正在播放，play成功后处于此状态。 | @@ -702,10 +722,10 @@ setDisplaySurface(surfaceId: string, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | -------- | ---- | ------------------------- | -| surfaceId | string | 是 | SurfaceId | -| callback | function | 是 | 设置SurfaceId的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | -------------------- | ---- | ------------------------- | +| surfaceId | string | 是 | SurfaceId | +| callback | AsyncCallback\ | 是 | 设置SurfaceId的回调方法。 | **示例：** @@ -763,9 +783,9 @@ prepare(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------ | -| callback | function | 是 | 准备播放视频的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback\ | 是 | 准备播放视频的回调方法。 | **示例：** @@ -813,9 +833,9 @@ play(callback: AsyncCallback\): void; **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------ | -| callback | function | 是 | 开始播放视频的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback\ | 是 | 开始播放视频的回调方法。 | **示例：** @@ -863,9 +883,9 @@ pause(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------ | -| callback | function | 是 | 暂停播放视频的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback\ | 是 | 暂停播放视频的回调方法。 | **示例：** @@ -913,9 +933,9 @@ stop(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------ | -| callback | function | 是 | 停止播放视频的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback\ | 是 | 停止播放视频的回调方法。 | **示例：** @@ -963,9 +983,9 @@ reset(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------ | -| callback | function | 是 | 切换播放视频的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback\ | 是 | 切换播放视频的回调方法。 | **示例：** @@ -1013,10 +1033,10 @@ seek(timeMs: number, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------------------------------------------ | -| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 | -| callback | function | 是 | 跳转到指定播放位置的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------------------------------------------------ | +| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 | +| callback | AsyncCallback\ | 是 | 跳转到指定播放位置的回调方法。 | **示例：** @@ -1045,7 +1065,7 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\): void | -------- | ---------------------- | ---- | ------------------------------------------------------------ | | timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围为[0, duration]。 | | mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 | -| callback | function | 是 | 跳转到指定播放位置的回调方法。 | +| callback | AsyncCallback\ | 是 | 跳转到指定播放位置的回调方法。 | **示例：** @@ -1110,10 +1130,10 @@ setVolume(vol: number, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------------------------------------------ | -| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 | -| callback | function | 是 | 设置音量的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------------------------------------------ | +| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 | +| callback | AsyncCallback\ | 是 | 设置音量的回调方法。 | **示例：** @@ -1169,9 +1189,9 @@ release(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------ | -| callback | function | 是 | 释放视频资源的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback\ | 是 | 释放视频资源的回调方法。 | **示例：** @@ -1295,10 +1315,10 @@ setSpeed(speed:number, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ---------------------------------------------------------- | -| speed | number | 是 | 指定播放视频速度，具体见[PlaybackSpeed](#playbackspeed8)。 | -| callback | function | 是 | 设置播放速度的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ---------------------------------------------------------- | +| speed | number | 是 | 指定播放视频速度，具体见[PlaybackSpeed](#playbackspeed8)。 | +| callback | AsyncCallback\ | 是 | 设置播放速度的回调方法。 | **示例：** @@ -1348,65 +1368,6 @@ videoPlayer.setSpeed(speed).then(() => { }); ``` -### selectBitrate9+ - -selectBitrate(bitrate:number, callback: AsyncCallback\): void - -通过回调方式设置码率，通过[availableBitratesCollect](#onavailablebitratescollect9)获取当前码流支持的Bitrate。 - -**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ---------------------------------------------------------- | -| bitrate | number | 是 | 指定码率播放，用于hls多码率场景，单位为bps。 | -| callback | AsyncCallback\ | 是 | 设置播放码率的回调方法，返回设置的值表示成功，其他则失败。 | - -**示例：** - -```js -let bitrate = 1024000; -videoPlayer.selectBitrate(bitrate, (err, result) => { - if (err == null) { - console.info('selectBitrate success!'); - } else { - console.info('selectBitrate fail!'); - } -}); -``` - -### selectBitrate9+ - -selectBitrate(bitrate:number): Promise\ - -通过Promise方式设置码率，通过[availableBitratesCollect](#onavailablebitratescollect9)获取当前码流支持的Bitrate。 - -**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------ | ---- | -------------------------------------------- | -| bitrate | number | 是 | 指定播放码率，用于hls多码率场景，单位为bps。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | --------------------------- | -| Promise\ | 指定播放码率Promise返回值。 | - -**示例：** - -```js -let bitrate = 1024000; -videoPlayer.selectBitrate(bitrate).then(() => { - console.info('selectBitrate success'); -}).catch((error) => { - console.info(`video catchCallback, error:${error}`); -}); -``` - ### on('playbackCompleted')8+ on(type: 'playbackCompleted', callback: Callback\): void @@ -1556,7 +1517,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer -| 名称 | 类型 | 描述 | +| 名称 | 类型 | 说明 | | -------- | ------ | -------------- | | idle | string | 视频播放空闲。 | | prepared | string | 视频播放准备。 | @@ -1571,7 +1532,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { **系统能力：** SystemCapability.Multimedia.Media.Core -| 名称 | 值 | 描述 | +| 名称 | 值 | 说明 | | -------------- | ---- | ------------------------------------------------------------ | | SEEK_NEXT_SYNC | 0 | 表示跳转到指定时间点的下一个关键帧，建议向后快进的时候用这个枚举值。 | | SEEK_PREV_SYNC | 1 | 表示跳转到指定时间点的上一个关键帧，建议向前快进的时候用这个枚举值。 | @@ -1582,7 +1543,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer -| 名称 | 值 | 描述 | +| 名称 | 值 | 说明 | | -------------------- | ---- | ------------------------------ | | SPEED_FORWARD_0_75_X | 0 | 表示视频播放正常播速的0.75倍。 | | SPEED_FORWARD_1_00_X | 1 | 表示视频播放正常播速。 | @@ -1596,7 +1557,7 @@ videoPlayer.on('availableBitratesCollect', (bitrates) => { **系统能力：** SystemCapability.Multimedia.Media.VideoPlayer -| 名称 | 默认值 | 描述 | +| 名称 | 值 | 说明 | | ---------------------------- | ------ | ---------- | | VIDEO_SCALE_TYPE_FIT | 0 | 视频拉伸至与窗口等大。 | | VIDEO_SCALE_TYPE_FIT_CROP| 1 | 保持视频宽高比拉伸至填满窗口，内容可能会有裁剪。 | @@ -1869,7 +1830,7 @@ audioRecorder.prepare(audioRecorderConfig); // prepar **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------------------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | audioEncoder(deprecated) | [AudioEncoder](#audioencoder) | 否 | 音频编码格式，默认设置为AAC_LC。
**说明：** 从API Version 8 开始废弃，建议使用audioEncoderMime替代。 | | audioEncodeBitRate | number | 否 | 音频编码比特率，默认值为48000。 | @@ -1890,13 +1851,13 @@ audioRecorder.prepare(audioRecorderConfig); // prepar **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder -| 名称 | 默认值 | 说明 | -| ------- | ------ | ------------------------------------------------------------ | -| DEFAULT | 0 | 默认编码格式。
仅做接口定义，暂不支持使用。 | -| AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。
仅做接口定义，暂不支持使用。 | -| AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。
仅做接口定义，暂不支持使用。 | -| AAC_LC | 3 | AAC-LC（Advanced Audio Coding Low Complexity）编码格式。 | -| HE_AAC | 4 | HE_AAC（High-Efficiency Advanced Audio Coding）编码格式。
仅做接口定义，暂不支持使用。 | +| 名称 | 值 | 说明 | +| ------- | ---- | ------------------------------------------------------------ | +| DEFAULT | 0 | 默认编码格式。
仅做接口定义，暂不支持使用。 | +| AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。
仅做接口定义，暂不支持使用。 | +| AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。
仅做接口定义，暂不支持使用。 | +| AAC_LC | 3 | AAC-LC（Advanced Audio Coding Low Complexity）编码格式。 | +| HE_AAC | 4 | HE_AAC（High-Efficiency Advanced Audio Coding）编码格式。
仅做接口定义，暂不支持使用。 | ## AudioOutputFormat(deprecated) @@ -1908,13 +1869,13 @@ audioRecorder.prepare(audioRecorderConfig); // prepar **系统能力：** SystemCapability.Multimedia.Media.AudioRecorder -| 名称 | 默认值 | 说明 | -| -------- | ------ | ------------------------------------------------------------ | -| DEFAULT | 0 | 默认封装格式。
仅做接口定义，暂不支持使用。 | -| MPEG_4 | 2 | 封装为MPEG-4格式。 | -| AMR_NB | 3 | 封装为AMR_NB格式。
仅做接口定义，暂不支持使用。 | -| AMR_WB | 4 | 封装为AMR_WB格式。
仅做接口定义，暂不支持使用。 | -| AAC_ADTS | 6 | 封装为ADTS（Audio Data Transport Stream）格式，是AAC音频的传输流格式。 | +| 名称 | 值 | 说明 | +| -------- | ---- | ------------------------------------------------------------ | +| DEFAULT | 0 | 默认封装格式。
仅做接口定义，暂不支持使用。 | +| MPEG_4 | 2 | 封装为MPEG-4格式。 | +| AMR_NB | 3 | 封装为AMR_NB格式。
仅做接口定义，暂不支持使用。 | +| AMR_WB | 4 | 封装为AMR_WB格式。
仅做接口定义，暂不支持使用。 | +| AAC_ADTS | 6 | 封装为ADTS（Audio Data Transport Stream）格式，是AAC音频的传输流格式。 | ## VideoRecorder9+ @@ -1926,6 +1887,8 @@ audioRecorder.prepare(audioRecorderConfig); // prepar **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------ | -------------------------------------- | ---- | ---- | ---------------- | | state9+ | [VideoRecordState](#videorecordstate9) | 是 | 否 | 视频录制的状态。 | @@ -1940,6 +1903,8 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1947,6 +1912,17 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\): void; | config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 | | callback | AsyncCallback\ | 是 | 异步视频录制prepare方法的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 201 | Permission denied | +| 401 | Parameter error | +| 5400102 | Operate not permit | +| 5400105 | Service died | + **示例：** ```js @@ -1992,6 +1968,8 @@ prepare(config: VideoRecorderConfig): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2004,6 +1982,17 @@ prepare(config: VideoRecorderConfig): Promise\; | -------------- | ---------------------------------------- | | Promise\ | 异步视频录制prepare方法的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 201 | Permission denied | +| 401 | Parameter error | +| 5400102 | Operate not permit | +| 5400105 | Service died | + **示例：** ```js @@ -2049,12 +2038,24 @@ getInputSurface(callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | --------------------------- | | callback | AsyncCallback\ | 是 | 异步获得surface的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2082,12 +2083,24 @@ getInputSurface(): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | ---------------- | -------------------------------- | | Promise\ | 异步获得surface的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2111,12 +2124,24 @@ start(callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------- | | callback | AsyncCallback\ | 是 | 异步开始视频录制的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2140,12 +2165,24 @@ start(): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | -------------- | ------------------------------------- | | Promise\ | 异步开始视频录制方法的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2167,12 +2204,24 @@ pause(callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------- | | callback | AsyncCallback\ | 是 | 异步暂停视频录制的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2196,12 +2245,24 @@ pause(): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | -------------- | ------------------------------------- | | Promise\ | 异步暂停视频录制方法的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2221,12 +2282,24 @@ resume(callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------- | | callback | AsyncCallback\ | 是 | 异步恢复视频录制的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2248,12 +2321,24 @@ resume(): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | -------------- | ------------------------------------- | | Promise\ | 异步恢复视频录制方法的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2275,12 +2360,24 @@ stop(callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------- | | callback | AsyncCallback\ | 是 | 异步停止视频录制的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2304,12 +2401,24 @@ stop(): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | -------------- | ------------------------------------- | | Promise\ | 异步停止视频录制方法的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 5400102 | Operate not permit | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2329,12 +2438,22 @@ release(callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------------------- | | callback | AsyncCallback\ | 是 | 异步释放视频录制资源的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------ | +| 5400105 | Service died | + **示例：** ```js @@ -2356,12 +2475,22 @@ release(): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | -------------- | ----------------------------------------- | | Promise\ | 异步释放视频录制资源方法的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------ | +| 5400105 | Service died | + **示例：** ```js @@ -2383,12 +2512,23 @@ reset(callback: AsyncCallback\): void; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------- | | callback | AsyncCallback\ | 是 | 异步重置视频录制的回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------ | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2412,12 +2552,23 @@ reset(): Promise\; **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + **返回值：** | 类型 | 说明 | | -------------- | ------------------------------------- | | Promise\ | 异步重置视频录制方法的Promise返回值。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------ | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2444,6 +2595,15 @@ on(type: 'error', callback: ErrorCallback): void | type | string | 是 | 录制错误事件回调类型'error'。
- 'error'：视频录制过程中发生错误，触发该事件。 | | callback | ErrorCallback | 是 | 录制错误事件回调方法。 | +**错误码：** + +以下错误码的详细介绍请参见[媒体错误码](../errorcodes/errorcode-media.md) + +| 错误码ID | 错误信息 | +| -------- | ------------ | +| 5400103 | IO error | +| 5400105 | Service died | + **示例：** ```js @@ -2459,7 +2619,7 @@ videoRecorder.on('error', (error) => { // 设 **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder -| 名称 | 类型 | 描述 | +| 名称 | 类型 | 说明 | | -------- | ------ | ---------------------- | | idle | string | 视频录制空闲。 | | prepared | string | 视频录制参数设置完成。 | @@ -2474,14 +2634,16 @@ videoRecorder.on('error', (error) => { // 设 **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder -| 名称 | 参数类型 | 必填 | 说明 | +**系统接口：** 该接口为系统接口 + +| 名称 | 类型 | 必填 | 说明 | | --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ | | audioSourceType | [AudioSourceType](#audiosourcetype9) | 是 | 视频录制的音频源类型。 | | videoSourceType | [VideoSourceType](#videosourcetype9) | 是 | 视频录制的视频源类型。 | | profile | [VideoRecorderProfile](#videorecorderprofile9) | 是 | 视频录制的profile。 | | rotation | number | 否 | 录制视频的旋转角度。 | | location | [Location](#location) | 否 | 录制视频的地理位置。 | -| url | string | 是 | 视频输出URL：fd://xx (fd number)
![](figures/zh-cn_image_url.png)| +| url | string | 是 | 视频输出URL：fd://xx (fd number)
![](figures/zh-cn_image_url.png) | ## AudioSourceType9+ @@ -2489,6 +2651,8 @@ videoRecorder.on('error', (error) => { // 设 **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + | 名称 | 值 | 说明 | | ------------------------- | ---- | ---------------------- | | AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 | @@ -2500,6 +2664,8 @@ videoRecorder.on('error', (error) => { // 设 **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder +**系统接口：** 该接口为系统接口 + | 名称 | 值 | 说明 | | ----------------------------- | ---- | ------------------------------- | | VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 | @@ -2511,7 +2677,9 @@ videoRecorder.on('error', (error) => { // 设 **系统能力：** SystemCapability.Multimedia.Media.VideoRecorder -| 名称 | 参数类型 | 必填 | 说明 | +**系统接口：** 该接口为系统接口 + +| 名称 | 类型 | 必填 | 说明 | | ---------------- | -------------------------------------------- | ---- | ---------------- | | audioBitrate | number | 是 | 音频编码比特率。 | | audioChannels | number | 是 | 音频采集声道数。 | @@ -2541,7 +2709,7 @@ videoRecorder.on('error', (error) => { // 设 **系统能力：** SystemCapability.Multimedia.Media.Core -| 名称 | 参数类型 | 必填 | 说明 | -| --------- | -------- | ---- | ---------------- | -| latitude | number | 是 | 地理位置的纬度。 | -| longitude | number | 是 | 地理位置的经度。 | \ No newline at end of file +| 名称 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ---------------- | +| latitude | number | 是 | 地理位置的纬度。 | +| longitude | number | 是 | 地理位置的经度。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-media.md b/zh-cn/application-dev/reference/errorcodes/errorcode-media.md new file mode 100644 index 0000000000000000000000000000000000000000..92e19c242cc544f4f63a0187c0643eb2accb4528 --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-media.md @@ -0,0 +1,115 @@ +# 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. + +**错误描述** + +不支持的规格。 + +**可能原因** + +不支持的文件或者格式。 + +**处理步骤** + +当前使用的格式规格不支持，用户需要切换为支持的规格。 + + +