From 6d7f0aef8d7c867e7eb7f44042762bcdcca42c44 Mon Sep 17 00:00:00 2001 From: magekkkk Date: Thu, 24 Feb 2022 12:08:00 +0000 Subject: [PATCH] add syscap in media js reference Signed-off-by: magekkkk --- .../reference/apis/js-apis-media.md | 282 ++++++++++++++---- 1 file changed, 227 insertions(+), 55 deletions(-) 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 90b9f701b25..4cf8213c90d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-media.md +++ b/zh-cn/application-dev/reference/apis/js-apis-media.md @@ -23,7 +23,7 @@ createAudioPlayer(): [AudioPlayer](#audioplayer) 同步方式创建音频播放实例。 - +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer **返回值：** @@ -43,6 +43,8 @@ createAudioPlayerAsync(callback: AsyncCallback\<[AudioPlayer](#audioplayer)>): v 异步方式创建音频播放实例。通过注册回调函数获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -68,6 +70,8 @@ createAudioPlayerAsync: Promise<[AudioPlayer](#audioplayer)> 异步方式创建音频播放实例。通过Promise获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **返回值：** | 类型 | 说明 | @@ -100,6 +104,8 @@ createVideoPlayer(callback: AsyncCallback\<[VideoPlayer](#videoplayer8)>): void 异步方式创建视频播放实例，通过注册回调函数获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -125,6 +131,8 @@ createVideoPlayer: Promise<[VideoPlayer](#videoplayer8)> 异步方式创建视频播放实例，通过Promise获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -157,6 +165,8 @@ createAudioRecorder(): AudioRecorder 创建音频录制的实例来控制音频的录制。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **返回值:** | 类型 | 说明 | @@ -175,6 +185,8 @@ createAudioRecorderAsync(callback: AsyncCallback\<[AudioRecorder](#audiorecorder 异步方式创建音频录制实例。通过注册回调函数获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -200,6 +212,8 @@ createAudioRecorderAsync: Promise<[AudioRecorder](#audiorecorder)> 异步方式创建音频录制实例。通过Promise获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **返回值：** | 类型 | 说明 | @@ -232,6 +246,8 @@ createVideoRecorderAsync(callback: AsyncCallback\<[VideoRecorder](#videorecorder 异步方式创建视频录制实例。通过注册回调函数获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -257,6 +273,8 @@ createVideoRecorderAsync: Promise<[VideoRecorder](#videorecorder8)> 异步方式创建视频录制实例。通过Promise获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -291,16 +309,16 @@ await media.createVideoRecorderAsync.then((video) => { | 名称 | 值 | 说明 | | -------------------------- | ---- | -------------------------------------- | -| MSERR_OK | 0 | 表示操作成功。 | -| MSERR_NO_MEMORY | 1 | 表示申请内存失败，系统可能无可用内存。 | -| MSERR_OPERATION_NOT_PERMIT | 2 | 表示无权限执行此操作。 | -| MSERR_INVALID_VAL | 3 | 表示传入入参无效。 | -| MSERR_IO | 4 | 表示发生IO错误。 | -| MSERR_TIMEOUT | 5 | 表示操作超时。 | -| MSERR_UNKNOWN | 6 | 表示未知错误。 | -| MSERR_SERVICE_DIED | 7 | 表示服务端失效。 | -| MSERR_INVALID_STATE | 8 | 表示在当前状态下，不允许执行此操作。 | -| MSERR_UNSUPPORTED | 9 | 表示在当前版本下，不支持此操作。 | +| MSERR_OK | 0 | 表示操作成功。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_NO_MEMORY | 1 | 表示申请内存失败，系统可能无可用内存。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_OPERATION_NOT_PERMIT | 2 | 表示无权限执行此操作。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_INVALID_VAL | 3 | 表示传入入参无效。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_IO | 4 | 表示发生IO错误。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_TIMEOUT | 5 | 表示操作超时。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_UNKNOWN | 6 | 表示未知错误。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_SERVICE_DIED | 7 | 表示服务端失效。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_INVALID_STATE | 8 | 表示在当前状态下，不允许执行此操作。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MSERR_UNSUPPORTED | 9 | 表示在当前版本下，不支持此操作。
**系统能力**: SystemCapability.Multimedia.Media.Core | ## MediaType8+ @@ -308,9 +326,9 @@ await media.createVideoRecorderAsync.then((video) => { | 名称 | 值 | 说明 | | ------------------- | ---- | ------------------ | -| MEDIA_TYPE_AUD | 0 | 表示音频。 | -| MEDIA_TYPE_VID | 1 | 表示视频。 | -| MEDIA_TYPE_SUBTITLE | 2 | 表示字幕：开发中。 | +| MEDIA_TYPE_AUD | 0 | 表示音频。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MEDIA_TYPE_VID | 1 | 表示视频。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MEDIA_TYPE_SUBTITLE | 2 | 表示字幕：开发中。
**系统能力**: SystemCapability.Multimedia.Media.Core | ## CodecMimeType8+ @@ -318,11 +336,11 @@ Codec MIME类型枚举 | 名称 | 值 | 说明 | | ------------ | ----------------- | ------------------------ | -| VIDEO_MPEG4 | ”video/mp4v-es“ | 表示视频/mpeg4类型。 | -| AUDIO_MPEG | "audio/mpeg" | 表示音频/mpeg类型。 | -| AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。 | -| AUDIO_VORBIS | "audio/vorbis" | 表示音频/vorbis类型。 | -| AUDIO_FLAC | "audio/flac" | 表示音频/flac类型。 | +| VIDEO_MPEG4 | ”video/mp4v-es“ | 表示视频/mpeg4类型。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| AUDIO_MPEG | "audio/mpeg" | 表示音频/mpeg类型。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| AUDIO_AAC | "audio/mp4a-latm" | 表示音频/mp4a-latm类型。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| AUDIO_VORBIS | "audio/vorbis" | 表示音频/vorbis类型。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| AUDIO_FLAC | "audio/flac" | 表示音频/flac类型。
**系统能力**: SystemCapability.Multimedia.Media.Core | ## MediaDescriptionKey8+ @@ -330,16 +348,16 @@ Codec MIME类型枚举 | 名称 | 值 | 说明 | | ------------------------ | --------------- | ------------------------------------------------------------ | -| MD_KEY_TRACK_INDEX | "track_index" | 表示轨道序号，其对应键值类型为number。 | -| MD_KEY_TRACK_TYPE | "track_type" | 表示轨道类型，其对应键值类型为number，参考[MediaType](#mediatype8)。 | -| MD_KEY_CODEC_MIME | "codec_mime" | 表示codec_mime类型，其对应键值类型为string。 | -| MD_KEY_DURATION | "duration" | 表示媒体时长，其对应键值类型为number，单位为ms。 | -| MD_KEY_BITRATE | "bitrate" | 表示比特率，其对应键值类型为number，单位为bps。 | -| MD_KEY_WIDTH | "width" | 表示视频宽度，其对应键值类型为number，单位为像素。 | -| MD_KEY_HEIGHT | "height" | 表示视频高度，其对应键值类型为number，单位为像素。 | -| MD_KEY_FRAME_RATE | "frame_rate" | 表示视频帧率，其对应键值类型为number，单位为100fps。 | -| MD_KEY_AUD_CHANNEL_COUNT | "channel_count" | 表示声道数，其对应键值类型为number。 | -| MD_KEY_AUD_SAMPLE_RATE | "sample_rate" | 表示采样率，其对应键值类型为number，单位为HZ。 | +| MD_KEY_TRACK_INDEX | "track_index" | 表示轨道序号，其对应键值类型为number。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_TRACK_TYPE | "track_type" | 表示轨道类型，其对应键值类型为number，参考[MediaType](#mediatype8)。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_CODEC_MIME | "codec_mime" | 表示codec_mime类型，其对应键值类型为string。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_DURATION | "duration" | 表示媒体时长，其对应键值类型为number，单位为ms。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_BITRATE | "bitrate" | 表示比特率，其对应键值类型为number，单位为bps。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_WIDTH | "width" | 表示视频宽度，其对应键值类型为number，单位为像素。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_HEIGHT | "height" | 表示视频高度，其对应键值类型为number，单位为像素。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_FRAME_RATE | "frame_rate" | 表示视频帧率，其对应键值类型为number，单位为100fps。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_AUD_CHANNEL_COUNT | "channel_count" | 表示声道数，其对应键值类型为number。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| MD_KEY_AUD_SAMPLE_RATE | "sample_rate" | 表示采样率，其对应键值类型为number，单位为HZ。
**系统能力**: SystemCapability.Multimedia.Media.Core | ## BufferingInfoType8+ @@ -347,10 +365,10 @@ Codec MIME类型枚举 | 名称 | 值 | 说明 | | ----------------- | ---- | -------------------------- | -| BUFFERING_START | 1 | 表示开始缓存。 | -| BUFFERING_END | 2 | 表示结束缓存。 | -| BUFFERING_PERCENT | 3 | 表示缓存百分比。 | -| CACHED_DURATION | 4 | 表示缓存时长，单位为毫秒。 | +| BUFFERING_START | 1 | 表示开始缓存。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| BUFFERING_END | 2 | 表示结束缓存。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| BUFFERING_PERCENT | 3 | 表示缓存百分比。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| CACHED_DURATION | 4 | 表示缓存时长，单位为毫秒。
**系统能力**: SystemCapability.Multimedia.Media.Core | ## AudioPlayer @@ -362,11 +380,11 @@ Codec MIME类型枚举 | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ | -| src | string | 是 | 是 | 音频媒体URI，支持当前主流的音频格式(mp4、aac、mp3、ogg)。
**支持路径示例**：
1、本地绝对路径：file:///data/data/ohos.xxx.xxx/files/test.mp4
![zh-cn_image_0000001164217678](figures/zh-cn_image_0000001164217678.png)
2、http网络播放路径：开发中
3、hls网络播放路径：开发中
4、fd类型播放：开发中
**注意事项**：
媒体素材需至少赋予读权限后，才可正常播放 | -| loop | boolean | 是 | 是 | 音频循环播放属性，设置为'true'表示循环播放。 | -| currentTime | number | 是 | 否 | 音频的当前播放位置。 | -| duration | number | 是 | 否 | 音频时长。 | -| state | [AudioState](#audiostate) | 是 | 否 | 音频播放的状态。 | +| src | string | 是 | 是 | 音频媒体URI，支持当前主流的音频格式(mp4、aac、mp3、ogg)。
**支持路径示例**：
1、本地绝对路径：file:///data/data/ohos.xxx.xxx/files/test.mp4
![zh-cn_image_0000001164217678](figures/zh-cn_image_0000001164217678.png)
2、http网络播放路径：开发中
3、hls网络播放路径：开发中
4、fd类型播放：开发中
**注意事项**：
媒体素材需至少赋予读权限后，才可正常播放。
**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer | +| loop | boolean | 是 | 是 | 音频循环播放属性，设置为'true'表示循环播放。
**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer | +| currentTime | number | 是 | 否 | 音频的当前播放位置。
**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer | +| duration | number | 是 | 否 | 音频时长。
**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer | +| state | [AudioState](#audiostate) | 是 | 否 | 音频播放的状态。
**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer | ### play @@ -374,6 +392,8 @@ play(): void 开始播放音频资源，需在[dataLoad](#on('play' | 'pause' | 'stop' | 'reset' | 'dataload' | 'finish' | 'volumechange'))事件成功触发后，才能调用play方法。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **示例：** ```js @@ -389,6 +409,8 @@ pause(): void 暂停播放音频资源。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **示例：** ```js @@ -404,6 +426,8 @@ stop(): void 停止播放音频资源。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **示例：** ```js @@ -419,6 +443,8 @@ reset(): void 切换播放音频资源。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **示例：** ```js @@ -434,6 +460,8 @@ seek(timeMs: number): void 跳转到指定播放位置。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -459,6 +487,8 @@ setVolume(vol: number): void 设置音量。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -480,6 +510,8 @@ release(): void 释放音频资源。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **示例：** ```js @@ -493,6 +525,8 @@ getTrackDescription(callback: AsyncCallback> 通过Promise方式获取音频轨道信息。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **返回值：** | 类型 | 说明 | @@ -568,6 +604,8 @@ on(type: 'bufferingUpdate', callback: (infoType: [BufferingInfoType](#bufferingi 开始订阅音频缓存更新事件。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -590,6 +628,8 @@ on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeCh 开始订阅音频播放事件。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -648,6 +688,8 @@ on(type: 'timeUpdate', callback: Callback\): void 开始订阅音频播放[seek()](#seek)时间更新事件。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -674,6 +716,8 @@ on(type: 'error', callback: ErrorCallback): void 开始订阅音频播放错误事件。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -696,6 +740,8 @@ audioPlayer.setVolume(3); //设置volume为无效值，触发'error'事件 音频播放的状态机。可通过state属性获取当前状态。 +**系统能力**: SystemCapability.Multimedia.Media.AudioPlayer + | 名称 | 类型 | 描述 | | ------------------ | ------ | -------------- | | idle | string | 音频播放空闲。 | @@ -714,13 +760,13 @@ audioPlayer.setVolume(3); //设置volume为无效值，触发'error'事件 | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ | -| url | string | 是 | 是 | 视频媒体URL，支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。
**支持路径示例**：
1. 本地绝对路径：file:///data/data/ohos.xxx.xxx/files/test.mp4
![zh-cn_image_0000001164217678](figures/zh-cn_image_0000001164217678.png)
**注意事项**：
媒体素材需至少赋予读权限后，才可正常播放 | -| loop | boolean | 是 | 是 | 视频循环播放属性，设置为'true'表示循环播放。 | -| currentTime | number | 是 | 否 | 视频的当前播放位置。 | -| duration | number | 是 | 否 | 视频时长，返回-1表示直播模式 | -| state | [VideoPlayState](#videoplaystate8) | 是 | 否 | 视频播放的状态。 | -| width | number | 是 | 否 | 视频宽。 | -| height | number | 是 | 否 | 视频高。 | +| url | string | 是 | 是 | 视频媒体URL，支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。
**支持路径示例**：
1. 本地绝对路径：file:///data/data/ohos.xxx.xxx/files/test.mp4
![zh-cn_image_0000001164217678](figures/zh-cn_image_0000001164217678.png)
**注意事项**：
媒体素材需至少赋予读权限后，才可正常播放。
**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer | +| loop | boolean | 是 | 是 | 视频循环播放属性，设置为'true'表示循环播放。
**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer | +| currentTime | number | 是 | 否 | 视频的当前播放位置。
**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer | +| duration | number | 是 | 否 | 视频时长，返回-1表示直播模式。
**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer | +| state | [VideoPlayState](#videoplaystate8) | 是 | 否 | 视频播放的状态。
**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer | +| width | number | 是 | 否 | 视频宽。
**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer | +| height | number | 是 | 否 | 视频高。
**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer | ### setDisplaySurface8+ @@ -728,6 +774,8 @@ setDisplaySurface(surfaceId: string, callback: AsyncCallback\): void 通过回调方式设置SurfaceId。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -753,6 +801,8 @@ setDisplaySurface(surfaceId: string): Promise\ 通过Promise方式设置SurfaceId。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -785,6 +835,8 @@ prepare(callback: AsyncCallback\): void 通过回调方式准备播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -809,6 +861,8 @@ prepare(): Promise\ 通过Promise方式准备播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -835,6 +889,8 @@ play(callback: AsyncCallback\): void; 通过回调方式开始播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -859,6 +915,8 @@ play(): Promise\; 通过Promise方式开始播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -885,6 +943,8 @@ pause(callback: AsyncCallback\): void 通过回调方式暂停播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -909,6 +969,8 @@ pause(): Promise\ 通过Promise方式暂停播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -935,6 +997,8 @@ stop(callback: AsyncCallback\): void 通过回调方式停止播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -959,6 +1023,8 @@ stop(): Promise\ 通过Promise方式停止播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -985,6 +1051,8 @@ reset(callback: AsyncCallback\): void 通过回调方式切换播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1009,6 +1077,8 @@ reset(): Promise\ 通过Promise方式切换播放视频。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -1035,6 +1105,8 @@ seek(timeMs: number, callback: AsyncCallback\): void 通过回调方式跳转到指定播放位置，默认跳转到指定时间点的下一个关键帧。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1060,6 +1132,8 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\): void 通过回调方式跳转到指定播放位置。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1086,6 +1160,8 @@ seek(timeMs: number, mode?:SeekMode): Promise\ 通过Promise方式跳转到指定播放位置，如果没有设置mode则跳转到指定时间点的下一个关键帧。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1123,6 +1199,8 @@ setVolume(vol: number, callback: AsyncCallback\): void 通过回调方式设置音量。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1148,6 +1226,8 @@ setVolume(vol: number): Promise\ 通过Promise方式设置音量。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1180,6 +1260,8 @@ release(callback: AsyncCallback\): void 通过回调方式释放视频资源。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1204,6 +1286,8 @@ release(): Promise\ 通过Promise方式释放视频资源。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -1230,6 +1314,8 @@ getTrackDescription(callback: AsyncCallback>)>> 通过Promise方式获取视频轨道信息。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **返回值：** | 类型 | 说明 | @@ -1306,6 +1394,8 @@ setSpeed(speed:number, callback: AsyncCallback\): void 通过回调方式设置播放速度。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1331,6 +1421,8 @@ setSpeed(speed:number): Promise\ 通过Promise方式设置播放速度。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1357,6 +1449,8 @@ on(type: 'playbackCompleted', callback: Callback\): void 开始监听视频播放完成事件。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1378,6 +1472,8 @@ on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: numbe 开始监听视频缓存更新事件。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1400,6 +1496,8 @@ on(type: 'startRenderFrame', callback: Callback\): void 开始监听视频播放首帧送显上报事件。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1421,6 +1519,8 @@ on(type: 'videoSizeChanged', callback: (width: number, height: number) => void): 开始监听视频播放宽高变化事件。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1443,6 +1543,8 @@ on(type: 'error', callback: ErrorCallback): void 开始监听视频播放错误事件。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1465,6 +1567,8 @@ videoPlayer.setVolume(3); //设置volume为无效值，触发'error'事件 视频播放的状态机，可通过state属性获取当前状态。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + | 名称 | 类型 | 描述 | | -------- | ------ | -------------- | | idle | string | 视频播放空闲。 | @@ -1478,6 +1582,8 @@ videoPlayer.setVolume(3); //设置volume为无效值，触发'error'事件 视频播放的Seek模式枚举，可通过seek方法作为参数传递下去。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + | 名称 | 值 | 描述 | | ----------------- | ---- | ------------------------------------------------------------ | | SEEK_NEXT_SYNC | 0 | 表示跳转到指定时间点的下一个关键帧，建议向后快进的时候用这个枚举值 | @@ -1489,6 +1595,8 @@ videoPlayer.setVolume(3); //设置volume为无效值，触发'error'事件 视频播放的倍速枚举，可通过setSpeed方法作为参数传递下去。 +**系统能力**: SystemCapability.Multimedia.Media.VideoPlayer + | 名称 | 值 | 描述 | | -------------------- | ---- | ------------------------------ | | SPEED_FORWARD_0_75_X | 0 | 表示视频播放正常播速的0.75倍。 | @@ -1503,6 +1611,8 @@ videoPlayer.setVolume(3); //设置volume为无效值，触发'error'事件 通过key-value方式获取媒体信息 +**系统能力**: SystemCapability.Multimedia.Media.Core + | 名称 | 类型 | 说明 | | ----- | ------ | ------------------------------------------------------------ | | key | string | 通过key值获取对应的value。key值具体可见[MediaDescriptionKey](#mediadescriptionkey8)。 | @@ -1540,6 +1650,8 @@ prepare(config: AudioRecorderConfig): void 录音准备。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1571,6 +1683,8 @@ start(): void 开始录制，需在[prepare](#audiorecorder_on)事件成功触发后，才能调用start方法。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **示例：** ```js @@ -1586,6 +1700,8 @@ pause():void 暂停录制，需要在[start](#audiorecorder_on)事件成功触发后，才能调用pause方法。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **示例：** ```js @@ -1601,6 +1717,8 @@ resume():void 暂停录制，需要在[pause](#audiorecorder_on)事件成功触发后，才能调用resume方法。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **示例：** ```js @@ -1616,6 +1734,8 @@ stop(): void 停止录音。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **示例：** ```js @@ -1631,6 +1751,8 @@ release(): void 释放录音资源。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **示例：** ```js @@ -1649,6 +1771,8 @@ reset(): void 进行重置录音之前，需要先调用[stop()](#audiorecorder_stop)停止录音。重置录音之后，需要调用[prepare()](#audiorecorder_prepare)设置录音参数项，才能再次进行录音。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **示例：** ```js @@ -1664,6 +1788,8 @@ on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset' 开始订阅音频录制事件。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1720,6 +1846,8 @@ on(type: 'error', callback: ErrorCallback): void 开始订阅音频录制错误事件。 +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1740,6 +1868,8 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' ## AudioRecorderConfig +**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder + 表示音频的录音配置。 | 名称 | 参数类型 | 必填 | 说明 | @@ -1759,7 +1889,7 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' | 名称 | 默认值 | 说明 | | ------ | ------ | ------------------------------------------------------------ | -| AAC_LC | 3 | AAC-LC（Advanced Audio Coding Low Complexity）编码格式。 | +| AAC_LC | 3 | AAC-LC（Advanced Audio Coding Low Complexity）编码格式。
**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder | ## AudioOutputFormat @@ -1768,8 +1898,8 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' | 名称 | 默认值 | 说明 | | -------- | ------ | ------------------------------------------------------------ | -| MPEG_4 | 2 | 封装为MPEG-4格式。 | -| AAC_ADTS | 6 | 封装为ADTS（Audio Data Transport Stream）格式，是AAC音频的传输流格式。 | +| MPEG_4 | 2 | 封装为MPEG-4格式。
**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder | +| AAC_ADTS | 6 | 封装为ADTS（Audio Data Transport Stream）格式，是AAC音频的传输流格式。
**系统能力**: SystemCapability.Multimedia.Media.AudioRecorder | ## VideoRecorder8+ @@ -1781,7 +1911,7 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' | 名称 | 类型 | 可读 | 可写 | 说明 | | ----- | ------------------------------------- | ---- | ---- | ---------------- | -| state | [VideoRecordState](#videorecordstate) | 是 | 否 | 视频录制的状态。 | +| state | [VideoRecordState](#videorecordstate) | 是 | 否 | 视频录制的状态。
**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder | ### prepare @@ -1789,6 +1919,8 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\): void; 异步方式进行视频录制的参数设置。通过注册回调函数获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1853,6 +1985,8 @@ prepare(config: VideoRecorderConfig): Promise\; 异步方式进行视频录制的参数设置。通过Promise获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1924,6 +2058,8 @@ getInputSurface(callback: AsyncCallback\): void; 只能在[prepare()](#videorecorder_prepare1)接口调用后调用。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -1955,6 +2091,8 @@ getInputSurface(): Promise\; 只能在[prepare()](#videorecorder_prepare1)接口调用后调用。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -1984,6 +2122,8 @@ start(callback: AsyncCallback\): void; 在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)后调用，需要依赖数据源先给surface传递数据。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2011,6 +2151,8 @@ start(): Promise\; 在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)后调用，需要依赖数据源先给surface传递数据。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -2038,6 +2180,8 @@ pause(callback: AsyncCallback\): void; 在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2065,6 +2209,8 @@ pause(): Promise\; 在[start()](#videorecorder_start1)后调用。可以通过调用[resume()](#videorecorder_resume1)接口来恢复录制。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -2090,6 +2236,8 @@ resume(callback: AsyncCallback\): void; 异步方式恢复视频录制。通过注册回调函数获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2115,6 +2263,8 @@ resume(): Promise\; 异步方式恢复视频录制。通过Promise获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -2142,6 +2292,8 @@ stop(callback: AsyncCallback\): void; 需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2169,6 +2321,8 @@ stop(): Promise\; 需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -2194,6 +2348,8 @@ release(callback: AsyncCallback\): void; 异步方式释放视频录制资源。通过注册回调函数获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2219,6 +2375,8 @@ release(): Promise\; 异步方式释放视频录制资源。通过Promise获取返回值。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -2246,6 +2404,8 @@ reset(callback: AsyncCallback\): void; 需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2273,6 +2433,8 @@ reset(): Promise\; 需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **返回值：** | 类型 | 说明 | @@ -2298,6 +2460,8 @@ on(type: 'error', callback: ErrorCallback): void 开始订阅视频录制错误事件。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2320,6 +2484,8 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 视频录制的状态机。可通过state属性获取当前状态。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + | 名称 | 类型 | 描述 | | -------- | ------ | ---------------------- | | idle | string | 视频录制空闲。 | @@ -2333,6 +2499,8 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 表示视频录制的参数设置。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + | 名称 | 参数类型 | 必填 | 说明 | | --------------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ | | audioSourceType | [AudioSourceType](#audiosourcetype8+) | 是 | 视频录制的音频源类型。 | @@ -2348,8 +2516,8 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | 名称 | 值 | 说明 | | -------------------------- | ---- | ---------------------- | -| AUDIO_SOURCE_TYPE_DEFAULT0 | 0 | 默认的音频输入源类型。 | -| AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。 | +| AUDIO_SOURCE_TYPE_DEFAULT0 | 0 | 默认的音频输入源类型。
**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder | +| AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。
**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder | ## VideoSourceType8+ @@ -2357,13 +2525,15 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | 名称 | 值 | 说明 | | ----------------------------- | ---- | ------------------------------- | -| VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 | -| VIDEO_SOURCE_TYPE_SURFACE_ES | 1 | 输入surface中携带的是ES data。 | +| VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。
**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder | +| VIDEO_SOURCE_TYPE_SURFACE_ES | 1 | 输入surface中携带的是ES data。
**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder | ## VideoRecorderProfile8+ 视频录制的配置文件。 +**系统能力**: SystemCapability.Multimedia.Media.VideoRecorder + | 名称 | 参数类型 | 必填 | 说明 | | ---------------- | -------------------------------------------- | ---- | ---------------- | | audioBitrate | number | 是 | 音频编码比特率。 | @@ -2381,13 +2551,15 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | 名称 | 值 | 说明 | | ----------- | ----- | --------------------- | -| CFT_MPEG_4 | "mp4" | 视频的容器格式，MP4。 | -| CFT_MPEG_4A | "m4a" | 音频的容器格式，M4A。 | +| CFT_MPEG_4 | "mp4" | 视频的容器格式，MP4。
**系统能力**: SystemCapability.Multimedia.Media.Core | +| CFT_MPEG_4A | "m4a" | 音频的容器格式，M4A。
**系统能力**: SystemCapability.Multimedia.Media.Core | ## Location8+ 视频录制的地理位置。 +**系统能力**: SystemCapability.Multimedia.Media.Core + | 名称 | 参数类型 | 必填 | 说明 | | --------- | -------- | ---- | ---------------- | | latitude | number | 是 | 地理位置的纬度。 | -- Gitee