diff --git a/zh-cn/OpenHarmony-Overview_zh.md b/zh-cn/OpenHarmony-Overview_zh.md
index 0364f1359d181f39221e2b048e667e0fb63b06c8..9e766989453a795d24550834dcdef54a034e9bc7 100644
--- a/zh-cn/OpenHarmony-Overview_zh.md
+++ b/zh-cn/OpenHarmony-Overview_zh.md
@@ -23,7 +23,7 @@ OpenHarmony是由开放原子开源基金会(OpenAtom Foundation)孵化及
OpenHarmony整体遵从分层设计,从下向上依次为:内核层、系统服务层、框架层和应用层。系统功能按照“系统 \> 子系统 \> 组件”逐级展开,在多设备部署场景下,支持根据实际需求裁剪某些非必要的组件。OpenHarmony技术架构如下所示:
-![](https://gitee.com/openharmony/docs/raw/master/zh-cn/figures/1.png)
+![](figures/1.png)
**内核层**
diff --git a/zh-cn/application-dev/reference/apis/js-apis-audio.md b/zh-cn/application-dev/reference/apis/js-apis-audio.md
index 4369e06d5710ff9b4fcefec08576015c83ebba7b..607758131ea1a1cf097668faf3f64b466abba8f8 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-audio.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-audio.md
@@ -1,5 +1,8 @@
# 音频管理
+> **说明:**
+> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
+
## 导入模块
```
@@ -13,6 +16,8 @@ getAudioManager(): AudioManager
获取音频管理器。
+**系统能力:** SystemCapability.Multimedia.Audio.Core
+
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
@@ -30,8 +35,8 @@ var audioManager = audio.getAudioManager();
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
-| RINGTONE | 2 | 表示铃声。 |
-| MEDIA | 3 | 表示媒体。 |
+| RINGTONE | 2 | 表示铃声。
**系统能力:** SystemCapability.Multimedia.Audio.Volume |
+| MEDIA | 3 | 表示媒体。
**系统能力:** SystemCapability.Multimedia.Audio.Volume |
## DeviceFlag
@@ -40,9 +45,9 @@ var audioManager = audio.getAudioManager();
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
-| OUTPUT_DEVICES_FLAG | 1 | 表示输出设备种类。 |
-| INPUT_DEVICES_FLAG | 2 | 表示输入设备种类。 |
-| ALL_DEVICES_FLAG | 3 | 表示所有设备种类。 |
+| OUTPUT_DEVICES_FLAG | 1 | 表示输出设备种类。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| INPUT_DEVICES_FLAG | 2 | 表示输入设备种类。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| ALL_DEVICES_FLAG | 3 | 表示所有设备种类。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
## DeviceRole
@@ -51,42 +56,42 @@ var audioManager = audio.getAudioManager();
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
-| INPUT_DEVICE | 1 | 输入设备角色。 |
-| OUTPUT_DEVICE | 2 | 输出设备角色。 |
+| INPUT_DEVICE | 1 | 输入设备角色。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| OUTPUT_DEVICE | 2 | 输出设备角色。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
## DeviceType
枚举,设备类型。
-| 名称 | 默认值 | 描述 |
-| -------------- | ------ | ------------------------------------------------------- |
-| INVALID | 0 | 无效设备。 |
-| EARPIECE | 1 | 听筒。 |
-| SPEAKER | 2 | 扬声器。 |
-| WIRED_HEADSET | 3 | 有线耳机。 |
-| BLUETOOTH_SCO | 7 | 蓝牙设备SCO连接(Synchronous Connection Oriented)。 |
-| BLUETOOTH_A2DP | 8 | 蓝牙设备A2DP连接(Advanced Audio Distribution Profile)。 |
-| MIC | 15 | 麦克风。 |
+| 名称 | 默认值 | 描述 |
+| -------------- | ------ | ------------------------------------------------------------ |
+| INVALID | 0 | 无效设备。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| EARPIECE | 1 | 听筒。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| SPEAKER | 2 | 扬声器。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| WIRED_HEADSET | 3 | 有线耳机。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| BLUETOOTH_SCO | 7 | 蓝牙设备SCO连接(Synchronous Connection Oriented)。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| BLUETOOTH_A2DP | 8 | 蓝牙设备A2DP连接(Advanced Audio Distribution Profile)。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| MIC | 15 | 麦克风。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
-## ActiveDeviceType7+
+## ActiveDeviceType
枚举,活跃设备类型。
-| 名称 | 默认值 | 描述 |
-| ------------- | ------ | -------------------------------------------------- |
-| SPEAKER | 2 | 扬声器。 |
-| BLUETOOTH_SCO | 7 | 蓝牙设备SCO连接(Synchronous Connection Oriented)。 |
+| 名称 | 默认值 | 描述 |
+| ------------- | ------ | ------------------------------------------------------------ |
+| SPEAKER | 2 | 扬声器。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| BLUETOOTH_SCO | 7 | 蓝牙设备SCO连接(Synchronous Connection Oriented)。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
-## AudioRingMode7+
+## AudioRingMode
枚举,铃声模式。
| 名称 | 默认值 | 描述 |
| -------- | -------- | -------- |
-| RINGER_MODE_SILENT | 0 | 静音模式 |
-| RINGER_MODE_VIBRATE | 1 | 震动模式 |
-| RINGER_MODE_NORMAL | 2 | 响铃模式 |
+| RINGER_MODE_SILENT | 0 | 静音模式。
**系统能力:** SystemCapability.Multimedia.Audio.Communication |
+| RINGER_MODE_VIBRATE | 1 | 震动模式。
**系统能力:** SystemCapability.Multimedia.Audio.Communication |
+| RINGER_MODE_NORMAL | 2 | 响铃模式。
**系统能力:** SystemCapability.Multimedia.Audio.Communication |
## AudioManager
@@ -99,6 +104,8 @@ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback&l
设置指定流的音量,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -126,6 +133,8 @@ setVolume(volumeType: AudioVolumeType, volume: number): Promise<void>
设置指定流的音量,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -154,6 +163,8 @@ getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): v
获取指定流的音量,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -180,6 +191,8 @@ getVolume(volumeType: AudioVolumeType): Promise<number>
获取指定流的音量,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -207,6 +220,8 @@ getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
获取指定流的最小音量,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -233,6 +248,8 @@ getMinVolume(volumeType: AudioVolumeType): Promise<number>
获取指定流的最小音量,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -260,6 +277,8 @@ getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
获取指定流的最大音量,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -286,6 +305,8 @@ getMaxVolume(volumeType: AudioVolumeType): Promise<number>
获取指定流的最大音量,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -307,12 +328,14 @@ audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data)=>
)
```
-### mute7+
+### mute
mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void>): void
设置指定音量流静音,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -334,12 +357,14 @@ audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err) => {
})
```
-### mute7+
+### mute
mute(volumeType: AudioVolumeType, mute: boolean): Promise<void>
设置指定音量流静音,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -364,12 +389,14 @@ audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() =>
```
-### isMute7+
+### isMute
isMute(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void
获取指定音量流是否被静音,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -391,12 +418,14 @@ audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => {
```
-### isMute7+
+### isMute
isMute(volumeType: AudioVolumeType): Promise<boolean>
获取指定音量流是否被静音,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -418,12 +447,14 @@ audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) =>
)
```
-### isActive7+
+### isActive
isActive(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void
获取指定音量流是否为活跃状态,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -444,12 +475,14 @@ audioManager.isActive(audio.AudioVolumeType.MEDIA, (err, value) => {
})
```
-### isActive7+
+### isActive
isActive(volumeType: AudioVolumeType): Promise<boolean>
获取指定音量流是否为活跃状态,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Volume
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -471,12 +504,14 @@ audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) =>
)
```
-### setRingerMode7+
+### setRingerMode
setRingerMode(mode: AudioRingMode, callback: AsyncCallback<void>): void
设置铃声模式,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Communication
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -497,12 +532,14 @@ audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err) => {
})
```
-### setRingerMode7+
+### setRingerMode
setRingerMode(mode: AudioRingMode): Promise<void>
设置铃声模式,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Communication
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -525,12 +562,14 @@ audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() =>
```
-### getRingerMode7+
+### getRingerMode
getRingerMode(callback: AsyncCallback<AudioRingMode>): void
获取铃声模式,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Communication
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -551,12 +590,14 @@ audioManager.getRingerMode((err, value) => {
```
-### getRingerMode7+
+### getRingerMode
getRingerMode(): Promise<AudioRingMode>
获取铃声模式,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Communication
+
**返回值:**
| 类型 | 说明 |
@@ -572,12 +613,14 @@ audioManager.getRingerMode().then((value) =>
)
```
-### setAudioParameter7+
+### setAudioParameter
setAudioParameter(key: string, value: string, callback: AsyncCallback<void>): void
音频参数设置,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Core
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -599,12 +642,14 @@ audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => {
})
```
-### setAudioParameter7+
+### setAudioParameter
setAudioParameter(key: string, value: string): Promise<void>
音频参数设置,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Core
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -627,12 +672,14 @@ audioManager.setAudioParameter('PBits per sample', '8 bit').then(() =>
)
```
-### getAudioParameter7+
+### getAudioParameter
getAudioParameter(key: string, callback: AsyncCallback<string>): void
获取指定音频参数值,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Core
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -653,12 +700,14 @@ audioManager.getAudioParameter('PBits per sample', (err, value) => {
})
```
-### getAudioParameter7+
+### getAudioParameter
getAudioParameter(key: string): Promise<string>
获取指定音频参数值,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Core
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -686,6 +735,8 @@ getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescrip
获取音频设备列表,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -711,6 +762,8 @@ audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value)=>{
获取音频设备列表,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -732,12 +785,14 @@ audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data)=>
)
```
-### setDeviceActive7+
+### setDeviceActive
setDeviceActive(deviceType: DeviceType, active: boolean, callback: AsyncCallback<void>): void
设置设备激活状态,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -759,12 +814,14 @@ audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true, (err)=> {
})
```
-### setDeviceActive7+
+### setDeviceActive
setDeviceActive(deviceType: DeviceType, active: boolean): Promise<void>
设置设备激活状态,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -788,12 +845,14 @@ audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true).then(()=>
)
```
-### isDeviceActive7+
+### isDeviceActive
isDeviceActive(deviceType: DeviceType, callback: AsyncCallback<boolean>): void
获取指定设备的激活状态,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -815,12 +874,14 @@ audioManager.isDeviceActive(audio.DeviceType.SPEAKER, (err, value) => {
```
-### isDeviceActive7+
+### isDeviceActive
isDeviceActive(deviceType: DeviceType): Promise<boolean>
获取指定设备的激活状态,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -842,12 +903,14 @@ audioManager.isDeviceActive(audio.DeviceType.SPEAKER).then((value) =>
)
```
-### setMicrophoneMute7+
+### setMicrophoneMute
setMicrophoneMute(mute: boolean, callback: AsyncCallback<void>): void
设置麦克风静音状态,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -868,12 +931,14 @@ audioManager.setMicrophoneMute(true, (err) => {
})
```
-### setMicrophoneMute7+
+### setMicrophoneMute
setMicrophoneMute(mute: boolean): Promise<void>
设置麦克风静音状态,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -895,12 +960,14 @@ audioManager.setMicrophoneMute(true).then(() =>
)
```
-### isMicrophoneMute7+
+### isMicrophoneMute
isMicrophoneMute(callback: AsyncCallback<boolean>): void
获取麦克风静音状态,使用callback方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
@@ -920,12 +987,14 @@ audioManager.isMicrophoneMute((err, value) => {
})
```
-### isMicrophoneMute7+
+### isMicrophoneMute
isMicrophoneMute(): Promise<boolean>
获取麦克风静音状态,使用promise方式返回异步结果。
+**系统能力:** SystemCapability.Multimedia.Audio.Device
+
**返回值:**
| 类型 | 说明 |
@@ -949,12 +1018,12 @@ audioManager.isMicrophoneMute().then((value) =>
| 名称 | 参数型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
-| deviceRole | [DeviceRole](#devicerole) | 是 | 否 | 设备角色。 |
-| deviceType | [DeviceType](#devicetype) | 是 | 否 | 设备类型。 |
+| deviceRole | [DeviceRole](#devicerole) | 是 | 否 | 设备角色。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
+| deviceType | [DeviceType](#devicetype) | 是 | 否 | 设备类型。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
## AudioDeviceDescriptors
| 名称 | 描述 |
| -------- | -------- |
-| 设备属性数组 | AudioDeviceDescriptor的数组,只读。 |
+| 设备属性数组 | AudioDeviceDescriptor的数组,只读。
**系统能力:** SystemCapability.Multimedia.Audio.Device |
diff --git a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md
index 9276e557f6419e68cfd7c32c49870a99dff7880a..22baa86785ce06e33a6eedb72656e56aad7a49a7 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md
@@ -1,7 +1,7 @@
# 性能打点
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
-> - 从API Version 8开始,该接口不再维护,推荐使用新接口[hiTraceMeter](js-apis-hitracemeter.md)。具体新接口在接口描述中说明。
+> - 从API Version 8开始,该接口不再维护,推荐使用新接口[hiTraceMeter](js-apis-hitracemeter.md)。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
diff --git a/zh-cn/application-dev/reference/apis/js-apis-camera.md b/zh-cn/application-dev/reference/apis/js-apis-camera.md
index 5393f3f49ca9a1116f9f0f586bdf9f709bcc54c7..ed5e53a56efcb451f35a7ac7c08c13956282d473 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-camera.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-camera.md
@@ -1,5 +1,8 @@
# 相机管理
+> **说明:**
+> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
+
## 导入模块
```
diff --git a/zh-cn/application-dev/reference/apis/js-apis-image.md b/zh-cn/application-dev/reference/apis/js-apis-image.md
index 6795829a272ad08c3d072ed2db9dd6b4c2ca9c87..9dbb932ac72f046b8c5ebe056bb2b74b17534007 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-image.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-image.md
@@ -1,6 +1,9 @@
图片处理
==========
+> **说明:**
+> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
+
导入模块
---------
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 b575b112344e28c3234a6a8ec7c4ecb6c64780eb..bc8c7da071b7677aa1c58b93125f9ceb741d4110 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-media.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-media.md
@@ -1,5 +1,8 @@
# 媒体服务
+> **说明:**
+> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
+
媒体子系统为开发者提供一套简单且易于理解的接口,使得开发者能够方便接入系统并使用系统的媒体资源。
媒体子系统包含了音视频相关媒体业务,提供以下常用功能:
@@ -23,13 +26,13 @@ createAudioPlayer(): [AudioPlayer](#audioplayer)
同步方式创建音频播放实例。
-
+**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer
**返回值:**
| 类型 | 说明 |
| --------------------------- | ------------------------------------------------------------ |
-| [AudioPlayer](#audioplayer) | 返回AudioPlayer类实例,失败时返回null。可用于音频播放、暂停、停止等操作。
**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer |
+| [AudioPlayer](#audioplayer) | 返回AudioPlayer类实例,失败时返回null。可用于音频播放、暂停、停止等操作。 |
**示例:**
@@ -43,11 +46,13 @@ createVideoPlayer(callback: AsyncCallback\<[VideoPlayer](#videoplayer8)>): void
异步方式创建视频播放实例,通过注册回调函数获取返回值。
+**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
+
**参数:**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
-| callback | AsyncCallback<[VideoPlayer](#videoplayer8)> | 是 | 异步创建视频播放实例回调方法。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------------------- | ---- | ------------------------------ |
+| callback | AsyncCallback<[VideoPlayer](#videoplayer8)> | 是 | 异步创建视频播放实例回调方法。 |
**示例:**
@@ -70,11 +75,13 @@ createVideoPlayer: Promise<[VideoPlayer](#videoplayer8)>
异步方式创建视频播放实例,通过Promise获取返回值。
+**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
+
**返回值:**
-| 类型 | 说明 |
-| ------------------------------------- | ------------------------------------------------------------ |
-| Promise<[VideoPlayer](#videoplayer8)> | 异步创建视频播放实例Promise返回值。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| 类型 | 说明 |
+| ------------------------------------- | ----------------------------------- |
+| Promise<[VideoPlayer](#videoplayer8)> | 异步创建视频播放实例Promise返回值。 |
**示例:**
@@ -104,11 +111,13 @@ createAudioRecorder(): AudioRecorder
创建音频录制的实例来控制音频的录制。
+**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder
+
**返回值:**
-| 类型 | 说明 |
-| ------------------------------- | ------------------------------------------------------------ |
-| [AudioRecorder](#audiorecorder) | 返回AudioRecorder类实例,失败时返回null。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| 类型 | 说明 |
+| ------------------------------- | ----------------------------------------- |
+| [AudioRecorder](#audiorecorder) | 返回AudioRecorder类实例,失败时返回null。 |
**示例:**
@@ -122,11 +131,13 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder8)>):
异步方式创建视频录制实例。通过注册回调函数获取返回值。
+**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
+
**参数:**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
-| callback | AsyncCallback<[VideoRecorder](#videorecorder8)> | 是 | 异步创建视频录制实例回调方法。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ----------------------------------------------- | ---- | ------------------------------ |
+| callback | AsyncCallback<[VideoRecorder](#videorecorder8)> | 是 | 异步创建视频录制实例回调方法。 |
**示例:**
@@ -149,11 +160,13 @@ createVideoRecorder: Promise<[VideoRecorder](#videorecorder8)>
异步方式创建视频录制实例。通过Promise获取返回值。
+**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
+
**返回值:**
-| 类型 | 说明 |
-| ----------------------------------------- | ------------------------------------------------------------ |
-| Promise<[VideoRecorder](#videorecorder8)> | 异步创建视频录制实例Promise返回值。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder |
+| 类型 | 说明 |
+| ----------------------------------------- | ----------------------------------- |
+| Promise<[VideoRecorder](#videorecorder8)> | 异步创建视频录制实例Promise返回值。 |
**示例:**
@@ -181,7 +194,7 @@ await media.createVideoRecorder.then((video) => {
## MediaErrorCode8+
-媒体服务错误类型枚举
+媒体服务错误类型枚举。
| 名称 | 值 | 说明 |
| -------------------------- | ---- | ------------------------------------------------------------ |
@@ -198,7 +211,7 @@ await media.createVideoRecorder.then((video) => {
## MediaType8+
-媒体类型枚举
+媒体类型枚举。
| 名称 | 值 | 说明 |
| -------------- | ---- | ------------------------------------------------------------ |
@@ -207,7 +220,7 @@ await media.createVideoRecorder.then((video) => {
## CodecMimeType8+
-Codec MIME类型枚举
+Codec MIME类型枚举。
| 名称 | 值 | 说明 |
| ------------ | ----------------- | ------------------------------------------------------------ |
@@ -218,7 +231,7 @@ Codec MIME类型枚举
## MediaDescriptionKey8+
-媒体信息描述枚举
+媒体信息描述枚举。
| 名称 | 值 | 说明 |
| ------------------------ | --------------- | ------------------------------------------------------------ |
@@ -235,7 +248,7 @@ Codec MIME类型枚举
## BufferingInfoType8+
-缓存事件类型枚举
+缓存事件类型枚举。
| 名称 | 值 | 说明 |
| ----------------- | ---- | ------------------------------------------------------------ |
@@ -254,7 +267,7 @@ Codec MIME类型枚举
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
-| src | string | 是 | 是 | 音频媒体URI,支持当前主流的音频格式(mp4、aac、mp3、ogg)。
**支持路径示例**:
1、fd类型播放:fd://xxx
![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png)
2、http网络播放路径:开发中
3、hls网络播放路径:开发中
**注意事项**:
媒体素材需至少赋予读权限后,才可正常播放。
**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer |
+| src | string | 是 | 是 | 音频媒体URI,支持当前主流的音频格式(mp4、aac、mp3、ogg)。
**支持路径示例**:
1、fd类型播放:fd://xxx
![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png)
2、http网络播放路径:开发中
3、hls网络播放路径:开发中
**注意事项**:
使用媒体素材需要获取读权限,否则无法正常播放。
**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer |
| loop | boolean | 是 | 是 | 音频循环播放属性,设置为'true'表示循环播放。
**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer |
| currentTime | number | 是 | 否 | 音频的当前播放位置。
**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer |
| duration | number | 是 | 否 | 音频时长。
**系统能力:** SystemCapability.Multimedia.Media.AudioPlayer |
@@ -640,17 +653,17 @@ audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
视频播放demo可参考:[视频播放开发指导](../../media/video-playback.md)
-### 属性8+
+### 属性
-| 名称 | 类型 | 可读 | 可写 | 说明 |
-| ----------- | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ |
-| url | string | 是 | 是 | 视频媒体URL,支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。
**支持路径示例**:
1. fd类型播放:fd://xxx
![zh-cn_image_0000001164217678](figures/zh-cn_image_url.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 |
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ |
+| url8+ | string | 是 | 是 | 视频媒体URL,支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。
**支持路径示例**:
1. fd类型播放:fd://xxx
![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png)
**注意事项**:
使用媒体素材需要获取读权限,否则无法正常播放。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| loop8+ | boolean | 是 | 是 | 视频循环播放属性,设置为'true'表示循环播放。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| currentTime8+ | number | 是 | 否 | 视频的当前播放位置。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| duration8+ | number | 是 | 否 | 视频时长,返回-1表示直播模式。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| state8+ | [VideoPlayState](#videoplaystate8) | 是 | 否 | 视频播放的状态。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| width8+ | number | 是 | 否 | 视频宽。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
+| height8+ | number | 是 | 否 | 视频高。
**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer |
### setDisplaySurface8+
@@ -1485,7 +1498,7 @@ videoPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
### [key : string] : any
-通过key-value方式获取媒体信息
+通过key-value方式获取媒体信息。
| 名称 | 类型 | 说明 |
| ----- | ------ | ------------------------------------------------------------ |
@@ -1763,11 +1776,11 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
| 名称 | 默认值 | 说明 |
| ------- | ------ | ------------------------------------------------------------ |
-| DEFAULT | 0 | Default audio encoding format is AMR_NB。本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
-| AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
-| AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| DEFAULT | 0 | Default audio encoding format is AMR_NB。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| AMR_NB | 1 | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| AMR_WB | 2 | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
| AAC_LC | 3 | AAC-LC(Advanced Audio Coding Low Complexity)编码格式。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
-| HE_AAC | 4 | HE_AAC(High-Efficiency Advanced Audio Coding)编码格式。本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| HE_AAC | 4 | HE_AAC(High-Efficiency Advanced Audio Coding)编码格式。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
## AudioOutputFormat
@@ -1776,10 +1789,10 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
| 名称 | 默认值 | 说明 |
| -------- | ------ | ------------------------------------------------------------ |
-| DEFAULT | 0 | 默认封装格式为MPEG-4。本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| DEFAULT | 0 | 默认封装格式为MPEG-4。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
| MPEG_4 | 2 | 封装为MPEG-4格式。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
-| AMR_NB | 3 | 封装为AMR_NB格式。本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
-| AMR_WB | 4 | 封装为AMR_WB格式。本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| AMR_NB | 3 | 封装为AMR_NB格式。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
+| AMR_WB | 4 | 封装为AMR_WB格式。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
| AAC_ADTS | 6 | 封装为ADTS(Audio Data Transport Stream)格式,是AAC音频的传输流格式。
**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder |
## VideoRecorder8+
@@ -1790,11 +1803,11 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
### 属性
-| 名称 | 类型 | 可读 | 可写 | 说明 |
-| ----- | ------------------------------------- | ---- | ---- | ---------------- |
-| state | [VideoRecordState](#videorecordstate) | 是 | 否 | 视频录制的状态。 |
+| 名称 | 类型 | 可读 | 可写 | 说明 |
+| ------------------ | ------------------------------------- | ---- | ---- | ---------------- |
+| state8+ | [VideoRecordState](#videorecordstate) | 是 | 否 | 视频录制的状态。 |
-### prepare
+### prepare8+
prepare(config: VideoRecorderConfig, callback: AsyncCallback\): void;
@@ -1862,7 +1875,7 @@ media.createVideoRecorder((err, recorder) => {
});
```
-### prepare
+### prepare8+
prepare(config: VideoRecorderConfig): Promise\;
@@ -1933,7 +1946,7 @@ await videoRecorder.prepare(videoConfig).then(() => {
});
```
-### getInputSurface
+### getInputSurface8+
getInputSurface(callback: AsyncCallback\): void;
@@ -1966,7 +1979,7 @@ videoRecorder.getInputSurface((err, surfaceId) => {
});
```
-### getInputSurface
+### getInputSurface8+
getInputSurface(): Promise\;
@@ -1999,13 +2012,13 @@ await videoRecorder.getInputSurface().then((surfaceId) => {
});
```
-### start
+### start8+
start(callback: AsyncCallback\): void;
异步方式开始视频录制。通过注册回调函数获取返回值。
-在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)后调用,需要依赖数据源先给surface传递数据。
+在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface8)后调用,需要依赖数据源先给surface传递数据。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
@@ -2028,13 +2041,13 @@ videoRecorder.start((err) => {
});
```
-### start
+### start8+
start(): Promise\;
异步方式开始视频录制。通过Promise获取返回值。
-在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)后调用,需要依赖数据源先给surface传递数据。
+在[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface8)后调用,需要依赖数据源先给surface传递数据。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
@@ -2057,7 +2070,7 @@ await videoRecorder.start().then(() => {
});
```
-### pause
+### pause8+
pause(callback: AsyncCallback\): void;
@@ -2086,7 +2099,7 @@ videoRecorder.pause((err) => {
});
```
-### pause
+### pause8+
pause(): Promise\;
@@ -2115,7 +2128,7 @@ await videoRecorder.pause().then(() => {
});
```
-### resume
+### resume8+
resume(callback: AsyncCallback\): void;
@@ -2142,7 +2155,7 @@ videoRecorder.resume((err) => {
});
```
-### resume
+### resume8+
resume(): Promise\;
@@ -2169,13 +2182,13 @@ await videoRecorder.resume().then(() => {
});
```
-### stop
+### stop8+
stop(callback: AsyncCallback\): void;
异步方式停止视频录制。通过注册回调函数获取返回值。
-需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
+需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface8)接口才能重新录制。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
@@ -2198,13 +2211,13 @@ videoRecorder.stop((err) => {
});
```
-### stop
+### stop8+
stop(): Promise\;
异步方式停止视频录制。通过Promise获取返回值。
-需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
+需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface8)接口才能重新录制。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
@@ -2227,7 +2240,7 @@ await videoRecorder.stop().then(() => {
});
```
-### release
+### release8+
release(callback: AsyncCallback\): void;
@@ -2254,7 +2267,7 @@ videoRecorder.release((err) => {
});
```
-### release
+### release8+
release(): Promise\;
@@ -2281,13 +2294,13 @@ await videoRecorder.release().then(() => {
});
```
-### reset
+### reset8+
reset(callback: AsyncCallback\): void;
异步方式重置视频录制。通过注册回调函数获取返回值。
-需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
+需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface8)接口才能重新录制。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
@@ -2310,13 +2323,13 @@ videoRecorder.reset((err) => {
});
```
-### reset
+### reset8+
reset(): Promise\;
异步方式重置视频录制。通过Promise获取返回值。
-需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface)接口才能重新录制。
+需要重新调用[prepare()](#videorecorder_prepare1)和[getInputSurface()](#getinputsurface8)接口才能重新录制。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder
@@ -2339,7 +2352,7 @@ await videoRecorder.reset().then(() => {
});
```
-### on('error')
+### on('error')8+
on(type: 'error', callback: ErrorCallback): void
@@ -2430,8 +2443,8 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| 名称 | 值 | 说明 |
| ----------- | ----- | ------------------------------------------------------------ |
-| CFT_MPEG_4 | "mp4" | 视频的容器格式,MP4。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder |
-| CFT_MPEG_4A | "m4a" | 音频的容器格式,M4A。
**系统能力:** SystemCapability.Multimedia.Media.VideoRecorder |
+| CFT_MPEG_4 | "mp4" | 视频的容器格式,MP4。
**系统能力:** SystemCapability.Multimedia.Media.Core |
+| CFT_MPEG_4A | "m4a" | 音频的容器格式,M4A。
**系统能力:** SystemCapability.Multimedia.Media.Core |
## Location8+
diff --git a/zh-cn/figures/1.png b/zh-cn/figures/1.png
index 6bde46d324c6d9da612d5070a99481ee11aab047..5910b98a0fb9b950b402b93be2cdf35e1b64d638 100644
Binary files a/zh-cn/figures/1.png and b/zh-cn/figures/1.png differ