diff --git a/en/application-dev/reference/apis/js-apis-xml.md b/en/application-dev/reference/apis/js-apis-xml.md index 945c5219bedb22f5efdd6f53b5d55d4cdd97f260..ec3549a4051ea6784a56be33c902fc167e1311a1 100644 --- a/en/application-dev/reference/apis/js-apis-xml.md +++ b/en/application-dev/reference/apis/js-apis-xml.md @@ -1,4 +1,4 @@ -# XML Parsing and Generation +# @ohos.xml (XML Parsing and Generation) > **NOTE** > @@ -24,10 +24,10 @@ A constructor used to create an **XmlSerializer** instance. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| buffer | ArrayBuffer \| DataView | Yes| **ArrayBuffer** or **DataView** for storing the XML information to write.| -| encoding | string | No| Encoding format.| +| Name | Type | Mandatory| Description | +| -------- | --------------------------------- | ---- | ------------------------------------------------ | +| buffer | ArrayBuffer \| DataView | Yes | **ArrayBuffer** or **DataView** for storing the XML information to write.| +| encoding | string | No | Encoding format. | **Example** @@ -48,10 +48,10 @@ Sets an attribute. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| name | string | Yes| Key of the attribute.| -| value | string | Yes| Value of the attribute.| +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | --------------- | +| name | string | Yes | Key of the attribute. | +| value | string | Yes | Value of the attribute.| **Example** @@ -60,8 +60,8 @@ let arrayBuffer = new ArrayBuffer(1024); let bufView = new DataView(arrayBuffer); let thatSer = new xml.XmlSerializer(bufView); thatSer.startElement("note"); -thatSer.setAttributes("importance", "high"); -thatSer.endElement(); +thatSer.setAttributes("importance", "high"); +thatSer.endElement(); ``` @@ -75,9 +75,9 @@ Adds an empty element. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| name | string | Yes| Name of the empty element to add.| +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ------------------ | +| name | string | Yes | Name of the empty element to add.| **Example** @@ -117,9 +117,9 @@ Writes the start tag based on the given element name. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| name | string | Yes| Name of the element.| +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ------------------ | +| name | string | Yes | Name of the element.| **Example** @@ -145,11 +145,11 @@ Writes the end tag of the element. let arrayBuffer = new ArrayBuffer(1024); let bufView = new DataView(arrayBuffer); let thatSer = new xml.XmlSerializer(bufView); -thatSer.setNamespace("h", "http://www.w3.org/TR/html4/"); +thatSer.setNamespace("h", "https://www.w3.org/TR/html4/"); thatSer.startElement("table"); thatSer.setAttributes("importance", "high"); thatSer.setText("Happy"); -thatSer.endElement(); // => Happy +thatSer.endElement(); // => Happy ``` @@ -163,10 +163,10 @@ Sets the namespace for an element tag. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| prefix | string | Yes| Prefix of the element and its child elements.| -| namespace | string | Yes| Namespace to set.| +| Name | Type | Mandatory| Description | +| --------- | ------ | ---- | ------------------------------ | +| prefix | string | Yes | Prefix of the element and its child elements. | +| namespace | string | Yes | Namespace to set.| **Example** @@ -174,9 +174,9 @@ Sets the namespace for an element tag. let arrayBuffer = new ArrayBuffer(1024); let thatSer = new xml.XmlSerializer(arrayBuffer); thatSer.setDeclaration(); -thatSer.setNamespace("h", "http://www.w3.org/TR/html4/"); +thatSer.setNamespace("h", "https://www.w3.org/TR/html4/"); thatSer.startElement("note"); -thatSer.endElement();// = >'\r\n'; +thatSer.endElement();// = >'\r\n'; ``` ### setComment @@ -189,9 +189,9 @@ Sets the comment. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| text | string | Yes| Comment to set.| +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------------------- | +| text | string | Yes | Comment to set.| **Example** @@ -214,9 +214,9 @@ Sets CDATA attributes. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| text | string | Yes| CDATA attribute to set.| +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ----------------- | +| text | string | Yes | CDATA attribute to set.| **Example** @@ -237,9 +237,9 @@ Sets **Text**. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| text | string | Yes| Content of the **Text** to set.| +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ---------------- | +| text | string | Yes | Content of the **Text** to set.| **Example** @@ -263,9 +263,9 @@ Sets **DocType**. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| text | string | Yes| Content of **DocType** to set.| +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ------------------- | +| text | string | Yes | Content of **DocType** to set.| **Example** @@ -289,10 +289,10 @@ Creates and returns an **XmlPullParser** object. The **XmlPullParser** object pa **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| buffer | ArrayBuffer \| DataView | Yes| **ArrayBuffer** or **DataView** that contains XML text information.| -| encoding | string | No| Encoding format. Only UTF-8 is supported.| +| Name | Type | Mandatory| Description | +| -------- | --------------------------------- | ---- | ------------------------------------------ | +| buffer | ArrayBuffer \| DataView | Yes | **ArrayBuffer** or **DataView** that contains XML text information.| +| encoding | string | No | Encoding format. Only UTF-8 is supported. | **Example** @@ -324,9 +324,9 @@ Parses XML information. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| option | [ParseOptions](#parseoptions) | Yes| Options for controlling and obtaining the parsed information.| +| Name| Type | Mandatory| Description | +| ------ | ----------------------------- | ---- | -------------------------------- | +| option | [ParseOptions](#parseoptions) | Yes | Options for controlling and obtaining the parsed information.| **Example** @@ -372,13 +372,13 @@ Defines the XML parsing options. **System capability**: SystemCapability.Utils.Lang -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| supportDoctype | boolean | No| Whether to ignore **Doctype**. The default value is **false**.| -| ignoreNameSpace | boolean | No| Whether to ignore **Namespace**. The default value is **false**.| -| tagValueCallbackFunction | (name: string, value: string)=> boolean | No| Callback used to return **tagValue**.| -| attributeValueCallbackFunction | (name: string, value: string)=> boolean | No| Callback used to return **attributeValue**.| -| tokenValueCallbackFunction | (eventType: [EventType](#eventtype), value: [ParseInfo](#parseinfo))=> boolean | No| Callback used to return **tokenValue**.| +| Name | Type | Mandatory| Description | +| ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------------- | +| supportDoctype | boolean | No | Whether to ignore **Doctype**. The default value is **false**.| +| ignoreNameSpace | boolean | No | Whether to ignore **Namespace**. The default value is **false**. | +| tagValueCallbackFunction | (name: string, value: string) => boolean | No | Callback used to return **tagValue**. | +| attributeValueCallbackFunction | (name: string, value: string) => boolean | No | Callback used to return **attributeValue**. | +| tokenValueCallbackFunction | (eventType: [EventType](#eventtype), value: [ParseInfo](#parseinfo)) => boolean | No | Callback used to return **tokenValue**. | ## ParseInfo @@ -395,8 +395,8 @@ Obtains the column line number, starting from 1. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | -------------- | | number | Column number obtained.| @@ -410,8 +410,8 @@ Obtains the depth of this element. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | -------------------- | | number | Depth obtained.| @@ -425,8 +425,8 @@ Obtains the current line number, starting from 1. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | -------------- | | number | Line number obtained.| @@ -440,8 +440,8 @@ Obtains the name of this element. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | ------------------ | | string | Element name obtained.| @@ -455,8 +455,8 @@ Obtains the namespace of this element. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | ------------------------ | | string | Namespace obtained.| @@ -470,8 +470,8 @@ Obtains the prefix of this element. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | ------------------ | | string | Element prefix obtained.| @@ -485,8 +485,8 @@ Obtains the text of the current event. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | ------------------------ | | string | Text content obtained.| @@ -500,8 +500,8 @@ Checks whether the current element is empty. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------- | ---------------------------- | | boolean | Returns **true** if the element is empty; returns **false** otherwise.| @@ -515,8 +515,8 @@ Checks whether the current text event contains only whitespace characters. **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------- | -------------------------------------- | | boolean | Returns **true** if the text event contains only whitespace characters; returns **false** otherwise.| @@ -529,8 +529,8 @@ Obtains the number of attributes for the current start tag. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | +| Type | Description | +| ------ | ---------------------- | | number | Number of attributes obtained.| @@ -540,16 +540,16 @@ Enumerates the events. **System capability**: SystemCapability.Utils.Lang -| Name| Value| Description| -| -------- | -------- | -------- | -| START_DOCUMENT | 0 | Indicates a start document event.| -| END_DOCUMENT | 1 | Indicates an end document event.| -| START_TAG | 2 | Indicates a start tag event.| -| END_TAG | 3 | Indicates an end tag event.| -| TEXT | 4 | Indicates a text event.| -| CDSECT | 5 | Indicates a CDATA section event.| -| COMMENT | 6 | Indicates an XML comment event.| -| DOCDECL | 7 | Indicates an XML document type declaration event.| -| INSTRUCTION | 8 | Indicates an XML processing instruction event.| -| ENTITY_REFERENCE | 9 | Indicates an entity reference event.| -| WHITESPACE | 10 | Indicates a whitespace character event.| +| Name | Value | Description | +| ---------------- | ---- | --------------------- | +| START_DOCUMENT | 0 | Indicates a start document event. | +| END_DOCUMENT | 1 | Indicates an end document event. | +| START_TAG | 2 | Indicates a start tag event. | +| END_TAG | 3 | Indicates an end tag event. | +| TEXT | 4 | Indicates a text event. | +| CDSECT | 5 | Indicates a CDATA section event. | +| COMMENT | 6 | Indicates an XML comment event. | +| DOCDECL | 7 | Indicates an XML document type declaration event.| +| INSTRUCTION | 8 | Indicates an XML processing instruction event.| +| ENTITY_REFERENCE | 9 | Indicates an entity reference event. | +| WHITESPACE | 10 | Indicates a whitespace character event. | diff --git a/en/application-dev/reference/errorcodes/errorcode-screenlock.md b/en/application-dev/reference/errorcodes/errorcode-screenlock.md new file mode 100644 index 0000000000000000000000000000000000000000..db1c6481b874be4d422528172f55467521185028 --- /dev/null +++ b/en/application-dev/reference/errorcodes/errorcode-screenlock.md @@ -0,0 +1,24 @@ +# Screen Lock Management Error Codes + +## 13200002 Screen Lock Management Service Is Abnormal + +**Error Message** + +The screenlock management service is abnormal. + +**Description** + +This error code is reported when the screen lock management service is not working correctly. + +**Possible Causes** + + +1. The service stops running due to unknown errors and is not automatically restored. +2. The service is running but does not respond due to unknown errors. + +**Solution** + +Run the **ps -ef** command to check whether the service is running. + +1. If the service is not running, restart the system. +2. If the service is running, close the service process and wait for automatic recovery. If the issue persists, perform step 1. diff --git a/en/contribute/code-contribution.md b/en/contribute/code-contribution.md index 6b540115fac2034d50361bf0d9f62aee451f94b4..a761bd38a8b59626d41f8744e0c9d03c48d8d10f 100644 --- a/en/contribute/code-contribution.md +++ b/en/contribute/code-contribution.md @@ -25,6 +25,9 @@ Develop, review, and test code following the OpenHarmony coding standards. Make ### Introducing Open-source Software For details, see [Introducing Open-Source Software](introducing-open-source-software.md). +### Test Guide + +[OpenHarmony Secure Test Guide](OpenHarmony-security-test-guide.md) ## Contribution Workflow @@ -32,7 +35,10 @@ For details, see [Contribution Process](contribution-process.md). ## Security Issue Disclosure -- [OpenHarmony Security Vulnerability Governance](https://gitee.com/openharmony/security/blob/master/en/security-process/README.md) -- [OpenHarmony Security and Disclosure Statement](https://gitee.com/openharmony/security/blob/master/en/security-process/security-disclosure.md) +- [OpenHarmony Security Vulnerability Governance](https://gitee.com/openharmony/security/blob/master/en/security-process/README.md) + +- [OpenHarmony Security and Disclosure Statement](https://gitee.com/openharmony/security/blob/master/en/security-process/security-disclosure.md) + + diff --git a/zh-cn/application-dev/application-models/process-model-stage.md b/zh-cn/application-dev/application-models/process-model-stage.md index 20e5a18424a94e7f765666e690972a145c2252fb..152d9b6cf9cb1479e4ef21818dd4836d975a9bc8 100644 --- a/zh-cn/application-dev/application-models/process-model-stage.md +++ b/zh-cn/application-dev/application-models/process-model-stage.md @@ -13,6 +13,9 @@ OpenHarmony的进程模型如下图所示： **图1** 进程模型示意图 ![process-model](figures/process-model.png) +> 说明： +> +> 仅系统应用支持构建ServiceExtensionAbility和DataShareExtensionAbility。 在上述模型基础上，对于系统应用可以通过申请多进程权限（如下图所示），为指定HAP配置一个自定义进程名，该HAP中的UIAbility、DataShareExtensionAbility、ServiceExtensionAbility就会运行在自定义进程中。不同的HAP可以通过配置不同的进程名运行在不同进程中。 diff --git a/zh-cn/application-dev/database/database-relational-overview.md b/zh-cn/application-dev/database/database-relational-overview.md index ae4bf5086a04d627144398ffff5f45f31723984f..cba72e0085f71da57bebecff8d39475e6751970e 100644 --- a/zh-cn/application-dev/database/database-relational-overview.md +++ b/zh-cn/application-dev/database/database-relational-overview.md @@ -1,6 +1,6 @@ # 关系型数据库概述 -关系型数据库（Relational Database，RDB）是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制，对外提供了一系列的增、删、改、查等接口，也可以直接运行用户输入的SQL语句来满足复杂的场景需要。 +关系型数据库（Relational Database，RDB）是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制，对外提供了一系列的增、删、改、查等接口，也可以直接运行用户输入的SQL语句来满足复杂的场景需要。当应用卸载后，其相关数据库会被自动清除。 关于数据库锁机制，开发者无需关注其具体实现。 diff --git a/zh-cn/application-dev/quick-start/figures/arkts-get-started.png b/zh-cn/application-dev/quick-start/figures/arkts-get-started.png index b2a0cb91637601846855c0eaa30e0610a5a11ed6..21de3f9615767dfb3e50fc5a0e1707eb87dfb73d 100644 Binary files a/zh-cn/application-dev/quick-start/figures/arkts-get-started.png and b/zh-cn/application-dev/quick-start/figures/arkts-get-started.png differ diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md index 6c4e6f0eefcbf84059e455902e9165ec330c4344..b66b1726be0906ff4964755eaa50a50b145b633a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md @@ -1,8 +1,6 @@ # @ohos.app.ability.AbilityConstant (AbilityConstant) -AbilityConstant是启动参数的接口。 - -AbilityConstant提供启动参数的接口的能力，包括设置初次开始原因的类型、上次退出原因的类型、继续结果的类型。 +AbilityConstant提供Ability相关的枚举，包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。 > **说明：** > @@ -19,14 +17,14 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | -| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | +| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | +| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | ## AbilityConstant.LaunchReason -初次开始原因的类型。 +初次启动原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -41,7 +39,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.LastExitReason -上次退出原因的类型。 +上次退出原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -54,7 +52,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.OnContinueResult -继续结果的类型。 +迁移结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -80,7 +78,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.MemoryLevel -内存级别的类型。 +内存级别。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -92,7 +90,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.OnSaveResult -保存应用数据的结果类型。 +保存应用数据的结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -107,7 +105,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ## AbilityConstant.StateType -保存应用数据场景原因类型。 +保存应用数据场景原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md index f148dca1d6c61519ce2b3224f4a72e9a252b63be..7b39d012c9ff117b63d14f3f8f4ebbbe411a0172 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md @@ -15,21 +15,21 @@ import common from '@ohos.app.ability.common' **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -| 名称 | 类型 | 必填 | 说明 | -| ----------- | -------------------- | ---- | ------------------------------------------------------------ | -| UIAbilityContext | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 否 | UIAbilityContext二级模块。 | -| AbilityStageContext | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 否 | AbilityStageContext二级模块。 | -| ApplicationContext | [ApplicationContext](js-apis-inner-application-applicationContext.md) | 否 | ApplicationContext二级模块。 | -| BaseContext | [BaseContext](js-apis-inner-application-baseContext.md) | 否 | BaseContext二级模块。 | -| Context | [Context](js-apis-inner-application-context.md) | 否 | Context二级模块。 | -| ExtensionContext | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 否 | ExtensionContext二级模块。 | -| FormExtensionContext | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 否 | FormExtensionContext二级模块。 | -| AreaMode | [AreaMode](#areamode) | 否 | AreaMode枚举值。 | -| EventHub | [EventHub](js-apis-inner-application-eventHub.md) | 否 | EventHub二级模块。 | -| PermissionRequestResult | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | 否 | PermissionRequestResult二级模块。 | -| PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | 否 | PacMap二级模块。 | -| AbilityResult | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 否 | AbilityResult二级模块。 | -| ConnectOptions | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | ConnectOptions二级模块。 | +| 名称 | 类型 | 说明 | +| ----------- | -------------------- | ------------------------------------------------------------ | +| UIAbilityContext | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | UIAbilityContext二级模块。 | +| AbilityStageContext | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | AbilityStageContext二级模块。 | +| ApplicationContext | [ApplicationContext](js-apis-inner-application-applicationContext.md) | ApplicationContext二级模块。 | +| BaseContext | [BaseContext](js-apis-inner-application-baseContext.md) | BaseContext二级模块。 | +| Context | [Context](js-apis-inner-application-context.md) | Context二级模块。 | +| ExtensionContext | [ExtensionContext](js-apis-inner-application-extensionContext.md) | ExtensionContext二级模块。 | +| FormExtensionContext | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | FormExtensionContext二级模块。 | +| AreaMode | [AreaMode](#areamode) | AreaMode枚举值。 | +| EventHub | [EventHub](js-apis-inner-application-eventHub.md) | EventHub二级模块。 | +| PermissionRequestResult | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | PermissionRequestResult二级模块。 | +| PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | PacMap二级模块。 | +| AbilityResult | [AbilityResult](js-apis-inner-ability-abilityResult.md) | AbilityResult二级模块。 | +| ConnectOptions | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | ConnectOptions二级模块。 | **示例：** ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md index bd26f19fd954c7efd40dac5a30afb2f86e6ff831..7e1d461c0f594cbe7fa2719e72ba855eb49a0a9c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md @@ -1,6 +1,6 @@ # @ohos.app.ability.contextConstant (ContextConstant) -ContextConstant模块提供数据加密等级定义的能力。 +ContextConstant提供Context相关的枚举，当前仅包含数据加密等级的枚举。 > **说明：** > @@ -19,7 +19,7 @@ import contextConstant from '@ohos.app.ability.contextConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | -| EL1 | 0 | 设备级加密区。 | -| EL2 | 1 | 用户凭据加密区。 | +| EL1 | 0 | 设备级加密区，设备开机后可访问的数据区。 | +| EL2 | 1 | 用户级加密区，设备开机，首次输入密码后才能够访问的数据区。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md index ce4b0804fdd44bb423c57d4bf5db47095a7a8230..00f29740f754294aba76d816eb465a01c873f8a5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md @@ -1,6 +1,6 @@ # @ohos.app.ability.ExtensionAbility (扩展能力基类) -ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。 +ExtensionAbility是特定场景扩展能力的基类，提供系统配置更新回调和系统内存调整回调。。 > **说明：** > @@ -16,7 +16,7 @@ import ExtensionAbility from '@ohos.app.ability.ExtensionAbility'; **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore **示例：** - + ```ts class MyExtensionAbility extends ExtensionAbility { onConfigurationUpdated(config) { @@ -28,3 +28,4 @@ import ExtensionAbility from '@ohos.app.ability.ExtensionAbility'; } } ``` + diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md index ab0c36b020e631c89cd71d26d7e8f38f4cbd5d1c..a231e6b8956f5630ce592ea4c1abedef58f09591 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md @@ -1,6 +1,6 @@ # @ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility) -ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的能力。 +ServiceExtensionAbility模块提供后台服务相关扩展能力，提供后台服务创建、销毁、连接、断开等生命周期回调。 > **说明：** > @@ -23,9 +23,9 @@ import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility'; **系统API**: 此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | +| context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | ## ServiceExtensionAbility.onCreate @@ -40,9 +40,9 @@ Extension生命周期回调，在创建时回调，执行初始化业务逻辑 **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** @@ -88,10 +88,10 @@ Extension生命周期回调，如果是startAbility拉起的服务，会在onCre **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | **示例：** @@ -116,15 +116,15 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | rpc.RemoteObject | 一个RemoteObject对象，用于和客户端进行通信。 | +| 类型 | 说明 | +| -------- | -------- | +| rpc.RemoteObject | 一个RemoteObject对象，用于和客户端进行通信。 | **示例：** @@ -158,9 +158,9 @@ Extension的生命周期，断开服务连接时回调。 **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** @@ -184,9 +184,9 @@ onReconnect(want: Want): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want |[Want](js-apis-app-ability-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | **示例：** @@ -210,9 +210,9 @@ onConfigurationUpdate(newConfig: Configuration): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | newConfig | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| newConfig | [Configuration](js-apis-app-ability-configuration.md) | 是 | 表示需要更新的配置信息。 | **示例：** @@ -236,9 +236,9 @@ onDump(params: Array\): Array\; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | params | Array\ | 是 | 表示命令形式的参数。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| params | Array\ | 是 | 表示命令形式的参数。| **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md index c27facb973d1b854c26e8921bc0f4ec549529d43..5ada363bc19af33cac1243e2fd127916703e75f0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md @@ -1,6 +1,6 @@ # @ohos.app.ability.StartOptions (StartOptions) -StartOptions模块对系统的基本通信组件进行查询和设置的能力。 +StartOptions可以作为[startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1)的入参，用于指定目标Ability的窗口模式。 > **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md index c64f9cab59628e60741da089dd4a737a335e6c86..bc9c8806d8b71b5fc04b42978c563d28c53f7678 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md @@ -1,11 +1,9 @@ # @ohos.app.ability.UIAbility (UIAbility) -Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。 +UIAbility是包含UI界面的应用组件，提供组件创建、销毁、前后台切换等生命周期回调，同时也具备组件协同的能力，组件协同主要提供如下常用功能： -该模块提供以下Ability相关的常用功能： - -- [Caller](#caller)：通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。 -- [Callee](#callee)：通用组件服务端注册和解除客户端caller通知送信的callback接口。 +- [Caller](#caller)：由[startAbilityByCall](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartabilitybycall)接口返回，CallerAbility(调用者)可使用Caller与CalleeAbility(被调用者)进行通信。 +- [Callee](#callee)：UIAbility的内部对象，CalleeAbility(被调用者)可以通过Callee与Caller进行通信。 > **说明：** > @@ -20,34 +18,34 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ## 属性 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：以下各项对应的系统能力均为SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 | -| launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability启动时的参数。 | -| lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | Ability最后请求时的参数。| -| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| +| context | [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md) | 是 | 否 | 上下文。 | +| launchWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | UIAbility启动时的参数。 | +| lastRequestWant | [Want](js-apis-app-ability-want.md) | 是 | 否 | UIAbility最后请求时的参数。| +| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。| -## Ability.onCreate +## UIAbility.onCreate -onCreate(want: Want, param: AbilityConstant.LaunchParam): void; +onCreate(want: Want, param: UIAbilityConstant.LaunchParam): void; -Ability创建时回调，执行初始化业务逻辑操作。 +UIAbility创建时回调，执行初始化业务逻辑操作。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | - | param | AbilityConstant.LaunchParam | 是 | 创建 ability、上次异常退出的原因信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | 当前UIAbility的Want类型信息，包括ability名称、bundle名称等。 | +| param | UIAbilityConstant.LaunchParam | 是 | 创建 ability、上次异常退出的原因信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onCreate(want, param) { console.log('onCreate, want:' + want.abilityName); } @@ -55,24 +53,24 @@ Ability创建时回调，执行初始化业务逻辑操作。 ``` -## Ability.onWindowStageCreate +## UIAbility.onWindowStageCreate onWindowStageCreate(windowStage: window.WindowStage): void 当WindowStage创建后调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| windowStage | window.WindowStage | 是 | WindowStage相关信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); } @@ -80,18 +78,18 @@ onWindowStageCreate(windowStage: window.WindowStage): void ``` -## Ability.onWindowStageDestroy +## UIAbility.onWindowStageDestroy onWindowStageDestroy(): void 当WindowStage销毁后调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onWindowStageDestroy() { console.log('onWindowStageDestroy'); } @@ -99,24 +97,24 @@ onWindowStageDestroy(): void ``` -## Ability.onWindowStageRestore +## UIAbility.onWindowStageRestore onWindowStageRestore(windowStage: window.WindowStage): void 当迁移多实例ability时，恢复WindowStage后调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| windowStage | window.WindowStage | 是 | WindowStage相关信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onWindowStageRestore(windowStage) { console.log('onWindowStageRestore'); } @@ -124,18 +122,18 @@ onWindowStageRestore(windowStage: window.WindowStage): void ``` -## Ability.onDestroy +## UIAbility.onDestroy onDestroy(): void; -Ability生命周期回调，在销毁时回调，执行资源清理等操作。 +UIAbility生命周期回调，在销毁时回调，执行资源清理等操作。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onDestroy() { console.log('onDestroy'); } @@ -143,18 +141,18 @@ Ability生命周期回调，在销毁时回调，执行资源清理等操作。 ``` -## Ability.onForeground +## UIAbility.onForeground onForeground(): void; -Ability生命周期回调，当应用从后台转到前台时触发。 +UIAbility生命周期回调，当应用从后台转到前台时触发。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onForeground() { console.log('onForeground'); } @@ -162,18 +160,18 @@ Ability生命周期回调，当应用从后台转到前台时触发。 ``` -## Ability.onBackground +## UIAbility.onBackground onBackground(): void; -Ability生命周期回调，当应用从前台转到后台时触发。 +UIAbility生命周期回调，当应用从前台转到后台时触发。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onBackground() { console.log('onBackground'); } @@ -181,83 +179,83 @@ Ability生命周期回调，当应用从前台转到后台时触发。 ``` -## Ability.onContinue +## UIAbility.onContinue -onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; +onContinue(wantParam : {[key: string]: any}): UIAbilityConstant.OnContinueResult; 当ability迁移准备迁移时触发，保存数据。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | wantParam | {[key: string]: any} | 是 | want相关参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| wantParam | {[key: string]: any} | 是 | want相关参数。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | AbilityConstant.OnContinueResult | 继续的结果。 | +| 类型 | 说明 | +| -------- | -------- | +| UIAbilityConstant.OnContinueResult | 继续的结果。 | **示例：** ```ts - import AbilityConstant from "@ohos.app.ability.AbilityConstant" - class MyAbility extends UIAbility { + import UIAbilityConstant from "@ohos.app.ability.UIAbilityConstant" + class MyUIAbility extends UIAbility { onContinue(wantParams) { console.log('onContinue'); wantParams["myData"] = "my1234567"; - return AbilityConstant.OnContinueResult.AGREE; + return UIAbilityConstant.OnContinueResult.AGREE; } } ``` -## Ability.onNewWant +## UIAbility.onNewWant -onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; +onNewWant(want: Want, launchParams: UIAbilityConstant.LaunchParam): void; 当ability的启动模式设置为单例时回调会被调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如ability名称，包名等。 | - | launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如ability名称，包名等。 | +| launchParams | UIAbilityConstant.LaunchParam | 是 | UIAbility启动的原因、上次异常退出的原因信息。 | **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onNewWant(want) { console.log('onNewWant, want:' + want.abilityName); } } ``` -## Ability.onDump +## UIAbility.onDump onDump(params: Array\): Array\; 转储客户端信息时调用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | params | Array\ | 是 | 表示命令形式的参数。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| params | Array\ | 是 | 表示命令形式的参数。| **示例：** ```ts - class MyAbility extends UIAbility { + class MyUIAbility extends UIAbility { onDump(params) { console.log('dump, params:' + JSON.stringify(params)); return ["params"] @@ -266,37 +264,37 @@ onDump(params: Array\): Array\; ``` -## Ability.onSaveState +## UIAbility.onSaveState -onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult; +onSaveState(reason: UIAbilityConstant.StateType, wantParam : {[key: string]: any}): UIAbilityConstant.OnSaveResult; -该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存Ability状态。 +该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存UIAbility状态。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | reason | [AbilityConstant.StateType](js-apis-app-ability-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 | - | wantParam | {[key: string]: any} | 是 | want相关参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| reason | [UIAbilityConstant.StateType](js-apis-app-ability-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 | +| wantParam | {[key: string]: any} | 是 | want相关参数。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态。 | +| 类型 | 说明 | +| -------- | -------- | +| UIAbilityConstant.OnSaveResult | 是否同意保存当前UIAbility的状态。 | **示例：** ```ts -import AbilityConstant from '@ohos.app.ability.AbilityConstant' +import UIAbilityConstant from '@ohos.app.ability.UIAbilityConstant' -class MyAbility extends UIAbility { +class MyUIAbility extends UIAbility { onSaveState(reason, wantParam) { console.log('onSaveState'); wantParam["myData"] = "my1234567"; - return AbilityConstant.OnSaveResult.RECOVERY_AGREE; + return UIAbilityConstant.OnSaveResult.RECOVERY_AGREE; } } ``` @@ -313,20 +311,20 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; 向通用组件服务端发送约定序列化数据。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 约定的服务端注册事件字符串。 | +| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise形式返回应答。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | Promise形式返回应答。 | **错误码：** @@ -361,11 +359,11 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; }; var method = 'call_Function'; // 约定的通知消息字符串 var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -393,20 +391,20 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa 向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 约定的服务端注册事件字符串。 | +| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<rpc.MessageParcel> | Promise形式返回通用组件服务端应答数据。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<rpc.MessageParcel> | Promise形式返回通用组件服务端应答数据。 | **错误码：** @@ -441,11 +439,11 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa }; var method = 'call_Function'; var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -475,7 +473,7 @@ release(): void; 主动释放通用组件服务端的通信接口。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **错误码：** @@ -490,11 +488,11 @@ release(): void; ```ts var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -518,23 +516,23 @@ release(): void; 注册通用组件服务端Stub（桩）断开监听通知。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 | **示例：** ```ts var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -560,14 +558,14 @@ release(): void; 注册通用组件服务端Stub（桩）断开监听通知。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 监听releaseCall事件，固定为'release'。 | - | callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 监听releaseCall事件，固定为'release'。 | +| callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 | **错误码：** @@ -580,11 +578,11 @@ release(): void; ```ts var caller; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onWindowStageCreate(windowStage) { - this.context.startAbilityByCall({ + this.context.startUIAbilityByCall({ bundleName: "com.example.myservice", - abilityName: "MainAbility", + abilityName: "MainUIAbility", deviceId: "" }).then((obj) => { caller = obj; @@ -615,14 +613,14 @@ on(method: string, callback: CalleeCallback): void; 通用组件服务端注册消息通知callback。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 与客户端约定的通知消息字符串。 | - | callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数, 回调函数至少要返回一个空的rpc.Sequenceable数据对象, 其他视为函数执行错误。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 与客户端约定的通知消息字符串。 | +| callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数, 回调函数至少要返回一个空的rpc.Sequenceable数据对象, 其他视为函数执行错误。 | **错误码：** @@ -662,7 +660,7 @@ on(method: string, callback: CalleeCallback): void; pdata.readSequenceable(msg); return new MyMessageAble("test1", "Callee test"); } - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onCreate(want, launchParam) { console.log('Callee onCreate is called'); try { @@ -681,13 +679,13 @@ off(method: string): void; 解除通用组件服务端注册消息通知callback。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | method | string | 是 | 已注册的通知事件字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| method | string | 是 | 已注册的通知事件字符串。 | **错误码：** @@ -701,7 +699,7 @@ off(method: string): void; ```ts var method = 'call_Function'; - export default class MainAbility extends UIAbility { + export default class MainUIAbility extends UIAbility { onCreate(want, launchParam) { console.log('Callee onCreate is called'); try { @@ -718,18 +716,18 @@ off(method: string): void; (msg: string): void; -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore -| 名称 | 可读 | 可写 | 类型 | 说明 | +| 名称 | 可读 | 可写 | 类型 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 | +| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 | ## CalleeCallback (indata: rpc.MessageParcel): rpc.Sequenceable; -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore +**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore -| 名称 | 可读 | 可写 | 类型 | 说明 | +| 名称 | 可读 | 可写 | 类型 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 | +| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md index 6520391748d7593bba343086ca2438fc253dbf71..6acbe99c6ea59a3ffe9e23622721af1230d5ff06 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md @@ -1,6 +1,6 @@ # @ohos.app.form.FormExtensionAbility (FormExtensionAbility) -FormExtensionAbility模块提供了卡片扩展相关接口。 +FormExtensionAbility为卡片扩展模块，提供卡片创建、销毁、刷新等生命周期回调。 > **说明：** > @@ -17,9 +17,9 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; **系统能力**：SystemCapability.Ability.Form -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | -| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自ExtensionContext。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | +| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtensionAbility的上下文环境，继承自[ExtensionContext](js-apis-inner-application-extensionContext.md)。 | ## onAddForm diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md index a3f91ff855b697a06b6dbe60fc6b19069fe23918..0c60a8d9511f4eafb61352bdbd574498ef73510f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -1,8 +1,6 @@ # @ohos.application.AbilityConstant (AbilityConstant) -AbilityConstant是启动参数的接口。 - -AbilityConstant提供启动参数的接口的能力，包括设置初次开始原因的类型、上次退出原因的类型、继续结果的类型。 +AbilityConstant提供Ability相关的枚举，包括设置初次启动原因、上次退出原因、迁移结果、窗口类型等。 > **说明：** > @@ -19,14 +17,14 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | -| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | +| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | +| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | ## AbilityConstant.LaunchReason -初次开始原因的类型。 +初次启动原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -41,7 +39,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.LastExitReason -上次退出原因的类型。 +上次退出原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -54,7 +52,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.OnContinueResult -继续结果的类型。 +迁移结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -92,7 +90,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.OnSaveResult -保存应用数据的结果类型。 +保存应用数据的结果。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -107,7 +105,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; ## AbilityConstant.StateType -保存应用数据场景原因类型。 +保存应用数据场景原因。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md index 754a819aff1bae7cc4642cdd2703cb309999f964..bc65594148e918b9719d49ebb8cca0736b3212af 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md @@ -1,6 +1,6 @@ # @ohos.application.AbilityLifecycleCallback (AbilityLifecycleCallback) -AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力，包括onAbilityCreate、onWindowStageCreate、onWindowStageDestroy等方法。 +AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力，包括onAbilityCreate、onWindowStageCreate、onWindowStageDestroy等方法，可以作为[registerAbilityLifecycleCallback](js-apis-inner-application-applicationContext.md#applicationcontextregisterabilitylifecyclecallback)的入参。 > **说明：** > @@ -25,9 +25,9 @@ onAbilityCreate(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onWindowStageCreate @@ -40,10 +40,10 @@ onWindowStageCreate(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onWindowStageActive @@ -56,10 +56,10 @@ onWindowStageActive(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onWindowStageInactive @@ -72,10 +72,10 @@ onWindowStageInactive(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onWindowStageDestroy @@ -88,10 +88,10 @@ onWindowStageDestroy(ability: Ability, windowStage: window.WindowStage): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | - | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | ## AbilityLifecycleCallback.onAbilityDestroy @@ -104,9 +104,9 @@ onAbilityDestroy(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onAbilityForeground @@ -119,9 +119,9 @@ onAbilityForeground(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onAbilityBackground @@ -134,9 +134,9 @@ onAbilityBackground(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | ## AbilityLifecycleCallback.onAbilityContinue @@ -149,64 +149,64 @@ onAbilityContinue(ability: Ability): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| ability | [Ability](js-apis-application-ability.md#Ability) | 是 | 当前Ability对象 | **示例：** - ```ts import AbilityStage from "@ohos.application.AbilityStage"; -var lifecycleid; +var lifecycleId; export default class MyAbilityStage extends AbilityStage { onCreate() { console.log("MyAbilityStage onCreate") - let AbilityLifecycleCallback = { - onAbilityCreate(ability){ - console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); + let AbilityLifecycleCallback = { + onAbilityCreate(ability) { + console.log("onAbilityCreate ability:" + JSON.stringify(ability)); }, - onWindowStageCreate(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); + onWindowStageCreate(ability, windowStage) { + console.log("onWindowStageCreate ability:" + JSON.stringify(ability)); + console.log("onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); }, - onWindowStageActive(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); + onWindowStageActive(ability, windowStage) { + console.log("onWindowStageActive ability:" + JSON.stringify(ability)); + console.log("onWindowStageActive windowStage:" + JSON.stringify(windowStage)); }, - onWindowStageInactive(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); + onWindowStageInactive(ability, windowStage) { + console.log("onWindowStageInactive ability:" + JSON.stringify(ability)); + console.log("onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); }, - onWindowStageDestroy(ability, windowStage){ - console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); + onWindowStageDestroy(ability, windowStage) { + console.log("onWindowStageDestroy ability:" + JSON.stringify(ability)); + console.log("onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); }, - onAbilityDestroy(ability){ - console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); + onAbilityDestroy(ability) { + console.log("onAbilityDestroy ability:" + JSON.stringify(ability)); }, - onAbilityForeground(ability){ - console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); + onAbilityForeground(ability) { + console.log("onAbilityForeground ability:" + JSON.stringify(ability)); }, - onAbilityBackground(ability){ - console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); + onAbilityBackground(ability) { + console.log("onAbilityBackground ability:" + JSON.stringify(ability)); }, - onAbilityContinue(ability){ - console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); + onAbilityContinue(ability) { + console.log("onAbilityContinue ability:" + JSON.stringify(ability)); } } // 1.通过context属性获取applicationContext let applicationContext = this.context.getApplicationContext(); // 2.通过applicationContext注册监听应用内生命周期 - lifecycleid = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); - console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid)); + lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); + console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); } + onDestroy() { let applicationContext = this.context.getApplicationContext(); - applicationContext.unregisterAbilityLifecycleCallback(lifecycleid, (error, data) => { - console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); + applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => { + console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); }); } } diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md index 432ffcc0d526a861e616846d94551a71f5a99d1f..1fe541aa5524c3c340276b00940a2dcf5cfc81ff 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md @@ -44,15 +44,15 @@ onAcceptWant(want: Want): string; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | string | 用户返回一个ability标识，如果之前启动过标识的ability，不创建新的实例并拉回栈顶，否则创建新的实例并启动。 | +| 类型 | 说明 | +| -------- | -------- | +| string | 用户返回一个ability标识，如果之前启动过标识的ability，不创建新的实例并拉回栈顶，否则创建新的实例并启动。 | **示例：** @@ -76,9 +76,9 @@ onConfigurationUpdated(config: Configuration): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-application-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| config | [Configuration](js-apis-application-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | **示例：** @@ -100,9 +100,9 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| **示例：** @@ -118,10 +118,10 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; context: AbilityStageContext; -指示有关上下文的配置信息。 +AbilityStage的上下文对象。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core -| 属性名 | 类型 | 说明 | -| ----------- | --------------------------- | ------------------------------------------------------------ | -| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在启动能力阶段进行初始化时回调。 | +| 属性名 | 类型 | 说明 | +| ------- | ------------------------------------------------------------ | -------------------------- | +| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | AbilityStage的上下文对象。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-arraylist.md b/zh-cn/application-dev/reference/apis/js-apis-arraylist.md index 448575f862be54c617432c375f62e5b41ac23334..8bd0b1dfdeb82d2ab2495e58dc8dd23ce9b2b7ed 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arraylist.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arraylist.md @@ -41,7 +41,7 @@ ArrayList的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -76,7 +76,7 @@ add(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -112,7 +112,7 @@ insert(element: T, index: number): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -150,7 +150,7 @@ has(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -187,7 +187,7 @@ getIndexOf(element: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -229,7 +229,7 @@ getLastIndexOf(element: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -271,7 +271,7 @@ removeByIndex(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -312,7 +312,7 @@ remove(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -346,7 +346,7 @@ removeByRange(fromIndex: number, toIndex: number): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -390,7 +390,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -438,7 +438,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -480,7 +480,7 @@ comparator的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -522,7 +522,7 @@ subArrayList(fromIndex: number, toIndex: number): ArrayList<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -552,7 +552,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -586,7 +586,7 @@ clone(): ArrayList<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -619,7 +619,7 @@ getCapacity(): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -652,7 +652,7 @@ convertToArray(): Array<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -685,7 +685,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -718,7 +718,7 @@ increaseCapacityTo(newCapacity: number): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -746,7 +746,7 @@ trimToCurrentLength(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -779,7 +779,7 @@ arrayList.trimToCurrentLength(); **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-buffer.md b/zh-cn/application-dev/reference/apis/js-apis-buffer.md index e4568281726e03a9d9a99ef8f534ea0bd92b6e60..33f6d16e90e4a44034281d7d598a96fa9e1a458b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-buffer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-buffer.md @@ -47,7 +47,7 @@ import buffer from '@ohos.buffer'; **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -244,7 +244,7 @@ concat(list: Buffer[] | Uint8Array[], totalLength?: number): Buffer **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -314,7 +314,7 @@ from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -509,6 +509,14 @@ compare(target: Buffer | Uint8Array, targetStart?: number, targetEnd?: number, s | -------- | -------- | | number | 比较结果。-1:前排序，0:与buf相同，1:后排序。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200001 | The value of "[targetStart/targetEnd/sourceStart/sourceEnd]" is out of range. | + **示例：** ```ts @@ -547,7 +555,7 @@ copy(target: Buffer| Uint8Array, targetStart?: number, sourceStart?: number, sou **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -647,7 +655,7 @@ fill(value: string | Buffer | Uint8Array | number, offset?: number, end?: number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -807,7 +815,7 @@ readBigInt64BE(offset?: number): bigint **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -848,7 +856,7 @@ readBigInt64LE(offset?: number): bigint **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -889,7 +897,7 @@ readBigUInt64BE(offset?: number): bigint **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -930,7 +938,7 @@ readBigUInt64LE(offset?: number): bigint **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -971,7 +979,7 @@ readDoubleBE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1011,7 +1019,7 @@ readDoubleLE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1051,7 +1059,7 @@ readFloatBE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1091,7 +1099,7 @@ readFloatLE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1131,7 +1139,7 @@ readInt8(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1172,7 +1180,7 @@ readInt16BE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1212,7 +1220,7 @@ readInt16LE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1252,7 +1260,7 @@ readInt32BE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1292,7 +1300,7 @@ readInt32LE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1334,7 +1342,7 @@ readIntBE(offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1378,7 +1386,7 @@ readIntLE(offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1419,7 +1427,7 @@ readUInt8(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1461,7 +1469,7 @@ readUInt16BE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1503,7 +1511,7 @@ readUInt16LE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1545,7 +1553,7 @@ readUInt32BE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1586,7 +1594,7 @@ readUInt32LE(offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1628,7 +1636,7 @@ readUIntBE(offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1670,7 +1678,7 @@ readUIntLE(offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1741,7 +1749,7 @@ swap16(): Buffer **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1776,7 +1784,7 @@ swap32(): Buffer **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1811,7 +1819,7 @@ swap64(): Buffer **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1940,7 +1948,7 @@ write(str: string, offset?: number, length?: number, encoding?: string): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -1984,7 +1992,7 @@ writeBigInt64BE(value: bigint, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2023,7 +2031,7 @@ writeBigInt64LE(value: bigint, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2062,7 +2070,7 @@ writeBigUInt64BE(value: bigint, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2101,7 +2109,7 @@ writeBigUInt64LE(value: bigint, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2140,7 +2148,7 @@ writeDoubleBE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2179,7 +2187,7 @@ writeDoubleLE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2218,7 +2226,7 @@ writeFloatBE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2258,7 +2266,7 @@ writeFloatLE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2297,7 +2305,7 @@ writeInt8(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2338,7 +2346,7 @@ writeInt16BE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2378,7 +2386,7 @@ writeInt16LE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2417,7 +2425,7 @@ writeInt32BE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2457,7 +2465,7 @@ writeInt32LE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2497,7 +2505,7 @@ writeIntBE(value: number, offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2538,7 +2546,7 @@ writeIntLE(value: number, offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2577,7 +2585,7 @@ writeUInt8(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2619,7 +2627,7 @@ writeUInt16BE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2659,7 +2667,7 @@ writeUInt16LE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2699,7 +2707,7 @@ writeUInt32BE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2738,7 +2746,7 @@ writeUInt32LE(value: number, offset?: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2778,7 +2786,7 @@ writeUIntBE(value: number, offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -2818,7 +2826,7 @@ writeUIntLE(value: number, offset: number, byteLength: number): number **错误码：** -以下错误码的详细介绍请参见[buffer错误码](../errorcodes/errorcode-buffer.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-convertxml.md b/zh-cn/application-dev/reference/apis/js-apis-convertxml.md index b6850622bbc43143963e57249dce78e3cc00be11..59bd9b802a6a1fd48c9059eb0a92064fe8c8c998 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-convertxml.md +++ b/zh-cn/application-dev/reference/apis/js-apis-convertxml.md @@ -36,6 +36,14 @@ convertToJSObject(xml: string, options?: ConvertOptions) : Object | ------ | ---------------------------- | | Object | 处理后返回的JavaScript对象。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200002 | Invalid xml string. | + **示例：** ```js @@ -60,14 +68,14 @@ console.log(result); ### convert(deprecated) -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[convertToJSObject9+](#converttojsobject9)替代。 - convert(xml: string, options?: ConvertOptions) : Object 转换xml文本为JavaScript对象。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[convertToJSObject9+](#converttojsobject9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md index 77df6f7329632d2143890aff7f04d50736e49b20..a54d63f77393df9988887fc17877a4e4d4bf3cc5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md @@ -999,9 +999,9 @@ close(): void 关闭结果集。 -**说明：** - -从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[close](#close9)替代。 +> **说明：** +> +> 从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用[close](#close9)替代。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-deque.md b/zh-cn/application-dev/reference/apis/js-apis-deque.md index 4ff01bbeb4e8be6eafacc03ed29eccb19f8f6b1b..a5e689de493073e4f2c304ab03d060dd06c4183c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-deque.md +++ b/zh-cn/application-dev/reference/apis/js-apis-deque.md @@ -40,7 +40,7 @@ Deque的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -68,7 +68,7 @@ insertFront(element: T): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -103,7 +103,7 @@ insertEnd(element: T): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -144,7 +144,7 @@ has(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -175,7 +175,7 @@ popFirst(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -209,7 +209,7 @@ popLast(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -253,7 +253,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -288,7 +288,7 @@ getFirst(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -321,7 +321,7 @@ getLast(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -354,7 +354,7 @@ let result = deque.getLast(); **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-display.md b/zh-cn/application-dev/reference/apis/js-apis-display.md index 44bb178903cdb5552e8eafd50a40fa56e3617e9b..c1efdb814984db91be93f0c5532646e152bd7acc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-display.md +++ b/zh-cn/application-dev/reference/apis/js-apis-display.md @@ -417,9 +417,9 @@ promise.then((data) => { | rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。
值为0时，表示显示设备屏幕旋转为0°；
值为1时，表示显示设备屏幕旋转为90°；
值为2时，表示显示设备屏幕旋转为180°；
值为3时，表示显示设备屏幕旋转为270°。| | width | number | 是 | 否 | 显示设备的宽度，单位为像素。| | height | number | 是 | 否 | 显示设备的高度，单位为像素。| -| densityDPI | number | 是 | 否 | 显示设备的屏幕密度，单位为DPI。| -| densityPixels | number | 是 | 否 | 显示设备的屏幕密度，单位为像素。| -| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。| +| densityDPI | number | 是 | 否 | 显示设备的屏幕密度，表示每英寸点数。一般取值160，480等。 | +| densityPixels | number | 是 | 否 | 显示设备的逻辑密度，是像素单位无关的缩放系数。一般取值1，3等。 | +| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。通常与densityPixels相同。 | | xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值。 | | yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值。| diff --git a/zh-cn/application-dev/reference/apis/js-apis-hashmap.md b/zh-cn/application-dev/reference/apis/js-apis-hashmap.md index e1c1516f8d3ad3088cf73fba2b0c67b9dc7dffaa..d4bac07c3165bfdd8e7cd6bcc2f771bffc43cbce 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hashmap.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hashmap.md @@ -42,7 +42,7 @@ HashMap的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -71,7 +71,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -107,7 +107,7 @@ hasKey(key: K): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -145,7 +145,7 @@ hasValue(value: V): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -183,7 +183,7 @@ get(key: K): V **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -215,7 +215,7 @@ setAll(map: HashMap): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -255,7 +255,7 @@ set(key: K, value: V): Object **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -291,7 +291,7 @@ remove(key: K): V **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -317,7 +317,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -349,7 +349,7 @@ keys(): IterableIterator<K> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -386,7 +386,7 @@ values(): IterableIterator<V> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -430,7 +430,7 @@ replace(key: K, newValue: V): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -469,7 +469,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -503,7 +503,7 @@ entries(): IterableIterator<[K, V]> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -541,7 +541,7 @@ while(temp != undefined) { **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-hashset.md b/zh-cn/application-dev/reference/apis/js-apis-hashset.md index b7ac547de66e7b5eda4fc880ac8329dd7a818ac9..b5b4028d55c862bd0eb8fe3adbca62034322c6cd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hashset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hashset.md @@ -50,7 +50,7 @@ HashSet的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -79,7 +79,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -115,7 +115,7 @@ has(value: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -153,7 +153,7 @@ add(value: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -189,7 +189,7 @@ remove(value: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -215,7 +215,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -247,7 +247,7 @@ values(): IterableIterator<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -292,7 +292,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -325,7 +325,7 @@ entries(): IterableIterator<[T, T]> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -363,7 +363,7 @@ while(temp != undefined) { **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-lightweightmap.md b/zh-cn/application-dev/reference/apis/js-apis-lightweightmap.md index efda7e6b1ec1bfc6f4bacac61e453cccbd8db45b..75a644181defcd3f7a1e8ddb313390f0881c71fb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-lightweightmap.md +++ b/zh-cn/application-dev/reference/apis/js-apis-lightweightmap.md @@ -43,7 +43,7 @@ LightWeightMap的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -72,7 +72,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -108,7 +108,7 @@ hasAll(map: LightWeightMap): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -148,7 +148,7 @@ hasKey(key: K): boolean; **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -187,7 +187,7 @@ hasValue(value: V): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -213,7 +213,7 @@ increaseCapacityTo(minimumCapacity: number): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -255,7 +255,7 @@ get(key: K): V **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -293,7 +293,7 @@ getIndexOfKey(key: K): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -331,7 +331,7 @@ getIndexOfValue(value: V): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -369,7 +369,7 @@ getKeyAt(index: number): K **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -402,7 +402,7 @@ setAll(map: LightWeightMap): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -441,7 +441,7 @@ set(key: K, value: V): Object **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -477,7 +477,7 @@ remove(key: K): V **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -515,7 +515,7 @@ removeAt(index: number): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -554,7 +554,7 @@ setValueAt(index: number, newValue: V): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -593,7 +593,7 @@ getValueAt(index: number): V **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -620,7 +620,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -652,7 +652,7 @@ keys(): IterableIterator<K> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -689,7 +689,7 @@ values(): IterableIterator<V> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -734,7 +734,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -768,7 +768,7 @@ entries(): IterableIterator<[K, V]> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -805,7 +805,7 @@ toString(): String **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -836,7 +836,7 @@ let iter = lightWeightMap.toString(); **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-lightweightset.md b/zh-cn/application-dev/reference/apis/js-apis-lightweightset.md index bd5ad4dba470c1017bf6c9714d550a21af1e2c29..2b7823b77e66da8e03ed3a937e832be30344f314 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-lightweightset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-lightweightset.md @@ -43,7 +43,7 @@ LightWeightSet的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -72,7 +72,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -107,7 +107,7 @@ add(obj: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -137,7 +137,7 @@ addAll(set: LightWeightSet<T>): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -177,7 +177,7 @@ hasAll(set: LightWeightSet<T>): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -217,7 +217,7 @@ has(key: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -255,7 +255,7 @@ equal(obj: Object): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -288,7 +288,7 @@ increaseCapacityTo(minimumCapacity: number): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -325,7 +325,7 @@ getIndexOf(key: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -363,7 +363,7 @@ remove(key: T): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -401,7 +401,7 @@ removeAt(index: number): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -439,7 +439,7 @@ getValueAt(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -465,7 +465,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -495,14 +495,6 @@ toString(): String | -------- | -------- | | String | 返回对应字符串。 | -**错误码：** - -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 - -| 错误码ID | 错误信息 | -| -------- | -------- | -| 10200011 | The toString method cannot be bound. | - **示例：** ```ts @@ -529,7 +521,7 @@ toArray(): Array<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -561,7 +553,7 @@ values(): IterableIterator<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -606,7 +598,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -640,7 +632,7 @@ entries(): IterableIterator<[T, T]> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -677,7 +669,7 @@ while(index < lightWeightSet.length) { **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-linkedlist.md b/zh-cn/application-dev/reference/apis/js-apis-linkedlist.md index 49e563ba232e8fb93d9a51dcf032972e3eca15a5..4add3e8a58999e7e1969a47c9b280367fa19116f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-linkedlist.md +++ b/zh-cn/application-dev/reference/apis/js-apis-linkedlist.md @@ -41,7 +41,7 @@ LinkedList的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -77,7 +77,7 @@ add(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -112,7 +112,7 @@ addFirst(element: T): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -148,7 +148,7 @@ insert(index: number, element: T): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -186,7 +186,7 @@ has(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -223,7 +223,7 @@ get(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -265,7 +265,7 @@ getLastIndexOf(element: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -307,7 +307,7 @@ getIndexOf(element: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -349,7 +349,7 @@ removeByIndex(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -384,7 +384,7 @@ removeFirst(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -419,7 +419,7 @@ removeLast(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -460,7 +460,7 @@ remove(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -499,7 +499,7 @@ removeFirstFound(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -539,7 +539,7 @@ removeLastFound(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -573,7 +573,7 @@ clone(): LinkedList<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -616,7 +616,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -645,7 +645,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -685,7 +685,7 @@ set(index: number, element: T): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -719,7 +719,7 @@ convertToArray(): Array<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -751,7 +751,7 @@ getFirst(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -784,7 +784,7 @@ getLast(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -817,7 +817,7 @@ linkedList.getLast(); **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-list.md b/zh-cn/application-dev/reference/apis/js-apis-list.md index e1da088b0ec3e656f2dd68d03a6769b6927d1503..6437f970f43def150dc114bb65214e57771e3bd4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-list.md +++ b/zh-cn/application-dev/reference/apis/js-apis-list.md @@ -40,7 +40,7 @@ List的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -75,7 +75,7 @@ add(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -111,7 +111,7 @@ insert(element: T, index: number): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -149,7 +149,7 @@ has(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -186,7 +186,7 @@ get(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -228,7 +228,7 @@ getLastIndexOf(element: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -270,7 +270,7 @@ getIndexOf(element: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -313,7 +313,7 @@ equal(obj: Object): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -358,7 +358,7 @@ removeByIndex(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -399,7 +399,7 @@ remove(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -442,7 +442,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -490,7 +490,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -532,7 +532,7 @@ comparator的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -573,7 +573,7 @@ getSubList(fromIndex: number, toIndex: number): List<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -603,7 +603,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -643,7 +643,7 @@ set(index: number, element: T): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -677,7 +677,7 @@ convertToArray(): Array<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -710,7 +710,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -743,7 +743,7 @@ getFirst(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -776,7 +776,7 @@ getLast(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -809,7 +809,7 @@ let result = list.getLast(); **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-plainarray.md b/zh-cn/application-dev/reference/apis/js-apis-plainarray.md index 5d45c7c81ed18dcf8a887f61c0ef5035e58dc6bc..fc77c0039193bd8988b6045c2b8d0837405df710 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-plainarray.md +++ b/zh-cn/application-dev/reference/apis/js-apis-plainarray.md @@ -43,7 +43,7 @@ PlainArray的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -72,7 +72,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -108,7 +108,7 @@ has(key: number): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -146,7 +146,7 @@ get(key: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -184,7 +184,7 @@ getIndexOfKey(key: number): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -222,7 +222,7 @@ getIndexOfValue(value: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -260,7 +260,7 @@ getKeyAt(index: number): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -297,7 +297,7 @@ getValueAt(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -329,7 +329,7 @@ clone(): PlainArray<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -362,7 +362,7 @@ add(key: number, value: T): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -398,7 +398,7 @@ remove(key: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -436,7 +436,7 @@ removeAt(index: number): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -475,7 +475,7 @@ removeRangeFrom(index: number, size: number): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -509,7 +509,7 @@ setValueAt(index: number, value: T): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -542,7 +542,7 @@ toString(): String **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -568,7 +568,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -608,7 +608,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -642,7 +642,7 @@ plainArray.forEach((value, index) => { **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-queue.md b/zh-cn/application-dev/reference/apis/js-apis-queue.md index d1867ea1928df30b69b67389aa62d249db9401c0..16de01a60ca82cc5c37435924b2dd7f1fcbe9c8d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-queue.md +++ b/zh-cn/application-dev/reference/apis/js-apis-queue.md @@ -40,7 +40,7 @@ Queue的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -75,7 +75,7 @@ add(element: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -109,7 +109,7 @@ pop(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -143,7 +143,7 @@ getFirst(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -186,7 +186,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -221,7 +221,7 @@ queue.forEach((value, index) => { **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-stack.md b/zh-cn/application-dev/reference/apis/js-apis-stack.md index 5e32474dc8af004c6e3bfb7d94fcaf8014ae67b5..bd30e4fc90703ec49f4392afc77e230064f9aefa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-stack.md +++ b/zh-cn/application-dev/reference/apis/js-apis-stack.md @@ -39,7 +39,7 @@ Stack的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -74,7 +74,7 @@ push(item: T): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -108,7 +108,7 @@ pop(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -142,7 +142,7 @@ peek(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -181,7 +181,7 @@ locate(element: T): number **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -224,7 +224,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -259,7 +259,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -292,7 +292,7 @@ let result = stack.isEmpty(); **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-treemap.md b/zh-cn/application-dev/reference/apis/js-apis-treemap.md index 56c03ddbff147208b19e90763690eeb7e7377152..88172bf388a5c8a9b053e9a4ef7282e7e5c129cd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-treemap.md +++ b/zh-cn/application-dev/reference/apis/js-apis-treemap.md @@ -48,7 +48,7 @@ TreeMap的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -77,7 +77,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -113,7 +113,7 @@ hasKey(key: K): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -151,7 +151,7 @@ hasValue(value: V): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -189,7 +189,7 @@ get(key: K): V **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -221,7 +221,7 @@ getFirstKey(): K **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -253,7 +253,7 @@ getLastKey(): K **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -285,7 +285,7 @@ setAll(map: TreeMap): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -325,7 +325,7 @@ set(key: K, value: V): Object **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -361,7 +361,7 @@ remove(key: K): V **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -399,7 +399,7 @@ getLowerKey(key: K): K **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -438,7 +438,7 @@ getHigherKey(key: K): K **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -477,7 +477,7 @@ replace(key: K, newValue: V): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -502,7 +502,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -534,7 +534,7 @@ keys(): IterableIterator<K> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -571,7 +571,7 @@ values(): IterableIterator<V> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -616,7 +616,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -650,7 +650,7 @@ entries(): IterableIterator<[K, V]> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -687,7 +687,7 @@ while(temp != undefined) { **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-treeset.md b/zh-cn/application-dev/reference/apis/js-apis-treeset.md index 6face00d64dcda42e9fbee451e924653b4f9b0c5..402ea10225fcdc632960f1fb35c4845b267f408b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-treeset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-treeset.md @@ -45,7 +45,7 @@ TreeSet的构造函数。 **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -74,7 +74,7 @@ isEmpty(): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -110,7 +110,7 @@ has(value: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -142,7 +142,7 @@ getFirstValue(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -174,7 +174,7 @@ getLastValue(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -212,7 +212,7 @@ add(value: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -248,7 +248,7 @@ remove(value: T): boolean **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -286,7 +286,7 @@ getLowerValue(key: T): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -325,7 +325,7 @@ getHigherValue(key: T): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -358,7 +358,7 @@ popFirst(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -390,7 +390,7 @@ popLast(): T **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -416,7 +416,7 @@ clear(): void **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -448,7 +448,7 @@ values(): IterableIterator<T> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -493,7 +493,7 @@ callbackfn的参数说明： **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -527,7 +527,7 @@ entries(): IterableIterator<[T, T]> **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | @@ -565,7 +565,7 @@ while(temp != undefined) { **错误码：** -以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)。 +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 | 错误码ID | 错误信息 | | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-uri.md b/zh-cn/application-dev/reference/apis/js-apis-uri.md index cdb616b74c7b403cf0993c98df71bb38bac37eee..0bdbebdcc84d95de7863b84f5a5e7204c0d9b44f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uri.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uri.md @@ -44,6 +44,14 @@ constructor是URI的构造函数。 | -------- | -------- | -------- | -------- | | uri | string | 是 | 入参对象。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200002 | Invalid uri string. | + **示例：** ```js @@ -79,14 +87,14 @@ result.toString() ### equals(deprecated) -> **说明：** -> -> 从API version 8开始支持，从API version 9开始废弃，建议使用[equalsTo9+](#equalsto9)替代。 - equals(other: URI): boolean 判断此URI是否与其他URI对象相等。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[equalsTo9+](#equalsto9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-url.md b/zh-cn/application-dev/reference/apis/js-apis-url.md index 845d9725007a48286fa64a7033cf56944c4c6329..f539153758e66eeb42cd3f69abb8e76e8fd964f8 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-url.md +++ b/zh-cn/application-dev/reference/apis/js-apis-url.md @@ -366,18 +366,148 @@ params.append('fod', '3'); console.log(params.toString()); ``` -## URLSearchParams(deprecated) +## URL + +### 属性 + +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| hash | string | 是 | 是 | 获取和设置URL的片段部分。 | +| host | string | 是 | 是 | 获取和设置URL的主机部分。 | +| hostname | string | 是 | 是 | 获取和设置URL的主机名部分，不带端口。 | +| href | string | 是 | 是 | 获取和设置序列化的URL。 | +| origin | string | 是 | 否 | 获取URL源的只读序列化。 | +| password | string | 是 | 是 | 获取和设置URL的密码部分。 | +| pathname | string | 是 | 是 | 获取和设置URL的路径部分。 | +| port | string | 是 | 是 | 获取和设置URL的端口部分。 | +| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 | +| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 | +| searchParams | URLSearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 | +| URLParams | URLParams | 是 | 否 | 获取URLParams表示URL查询参数的对象。 | +| username | string | 是 | 是 | 获取和设置URL的用户名部分。 | ### constructor(deprecated) +constructor(url: string, base?: string | URL) + +URL的构造函数。 + > **说明：** > -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+](#constructor9+)替代。 +> 从API version 7开始支持，从API version 9开始废弃，建议使用[parseURL9+](#parseurl9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| url | string | 是 | 入参对象。 | +| base | string \| URL | 否 | 入参字符串或者对象。
- string：字符串
- URL：字符串或对象 | + +**示例：** + +```js +let mm = 'http://username:password@host:8080'; +let a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/'; +let b = new Url.URL(mm); // Output 'http://username:password@host:8080/'; +new Url.URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1'; +let c = new Url.URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1'; +new Url.URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1'; +new Url.URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1'; +new Url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1 +new Url.URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL +new Url.URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL +new Url.URL('https://www.example.com', ); // Output https://www.example.com/ +new Url.URL('https://www.example.com', b); // Output https://www.example.com/ +``` + +### parseURL9+ + +static parseURL(url : string, base?: string | URL): URL + +URL静态成员函数。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| url | string | 是 | 入参对象。 | +| base | string \| URL | 否 | 入参字符串或者对象。
- string：字符串
- URL：字符串或对象 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200002 | Invalid url string. | + +**示例：** + +```js +let mm = 'http://username:password@host:8080'; +Url.URL.parseURL(mm); // Output 'http://username:password@host:8080/'; +``` + +### tostring + +toString(): string + +将解析过后的URL转化为字符串。 + +**系统能力：** SystemCapability.Utils.Lang + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 用于返回网址的字符串序列化。 | + +**示例：** + +```js +const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); +url.toString(); +``` + + +### toJSON + +toJSON(): string + +将解析过后的URL转化为JSON字符串。 + +**系统能力：** SystemCapability.Utils.Lang + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 用于返回网址的字符串序列化。 | + +**示例：** +```js +const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); +url.toJSON(); +``` + +## URLSearchParams(deprecated) + +### constructor(deprecated) constructor(init?: string[][] | Record<string, string> | string | URLSearchParams) URLSearchParams的构造函数。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+](#constructor9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -398,14 +528,14 @@ let params = new Url.URLSearchParams(urlObject.search); ### append(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.append9+](#append9)替代。 - append(name: string, value: string): void 将新的键值对插入到查询字符串。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.append9+](#append9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -425,14 +555,14 @@ paramsObject.append('fod', '3'); ### delete(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.delete9+](#delete9)替代。 - delete(name: string): void 删除指定名称的键值对。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.delete9+](#delete9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -451,14 +581,14 @@ paramsobject.delete('fod'); ### getAll(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.getAll9+](#getall9)替代。 - getAll(name: string): string[] 获取指定名称的所有键值对。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.getAll9+](#getall9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -484,14 +614,14 @@ console.log(params.getAll('fod').toString()) // Output ["1","3"]. ### entries(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.entries9+](#entries9)替代。 - entries(): IterableIterator<[string, string]> 返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.entries9+](#entries9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -511,14 +641,15 @@ for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pair ### forEach(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.forEach9+](#foreach9)替代。 forEach(callbackFn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void 通过回调函数来遍历URLSearchParams实例对象上的键值对。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.forEach9+](#foreach9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -547,14 +678,15 @@ myURLObject.searchParams.forEach((value, name, searchParams) => { ### get(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.get9+](#get9)替代。 get(name: string): string | null 获取指定名称对应的第一个值。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.get9+](#get9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -580,14 +712,15 @@ let age = parseInt(paramsObject.get("age"), 10); // is the number 18 ### has(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.has9+](#has9)替代。 has(name: string): boolean 判断一个指定的键名对应的值是否存在。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.has9+](#has9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -612,14 +745,15 @@ paramsObject.has('bard') === true; ### set(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.set9+](#set9)替代。 set(name: string, value: string): void 将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对，请将第一个键值对的值设置为value并删除所有其他值。如果不是，则将键值对附加到查询字符串。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.set9+](#set9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -639,14 +773,15 @@ paramsObject.set('baz', '3'); // Add a third parameter. ### sort(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.sort9+](#sort9)替代。 sort(): void 对包含在此对象中的所有键值对进行排序，并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 （即，将保留具有相等键的键值对之间的相对顺序）。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.sort9+](#sort9)替代。 + **系统能力：** SystemCapability.Utils.Lang **示例：** @@ -659,14 +794,15 @@ console.log(searchParamsObject.toString()); // Display the sorted query string / ### keys(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.keys9+](#keys9)替代。 keys(): IterableIterator<string> 返回一个所有键值对的name的ES6迭代器。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.keys9+](#keys9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -686,14 +822,15 @@ for (var key of searchParamsObject .keys()) { // Output key-value pairs ### values(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.values9+](#values9)替代。 values(): IterableIterator<string> 返回一个所有键值对的value的ES6迭代器。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.values9+](#values9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -714,14 +851,14 @@ for (var value of searchParams.values()) { ### [Symbol.iterator](deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[[Symbol.iterator]9+](#symboliterator9)替代。 - [Symbol.iterator]\(): IterableIterator<[string, string]> 返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[[Symbol.iterator]9+](#symboliterator9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -740,14 +877,15 @@ for (const [name, value] of paramsObject) { ``` ### tostring(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[tostring9+](#tostring9)替代。 toString(): string 返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[tostring9+](#tostring9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-util.md b/zh-cn/application-dev/reference/apis/js-apis-util.md index 18988029313b122955f9a4b4429f09aadda67c6e..5c7c72542afd36379f4f8fc2dab46d84347163c7 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-util.md +++ b/zh-cn/application-dev/reference/apis/js-apis-util.md @@ -41,38 +41,6 @@ let res = util.format("%s", "hello world!"); console.log(res); ``` -## util.printf(deprecated) - -printf(format: string, ...args: Object[]): string - -通过式样化字符串对输入的内容按特定格式输出。 - -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[util.format9+](#utilformat9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| format | string | 是 | 式样化字符串。 | -| ...args | Object[] | 否 | 替换式样化字符串通配符的数据。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| string | 按特定格式式样化后的字符串。 | - -**示例：** - - ```js - let res = util.printf("%s", "hello world!"); - console.log(res); - ``` - ## util.errnoToString9+ errnoToString(errno: number): string @@ -101,38 +69,6 @@ let result = util.errnoToString(errnum); console.log("result = " + result); ``` -## util.getErrorString(deprecated) - -getErrorString(errno: number): string - -获取系统错误码对应的详细信息。 - -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[util.errnoToString9+](#utilerrnotostring9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| errno | number | 是 | 系统发生错误产生的错误码。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| string | 错误码对应的详细信息。 | - -**示例：** - - ```js - let errnum = 10; // 10 : a system error number - let result = util.getErrorString(errnum); - console.log("result = " + result); - ``` - ## util.callbackWrapper callbackWrapper(original: Function): (err: Object, value: Object )=>void @@ -203,30 +139,6 @@ promisify(original: (err: Object, value: Object) => void): Function }) ``` -## util.promiseWrapper(deprecated) - -promiseWrapper(original: (err: Object, value: Object) => void): Object - -对异步函数处理并返回一个promise的版本。 - -> **说明：** -> -> 此接口不可用，建议使用[util.promisify9+](#utilpromisify9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| original | Function | 是 | 异步函数。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Function | 采用遵循常见的错误优先的回调风格的函数（也就是将 (err, value) => ... 回调作为最后一个参数），并返回一个返回 promise 的版本。 | - ## util.randomUUID9+ randomUUID(entropyCache?: boolean): string @@ -314,6 +226,96 @@ parseUUID(uuid: string): Uint8Array // 132,189,247,150,102,204,70,85,155,137,214,33,141,16,15,156 ``` +## util.printf(deprecated) + +printf(format: string, ...args: Object[]): string + +通过式样化字符串对输入的内容按特定格式输出。 + +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[util.format9+](#utilformat9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| format | string | 是 | 式样化字符串。 | +| ...args | Object[] | 否 | 替换式样化字符串通配符的数据。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 按特定格式式样化后的字符串。 | + +**示例：** + + ```js + let res = util.printf("%s", "hello world!"); + console.log(res); + ``` + + +## util.getErrorString(deprecated) + +getErrorString(errno: number): string + +获取系统错误码对应的详细信息。 + +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[util.errnoToString9+](#utilerrnotostring9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| errno | number | 是 | 系统发生错误产生的错误码。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 错误码对应的详细信息。 | + +**示例：** + + ```js + let errnum = 10; // 10 : a system error number + let result = util.getErrorString(errnum); + console.log("result = " + result); + ``` + +## util.promiseWrapper(deprecated) + +promiseWrapper(original: (err: Object, value: Object) => void): Object + +对异步函数处理并返回一个promise的版本。 + +> **说明：** +> +> 此接口不可用，建议使用[util.promisify9+](#utilpromisify9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| original | Function | 是 | 异步函数。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Function | 采用遵循常见的错误优先的回调风格的函数（也就是将 (err, value) => ... 回调作为最后一个参数），并返回一个返回 promise 的版本。 | + + ## TextDecoder ### 属性 @@ -363,38 +365,6 @@ let textDecoder = new util.TextDecoder() textDecoder.create('utf-8', { ignoreBOM : true }); ``` -### constructor(deprecated) - -constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },) - -TextDecoder的构造函数。 - -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| encoding | string | 否 | 编码格式。 | -| options | Object | 否 | 编码相关选项参数，存在两个属性fatal和ignoreBOM。 | - - **表1** options - -| 名称 | 参数类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| fatal | boolean | 否 | 是否显示致命错误。 | -| ignoreBOM | boolean | 否 | 是否忽略BOM标记。 | - -**示例：** - - ```js - let textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); - ``` - ### decode decode(input: Uint8Array, options?: { stream?: false }): string @@ -482,6 +452,37 @@ decodeWithStream(input: Uint8Array, options?: { stream?: boolean }): string console.log("retStr = " + retStr); ``` +### constructor(deprecated) + +constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },) + +TextDecoder的构造函数。 + +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| encoding | string | 否 | 编码格式。 | +| options | Object | 否 | 编码相关选项参数，存在两个属性fatal和ignoreBOM。 | + + **表1** options + +| 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| fatal | boolean | 否 | 是否显示致命错误。 | +| ignoreBOM | boolean | 否 | 是否忽略BOM标记。 | + +**示例：** + + ```js + let textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); + ``` ## TextEncoder @@ -537,78 +538,80 @@ let result = new Uint8Array(buffer); result = textEncoder.encodeInto("\uD800¥¥"); ``` -### encode(deprecated) - -encode(input?: string): Uint8Array +### encodeIntoUint8Array9+ -通过输入参数编码后输出对应文本。 +encodeIntoUint8Array(input: string, dest: Uint8Array, ): { read: number; written: number } -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[encodeInto9+](#encodeinto9)替代。 +放置生成的UTF-8编码文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| input | string | 否 | 需要编码的字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ------------------------------------------------------- | +| input | string | 是 | 需要编码的字符串。 | +| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | +| 类型 | 说明 | +| ---------- | ------------------ | | Uint8Array | 返回编码后的文本。 | **示例：** + ```js - let textEncoder = new util.TextEncoder(); - let buffer = new ArrayBuffer(20); - let result = new Uint8Array(buffer); - result = textEncoder.encode("\uD800¥¥"); +let that = new util.TextEncoder() +let buffer = new ArrayBuffer(4) +let dest = new Uint8Array(buffer) +let result = new Object() +result = that.encodeInto('abcd', dest) ``` -### encodeIntoUint8Array9+ +### encodeInto(deprecated) -encodeIntoUint8Array(input: string, dest: Uint8Array, ): { read: number; written: number } +encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } 放置生成的UTF-8编码文本。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[encodeIntoUint8Array9+](#encodeintouint8array9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ------------------------------------------------------- | -| input | string | 是 | 需要编码的字符串。 | -| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| input | string | 是 | 需要编码的字符串。 | +| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | **返回值：** -| 类型 | 说明 | -| ---------- | ------------------ | +| 类型 | 说明 | +| -------- | -------- | | Uint8Array | 返回编码后的文本。 | **示例：** - ```js -let that = new util.TextEncoder() -let buffer = new ArrayBuffer(4) -let dest = new Uint8Array(buffer) -let result = new Object() -result = that.encodeInto('abcd', dest) + let that = new util.TextEncoder() + let buffer = new ArrayBuffer(4) + let dest = new Uint8Array(buffer) + let result = new Object() + result = that.encodeInto('abcd', dest) ``` -### encodeInto(deprecated) +### encode(deprecated) -encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } +encode(input?: string): Uint8Array -放置生成的UTF-8编码文本。 +通过输入参数编码后输出对应文本。 > **说明：** > -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[encodeIntoUint8Array9+](#encodeintouint8array9)替代。 +> 从API version 7开始支持，从API version 9开始废弃，建议使用[encodeInto9+](#encodeinto9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -616,8 +619,7 @@ encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| input | string | 是 | 需要编码的字符串。 | -| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | +| input | string | 否 | 需要编码的字符串。 | **返回值：** @@ -627,11 +629,10 @@ encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } **示例：** ```js - let that = new util.TextEncoder() - let buffer = new ArrayBuffer(4) - let dest = new Uint8Array(buffer) - let result = new Object() - result = that.encodeInto('abcd', dest) + let textEncoder = new util.TextEncoder(); + let buffer = new ArrayBuffer(20); + let result = new Uint8Array(buffer); + result = textEncoder.encode("\uD800¥¥"); ``` ## RationalNumber8+ @@ -671,31 +672,6 @@ parseRationalNumber(numerator: number,denominator: number): RationalNumber let rationalNumber = util.RationalNumber.parseRationalNumber(1,2) ``` -### constructor(deprecated) - -constructor(numerator: number,denominator: number) - -RationalNumber的构造函数。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| numerator | number | 是 | 分子，整数类型。 | -| denominator | number | 是 | 分母，整数类型。 | - -**示例：** - -```js -let rationalNumber = new util.RationalNumber(1,2); -``` - ### createRationalFromString8+ static createRationalFromString​(rationalString: string): RationalNumber​ @@ -751,38 +727,6 @@ let rational = util.RationalNumber.createRationalFromString("3/4"); let result = rationalNumber.compare(rational); ``` -### compareTo(deprecated) - -compareTo​(another: RationalNumber): number​ - -将当前的RationalNumber对象与给定的对象进行比较。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[compare9+](#compare9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| another | RationalNumber | 是 | 其他的有理数对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| number | 如果两个对象相等，则返回0；如果给定对象小于当前对象，则返回1；如果给定对象大于当前对象，则返回-1。 | - -**示例：** - -```js -let rationalNumber = new util.RationalNumber(1,2); -let rational = util.RationalNumber.createRationalFromString("3/4"); -let result = rationalNumber.compareTo(rational); -``` - ### valueOf8+ valueOf(): number @@ -860,38 +804,6 @@ let rationalNumber = new util.RationalNumber(1,2); let result = util.RationalNumber.getCommonFactor(4,6); ``` -### getCommonDivisor(deprecated) - -static getCommonDivisor​(number1: number,number2: number): number - -获取两个指定整数的最大公约数。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getCommonFactor9+](#getcommonfactor9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| number1 | number | 是 | 整数类型。 | -| number2 | number | 是 | 整数类型。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| number | 返回两个给定数字的最大公约数。 | - -**示例：** - -```js -let rationalNumber = new util.RationalNumber(1,2); -let result = util.RationalNumber.getCommonDivisor(4,6); -``` - ### getNumerator8+ getNumerator​(): number @@ -1018,6 +930,94 @@ let rationalNumber = new util.RationalNumber(1,2); let result = rationalNumber.toString(); ``` +### constructor(deprecated) + +constructor(numerator: number,denominator: number) + +RationalNumber的构造函数。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| numerator | number | 是 | 分子，整数类型。 | +| denominator | number | 是 | 分母，整数类型。 | + +**示例：** + +```js +let rationalNumber = new util.RationalNumber(1,2); +``` + +### compareTo(deprecated) + +compareTo​(another: RationalNumber): number​ + +将当前的RationalNumber对象与给定的对象进行比较。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[compare9+](#compare9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| another | RationalNumber | 是 | 其他的有理数对象。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 如果两个对象相等，则返回0；如果给定对象小于当前对象，则返回1；如果给定对象大于当前对象，则返回-1。 | + +**示例：** + +```js +let rationalNumber = new util.RationalNumber(1,2); +let rational = util.RationalNumber.createRationalFromString("3/4"); +let result = rationalNumber.compareTo(rational); +``` + +### getCommonDivisor(deprecated) + +static getCommonDivisor​(number1: number,number2: number): number + +获取两个指定整数的最大公约数。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getCommonFactor9+](#getcommonfactor9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| number1 | number | 是 | 整数类型。 | +| number2 | number | 是 | 整数类型。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 返回两个给定数字的最大公约数。 | + +**示例：** + +```js +let rationalNumber = new util.RationalNumber(1,2); +let result = util.RationalNumber.getCommonDivisor(4,6); +``` ## LRUCache9+ @@ -1564,1026 +1564,987 @@ pro.put(2,10); let result = pro[Symbol.iterator](); ``` -## LruBuffer(deprecated) -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[LRUCache9+](#lrucache9)替代。 +## ScopeHelper9+ -### 属性 +### constructor9+ -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。 +constructor(lowerObj: ScopeType, upperObj: ScopeType) -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| length | number | 是 | 否 | 当前缓冲区中值的总数。 | +用于创建指定下限和上限的作用域实例的构造函数，返回一个ScopeHelper对象。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------------------- | +| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.put(1,8); - let result = pro.length; +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); ``` -### constructor(deprecated) -constructor(capacity?: number) +### toString9+ -默认构造函数用于创建一个新的LruBuffer实例，默认容量为64。 +toString(): string -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 +该字符串化方法返回一个包含当前范围的字符串表示形式。 **系统能力：** SystemCapability.Utils.Lang -**参数：** +**返回值：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| capacity | number | 否 | 指示要为缓冲区自定义的容量。 | +| 类型 | 说明 | +| ------ | -------------------------------------- | +| string | 返回包含当前范围对象的字符串表示形式。 | **示例：** ```js - let lrubuffer= new util.LruBuffer(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.toString(); ``` -### updateCapacity(deprecated) -updateCapacity(newCapacity: number): void +### intersect9+ -将缓冲区容量更新为指定容量，如果newCapacity小于或等于0，则抛出异常。 +intersect(range: ScopeHelper): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[updateCapacity9+](#updatecapacity9)替代。 +获取给定范围和当前范围的交集。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| newCapacity | number | 是 | 指示要为缓冲区自定义的容量。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------------- | ---- | ------------------ | +| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------ | ------------------------------ | +| [ScopeHelper9+](#scopehelper9) | 返回给定范围和当前范围的交集。 | **示例：** ```js - let pro = new util.LruBuffer(); - let result = pro.updateCapacity(100); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); +range.intersect(rangeFir ); ``` -### toString(deprecated) -toString(): string +### intersect9+ -返回对象的字符串表示形式。 +intersect(lowerObj:ScopeType,upperObj:ScopeType):ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[toString9+](#tostring9)替代。 +获取当前范围与给定下限和上限范围的交集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------------- | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| string | 返回对象的字符串表示形式。 | +| 类型 | 说明 | +| ---------------------------- | ---------------------------------------- | +| [ScopeHelper](#scopehelper9) | 返回当前范围与给定下限和上限范围的交集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.get(2); - pro.remove(20); - let result = pro.toString(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.intersect(tempMiDF, tempMidS); ``` -### getCapacity(deprecated) -getCapacity(): number +### getUpper9+ -获取当前缓冲区的容量。 +getUpper(): ScopeType -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getCapacity9+](#getcapacity9)替代。 +获取当前范围的上限。 **系统能力：** SystemCapability.Utils.Lang **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回当前缓冲区的容量。 | +| 类型 | 说明 | +| ------------------------ | ---------------------- | +| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | **示例：** + ```js - let pro = new util.LruBuffer(); - let result = pro.getCapacity(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.getUpper(); ``` -### clear(deprecated) -clear(): void +### getLower9+ -从当前缓冲区清除键值对。后续会调用afterRemoval()方法执行后续操作。 +getLower(): ScopeType -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[clear9+](#clear9)替代。 +获取当前范围的下限。 **系统能力：** SystemCapability.Utils.Lang +**返回值：** + +| 类型 | 说明 | +| ------------------------ | ---------------------- | +| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | + **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.length; - pro.clear(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.getLower(); ``` -### getCreateCount(deprecated) -getCreateCount(): number +### expand9+ -获取createDefault()返回值的次数。 +expand(lowerObj: ScopeType,upperObj: ScopeType): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getCreateCount9+](#getcreatecount9)替代。 +创建并返回包括当前范围和给定下限和上限的并集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------------- | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回createDefault()返回值的次数。 | +| 类型 | 说明 | +| ---------------------------- | ------------------------------------ | +| [ScopeHelper](#scopehelper9) | 返回当前范围和给定下限和上限的并集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(1,8); - let result = pro.getCreateCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.expand(tempMiDF, tempMidS); ``` -### getMissCount(deprecated) -getMissCount(): number +### expand9+ -获取查询值不匹配的次数。 +expand(range: ScopeHelper): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getMissCount9+](#getmisscount9)替代。 +创建并返回包括当前范围和给定范围的并集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------------- | ---- | ------------------ | +| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回查询值不匹配的次数。 | +| 类型 | 说明 | +| ---------------------------- | ---------------------------------- | +| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定范围的并集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.get(2); - let result = pro.getMissCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let range = new util.ScopeHelper(tempLower, tempUpper); +let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); +let result = range.expand(rangeFir); ``` -### getRemovalCount(deprecated) -getRemovalCount(): number +### expand9+ -获取从缓冲区中逐出值的次数。 +expand(value: ScopeType): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getRemovalCount9+](#getremovalcount9)替代。 +创建并返回包括当前范围和给定值的并集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------ | ---- | ---------------- | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回从缓冲区中驱逐的次数。 | +| 类型 | 说明 | +| ---------------------------- | -------------------------------- | +| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定值的并集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.updateCapacity(2); - pro.put(50,22); - let result = pro.getRemovalCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.expand(tempMiDF); ``` -### getMatchCount(deprecated) -getMatchCount(): number +### contains9+ -获取查询值匹配成功的次数。 +contains(value: ScopeType): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getMatchCount9+](#getmatchcount9)替代。 +检查给定value是否包含在当前范围内。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------ | ---- | ---------------- | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回查询值匹配成功的次数。 | +| 类型 | 说明 | +| ------- | --------------------------------------------------- | +| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.get(2); - let result = pro.getMatchCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let range = new util.ScopeHelper(tempLower, tempUpper); +range.contains(tempMiDF); ``` -### getPutCount(deprecated) -getPutCount(): number +### contains9+ -获取将值添加到缓冲区的次数。 +contains(range: ScopeHelper): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getPutCount9+](#getputcount9)替代。 +检查给定range是否在当前范围内。 **系统能力：** SystemCapability.Utils.Lang -**返回值：** +**参数：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回将值添加到缓冲区的次数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------------- | ---- | ------------------ | +| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ----------------------------------------------------- | +| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.getPutCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let tempLess = new Temperature(20); +let tempMore = new Temperature(45); +let rangeSec = new util.ScopeHelper(tempLess, tempMore); +let result = range.contains(rangeSec); ``` -### isEmpty(deprecated) -isEmpty(): boolean +### clamp9+ -检查当前缓冲区是否为空。 +clamp(value: ScopeType): ScopeType -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[isEmpty9+](#isempty9)替代。 +将给定值限定到当前范围内。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------ | ---- | -------------- | +| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| boolean | 如果当前缓冲区不包含任何值，则返回true。 | +| 类型 | 说明 | +| ------------------------ | ------------------------------------------------------------ | +| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.isEmpty(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.clamp(tempMiDF); ``` -### get(deprecated) +## Base64Helper9+ -get(key: K): V | undefined +### constructor9+ -表示要查询的键。 +constructor() -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[get9+](#get9)替代。 +Base64Helper的构造函数。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 要查询的键。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| V \| undefined | 如果指定的键存在于缓冲区中，则返回与键关联的值；否则返回undefined。 | - **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.get(2); +let base64 = new util.Base64Helper(); ``` -### put(deprecated) - -put(key: K,value: V): V +### encodeSync9+ -将键值对添加到缓冲区。 +encodeSync(src: Uint8Array): Uint8Array -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[put9+](#put9)替代。 +通过输入参数编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 要添加的密钥。 | -| value | V | 是 | 指示与要添加的键关联的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ------------------- | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| V | 返回与添加的键关联的值；如果要添加的键已经存在，则返回原始值，如果键或值为空，则抛出此异常。 | +| 类型 | 说明 | +| ---------- | ----------------------------- | +| Uint8Array | 返回编码后新分配的Uint8数组。 | **示例：** ```js - let pro = new util.LruBuffer(); - let result = pro.put(2,10); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +let result = that.encodeSync(array); ``` -### values(deprecated) -values(): V[] +### encodeToStringSync9+ -获取当前缓冲区中所有值从最近访问到最近最少访问的顺序列表。 +encodeToStringSync(src: Uint8Array): string -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[values9+](#values9)替代。 +通过输入参数编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ------------------- | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| V [] | 按从最近访问到最近最少访问的顺序返回当前缓冲区中所有值的列表。 | +| 类型 | 说明 | +| ------ | -------------------- | +| string | 返回编码后的字符串。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.put(2,"anhu"); - pro.put("afaf","grfb"); - let result = pro.values(); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +let result = that.encodeToStringSync(array); ``` -### keys(deprecated) -keys(): K[] +### decodeSync9+ -获取当前缓冲区中所有键从最近访问到最近最少访问的升序列表。 +decodeSync(src: Uint8Array | string): Uint8Array -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[keys9+](#keys9)替代。 +通过输入参数解码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------ | ---- | ----------------------------- | +| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| K [] | 按升序返回当前缓冲区中所有键的列表，从最近访问到最近最少访问。 | +| 类型 | 说明 | +| ---------- | ----------------------------- | +| Uint8Array | 返回解码后新分配的Uint8数组。 | **示例：** + ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.keys(); +let that = new util.Base64Helper(); +let buff = 'czEz'; +let result = that.decodeSync(buff); ``` -### remove(deprecated) -remove(key: K): V | undefined +### encode9+ -从当前缓冲区中删除指定的键及其关联的值。 +encode(src: Uint8Array): Promise<Uint8Array> -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[remove9+](#remove9)替代。 +通过输入参数异步编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 要删除的密钥。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ----------------------- | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| V \| undefined | 返回一个包含已删除键值对的Optional对象；如果key不存在，则返回一个空的Optional对象，如果key为null，则抛出异常。 | +| 类型 | 说明 | +| ------------------------- | --------------------------------- | +| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | **示例：** + ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.remove(20); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +let rarray = new Uint8Array([99,122,69,122]); +that.encode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } +}) ``` -### afterRemoval(deprecated) -afterRemoval(isEvict: boolean,key: K,value: V,newValue: V): void +### encodeToString9+ -删除值后执行后续操作。 +encodeToString(src: Uint8Array): Promise<string> -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[afterRemoval9+](#afterremoval9)替代。 +通过输入参数异步编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| isEvict | boolean | 是 | 因容量不足而调用该方法时，参数值为true，其他情况为false。 | -| key | K | 是 | 表示删除的键。 | -| value | V | 是 | 表示删除的值。 | -| newValue | V | 是 | 如果已调用put方法并且要添加的键已经存在，则参数值是关联的新值。其他情况下参数值为空。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ----------------------- | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | ------------------------ | +| Promise<string> | 返回异步编码后的字符串。 | **示例：** ```js - let arr = []; - class ChildLruBuffer extends util.LruBuffer - { - constructor() - { - super(); - } - afterRemoval(isEvict, key, value, newValue) - { - if (isEvict === false) - { - arr = [key, value, newValue]; - } - } - } - let lru = new ChildLruBuffer(); - lru.afterRemoval(false,10,30,null); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +that.encodeToString(array).then(val=>{ + console.log(val) +}) ``` -### contains(deprecated) -contains(key: K): boolean - -检查当前缓冲区是否包含指定的键。 +### decode9+ +decode(src: Uint8Array | string): Promise<Uint8Array> -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[contains9+](#contains9)替代。 +通过输入参数异步解码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 表示要检查的键。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------ | ---- | --------------------------------- | +| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| boolean | 如果缓冲区包含指定的键，则返回 true。 | +| 类型 | 说明 | +| ------------------------- | --------------------------------- | +| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.contains(20); +let that = new util.Base64Helper(); +let array = new Uint8Array([99,122,69,122]); +let rarray = new Uint8Array([115,49,51]); +that.decode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } +}) ``` -### createDefault(deprecated) - -createDefault(key: K): V -如果未计算特定键的值，则执行后续操作，参数表示丢失的键，返回与键关联的值。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[createDefault9+](#createdefault9)替代。 +## types8+ -**系统能力：** SystemCapability.Utils.Lang -**参数：** +### constructor8+ -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 表示丢失的键。 | +constructor() -**返回值：** +Types的构造函数。 -| 类型 | 说明 | -| -------- | -------- | -| V | 返回与键关联的值。 | +**系统能力：** SystemCapability.Utils.Lang **示例：** ```js - let pro = new util.LruBuffer(); - let result = pro.createDefault(50); + let type = new util.types(); ``` -### entries(deprecated) -entries(): IterableIterator<[K,V]> +### isAnyArrayBuffer8+ -允许迭代包含在这个对象中的所有键值对。 +isAnyArrayBuffer(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[entries9+](#entries9)替代。 +检查输入的value是否是ArrayBuffer类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [K, V] | 返回一个可迭代数组。 | +| boolean | 判断的结果，如果是ArrayBuffer类型为true，反之为false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.entries(); + let that = new util.types(); + let result = that.isAnyArrayBuffer(new ArrayBuffer(0)); ``` -### [Symbol.iterator](deprecated) -[Symbol.iterator]\(): IterableIterator<[K, V]> +### isArrayBufferView8+ -返回一个键值对形式的二维数组。 +isArrayBufferView(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[Symbol.iterator9+](#symboliterator9)替代。 +检查输入的value是否是内置ArrayBufferView辅助类型。 + +ArrayBufferView辅助类型包括：Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint32Array、Float32Array、Float64Array、DataView。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [K, V] | 返回一个键值对形式的二维数组。 | +| boolean | 判断的结果，如果是内置包含的ArrayBufferView辅助类型为true，反之为false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro[Symbol.iterator](); + let that = new util.types(); + let result = that.isArrayBufferView(new Int8Array([])); ``` -### ScopeType8+ - -用于表示范围中的值的类型。该类型的值，类型可以为ScopeComparable或number。 - -ScopeComparable类型的值需要实现compareTo方法，确保传入的数据具有可比性。 - -```js -interface ScopeComparable{ - compareTo(other: ScopeComparable): boolean; -} -type ScopeType = ScopeComparable | number; -``` - - -构造新类，实现compareTo方法。后续示例代码中，均通过Temperature，获取[ScopeType](#scopetype8)的实例化对象。 - - -示例： -```js -class Temperature{ - constructor(value){ - // 当使用ts语言开发时，需要补充以下代码： - // private readonly _temp: Temperature; - this._temp = value; - } - compareTo(value){ - return this._temp >= value.getTemp(); - } - getTemp(){ - return this._temp; - } - toString(){ - return this._temp.toString(); - } -} -``` - -## ScopeHelper9+ -### constructor9+ +### isArgumentsObject8+ -constructor(lowerObj: ScopeType, upperObj: ScopeType) +isArgumentsObject(value: Object): boolean -用于创建指定下限和上限的作用域实例的构造函数，返回一个ScopeHelper对象。 +检查输入的value是否是一个arguments对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------ | ---- | ---------------------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的arguments类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); + let that = new util.types(); + function foo() { + var result = that.isArgumentsObject(arguments); + } + let f = foo(); ``` -### toString9+ +### isArrayBuffer8+ -toString(): string +isArrayBuffer(value: Object): boolean -该字符串化方法返回一个包含当前范围的字符串表示形式。 +检查输入的value是否是ArrayBuffer类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** -| 类型 | 说明 | -| ------ | -------------------------------------- | -| string | 返回包含当前范围对象的字符串表示形式。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的ArrayBuffer类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.toString(); + let that = new util.types(); + let result = that.isArrayBuffer(new ArrayBuffer(0)); ``` -### intersect9+ +### isAsyncFunction8+ -intersect(range: ScopeHelper): ScopeHelper +isAsyncFunction(value: Object): boolean -获取给定范围和当前范围的交集。 +检查输入的value是否是一个异步函数类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------- | ---- | ------------------ | -| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------------ | ------------------------------ | -| [ScopeHelper9+](#scopehelper9) | 返回给定范围和当前范围的交集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的异步函数类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); -range.intersect(rangeFir ); + let that = new util.types(); + let result = that.isAsyncFunction(async function foo() {}); ``` -### intersect9+ +### isBooleanObject8+ -intersect(lowerObj:ScopeType,upperObj:ScopeType):ScopeHelper +isBooleanObject(value: Object): boolean -获取当前范围与给定下限和上限范围的交集。 +检查输入的value是否是一个Boolean对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------ | ---- | ---------------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | ---------------------------------------- | -| [ScopeHelper](#scopehelper9) | 返回当前范围与给定下限和上限范围的交集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Boolean对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.intersect(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isBooleanObject(new Boolean(true)); ``` -### getUpper9+ +### isBoxedPrimitive8+ -getUpper(): ScopeType +isBoxedPrimitive(value: Object): boolean -获取当前范围的上限。 +检查输入的value是否是Boolean或Number或String或Symbol对象类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** -| 类型 | 说明 | -| ------------------------ | ---------------------- | -| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Boolean或Number或String或Symbol对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.getUpper(); + let that = new util.types(); + let result = that.isBoxedPrimitive(new Boolean(false)); ``` -### getLower9+ +### isDataView8+ -getLower(): ScopeType +isDataView(value: Object): boolean -获取当前范围的下限。 +检查输入的value是否是DataView类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** -| 类型 | 说明 | -| ------------------------ | ---------------------- | -| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的DataView对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.getLower(); + let that = new util.types(); + const ab = new ArrayBuffer(20); + let result = that.isDataView(new DataView(ab)); ``` -### expand9+ +### isDate8+ -expand(lowerObj: ScopeType,upperObj: ScopeType): ScopeHelper +isDate(value: Object): boolean -创建并返回包括当前范围和给定下限和上限的并集。 +检查输入的value是否是Date类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------ | ---- | ---------------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | ------------------------------------ | -| [ScopeHelper](#scopehelper9) | 返回当前范围和给定下限和上限的并集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Date对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.expand(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isDate(new Date()); ``` -### expand9+ +### isExternal8+ -expand(range: ScopeHelper): ScopeHelper +isExternal(value: Object): boolean -创建并返回包括当前范围和给定范围的并集。 +检查输入的value是否是native External类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------- | ---- | ------------------ | -| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | ---------------------------------- | -| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定范围的并集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含native External类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let range = new util.ScopeHelper(tempLower, tempUpper); -let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); -let result = range.expand(rangeFir); + let that = new util.types(); + let result = that.isExternal(true); ``` -### expand9+ +### isFloat32Array8+ -expand(value: ScopeType): ScopeHelper +isFloat32Array(value: Object): boolean -创建并返回包括当前范围和给定值的并集。 +检查输入的value是否是Float32Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------ | ---- | ---------------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | -------------------------------- | -| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定值的并集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Float32Array数组类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.expand(tempMiDF); + let that = new util.types(); + let result = that.isFloat32Array(new Float32Array()); ``` -### contains9+ +### isFloat64Array8+ -contains(value: ScopeType): boolean +isFloat64Array(value: Object): boolean -检查给定value是否包含在当前范围内。 +检查输入的value是否是Float64Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------ | ---- | ---------------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------- | --------------------------------------------------- | -| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Float64Array数组类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let range = new util.ScopeHelper(tempLower, tempUpper); -range.contains(tempMiDF); + let that = new util.types(); + let result = that.isFloat64Array(new Float64Array()); ``` -### contains9+ +### isGeneratorFunction8+ -contains(range: ScopeHelper): boolean +isGeneratorFunction(value: Object): boolean -检查给定range是否在当前范围内。 +检查输入的value是否是generator函数类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------- | ---- | ------------------ | -| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------- | ----------------------------------------------------- | -| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的generator函数类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let tempLess = new Temperature(20); -let tempMore = new Temperature(45); -let rangeSec = new util.ScopeHelper(tempLess, tempMore); -let result = range.contains(rangeSec); + let that = new util.types(); + let result = that.isGeneratorFunction(function* foo() {}); ``` -### clamp9+ +### isGeneratorObject8+ -clamp(value: ScopeType): ScopeType +isGeneratorObject(value: Object): boolean -将给定值限定到当前范围内。 +检查输入的value是否是generator对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------ | ---- | -------------- | -| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------ | ------------------------------------------------------------ | -| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的generator对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.clamp(tempMiDF); + let that = new util.types(); + function* foo() {} + const generator = foo(); + let result = that.isGeneratorObject(generator); ``` -## Scope(deprecated) - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[ScopeHelper9+](#scopehelper9)替代。 - -### constructor(deprecated) -constructor(lowerObj: ScopeType, upperObj: ScopeType) - -用于创建指定下限和上限的作用域实例的构造函数，返回一个Scope对象。 +### isInt8Array8+ -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 +isInt8Array(value: Object): boolean +检查输入的value是否是Int8Array数组类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2591,52 +2552,55 @@ constructor(lowerObj: ScopeType, upperObj: ScopeType) | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | +| value | Object | 是 | 待检测对象。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Int8Array数组类型为true，反之为false。 | **示例：** + ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); + let that = new util.types(); + let result = that.isInt8Array(new Int8Array([])); ``` -### toString(deprecated) -toString(): string +### isInt16Array8+ -该字符串化方法返回一个包含当前范围的字符串表示形式。 +isInt16Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[toString9+](#tostring9)替代。 +检查输入的value是否是Int16Array数组类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| string | 返回包含当前范围对象的字符串表示形式。 | +| boolean | 判断的结果，如果是内置包含的Int16Array数组类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let result = range.toString(); + let that = new util.types(); + let result = that.isInt16Array(new Int16Array([])); ``` -### intersect(deprecated) -intersect(range: Scope): Scope +### isInt32Array8+ -获取给定范围和当前范围的交集。 +isInt32Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 +检查输入的value是否是Int32Array数组类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2644,35 +2608,27 @@ intersect(range: Scope): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回给定范围和当前范围的交集。 | +| boolean | 判断的结果，如果是内置包含的Int32Array数组类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let rangeFir = new util.Scope(tempMiDF, tempMidS); - range.intersect(rangeFir ); + let that = new util.types(); + let result = that.isInt32Array(new Int32Array([])); ``` -### intersect(deprecated) -intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope +### isMap8+ -获取当前范围与给定下限和上限范围的交集。 +isMap(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 +检查输入的value是否是Map类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2680,89 +2636,85 @@ intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回当前范围与给定下限和上限范围的交集。 | +| boolean | 判断的结果，如果是内置包含的Map类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let range = new util.Scope(tempLower, tempUpper); - let result = range.intersect(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isMap(new Map()); ``` -### getUpper(deprecated) -getUpper(): ScopeType +### isMapIterator8+ -获取当前范围的上限。 +isMapIterator(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getUpper9+](#getupper9)替代。 +检查输入的value是否是Map的Iterator类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | +| boolean | 判断的结果，如果是内置包含的Map的Iterator类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let result = range.getUpper(); + let that = new util.types(); + const map = new Map(); + let result = that.isMapIterator(map.keys()); ``` -### getLower(deprecated) -getLower(): ScopeType +### isNativeError8+ -获取当前范围的下限。 +isNativeError(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getLower9+](#getlower9)替代。 +检查输入的value是否是Error类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | +| boolean | 判断的结果，如果是内置包含的Error类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let result = range.getLower(); + let that = new util.types(); + let result = that.isNativeError(new TypeError()); ``` -### expand(deprecated) -expand(lowerObj: ScopeType,upperObj: ScopeType): Scope +### isNumberObject8+ -创建并返回包括当前范围和给定下限和上限的并集。 +isNumberObject(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[expand9+](#expand9)替代。 +检查输入的value是否是Number对象类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2770,35 +2722,27 @@ expand(lowerObj: ScopeType,upperObj: ScopeType): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回当前范围和给定下限和上限的并集。 | +| boolean | 判断的结果，如果是内置包含的Number对象类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let range = new util.Scope(tempLower, tempUpper); - let result = range.expand(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isNumberObject(new Number(0)); ``` -### expand(deprecated) -expand(range: Scope): Scope +### isPromise8+ -创建并返回包括当前范围和给定范围的并集。 +isPromise(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[expand9+](#expand9)替代。 +检查输入的value是否是Promise类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2806,35 +2750,27 @@ expand(range: Scope): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回包括当前范围和给定范围的并集。 | +| boolean | 判断的结果，如果是内置包含的Promise类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let range = new util.Scope(tempLower, tempUpper); - let rangeFir = new util.Scope(tempMiDF, tempMidS); - let result = range.expand(rangeFir); + let that = new util.types(); + let result = that.isPromise(Promise.resolve(1)); ``` -### expand(deprecated) -expand(value: ScopeType): Scope +### isProxy8+ -创建并返回包括当前范围和给定值的并集。 +isProxy(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[expand9+](#expand9)替代。 +检查输入的value是否是Proxy类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2842,33 +2778,29 @@ expand(value: ScopeType): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回包括当前范围和给定值的并集。 | +| boolean | 判断的结果，如果是内置包含的Proxy类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let range = new util.Scope(tempLower, tempUpper); - let result = range.expand(tempMiDF); + let that = new util.types(); + const target = {}; + const proxy = new Proxy(target, {}); + let result = that.isProxy(proxy); ``` -### contains(deprecated) -contains(value: ScopeType): boolean +### isRegExp8+ -检查给定value是否包含在当前范围内。 +isRegExp(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[contains9+](#contains9)替代。 +检查输入的value是否是RegExp类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2876,33 +2808,27 @@ contains(value: ScopeType): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | +| boolean | 判断的结果，如果是内置包含的RegExp类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let range = new util.Scope(tempLower, tempUpper); - range.contains(tempMiDF); + let that = new util.types(); + let result = that.isRegExp(new RegExp('abc')); ``` -### contains(deprecated) -contains(range: Scope): boolean +### isSet8+ -检查给定range是否在当前范围内。 +isSet(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[contains9+](#contains9)替代。 +检查输入的value是否是Set类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2910,36 +2836,27 @@ contains(range: Scope): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | +| boolean | 判断的结果，如果是内置包含的Set类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let tempLess = new Temperature(20); - let tempMore = new Temperature(45); - let rangeSec = new util.Scope(tempLess, tempMore); - let result = range.contains(rangeSec); + let that = new util.types(); + let result = that.isSet(new Set()); ``` -### clamp(deprecated) - -clamp(value: ScopeType): ScopeType +### isSetIterator8+ -将给定值限定到当前范围内。 +isSetIterator(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[clamp9+](#clamp9)替代。 +检查输入的value是否是Set的Iterator类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2947,259 +2864,227 @@ clamp(value: ScopeType): ScopeType | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | +| boolean | 判断的结果，如果是内置包含的Set的Iterator类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let range = new util.Scope(tempLower, tempUpper); - let result = range.clamp(tempMiDF); + let that = new util.types(); + const set = new Set(); + let result = that.isSetIterator(set.keys()); ``` -## Base64Helper9+ - -### constructor9+ - -constructor() - -Base64Helper的构造函数。 - -**系统能力：** SystemCapability.Utils.Lang - -**示例：** - - ```js -let base64 = new util.Base64Helper(); - ``` -### encodeSync9+ +### isStringObject8+ -encodeSync(src: Uint8Array): Uint8Array +isStringObject(value: Object): boolean -通过输入参数编码后输出对应文本。 +检查输入的value是否是String对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ------------------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------- | ----------------------------- | -| Uint8Array | 返回编码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的String对象类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -let result = that.encodeSync(array); + let that = new util.types(); + let result = that.isStringObject(new String('foo')); ``` -### encodeToStringSync9+ +### isSymbolObjec8+ -encodeToStringSync(src: Uint8Array): string +isSymbolObject(value: Object): boolean -通过输入参数编码后输出对应文本。 +检查输入的value是否是Symbol对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ------------------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------ | -------------------- | -| string | 返回编码后的字符串。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Symbol对象类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -let result = that.encodeToStringSync(array); + let that = new util.types(); + const symbols = Symbol('foo'); + let result = that.isSymbolObject(Object(symbols)); ``` -### decodeSync9+ +### isTypedArray8+ -decodeSync(src: Uint8Array | string): Uint8Array +isTypedArray(value: Object): boolean -通过输入参数解码后输出对应文本。 +检查输入的value是否是TypedArray类型的辅助类型。 + +TypedArray类型的辅助类型，包括Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint16Array、Uint32Array、Float32Array、Float64Array、DataView。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------------ | ---- | ----------------------------- | -| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------- | ----------------------------- | -| Uint8Array | 返回解码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的TypedArray包含的类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let buff = 'czEz'; -let result = that.decodeSync(buff); + let that = new util.types(); + let result = that.isTypedArray(new Float64Array([])); ``` -### encode9+ +### isUint8Array8+ -encode(src: Uint8Array): Promise<Uint8Array> +isUint8Array(value: Object): boolean -通过输入参数异步编码后输出对应文本。 +检查输入的value是否是Uint8Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ----------------------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------- | --------------------------------- | -| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint8Array数组类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -let rarray = new Uint8Array([99,122,69,122]); -that.encode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } -}) + let that = new util.types(); + let result = that.isUint8Array(new Uint8Array([])); ``` -### encodeToString9+ +### isUint8ClampedArray8+ -encodeToString(src: Uint8Array): Promise<string> +isUint8ClampedArray(value: Object): boolean -通过输入参数异步编码后输出对应文本。 +检查输入的value是否是Uint8ClampedArray数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ----------------------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| --------------------- | ------------------------ | -| Promise<string> | 返回异步编码后的字符串。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint8ClampedArray数组类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -that.encodeToString(array).then(val=>{ - console.log(val) -}) + let that = new util.types(); + let result = that.isUint8ClampedArray(new Uint8ClampedArray([])); ``` -### decode9+ +### isUint16Array8+ -decode(src: Uint8Array | string): Promise<Uint8Array> +isUint16Array(value: Object): boolean -通过输入参数异步解码后输出对应文本。 +检查输入的value是否是Uint16Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------------ | ---- | --------------------------------- | -| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------- | --------------------------------- | -| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint16Array数组类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([99,122,69,122]); -let rarray = new Uint8Array([115,49,51]); -that.decode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } -}) + let that = new util.types(); + let result = that.isUint16Array(new Uint16Array([])); ``` -## Base64(deprecated) +### isUint32Array8+ -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[Base64Helper9+](#base64helper9)替代。 +isUint32Array(value: Object): boolean -### constructor(deprecated) +检查输入的value是否是Uint32Array数组类型。 -constructor() +**系统能力：** SystemCapability.Utils.Lang -Base64的构造函数。 +**参数：** -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | -**系统能力：** SystemCapability.Utils.Lang +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint32Array数组类型为true，反之为false。 | **示例：** ```js - let base64 = new util.Base64(); + let that = new util.types(); + let result = that.isUint32Array(new Uint32Array([])); ``` -### encodeSync(deprecated) -encodeSync(src: Uint8Array): Uint8Array +### isWeakMap8+ -通过输入参数编码后输出对应文本。 +isWeakMap(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encodeSync9+](#encodesync9)替代。 +检查输入的value是否是WeakMap类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3207,31 +3092,27 @@ encodeSync(src: Uint8Array): Uint8Array | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Uint8Array | 返回编码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的WeakMap类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - let result = that.encodeSync(array); + let that = new util.types(); + let result = that.isWeakMap(new WeakMap()); ``` -### encodeToStringSync(deprecated) -encodeToStringSync(src: Uint8Array): string +### isWeakSet8+ -通过输入参数编码后输出对应文本。 +isWeakSet(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encodeToStringSync9+](#encodetostringsync9)替代。 +检查输入的value是否是WeakSet类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3239,31 +3120,27 @@ encodeToStringSync(src: Uint8Array): string | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| string | 返回编码后的字符串。 | +| boolean | 判断的结果，如果是内置包含的WeakSet类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - let result = that.encodeToStringSync(array); + let that = new util.types(); + let result = that.isWeakSet(new WeakSet()); ``` -### decodeSync(deprecated) -decodeSync(src: Uint8Array | string): Uint8Array +### isBigInt64Array8+ -通过输入参数解码后输出对应文本。 +isBigInt64Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[decodeSync9+](#decodesync9)替代。 +检查输入的value是否是BigInt64Array类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3271,31 +3148,27 @@ decodeSync(src: Uint8Array | string): Uint8Array | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Uint8Array | 返回解码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的BigInt64Array类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let buff = 'czEz'; - let result = that.decodeSync(buff); + let that = new util.types(); + let result = that.isBigInt64Array(new BigInt64Array([])); ``` -### encode(deprecated) -encode(src: Uint8Array): Promise<Uint8Array> +### isBigUint64Array8+ -通过输入参数异步编码后输出对应文本。 +isBigUint64Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encode9+](#encode9)替代。 +检查输入的value是否是BigUint64Array类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3303,36 +3176,27 @@ encode(src: Uint8Array): Promise<Uint8Array> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的BigUint64Array类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - let rarray = new Uint8Array([99,122,69,122]); - that.encode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } - }) + let that = new util.types(); + let result = that.isBigUint64Array(new BigUint64Array([])); ``` -### encodeToString(deprecated) -encodeToString(src: Uint8Array): Promise<string> +### isModuleNamespaceObject8+ -通过输入参数异步编码后输出对应文本。 +isModuleNamespaceObject(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encodeToString9+](#encodetostring9)替代。 +检查输入的value是否是Module Namespace Object类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3340,34 +3204,28 @@ encodeToString(src: Uint8Array): Promise<string> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise<string> | 返回异步编码后的字符串。 | +| boolean | 判断的结果，如果是内置包含的Module Namespace Object类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - that.encodeToString(array).then(val=>{ - console.log(val) - }) + import url from '@ohos.url' + let that = new util.types(); + let result = that.isModuleNamespaceObject(url); ``` -### decode(deprecated) - -decode(src: Uint8Array | string): Promise<Uint8Array> +### isSharedArrayBuffer8+ -通过输入参数异步解码后输出对应文本。 +isSharedArrayBuffer(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[decode9+](#decode9)替代。 +检查输入的value是否是SharedArrayBuffer类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3375,50 +3233,53 @@ decode(src: Uint8Array | string): Promise<Uint8Array> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的SharedArrayBuffer类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([99,122,69,122]); - let rarray = new Uint8Array([115,49,51]); - that.decode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } - }) + let that = new util.types(); + let result = that.isSharedArrayBuffer(new SharedArrayBuffer(0)); ``` -## types8+ - +## LruBuffer(deprecated) -### constructor8+ +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[LRUCache9+](#lrucache9)替代。 -constructor() +### 属性 -Types的构造函数。 +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。 -**系统能力：** SystemCapability.Utils.Lang +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| length | number | 是 | 否 | 当前缓冲区中值的总数。 | **示例：** ```js - let type = new util.types(); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.put(1,8); + let result = pro.length; ``` +### constructor(deprecated) -### isAnyArrayBuffer8+ +constructor(capacity?: number) -isAnyArrayBuffer(value: Object): boolean +默认构造函数用于创建一个新的LruBuffer实例，默认容量为64。 -检查输入的value是否是ArrayBuffer类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3426,29 +3287,23 @@ isAnyArrayBuffer(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是ArrayBuffer类型为true，反之为false。 | +| capacity | number | 否 | 指示要为缓冲区自定义的容量。 | **示例：** ```js - let that = new util.types(); - let result = that.isAnyArrayBuffer(new ArrayBuffer(0)); + let lrubuffer= new util.LruBuffer(); ``` +### updateCapacity(deprecated) -### isArrayBufferView8+ - -isArrayBufferView(value: Object): boolean +updateCapacity(newCapacity: number): void -检查输入的value是否是内置ArrayBufferView辅助类型。 +将缓冲区容量更新为指定容量，如果newCapacity小于或等于0，则抛出异常。 -ArrayBufferView辅助类型包括：Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint32Array、Float32Array、Float64Array、DataView。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[updateCapacity9+](#updatecapacity9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3456,255 +3311,257 @@ ArrayBufferView辅助类型包括：Int8Array、Int16Array、Int32Array、Uint8A | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的ArrayBufferView辅助类型为true，反之为false。 | +| newCapacity | number | 是 | 指示要为缓冲区自定义的容量。 | **示例：** ```js - let that = new util.types(); - let result = that.isArrayBufferView(new Int8Array([])); + let pro = new util.LruBuffer(); + let result = pro.updateCapacity(100); ``` +### toString(deprecated) -### isArgumentsObject8+ +toString(): string -isArgumentsObject(value: Object): boolean +返回对象的字符串表示形式。 -检查输入的value是否是一个arguments对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[toString9+](#tostring9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的arguments类型为true，反之为false。 | +| string | 返回对象的字符串表示形式。 | **示例：** ```js - let that = new util.types(); - function foo() { - var result = that.isArgumentsObject(arguments); - } - let f = foo(); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + pro.remove(20); + let result = pro.toString(); ``` +### getCapacity(deprecated) -### isArrayBuffer8+ +getCapacity(): number -isArrayBuffer(value: Object): boolean +获取当前缓冲区的容量。 -检查输入的value是否是ArrayBuffer类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getCapacity9+](#getcapacity9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的ArrayBuffer类型为true，反之为false。 | +| number | 返回当前缓冲区的容量。 | **示例：** - ```js - let that = new util.types(); - let result = that.isArrayBuffer(new ArrayBuffer(0)); + let pro = new util.LruBuffer(); + let result = pro.getCapacity(); ``` +### clear(deprecated) -### isAsyncFunction8+ +clear(): void -isAsyncFunction(value: Object): boolean +从当前缓冲区清除键值对。后续会调用afterRemoval()方法执行后续操作。 -检查输入的value是否是一个异步函数类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[clear9+](#clear9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** +**示例：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | + ```js + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.length; + pro.clear(); + ``` + +### getCreateCount(deprecated) + +getCreateCount(): number + +获取createDefault()返回值的次数。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getCreateCount9+](#getcreatecount9)替代。 + +**系统能力：** SystemCapability.Utils.Lang **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的异步函数类型为true，反之为false。 | +| number | 返回createDefault()返回值的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isAsyncFunction(async function foo() {}); + let pro = new util.LruBuffer(); + pro.put(1,8); + let result = pro.getCreateCount(); ``` +### getMissCount(deprecated) -### isBooleanObject8+ +getMissCount(): number -isBooleanObject(value: Object): boolean +获取查询值不匹配的次数。 -检查输入的value是否是一个Boolean对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getMissCount9+](#getmisscount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Boolean对象类型为true，反之为false。 | +| number | 返回查询值不匹配的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isBooleanObject(new Boolean(true)); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + let result = pro.getMissCount(); ``` +### getRemovalCount(deprecated) -### isBoxedPrimitive8+ +getRemovalCount(): number -isBoxedPrimitive(value: Object): boolean +获取从缓冲区中逐出值的次数。 -检查输入的value是否是Boolean或Number或String或Symbol对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getRemovalCount9+](#getremovalcount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Boolean或Number或String或Symbol对象类型为true，反之为false。 | +| number | 返回从缓冲区中驱逐的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isBoxedPrimitive(new Boolean(false)); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.updateCapacity(2); + pro.put(50,22); + let result = pro.getRemovalCount(); ``` +### getMatchCount(deprecated) -### isDataView8+ +getMatchCount(): number -isDataView(value: Object): boolean +获取查询值匹配成功的次数。 -检查输入的value是否是DataView类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getMatchCount9+](#getmatchcount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的DataView对象类型为true，反之为false。 | +| number | 返回查询值匹配成功的次数。 | **示例：** ```js - let that = new util.types(); - const ab = new ArrayBuffer(20); - let result = that.isDataView(new DataView(ab)); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + let result = pro.getMatchCount(); ``` +### getPutCount(deprecated) -### isDate8+ +getPutCount(): number -isDate(value: Object): boolean +获取将值添加到缓冲区的次数。 -检查输入的value是否是Date类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getPutCount9+](#getputcount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Date对象类型为true，反之为false。 | +| number | 返回将值添加到缓冲区的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isDate(new Date()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.getPutCount(); ``` +### isEmpty(deprecated) -### isExternal8+ +isEmpty(): boolean -isExternal(value: Object): boolean +检查当前缓冲区是否为空。 -检查输入的value是否是native External类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[isEmpty9+](#isempty9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含native External类型为true，反之为false。 | +| boolean | 如果当前缓冲区不包含任何值，则返回true。 | **示例：** ```js - let that = new util.types(); - let result = that.isExternal(true); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.isEmpty(); ``` +### get(deprecated) -### isFloat32Array8+ +get(key: K): V | undefined -isFloat32Array(value: Object): boolean +表示要查询的键。 -检查输入的value是否是Float32Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[get9+](#get9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3712,27 +3569,31 @@ isFloat32Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 要查询的键。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Float32Array数组类型为true，反之为false。 | +| V \| undefined | 如果指定的键存在于缓冲区中，则返回与键关联的值；否则返回undefined。 | **示例：** ```js - let that = new util.types(); - let result = that.isFloat32Array(new Float32Array()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.get(2); ``` +### put(deprecated) -### isFloat64Array8+ +put(key: K,value: V): V -isFloat64Array(value: Object): boolean +将键值对添加到缓冲区。 -检查输入的value是否是Float64Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[put9+](#put9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3740,85 +3601,84 @@ isFloat64Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 要添加的密钥。 | +| value | V | 是 | 指示与要添加的键关联的值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Float64Array数组类型为true，反之为false。 | +| V | 返回与添加的键关联的值；如果要添加的键已经存在，则返回原始值，如果键或值为空，则抛出此异常。 | **示例：** ```js - let that = new util.types(); - let result = that.isFloat64Array(new Float64Array()); + let pro = new util.LruBuffer(); + let result = pro.put(2,10); ``` +### values(deprecated) -### isGeneratorFunction8+ +values(): V[] -isGeneratorFunction(value: Object): boolean +获取当前缓冲区中所有值从最近访问到最近最少访问的顺序列表。 -检查输入的value是否是generator函数类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[values9+](#values9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的generator函数类型为true，反之为false。 | +| V [] | 按从最近访问到最近最少访问的顺序返回当前缓冲区中所有值的列表。 | **示例：** ```js - let that = new util.types(); - let result = that.isGeneratorFunction(function* foo() {}); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.put(2,"anhu"); + pro.put("afaf","grfb"); + let result = pro.values(); ``` +### keys(deprecated) -### isGeneratorObject8+ +keys(): K[] -isGeneratorObject(value: Object): boolean +获取当前缓冲区中所有键从最近访问到最近最少访问的升序列表。 -检查输入的value是否是generator对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[keys9+](#keys9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的generator对象类型为true，反之为false。 | +| K [] | 按升序返回当前缓冲区中所有键的列表，从最近访问到最近最少访问。 | **示例：** - ```js - let that = new util.types(); - function* foo() {} - const generator = foo(); - let result = that.isGeneratorObject(generator); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.keys(); ``` +### remove(deprecated) -### isInt8Array8+ +remove(key: K): V | undefined -isInt8Array(value: Object): boolean +从当前缓冲区中删除指定的键及其关联的值。 -检查输入的value是否是Int8Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[remove9+](#remove9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3826,27 +3686,30 @@ isInt8Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 要删除的密钥。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Int8Array数组类型为true，反之为false。 | +| V \| undefined | 返回一个包含已删除键值对的Optional对象；如果key不存在，则返回一个空的Optional对象，如果key为null，则抛出异常。 | **示例：** - ```js - let that = new util.types(); - let result = that.isInt8Array(new Int8Array([])); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.remove(20); ``` +### afterRemoval(deprecated) -### isInt16Array8+ +afterRemoval(isEvict: boolean,key: K,value: V,newValue: V): void -isInt16Array(value: Object): boolean +删除值后执行后续操作。 -检查输入的value是否是Int16Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[afterRemoval9+](#afterremoval9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3854,27 +3717,43 @@ isInt16Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Int16Array数组类型为true，反之为false。 | +| isEvict | boolean | 是 | 因容量不足而调用该方法时，参数值为true，其他情况为false。 | +| key | K | 是 | 表示删除的键。 | +| value | V | 是 | 表示删除的值。 | +| newValue | V | 是 | 如果已调用put方法并且要添加的键已经存在，则参数值是关联的新值。其他情况下参数值为空。 | **示例：** ```js - let that = new util.types(); - let result = that.isInt16Array(new Int16Array([])); + let arr = []; + class ChildLruBuffer extends util.LruBuffer + { + constructor() + { + super(); + } + afterRemoval(isEvict, key, value, newValue) + { + if (isEvict === false) + { + arr = [key, value, newValue]; + } + } + } + let lru = new ChildLruBuffer(); + lru.afterRemoval(false,10,30,null); ``` +### contains(deprecated) -### isInt32Array8+ +contains(key: K): boolean -isInt32Array(value: Object): boolean +检查当前缓冲区是否包含指定的键。 -检查输入的value是否是Int32Array数组类型。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[contains9+](#contains9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3882,27 +3761,31 @@ isInt32Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 表示要检查的键。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Int32Array数组类型为true，反之为false。 | +| boolean | 如果缓冲区包含指定的键，则返回 true。 | **示例：** ```js - let that = new util.types(); - let result = that.isInt32Array(new Int32Array([])); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.contains(20); ``` +### createDefault(deprecated) -### isMap8+ +createDefault(key: K): V -isMap(value: Object): boolean +如果未计算特定键的值，则执行后续操作，参数表示丢失的键，返回与键关联的值。 -检查输入的value是否是Map类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[createDefault9+](#createdefault9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3910,113 +3793,126 @@ isMap(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 表示丢失的键。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Map类型为true，反之为false。 | +| V | 返回与键关联的值。 | **示例：** ```js - let that = new util.types(); - let result = that.isMap(new Map()); + let pro = new util.LruBuffer(); + let result = pro.createDefault(50); ``` +### entries(deprecated) -### isMapIterator8+ +entries(): IterableIterator<[K,V]> -isMapIterator(value: Object): boolean +允许迭代包含在这个对象中的所有键值对。 -检查输入的value是否是Map的Iterator类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[entries9+](#entries9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Map的Iterator类型为true，反之为false。 | +| [K, V] | 返回一个可迭代数组。 | **示例：** ```js - let that = new util.types(); - const map = new Map(); - let result = that.isMapIterator(map.keys()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.entries(); ``` +### [Symbol.iterator](deprecated) -### isNativeError8+ +[Symbol.iterator]\(): IterableIterator<[K, V]> -isNativeError(value: Object): boolean +返回一个键值对形式的二维数组。 -检查输入的value是否是Error类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[Symbol.iterator9+](#symboliterator9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Error类型为true，反之为false。 | +| [K, V] | 返回一个键值对形式的二维数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isNativeError(new TypeError()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro[Symbol.iterator](); ``` +### ScopeType8+ -### isNumberObject8+ +用于表示范围中的值的类型。该类型的值，类型可以为ScopeComparable或number。 -isNumberObject(value: Object): boolean +ScopeComparable类型的值需要实现compareTo方法，确保传入的数据具有可比性。 -检查输入的value是否是Number对象类型。 +```js +interface ScopeComparable{ + compareTo(other: ScopeComparable): boolean; +} +type ScopeType = ScopeComparable | number; +``` -**系统能力：** SystemCapability.Utils.Lang -**参数：** +构造新类，实现compareTo方法。后续示例代码中，均通过Temperature，获取[ScopeType](#scopetype8)的实例化对象。 -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | -**返回值：** +示例： +```js +class Temperature{ + constructor(value){ + // 当使用ts语言开发时，需要补充以下代码： + // private readonly _temp: Temperature; + this._temp = value; + } + compareTo(value){ + return this._temp >= value.getTemp(); + } + getTemp(){ + return this._temp; + } + toString(){ + return this._temp.toString(); + } +} +``` -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Number对象类型为true，反之为false。 | +## Scope(deprecated) -**示例：** +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[ScopeHelper9+](#scopehelper9)替代。 - ```js - let that = new util.types(); - let result = that.isNumberObject(new Number(0)); - ``` +### constructor(deprecated) +constructor(lowerObj: ScopeType, upperObj: ScopeType) -### isPromise8+ +用于创建指定下限和上限的作用域实例的构造函数，返回一个Scope对象。 -isPromise(value: Object): boolean +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 -检查输入的value是否是Promise类型。 **系统能力：** SystemCapability.Utils.Lang @@ -4024,27 +3920,52 @@ isPromise(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | + +**示例：** + ```js + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + ``` + +### toString(deprecated) + +toString(): string + +该字符串化方法返回一个包含当前范围的字符串表示形式。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[toString9+](#tostring9)替代。 + +**系统能力：** SystemCapability.Utils.Lang **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Promise类型为true，反之为false。 | +| string | 返回包含当前范围对象的字符串表示形式。 | **示例：** ```js - let that = new util.types(); - let result = that.isPromise(Promise.resolve(1)); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.toString(); ``` +### intersect(deprecated) -### isProxy8+ +intersect(range: Scope): Scope -isProxy(value: Object): boolean +获取给定范围和当前范围的交集。 -检查输入的value是否是Proxy类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4052,29 +3973,35 @@ isProxy(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Proxy类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回给定范围和当前范围的交集。 | **示例：** ```js - let that = new util.types(); - const target = {}; - const proxy = new Proxy(target, {}); - let result = that.isProxy(proxy); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let rangeFir = new util.Scope(tempMiDF, tempMidS); + range.intersect(rangeFir ); ``` +### intersect(deprecated) -### isRegExp8+ +intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope -isRegExp(value: Object): boolean +获取当前范围与给定下限和上限范围的交集。 -检查输入的value是否是RegExp类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4082,84 +4009,89 @@ isRegExp(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的RegExp类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回当前范围与给定下限和上限范围的交集。 | **示例：** ```js - let that = new util.types(); - let result = that.isRegExp(new RegExp('abc')); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let result = range.intersect(tempMiDF, tempMidS); ``` +### getUpper(deprecated) -### isSet8+ +getUpper(): ScopeType -isSet(value: Object): boolean +获取当前范围的上限。 -检查输入的value是否是Set类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getUpper9+](#getupper9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Set类型为true，反之为false。 | +| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | **示例：** ```js - let that = new util.types(); - let result = that.isSet(new Set()); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.getUpper(); ``` +### getLower(deprecated) -### isSetIterator8+ +getLower(): ScopeType -isSetIterator(value: Object): boolean +获取当前范围的下限。 -检查输入的value是否是Set的Iterator类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getLower9+](#getlower9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Set的Iterator类型为true，反之为false。 | +| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | **示例：** ```js - let that = new util.types(); - const set = new Set(); - let result = that.isSetIterator(set.keys()); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.getLower(); ``` +### expand(deprecated) -### isStringObject8+ +expand(lowerObj: ScopeType,upperObj: ScopeType): Scope -isStringObject(value: Object): boolean +创建并返回包括当前范围和给定下限和上限的并集。 -检查输入的value是否是String对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[expand9+](#expand9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4167,27 +4099,35 @@ isStringObject(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的String对象类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回当前范围和给定下限和上限的并集。 | **示例：** ```js - let that = new util.types(); - let result = that.isStringObject(new String('foo')); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let result = range.expand(tempMiDF, tempMidS); ``` +### expand(deprecated) -### isSymbolObjec8+ +expand(range: Scope): Scope -isSymbolObject(value: Object): boolean +创建并返回包括当前范围和给定范围的并集。 -检查输入的value是否是Symbol对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[expand9+](#expand9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4195,30 +4135,35 @@ isSymbolObject(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Symbol对象类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回包括当前范围和给定范围的并集。 | **示例：** ```js - let that = new util.types(); - const symbols = Symbol('foo'); - let result = that.isSymbolObject(Object(symbols)); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let rangeFir = new util.Scope(tempMiDF, tempMidS); + let result = range.expand(rangeFir); ``` +### expand(deprecated) -### isTypedArray8+ - -isTypedArray(value: Object): boolean +expand(value: ScopeType): Scope -检查输入的value是否是TypedArray类型的辅助类型。 +创建并返回包括当前范围和给定值的并集。 -TypedArray类型的辅助类型，包括Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint16Array、Uint32Array、Float32Array、Float64Array、DataView。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[expand9+](#expand9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4226,27 +4171,33 @@ TypedArray类型的辅助类型，包括Int8Array、Int16Array、Int32Array、Ui | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的TypedArray包含的类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回包括当前范围和给定值的并集。 | **示例：** ```js - let that = new util.types(); - let result = that.isTypedArray(new Float64Array([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + let result = range.expand(tempMiDF); ``` +### contains(deprecated) -### isUint8Array8+ +contains(value: ScopeType): boolean -isUint8Array(value: Object): boolean +检查给定value是否包含在当前范围内。 -检查输入的value是否是Uint8Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[contains9+](#contains9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4254,27 +4205,33 @@ isUint8Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint8Array数组类型为true，反之为false。 | +| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let that = new util.types(); - let result = that.isUint8Array(new Uint8Array([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + range.contains(tempMiDF); ``` +### contains(deprecated) -### isUint8ClampedArray8+ +contains(range: Scope): boolean -isUint8ClampedArray(value: Object): boolean +检查给定range是否在当前范围内。 -检查输入的value是否是Uint8ClampedArray数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[contains9+](#contains9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4282,27 +4239,36 @@ isUint8ClampedArray(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint8ClampedArray数组类型为true，反之为false。 | +| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let that = new util.types(); - let result = that.isUint8ClampedArray(new Uint8ClampedArray([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let tempLess = new Temperature(20); + let tempMore = new Temperature(45); + let rangeSec = new util.Scope(tempLess, tempMore); + let result = range.contains(rangeSec); ``` +### clamp(deprecated) -### isUint16Array8+ -isUint16Array(value: Object): boolean +clamp(value: ScopeType): ScopeType -检查输入的value是否是Uint16Array数组类型。 +将给定值限定到当前范围内。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[clamp9+](#clamp9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4310,55 +4276,58 @@ isUint16Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint16Array数组类型为true，反之为false。 | +| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | **示例：** ```js - let that = new util.types(); - let result = that.isUint16Array(new Uint16Array([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + let result = range.clamp(tempMiDF); ``` -### isUint32Array8+ - -isUint32Array(value: Object): boolean +## Base64(deprecated) -检查输入的value是否是Uint32Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[Base64Helper9+](#base64helper9)替代。 -**系统能力：** SystemCapability.Utils.Lang +### constructor(deprecated) -**参数：** +constructor() -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +Base64的构造函数。 -**返回值：** +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint32Array数组类型为true，反之为false。 | +**系统能力：** SystemCapability.Utils.Lang **示例：** ```js - let that = new util.types(); - let result = that.isUint32Array(new Uint32Array([])); + let base64 = new util.Base64(); ``` +### encodeSync(deprecated) -### isWeakMap8+ +encodeSync(src: Uint8Array): Uint8Array -isWeakMap(value: Object): boolean +通过输入参数编码后输出对应文本。 -检查输入的value是否是WeakMap类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encodeSync9+](#encodesync9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4366,27 +4335,31 @@ isWeakMap(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的WeakMap类型为true，反之为false。 | +| Uint8Array | 返回编码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isWeakMap(new WeakMap()); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let result = that.encodeSync(array); ``` +### encodeToStringSync(deprecated) -### isWeakSet8+ +encodeToStringSync(src: Uint8Array): string -isWeakSet(value: Object): boolean +通过输入参数编码后输出对应文本。 -检查输入的value是否是WeakSet类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encodeToStringSync9+](#encodetostringsync9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4394,27 +4367,31 @@ isWeakSet(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的WeakSet类型为true，反之为false。 | +| string | 返回编码后的字符串。 | **示例：** ```js - let that = new util.types(); - let result = that.isWeakSet(new WeakSet()); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let result = that.encodeToStringSync(array); ``` +### decodeSync(deprecated) -### isBigInt64Array8+ +decodeSync(src: Uint8Array | string): Uint8Array -isBigInt64Array(value: Object): boolean +通过输入参数解码后输出对应文本。 -检查输入的value是否是BigInt64Array类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[decodeSync9+](#decodesync9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4422,27 +4399,31 @@ isBigInt64Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的BigInt64Array类型为true，反之为false。 | +| Uint8Array | 返回解码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isBigInt64Array(new BigInt64Array([])); + let that = new util.Base64(); + let buff = 'czEz'; + let result = that.decodeSync(buff); ``` +### encode(deprecated) -### isBigUint64Array8+ +encode(src: Uint8Array): Promise<Uint8Array> -isBigUint64Array(value: Object): boolean +通过输入参数异步编码后输出对应文本。 -检查输入的value是否是BigUint64Array类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encode9+](#encode9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4450,27 +4431,36 @@ isBigUint64Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的BigUint64Array类型为true，反之为false。 | +| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isBigUint64Array(new BigUint64Array([])); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let rarray = new Uint8Array([99,122,69,122]); + that.encode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } + }) ``` +### encodeToString(deprecated) -### isModuleNamespaceObject8+ +encodeToString(src: Uint8Array): Promise<string> -isModuleNamespaceObject(value: Object): boolean +通过输入参数异步编码后输出对应文本。 -检查输入的value是否是Module Namespace Object类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encodeToString9+](#encodetostring9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4478,28 +4468,34 @@ isModuleNamespaceObject(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Module Namespace Object类型为true，反之为false。 | +| Promise<string> | 返回异步编码后的字符串。 | **示例：** ```js - import url from '@ohos.url' - let that = new util.types(); - let result = that.isModuleNamespaceObject(url); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + that.encodeToString(array).then(val=>{ + console.log(val) + }) ``` +### decode(deprecated) -### isSharedArrayBuffer8+ -isSharedArrayBuffer(value: Object): boolean +decode(src: Uint8Array | string): Promise<Uint8Array> -检查输入的value是否是SharedArrayBuffer类型。 +通过输入参数异步解码后输出对应文本。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[decode9+](#decode9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4507,18 +4503,25 @@ isSharedArrayBuffer(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的SharedArrayBuffer类型为true，反之为false。 | +| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isSharedArrayBuffer(new SharedArrayBuffer(0)); + let that = new util.Base64(); + let array = new Uint8Array([99,122,69,122]); + let rarray = new Uint8Array([115,49,51]); + that.decode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } + }) ``` + \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-worker.md b/zh-cn/application-dev/reference/apis/js-apis-worker.md index e4616aff5b3be8b9f25f487af558ba36d234273a..9e98a5244869cf5fd48b55ee677f6b6a860e9949 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-worker.md +++ b/zh-cn/application-dev/reference/apis/js-apis-worker.md @@ -4,6 +4,8 @@ Worker是与主线程并行的独立线程。创建Worker的线程称之为宿 Worker主要作用是为应用程序提供一个多线程的运行环境，可满足应用程序在执行过程中与主线程分离，在后台线程中运行一个脚本操作耗时操作，极大避免类似于计算密集型或高延迟的任务阻塞主线程的运行。由于Worker一旦被创建则不会主动被销毁，若不处于任务状态一直运行，在一定程度上会造成资源的浪费，应及时关闭空闲的Worker。 +Worker的上下文对象和主线程的上下文对象是不同的，Worker线程不支持UI操作。 + > **说明：**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -39,13 +41,13 @@ Worker构造函数的选项信息，用于为Worker添加其他信息。 ## ThreadWorker9+ -使用以下方法前，均需先构造Worker实例，Worker类继承[WorkerEventTarget](#workereventtarget9)。 +使用以下方法前，均需先构造ThreadWorker实例，ThreadWorker类继承[WorkerEventTarget](#workereventtarget9)。 ### constructor9+ constructor(scriptURL: string, options?: WorkerOptions) -Worker构造函数。 +ThreadWorker构造函数。 **系统能力：** SystemCapability.Utils.Lang @@ -58,9 +60,20 @@ Worker构造函数。 **返回值：** -| 类型 | 说明 | -| ------ | --------------------------------------------------------- | -| Worker | 执行Worker构造函数生成的Worker对象，失败则返回undefined。 | +| 类型 | 说明 | +| ------------ | ------------------------------------------------------------ | +| ThreadWorker | 执行ThreadWorker构造函数生成的ThreadWorker对象，失败则返回undefined。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200003 | Worker initialization failure. | +| 10200007 | The worker file patch is invalid path. | + + **示例：** @@ -137,6 +150,40 @@ Stage模型: } ``` +### postMessage9+ + +postMessage(message: Object, transfer: ArrayBuffer[]): void; + +向Worker线程发送数据，数据类型必须是序列化所支持的类型。序列化支持类型见其他说明。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------------------------------ | +| message | Object | 是 | 发送至Worker的数据。 | +| transfer | ArrayBuffer[] | 是 | 可传递 ArrayBuffer 的实例对象，数组中不可传入null。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ----------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200006 | Serializing an uncaught exception failed. | + +**示例：** + +```js +const workerInstance = new worker.ThreadWorker("workers/worker.js"); + +workerInstance.postMessage("hello world"); + +var buffer = new ArrayBuffer(8); +workerInstance.postMessage(buffer, [buffer]); +``` ### postMessage9+ @@ -153,6 +200,15 @@ postMessage(message: Object, options?: PostMessageOptions): void | message | Object | 是 | 发送至Worker的数据。 | | options | [PostMessageOptions](#postmessageoptions) | 否 | 可转移对象是 ArrayBuffer 的实例对象。transferList数组中不可传入null。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ----------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200006 | Serializing an uncaught exception failed. | + **示例：** ```js @@ -164,7 +220,6 @@ var buffer = new ArrayBuffer(8); workerInstance.postMessage(buffer, [buffer]); ``` - ### on9+ on(type: string, listener: WorkerEventListener): void @@ -180,6 +235,15 @@ on(type: string, listener: WorkerEventListener): void | type | string | 是 | 监听的事件类型。 | | listener | [WorkerEventListener](#workereventlistener9) | 是 | 回调的事件。回调事件。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -205,6 +269,15 @@ once(type: string, listener: WorkerEventListener): void | type | string | 是 | 监听的事件类型。 | | listener | [WorkerEventListener](#workereventlistener9) | 是 | 回调的事件。回调事件。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -230,6 +303,15 @@ off(type: string, listener?: WorkerEventListener): void | type | string | 是 | 需要删除的事件类型。 | | listener | [WorkerEventListener](#workereventlistener9) | 否 | 回调的事件。删除的回调事件。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -247,6 +329,14 @@ terminate(): void **系统能力：** SystemCapability.Utils.Lang +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + **示例：** ```js @@ -269,6 +359,15 @@ Worker对象的onexit属性表示Worker销毁时被调用的事件处理程序 | ------ | ------ | ---- | ------------------ | | code | number | 是 | Worker退出的code。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -300,6 +399,15 @@ Worker对象的onerror属性表示Worker在执行过程中发生异常被调用 | ------ | ------------------------- | ---- | ---------- | | err | [ErrorEvent](#errorevent) | 是 | 异常数据。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -324,6 +432,15 @@ Worker对象的onmessage属性表示宿主线程接收到来自其创建的Worke | ------ | -------------------------------- | ---- | ---------------------- | | event | [MessageEvents](#messageevents9) | 是 | 收到的Worker消息数据。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -350,6 +467,15 @@ Worker对象的onmessageerror属性表示当Worker对象接收到一条无法被 | ------ | -------------------------------- | ---- | ---------- | | event | [MessageEvents](#messageevents9) | 是 | 异常数据。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -359,6 +485,169 @@ workerInstance.onmessageerror= function(e) { } ``` +### addEventListener9+ + +addEventListener(type: string, listener: WorkerEventListener): void + +向Worker添加一个事件监听，该接口与[on9+](#on9)接口功能一致。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | ---------------- | +| type | string | 是 | 监听的事件类型。 | +| listener | [WorkerEventListener](#workereventlistener9) | 是 | 回调的事件。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + +**示例：** + +```js +const workerInstance = new worker.ThreadWorker("workers/worker.js"); +workerInstance.addEventListener("alert", (e)=>{ + console.log("alert listener callback"); +}) +``` + + +### removeEventListener9+ + +removeEventListener(type: string, callback?: WorkerEventListener): void + +删除Worker的事件监听，该接口与[off9+](#off9)接口功能一致。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | ---------------------------- | +| type | string | 是 | 需要删除的监听事件类型。 | +| callback | [WorkerEventListener](#workereventlistener9) | 否 | 回调的事件。删除的回调事件。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + +**示例：** + +```js +const workerInstance = new worker.ThreadWorker("workers/worker.js"); +workerInstance.addEventListener("alert", (e)=>{ + console.log("alert listener callback"); +}) +workerInstance.removeEventListener("alert"); +``` + + +### dispatchEvent9+ + +dispatchEvent(event: Event): boolean + +分发定义在Worker的事件。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------------- | ---- | ---------------- | +| event | [Event](#event) | 是 | 需要分发的事件。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ------------------------------- | +| boolean | 分发的结果，false表示分发失败。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + +**示例：** + +```js +const workerInstance = new worker.ThreadWorker("workers/worker.js"); +//用法一: +workerInstance.on("alert_on", (e)=>{ + console.log("alert listener callback"); +}) +workerInstance.once("alert_once", (e)=>{ + console.log("alert listener callback"); +}) +workerInstance.addEventListener("alert_add", (e)=>{ + console.log("alert listener callback"); +}) + +//once接口创建的事件执行一次便会删除。 +workerInstance.dispatchEvent({type:"alert_once", timeStamp:0});//timeStamp暂未支持。 +//on接口创建的事件可以一直被分发，不能主动删除。 +workerInstance.dispatchEvent({type:"alert_on", timeStamp:0}); +workerInstance.dispatchEvent({type:"alert_on", timeStamp:0}); +//addEventListener接口创建的事件可以一直被分发，不能主动删除。 +workerInstance.dispatchEvent({type:"alert_add", timeStamp:0}); +workerInstance.dispatchEvent({type:"alert_add", timeStamp:0}); + +//用法二: +//event类型的type支持自定义，同时存在"message"/"messageerror"/"error"特殊类型，如下所示 +//当type = "message"，onmessage接口定义的方法同时会执行。 +//当type = "messageerror"，onmessageerror接口定义的方法同时会执行。 +//当type = "error"，onerror接口定义的方法同时会执行。 +//若调用removeEventListener接口或者off接口取消事件时，能且只能取消使用addEventListener/on/once创建的事件。 + +workerInstance.addEventListener("message", (e)=>{ + console.log("message listener callback"); +}) +workerInstance.onmessage = function(e) { + console.log("onmessage : message listener callback"); +} +//调用dispatchEvent分发“message”事件，addEventListener和onmessage中定义的方法都会被执行。 +workerInstance.dispatchEvent({type:"message", timeStamp:0}); +``` + + +### removeAllListener9+ + +removeAllListener(): void + +删除Worker所有的事件监听。 + +**系统能力：** SystemCapability.Utils.Lang + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + +**示例：** + +```js +const workerInstance = new worker.ThreadWorker("workers/worker.js"); +workerInstance.addEventListener("alert", (e)=>{ + console.log("alert listener callback"); +}) +workerInstance.removeAllListener(); +``` ## WorkerEventTarget9+ @@ -377,6 +666,15 @@ addEventListener(type: string, listener: WorkerEventListener): void | type | string | 是 | 监听的事件类型。 | | listener | [WorkerEventListener](#workereventlistener9) | 是 | 回调的事件。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -402,6 +700,14 @@ removeEventListener(type: string, callback?: WorkerEventListener): void | type | string | 是 | 需要删除的监听事件类型。 | | callback | [WorkerEventListener](#workereventlistener9) | 否 | 回调的事件。删除的回调事件。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + **示例：** ```js @@ -433,6 +739,14 @@ dispatchEvent(event: Event): boolean | ------- | ------------------------------- | | boolean | 分发的结果，false表示分发失败。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + **示例：** ```js @@ -449,7 +763,7 @@ workerInstance.addEventListener("alert_add", (e)=>{ }) //once接口创建的事件执行一次便会删除。 -workerInstance.dispatchEvent({type:"alert_once", timeStamp:0}); +workerInstance.dispatchEvent({type:"alert_once", timeStamp:0});//timeStamp暂未支持。 //on接口创建的事件可以一直被分发，不能主动删除。 workerInstance.dispatchEvent({type:"alert_on", timeStamp:0}); workerInstance.dispatchEvent({type:"alert_on", timeStamp:0}); @@ -483,6 +797,14 @@ removeAllListener(): void **系统能力：** SystemCapability.Utils.Lang +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + **示例：** ```js @@ -498,6 +820,53 @@ workerInstance.removeAllListener(); Worker线程用于与宿主线程通信的类，通过postMessage接口发送消息给宿主线程、close接口销毁Worker线程。ThreadWorkerGlobalScope类继承[GlobalScope9+](#globalscope9)。 +### postMessage9+ + +postMessage(messageObject: Object, transfer: ArrayBuffer[]): void; + +Worker线程向宿主线程发送消息。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------------------------- | +| message | Object | 是 | 发送至宿主线程的数据。 | +| transfer | ArrayBuffer[] | 是 | 可传输对象是ArrayBuffer的实例对象，数组中不可传入null。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ----------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200006 | Serializing an uncaught exception failed. | + +**示例：** + +```js +// main.js +import worker from '@ohos.worker'; +const workerInstance = new worker.ThreadWorker("workers/worker.js"); +workerInstance.postMessage("hello world"); +workerInstance.onmessage = function(e) { + // let data = e.data; + console.log("receive data from worker.js"); +} +``` + +```js +// worker.js +import worker from '@ohos.worker'; +const workerPort = worker.workerPort; +workerPort.onmessage = function(e){ + // let data = e.data; + var buffer = new ArrayBuffer(8); + workerPort.postMessage(buffer, [buffer]); +} +``` ### postMessage9+ @@ -514,6 +883,15 @@ Worker线程向宿主线程发送消息。 | message | Object | 是 | 发送至宿主线程的数据。 | | options | [PostMessageOptions](#postmessageoptions) | 否 | 可转移对象是ArrayBuffer的实例对象。transferList数组中不可传入null。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ----------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200006 | Serializing an uncaught exception failed. | + **示例：** ```js @@ -530,10 +908,10 @@ workerInstance.onmessage = function(e) { ```js // worker.js import worker from '@ohos.worker'; -const parentPort = worker.workerPort; -parentPort.onmessage = function(e){ +const workerPort = worker.workerPort; +workerPort.onmessage = function(e){ // let data = e.data; - parentPort.postMessage("receive data from main.js"); + workerPort.postMessage("receive data from main.js"); } ``` @@ -546,6 +924,14 @@ close(): void **系统能力：** SystemCapability.Utils.Lang +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------- | +| 10200004 | Worker instance is not running. | + **示例：** ```js @@ -557,16 +943,16 @@ const workerInstance = new worker.ThreadWorker("workers/worker.js"); ```js // worker.js import worker from '@ohos.worker'; -const parentPort = worker.workerPort; -parentPort.onmessage = function(e) { - parentPort.close() +const workerPort = worker.workerPort; +workerPort.onmessage = function(e) { + workerPort.close() } ``` ### onmessage9+ -onmessage?: (this: ThreadWorkerGlobalScope, event: MessageEvents) => void +onmessage?: (this: ThreadWorkerGlobalScope, ev: MessageEvents) => void DedicatedWorkerGlobalScope的onmessage属性表示Worker线程收到来自其宿主线程通过postMessage接口发送的消息时被调用的事件处理程序，处理程序在Worker线程中执行。 @@ -577,7 +963,16 @@ DedicatedWorkerGlobalScope的onmessage属性表示Worker线程收到来自其宿 | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------------------------------------------- | ---- | ------------------------ | | this | [ThreadWorkerGlobalScope](#threadworkerglobalscope9) | 是 | 指向调用者对象。 | -| event | [MessageEvents](#messageevents9) | 是 | 收到宿主线程发送的数据。 | +| ev | [MessageEvents](#messageevents9) | 是 | 收到宿主线程发送的数据。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | **示例：** @@ -591,8 +986,8 @@ workerInstance.postMessage("hello world"); ```js // worker.js import worker from '@ohos.worker'; -const parentPort = worker.workerPort; -parentPort.onmessage = function(e) { +const workerPort = worker.workerPort; +workerPort.onmessage = function(e) { console.log("receive main.js message"); } ``` @@ -600,7 +995,7 @@ parentPort.onmessage = function(e) { ### onmessageerror9+ -onmessageerror?: (this: ThreadWorkerGlobalScope, event: MessageEvents) => void +onmessageerror?: (this: ThreadWorkerGlobalScope, ev: MessageEvents) => void DedicatedWorkerGlobalScope的onmessageerror属性表示当Worker对象接收到一条无法被反序列化的消息时被调用的事件处理程序，处理程序在Worker线程中执行。 @@ -611,7 +1006,16 @@ DedicatedWorkerGlobalScope的onmessageerror属性表示当Worker对象接收到 | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------------------- | ---- | ---------- | | this | [ThreadWorkerGlobalScope](#threadworkerglobalscope9) | 是 | 指向调用者对象。 | -| event | [MessageEvents](#messageevents9) | 是 | 异常数据。 | +| ev | [MessageEvents](#messageevents9) | 是 | 异常数据。 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | **示例：** @@ -651,6 +1055,15 @@ parentPort.onmessageerror = function(e) { | ------------------------------------- | ------------------------------- | | void \| Promise<void> | 无返回值或者以Promise形式返回。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------------------------------------------- | +| 10200004 | Worker instance is not running. | +| 10200005 | The invoked API is not supported in workers. | + **示例：** ```js @@ -700,8 +1113,8 @@ const workerInstance = new worker.ThreadWorker("workers/worker.js") ```js // worker.js import worker from '@ohos.worker'; -const parentPort = worker.workerPort -parentPort.onerror = function(e){ +const workerPort = worker.workerPort +workerPort.onerror = function(e){ console.log("worker.js onerror") } ``` @@ -815,9 +1228,10 @@ Stage模型: } } ``` + ### postMessage(deprecated) -postMessage(message: Object, options?: PostMessageOptions): void +postMessage(message: Object, transfer: ArrayBuffer[]): void; 向Worker线程发送数据，数据类型必须是序列化所支持的类型。序列化支持类型见其他说明。 @@ -828,6 +1242,35 @@ postMessage(message: Object, options?: PostMessageOptions): void **参数：** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ----------------------------------------------- | +| message | Object | 是 | 发送至Worker的数据。 | +| transfer | ArrayBuffer[] | 是 | 可转移对象是 ArrayBuffer 的实例对象。 | + +**示例：** + +```js +const workerInstance = new worker.Worker("workers/worker.js"); + +workerInstance.postMessage("hello world"); + +var buffer = new ArrayBuffer(8); +workerInstance.postMessage(buffer, [buffer]); +``` + +### postMessage(deprecated) + +postMessage(message: Object, options?: PostMessageOptions): void + +向Worker线程发送数据，数据类型必须是序列化所支持的类型。序列化支持类型见其他说明。 + +> **说明：**
+> 从API version 7 开始支持，从API version 9 开始废弃，建议使用[ThreadWorker.postMessage9+](#postmessage9-1)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | message | Object | 是 | 发送至Worker的数据。 | @@ -839,9 +1282,6 @@ postMessage(message: Object, options?: PostMessageOptions): void const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.postMessage("hello world"); - -var buffer = new ArrayBuffer(8); -workerInstance.postMessage(buffer, [buffer]); ``` @@ -1165,7 +1605,7 @@ workerInstance.addEventListener("alert_add", (e)=>{ }) //once接口创建的事件执行一次便会删除。 -workerInstance.dispatchEvent({type:"alert_once", timeStamp:0}); +workerInstance.dispatchEvent({type:"alert_once", timeStamp:0});//timeStamp暂未支持。 //on接口创建的事件可以一直被分发，不能主动删除。 workerInstance.dispatchEvent({type:"alert_on", timeStamp:0}); workerInstance.dispatchEvent({type:"alert_on", timeStamp:0}); @@ -1218,6 +1658,44 @@ Worker线程用于与宿主线程通信的类，通过postMessage接口发送消 > **说明：**
> 从API version 7 开始支持，从API version 9 开始废弃，建议使用[ThreadWorkerGlobalScope9+](#threadworkerglobalscope9)替代。 +### postMessage9+ + +postMessage(messageObject: Object, transfer: ArrayBuffer[]): void; + +Worker线程向宿主线程发送消息。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ----------------------------------------------------- | +| message | Object | 是 | 发送至宿主线程的数据。 | +| transfer | ArrayBuffer[] | 是 | 可传输对象是ArrayBuffer的实例对象，数组不可传入null。 | + +**示例：** + +```js +// main.js +import worker from '@ohos.worker'; +const workerInstance = new worker.Worker("workers/worker.js"); +workerInstance.postMessage("hello world"); +workerInstance.onmessage = function(e) { + // let data = e.data; + console.log("receive data from worker.js"); +} +``` +```js +// worker.js +import worker from '@ohos.worker'; +const parentPort = worker.parentPort; +parentPort.onmessage = function(e){ + // let data = e.data; + let buffer = new ArrayBuffer(5) + parentPort.postMessage(buffer, [buffer]); +} +``` + ### postMessage(deprecated) postMessage(messageObject: Object, options?: PostMessageOptions): void @@ -1258,7 +1736,6 @@ parentPort.onmessage = function(e){ } ``` - ### close(deprecated) close(): void @@ -1289,7 +1766,7 @@ parentPort.onmessage = function(e) { ### onmessage(deprecated) -onmessage?: (this: DedicatedWorkerGlobalScope, event: MessageEvent) => void +onmessage?: (this: DedicatedWorkerGlobalScope, ev: MessageEvent) => void DedicatedWorkerGlobalScope的onmessage属性表示Worker线程收到来自其宿主线程通过postMessage接口发送的消息时被调用的事件处理程序，处理程序在Worker线程中执行。 @@ -1303,7 +1780,7 @@ DedicatedWorkerGlobalScope的onmessage属性表示Worker线程收到来自其宿 | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------------------------------------ | ---- | ------------------------ | | this | [DedicatedWorkerGlobalScope](#dedicatedworkerglobalscopedeprecated) | 是 | 指向调用者对象。 | -| event | [MessageEvent](#messageeventt) | 是 | 收到宿主线程发送的数据。 | +| ev | [MessageEvent](#messageeventt) | 是 | 收到宿主线程发送的数据。 | **示例：** @@ -1325,7 +1802,7 @@ parentPort.onmessage = function(e) { ### onmessageerror(deprecated) -onmessageerror?: (this: DedicatedWorkerGlobalScope, event: MessageEvent) => void +onmessageerror?: (this: DedicatedWorkerGlobalScope, ev: MessageEvent) => void DedicatedWorkerGlobalScope的onmessageerror属性表示当Worker对象接收到一条无法被反序列化的消息时被调用的事件处理程序，处理程序在Worker线程中执行。 @@ -1339,7 +1816,7 @@ DedicatedWorkerGlobalScope的onmessageerror属性表示当Worker对象接收到 | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------ | ---- | ---------- | | this | [DedicatedWorkerGlobalScope](#dedicatedworkerglobalscopedeprecated) | 是 | 指向调用者对象。 | -| event | [MessageEvent](#messageeventt) | 是 | 异常数据。 | +| ev | [MessageEvent](#messageeventt) | 是 | 异常数据。 | **示例：** @@ -1375,10 +1852,10 @@ parentPort.onmessageerror = function(e) { **系统能力：** SystemCapability.Utils.Lang -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------- | ------ | ---- | ---- | ---------------------------------- | -| type | string | 是 | 否 | 指定事件的类型。 | -| timeStamp | number | 是 | 否 | 事件创建时的时间戳（精度为毫秒）。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------- | ------ | ---- | ---- | -------------------------------------------- | +| type | string | 是 | 否 | 指定事件的类型。 | +| timeStamp | number | 是 | 否 | 事件创建时的时间戳（精度为毫秒），暂未支持。 | ## EventListener(deprecated) @@ -1524,14 +2001,14 @@ workerInstance.onmessage = function(d) { ```js // worker.js import worker from '@ohos.worker'; -const parentPort = worker.workerPort; +const workerPort = worker.workerPort; class MyModel { name = "undefined" Init() { this.name = "MyModel" } } -parentPort.onmessage = function(d) { +workerPort.onmessage = function(d) { console.log("worker.js onmessage"); let data = d.data; let func1 = function() { @@ -1545,14 +2022,14 @@ parentPort.onmessage = function(d) { } } let obj2 = new MyModel(); - // parentPort.postMessage(func1); 传递func1发生序列化错误 - // parentPort.postMessage(obj1); 传递obj1发生序列化错误 - parentPort.postMessage(obj2); // 传递obj2不会发生序列化错误 + // workerPort.postMessage(func1); 传递func1发生序列化错误 + // workerPort.postMessage(obj1); 传递obj1发生序列化错误 + workerPort.postMessage(obj2); // 传递obj2不会发生序列化错误 } -parentPort.onmessageerror = function(e) { +workerPort.onmessageerror = function(e) { console.log("worker.js onmessageerror"); } -parentPort.onerror = function(e) { +workerPort.onerror = function(e) { console.log("worker.js onerror"); } ``` @@ -1570,6 +2047,7 @@ Actor并发模型的交互原理：各个Actor并发地处理主线程任务， - 自API version 9版本开始，若Worker处于已经销毁或正在销毁等非运行状态时，调用其功能接口，会抛出相应的BusinessError。 - Worker的创建和销毁耗费性能，建议管理已创建的Worker并重复使用。 - 创建Worker工程时，new worker.Worker构造函数和new worker.ThreadWorker构造函数不能同时使用，否则将导致工程中Worker的功能异常。自API version 9版本开始，建议使用[new worker.ThreadWorker](#constructor9)构造函数，在API version 8及之前的版本，建议使用[new worker.Worker](#constructordeprecated)构造函数。 +- 创建Worker工程时，在Worker线程的文件中（比如本文中worker.ts）不能导入任何有关构建UI的方法（比如ETS文件等），否则会导致Worker的功能失效。排查方式：解压生成的Hap包，在创建Worker线程的文件目录中找到"worker.js"，全局搜索"View"关键字。如果存在该关键字，说明在worker.js中打包进去了构建UI的方法，会导致Worker的功能失效，建议在创建Worker线程的文件中修改 "import “xxx” from src"中src的目录层级。 ## 完整示例 > **说明：**
@@ -1610,23 +2088,23 @@ workerInstance.onexit = function() { import worker from '@ohos.worker'; // 创建worker线程中与主线程通信的对象 -const parentPort = worker.workerPort +const workerPort = worker.workerPort // API version 9之前版本，创建worker线程中与主线程通信的对象 // const parentPort = worker.parentPort // worker线程接收主线程信息 -parentPort.onmessage = function(e) { +workerPort.onmessage = function(e) { // data：主线程发送的信息 let data = e.data; console.log("worker.ts onmessage"); // worker线程向主线程发送信息 - parentPort.postMessage("123") + workerPort.postMessage("123") } // worker线程发生error的回调 -parentPort.onerror= function(e) { +workerPort.onerror= function(e) { console.log("worker.ts onerror"); } ``` @@ -1672,20 +2150,20 @@ workerInstance.onexit = function() { import worker from '@ohos.worker'; // 创建worker线程中与主线程通信的对象 -const parentPort = worker.workerPort +const workerPort = worker.workerPort // worker线程接收主线程信息 -parentPort.onmessage = function(e) { +workerPort.onmessage = function(e) { // data：主线程发送的信息 let data = e.data; console.log("worker.ts onmessage"); // worker线程向主线程发送信息 - parentPort.postMessage("123") + workerPort.postMessage("123") } // worker线程发生error的回调 -parentPort.onerror= function(e) { +workerPort.onerror= function(e) { console.log("worker.ts onerror"); } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-zlib.md b/zh-cn/application-dev/reference/apis/js-apis-zlib.md index 708f07cf39999a80c913d3f057594c8b38b97698..8a2d9c2f02cb04c467bcc35e49a263641fa9d526 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-zlib.md +++ b/zh-cn/application-dev/reference/apis/js-apis-zlib.md @@ -25,7 +25,7 @@ zipFile(inFile: string, outFile: string, options: Options): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------- | ---- | ------------------------------------------------------------ | -| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径，对应的路径参考[FA模型](js-apis-inner-app-context.md)，[Stage模型](js-apis-application-context.md)。 | +| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径，路径必须为沙箱路径，沙箱路径可以通过context获取，可参考[FA模型](js-apis-inner-app-context.md)，[Stage模型](js-apis-application-context.md)。 | | outFile | string | 是 | 指定压缩结果的文件路径（文件的扩展名zip）。 | | options | [Options](#options) | 是 | 压缩的可选参数。 | @@ -39,6 +39,7 @@ zipFile(inFile: string, outFile: string, options: Options): Promise<void> ```typescript //【压缩文件 例子1】 +// 代码中使用的路径需为应用的沙箱路径，如/data/storage/el2/base/haps,也可以通过context获取 import zlib from '@ohos.zlib'; let inFile = '/xxx/filename.xxx'; let outFile = '/xxx/xxx.zip'; @@ -59,6 +60,7 @@ zlib.zipFile(inFile, outFile, options).then((data) => { ```typescript // 【压缩文件夹 例子2】 +// 代码中使用的路径需为应用的沙箱路径，如/data/storage/el2/base/haps,也可以通过context获取 import zlib from '@ohos.zlib'; let inFile = '/xxx/xxx'; let outFile = '/xxx/xxx.zip'; @@ -89,7 +91,7 @@ unzipFile(inFile:string, outFile:string, options: Options): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------- | ---- | ------------------------------------------------------------ | -| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径，对应的路径参考[FA模型](js-apis-inner-app-context.md)，[stage模型](js-apis-application-context.md)。 | +| inFile | string | 是 | 指定的待解压缩文件的文件路径，路径必须为沙箱路径，沙箱路径可以通过context获取，可参考[FA模型](js-apis-inner-app-context.md)，[Stage模型](js-apis-application-context.md)。 | | outFile | string | 是 | 指定的解压文件路径。 | | options | [Options](#options) | 是 | 解压的可选参数。 | @@ -103,6 +105,7 @@ unzipFile(inFile:string, outFile:string, options: Options): Promise<void> ```typescript // 【解压缩 例子1】 +// 代码中使用的路径需为应用的沙箱路径，如/data/storage/el2/base/haps,也可以通过context获取 import zlib from '@ohos.zlib'; let inFile = '/xx/xxx.zip'; let outFile = '/xxx'; @@ -131,7 +134,7 @@ compressFile(inFile: string, outFile: string, options: Options, callback: AsyncC | 参数名 | 类型 | 必填 | 说明 | | ----------------------- | ------------------- | ---- | ------------------------------------------------------------ | -| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径，对应的路径参考[FA模型](js-apis-inner-app-context.md)，[stage模型](js-apis-application-context.md)。 | +| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径，路径必须为沙箱路径，沙箱路径可以通过context获取，可参考[FA模型](js-apis-inner-app-context.md)，[Stage模型](js-apis-application-context.md)。 | | outFile | string | 是 | 指定的解压文件路径。 | | options | [Options](#options) | 是 | 压缩的配置参数。 | | AsyncCallback<**void**> | callback | 否 | 压缩时的回调函数。 | @@ -141,8 +144,8 @@ compressFile(inFile: string, outFile: string, options: Options, callback: AsyncC 以下错误码的详细介绍请参见[ohos.zlib错误码](../errorcodes/errorcode-zlib.md)。 | 错误码ID | 错误信息 | | -------- | --------------------------------------| -| 900001 | The Input source file is invalid. | -| 900002 | The Input destination file is invalid. | +| 900001 | The input source file is invalid. | +| 900002 | The input destination file is invalid. | **示例** @@ -179,7 +182,7 @@ compressFile(inFile: string, outFile: string, options: Options): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------- | ---- | ------------------------------------------------------------ | -| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径，对应的路径参考[FA模型](js-apis-inner-app-context.md)，[stage模型](js-apis-application-context.md)。 | +| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径，路径必须为沙箱路径，沙箱路径可以通过context获取，可参考[FA模型](js-apis-inner-app-context.md)，[Stage模型](js-apis-application-context.md)。 | | outFile | string | 是 | 指定的解压文件路径。 | | options | [Options](#options) | 是 | 压缩的配置参数。 | @@ -189,8 +192,8 @@ compressFile(inFile: string, outFile: string, options: Options): Promise\; | 错误码ID | 错误信息 | | -------- | ------------------------------------- | -| 900001 | The Input source file is invalid. | -| 900002 | The Input destination file is invalid. | +| 900001 | The input source file is invalid. | +| 900002 | The input destination file is invalid. | ```typescript // 【压缩文件 例子2】 @@ -229,7 +232,7 @@ decompressFile(inFile: string, outFile: string, options: Options, callback: Asyn | 参数名 | 类型 | 必填 | 说明 | | ----------------------- | ------------------- | ---- | ------------------------------------------------------------ | -| inFile | string | 是 | 指定的待解压缩文件的文件路径，对应的路径参考[FA模型](js-apis-inner-app-context.md)，[stage模型](js-apis-application-context.md)。 | +| inFile | string | 是 | 指定的待解压缩文件的文件路径，路径必须为沙箱路径，沙箱路径可以通过context获取，可参考[FA模型](js-apis-inner-app-context.md)，[Stage模型](js-apis-application-context.md)。 | | outFile | string | 是 | 指定的解压后的目录路径。 | | options | [Options](#options) | 是 | 解压的配置参数。 | | AsyncCallback<**void**> | callback | 否 | 解压是的回调函数。 | @@ -240,8 +243,8 @@ decompressFile(inFile: string, outFile: string, options: Options, callback: Asyn | 错误码ID | 错误信息 | -------- | --------------------------------------| -| 900001 | The Input source file is invalid. | -| 900002 | The Input destination file is invalid. | +| 900001 | The input source file is invalid. | +| 900002 | The input destination file is invalid. | **示例** @@ -278,7 +281,7 @@ decompressFile(inFile: string, outFile: string, options: Options): Promise\9+](../apis/js-apis-worker.md#constructor9)接口的示例。 + +## 10200009 Buffer的长度错误 + +**错误信息** + +Buffer size must be a multiple of ${size}. + +**错误描述** + +Buffer的长度错误，不符合要求。 + +**可能原因** + +Buffer的长度错误，不符合要求。Buffer长度要求为size的整数倍。其中size为16-bits、32-bits或者64-bits。 + +**处理步骤** + +确保Buffer长度符合要求。 +Buffer长度要求为size的整数倍。其中size为16-bits、32-bits或者64-bits。 + +## 10200010 容器为空 + +**错误信息** + +The container is empty. + +**错误描述** + +操作的容器为空。 + +**可能原因** + +操作的容器为空，未添加相关元素。 + +**处理步骤** + +确保操作的容器不为空，空容器请先向容器内添加元素。 + +## 10200011 传入的this.object不是容器类的实例 + +**错误信息** + +The {methodName} method cannot be bound. + +**错误描述** + +调用语言容器类的方法时，传入的this.object不是容器类的实例语言，容器类的方法不支持bind。 + +**可能原因** + +容器类的方法不支持bind。 + +**处理步骤** + +1. 检查是否使用bind API调用语言容器类的方法。 +2. 检查是否把语言容器类的方法赋值给不是语言容器实例的对象来调用。 + +## 10200012 构造函数调用异常 + +**错误信息** + +The {className}'s constructor cannot be directly invoked. + +**错误描述** + +构造语言容器类的构造方法不支持直接调用。 + +**可能原因** + +调用构造函数时未使用new关键字。 + +**处理步骤** + +检查是否使用直接调用了语言容器类的方法，建议使用new关键字创建语言容器类。 + +## 10200013 只读属性设置错误 + +**错误信息** + +Cannot set property ${propertyName} of Buffer which has only a getter. + +**错误描述** + +Buffer的属性${propertyName}只读，不能进行设置。 + +**可能原因** + +对Buffer的只读属性进行设置，导致异常。 + +**处理步骤** + +不要对Buffer只读属性进行相关设置。 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-zlib.md b/zh-cn/application-dev/reference/errorcodes/errorcode-zlib.md index d7038b823654fdaa4601f053f7f808a006113e46..5c70b5f61069f05093c8a53d8aa3e35123c52f38 100755 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-zlib.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-zlib.md @@ -8,11 +8,11 @@ The input source file is invalid. **错误描述** -当调用compress或decompress接口时，传入源文件无效。 +当调用compressFile或decompressFile接口时，传入源文件无效。 **可能原因** -当调用compress接口时，传入的待压缩的文件不存在；当调用decompress接口时，传入的待解压缩的文件不存在。 +当调用compressFile接口时，传入的待压缩的文件不存在；当调用decompressFile接口时，传入的待解压缩的文件不存在。 **处理步骤** @@ -27,14 +27,14 @@ The input destination file is invalid. **错误描述** -当调用compress或decompress接口时，传入目标文件无效。 +当调用compressFile或decompressFile接口时，传入目标文件无效。 **可能原因** -1. 当调用compress接口时，传入的目标文件路径无效，如不存在的沙箱路径。 -2. 当调用decompress接口时，传入的目标目录不存在。 +1. 当调用compressFile接口时，传入的目标文件路径无效，如不存在的沙箱路径。 +2. 当调用decompressFile接口时，传入的目标目录不存在。 **处理步骤** -1. 检查目标文件路径是否正确，不正确填写正确的沙箱路径。 -2. 检查目标文件目录是否存在，不存在新建这个路径。 \ No newline at end of file +1. 检查目标文件路径是否正确，如果不正确，填写正确的沙箱路径。 +2. 检查目标文件目录是否存在，如果不存在，新建这个路径。 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/native-apis/Readme-CN.md b/zh-cn/application-dev/reference/native-apis/Readme-CN.md index 54138c3cb2fb3c394ba3693d4498a98e4e15876d..54bf703ba8b775366036a719e5e4d83207b2ce71 100644 --- a/zh-cn/application-dev/reference/native-apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/native-apis/Readme-CN.md @@ -12,6 +12,13 @@ - [Rawfile](rawfile.md) - [MindSpore](_mind_spore.md) - [NeuralNeworkRuntime](_neural_nework_runtime.md) + - [Avsession](avsession.md) + - [AudioDecoder](_audio_decoder.md) + - [AudioEncoder](_audio_encoder.md) + - [CodecBase](_codec_base.md) + - [VideoDecoder](_video_decoder.md) + - [VideoEncoder](_video_encoder.md) + - [Core](_core.md) - 头文件 - [drawing_bitmap.h](drawing__bitmap_8h.md) - [drawing_brush.h](drawing__brush_8h.md) @@ -42,6 +49,24 @@ - [types.h](types_8h.md) - [neural_network_runtime_type.h](neural__network__runtime__type_8h.md) - [neural_network_runtime.h](neural__network__runtime_8h.md) + - [av_session.h](av__session_8h.md) + - [avcontrol_command.h](avcontrol__command_8h.md) + - [avmeta_data.h](avmeta__data_8h.md) + - [avplayback_state.h](avplayback__state_8h.md) + - [avsession_controller.h](avsession__controller_8h.md) + - [avsession_descriptor.h](avsession__descriptor_8h.md) + - [avsession_errors.h](avsession__errors_8h.md) + - [avsession_info.h](avsession__info_8h.md) + - [avsession_manager.h](avsession__manager_8h.md) + - [avsession_pixel_map.h](avsession__pixel__map_8h.md) + - [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) + - [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) + - [native_avcodec_base.h](native__avcodec__base_8h.md) + - [native_avcodec_videodecoder.h](native__avcodec__videodecoder_8h.md) + - [native_avcodec_videoencoder.h](native__avcodec__videoencoder_8h.md) + - [native_averrors.h](native__averrors_8h.md) + - [native_avformat.h](native__avformat_8h.md) + - [native_avmemory.h](native__avmemory_8h.md) - 结构体 - [OH_Drawing_BitmapFormat](_o_h___drawing___bitmap_format.md) - [OH_NativeBuffer_Config](_o_h___native_buffer___config.md) @@ -62,4 +87,21 @@ - [OH_NN_Memory](_o_h___n_n___memory.md) - [OH_NN_QuantParam](_o_h___n_n___quant_param.md) - [OH_NN_Tensor](_o_h___n_n___tensor.md) - - [OH_NN_UInt32Array](_o_h___n_n___u_int32_array.md) \ No newline at end of file + - [OH_NN_UInt32Array](_o_h___n_n___u_int32_array.md) + - [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) + - [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) + - [OHOS::AVSession::AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) + - [OHOS::AVSession::AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md) + - [OHOS::AVSession::AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) + - [OHOS::AVSession::AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) + - [OHOS::AVSession::AVPlaybackState::Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) + - [OHOS::AVSession::AVSession](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md) + - [OHOS::AVSession::AVSessionBasicInfo](o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md) + - [OHOS::AVSession::AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md) + - [OHOS::AVSession::AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md) + - [OHOS::AVSession::AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) + - [OHOS::AVSession::AVSessionManager](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md) + - [OHOS::AVSession::AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md) + - [OHOS::AVSession::OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) + - [OHOS::AVSession::SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md) + - [OHOS::AVSession::SessionToken](_o_h_o_s_1_1_a_v_session_1_1_session_token.md) \ No newline at end of file diff --git a/zh-cn/application-dev/reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md b/zh-cn/application-dev/reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md new file mode 100644 index 0000000000000000000000000000000000000000..ab87d4886fa45ee895144dae8d7da540ace76590 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md @@ -0,0 +1,44 @@ +# OHOS::AVSession::AVPlaybackState::Position + + +## 概述 + +播放位置的相关信息。 + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [elapsedTime_](#elapsedtime) {} | int64_t
媒体已经播放的时间点，第x ms，单位为ms  | +| [updateTime_](#updatetime) {} | int64_t
更新的时间戳，单位为ms  | + + +## 结构体成员变量说明 + + +### elapsedTime_ + + +``` +int64_t OHOS::AVSession::AVPlaybackState::Position::elapsedTime_ {} +``` +**描述:** +媒体已经播放的时间点，第x ms，单位为ms + + +### updateTime_ + + +``` +int64_t OHOS::AVSession::AVPlaybackState::Position::updateTime_ {} +``` +**描述:** +更新的时间戳，单位为ms diff --git a/zh-cn/application-dev/reference/native-apis/_audio_decoder.md b/zh-cn/application-dev/reference/native-apis/_audio_decoder.md new file mode 100644 index 0000000000000000000000000000000000000000..bc160c71ac1a6bb8bd68731801cd47b55d8b8351 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_audio_decoder.md @@ -0,0 +1,382 @@ +# AudioDecoder + + +## 概述 + +AudioDecoder模块提供用于音频解码功能的函数。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) | 声明用于音频解码的Native API。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AudioDecoder_CreateByMime](#oh_audiodecoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个音频解码器实例，大多数情况下推荐使用该接口。 | +| [OH_AudioDecoder_CreateByName](#oh_audiodecoder_createbyname) (const char \*name) | OH_AVCodec \*
通过音频解码器名称创建一个音频解码器实例，使用这个接口的前提是必须清楚解码器准确的名称。 | +| [OH_AudioDecoder_Destroy](#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部资源，并销毁解码器实例 | +| [OH_AudioDecoder_SetCallback](#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应音频解码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioDecoder_Configure](#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置音频解码器，典型地，需要配置被解码音频轨道的描述信息，这些信息能够从容器中提取出来， 该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioDecoder_Prepare](#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备解码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_AudioDecoder_Start](#oh_audiodecoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动解码器，该接口必须在已经Prepare成功后调用。 在启动成功后，解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_AudioDecoder_Stop](#oh_audiodecoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止解码器。在停止后可通过Start重新进入Started状态，但需要注意的是，若先前给解码器输入过 Codec-Specific-Data，则需要重新输入。 | +| [OH_AudioDecoder_Flush](#oh_audiodecoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_AudioDecoder_Reset](#oh_audiodecoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置解码器。如需继续解码工作，需要重新调用Configure接口以配置该解码器实例。 | +| [OH_AudioDecoder_GetOutputDescription](#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该解码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例需调用者手动释放。 | +| [OH_AudioDecoder_SetParameter](#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向解码器设置动态参数，注意：该接口仅能在解码器被启动后调用，同时错误的参数设置，可能会导致解码失败。 | +| [OH_AudioDecoder_PushInputData](#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | [OH_AVErrCode](_core.md#oh_averrcode)
将填充好数据的输入Buffer提交给音频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。另外，对于部分解码器，要求在最开始给解码器输入 Codec-Specific-Data，用以初始化解码器的解码过程。 | +| [OH_AudioDecoder_FreeOutputData](#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给解码器。 | + + +## 函数说明 + + +### OH_AudioDecoder_Configure() + + +``` +OH_AVErrCode OH_AudioDecoder_Configure (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +配置音频解码器，典型地，需要配置被解码音频轨道的描述信息，这些信息能够从容器中提取出来， 该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | 指向OH_AVFormat的指针，用以给出待解码音频轨道的描述信息 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_CreateByMime() + + +``` +OH_AVCodec* OH_AudioDecoder_CreateByMime (const char * mime) +``` +**描述:** +通过mime类型创建一个音频解码器实例，大多数情况下推荐使用该接口。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mime | mime类型描述字符串，参考[OH_AVCODEC_MIMETYPE_AUDIO_AAC](_codec_base.md#oh_avcodec_mimetype_audio_aac) | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_AudioDecoder_CreateByName() + + +``` +OH_AVCodec* OH_AudioDecoder_CreateByName (const char * name) +``` +**描述:** +通过音频解码器名称创建一个音频解码器实例，使用这个接口的前提是必须清楚解码器准确的名称。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| name | 音频解码器名称 | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_AudioDecoder_Destroy() + + +``` +OH_AVErrCode OH_AudioDecoder_Destroy (OH_AVCodec * codec) +``` +**描述:** +清空解码器内部资源，并销毁解码器实例 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_Flush() + + +``` +OH_AVErrCode OH_AudioDecoder_Flush (OH_AVCodec * codec) +``` +**描述:** +清空解码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_FreeOutputData() + + +``` +OH_AVErrCode OH_AudioDecoder_FreeOutputData (OH_AVCodec * codec, uint32_t index ) +``` +**描述:** +将处理结束的输出Buffer交还给解码器。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输出Buffer对应的索引值 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_GetOutputDescription() + + +``` +OH_AVFormat* OH_AudioDecoder_GetOutputDescription (OH_AVCodec * codec) +``` +**描述:** +获取该解码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例需调用者手动释放。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +返回OH_AVFormat句柄指针，需调用者手动释放; + + +### OH_AudioDecoder_Prepare() + + +``` +OH_AVErrCode OH_AudioDecoder_Prepare (OH_AVCodec * codec) +``` +**描述:** +准备解码器内部资源，调用该接口前必须先调用Configure接口。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_PushInputData() + + +``` +OH_AVErrCode OH_AudioDecoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr ) +``` +**描述:** +将填充好数据的输入Buffer提交给音频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。另外，对于部分解码器，要求在最开始给解码器输入 Codec-Specific-Data，用以初始化解码器的解码过程。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输入Buffer对应的索引值 | +| attr | 描述该Buffer内所包含数据的信息 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_Reset() + + +``` +OH_AVErrCode OH_AudioDecoder_Reset (OH_AVCodec * codec) +``` +**描述:** +重置解码器。如需继续解码工作，需要重新调用Configure接口以配置该解码器实例。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_SetCallback() + + +``` +OH_AVErrCode OH_AudioDecoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData ) +``` +**描述:** +设置异步回调函数，使得你的应用能够响应音频解码器产生的事件，该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| callback | 一个包含所有回调函数的集合体，参考[OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) | +| userData | 用户特定数据 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_SetParameter() + + +``` +OH_AVErrCode OH_AudioDecoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +向解码器设置动态参数，注意：该接口仅能在解码器被启动后调用，同时错误的参数设置，可能会导致解码失败。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | OH_AVFormat句柄指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_Start() + + +``` +OH_AVErrCode OH_AudioDecoder_Start (OH_AVCodec * codec) +``` +**描述:** +启动解码器，该接口必须在已经Prepare成功后调用。 在启动成功后，解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioDecoder_Stop() + + +``` +OH_AVErrCode OH_AudioDecoder_Stop (OH_AVCodec * codec) +``` +**描述:** +停止解码器。在停止后可通过Start重新进入Started状态，但需要注意的是，若先前给解码器输入过 Codec-Specific-Data，则需要重新输入。 + +@syscap SystemCapability.Multimedia.Media.AudioDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) diff --git a/zh-cn/application-dev/reference/native-apis/_audio_encoder.md b/zh-cn/application-dev/reference/native-apis/_audio_encoder.md new file mode 100644 index 0000000000000000000000000000000000000000..a3edbb7794850ffc8b0136787d4caeda2bab7135 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_audio_encoder.md @@ -0,0 +1,382 @@ +# AudioEncoder + + +## 概述 + +AudioEncoder模块提供用于音频编码功能的函数。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) | 声明用于音频编码的Native API。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AudioEncoder_CreateByMime](#oh_audioencoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个音频编码器实例，大多数情况下推荐使用该接口。 | +| [OH_AudioEncoder_CreateByName](#oh_audioencoder_createbyname) (const char \*name) | OH_AVCodec \*
通过音频编码器名称创建一个音频编码器实例，使用这个接口的前提是必须清楚编码器准确的名称。 | +| [OH_AudioEncoder_Destroy](#oh_audioencoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部资源，并销毁编码器实例。 | +| [OH_AudioEncoder_SetCallback](#oh_audioencoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应音频编码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioEncoder_Configure](#oh_audioencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置音频编码器，典型地，需要配置被编码音频轨道的描述信息，该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioEncoder_Prepare](#oh_audioencoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备编码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_AudioEncoder_Start](#oh_audioencoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动编码器，该接口必须在已经Prepare成功后调用。 在启动成功后，编码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_AudioEncoder_Stop](#oh_audioencoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止编码器。在停止后可通过Start重新进入Started状态。 | +| [OH_AudioEncoder_Flush](#oh_audioencoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_AudioEncoder_Reset](#oh_audioencoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置编码器。如需继续编码工作，需要重新调用Configure接口以配置该编码器实例。 | +| [OH_AudioEncoder_GetOutputDescription](#oh_audioencoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该编码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例需调用者手动释放。 | +| [OH_AudioEncoder_SetParameter](#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向编码器设置动态参数，注意：该接口仅能在编码器被启动后调用，同时错误的参数设置，可能会导致编码失败。 | +| [OH_AudioEncoder_PushInputData](#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | [OH_AVErrCode](_core.md#oh_averrcode)
将填充好数据的输入Buffer提交给音频编码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给编码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。 | +| [OH_AudioEncoder_FreeOutputData](#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给编码器。 | + + +## 函数说明 + + +### OH_AudioEncoder_Configure() + + +``` +OH_AVErrCode OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +配置音频编码器，典型地，需要配置被编码音频轨道的描述信息，该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | OH_AVFormat句柄指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_CreateByMime() + + +``` +OH_AVCodec* OH_AudioEncoder_CreateByMime (const char * mime) +``` +**描述:** +通过mime类型创建一个音频编码器实例，大多数情况下推荐使用该接口。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mime | mime类型描述字符串，参考[OH_AVCODEC_MIMETYPE_AUDIO_AAC](_codec_base.md#oh_avcodec_mimetype_audio_aac) | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_AudioEncoder_CreateByName() + + +``` +OH_AVCodec* OH_AudioEncoder_CreateByName (const char * name) +``` +**描述:** +通过音频编码器名称创建一个音频编码器实例，使用这个接口的前提是必须清楚编码器准确的名称。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| name | 音频编码器名称 | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_AudioEncoder_Destroy() + + +``` +OH_AVErrCode OH_AudioEncoder_Destroy (OH_AVCodec * codec) +``` +**描述:** +清空编码器内部资源，并销毁编码器实例。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_Flush() + + +``` +OH_AVErrCode OH_AudioEncoder_Flush (OH_AVCodec * codec) +``` +**描述:** +清空编码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_FreeOutputData() + + +``` +OH_AVErrCode OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, uint32_t index ) +``` +**描述:** +将处理结束的输出Buffer交还给编码器。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输出Buffer对应的索引值 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_GetOutputDescription() + + +``` +OH_AVFormat* OH_AudioEncoder_GetOutputDescription (OH_AVCodec * codec) +``` +**描述:** +获取该编码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例需调用者手动释放。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +返回OH_AVFormat句柄指针，需调用者手动释放; + + +### OH_AudioEncoder_Prepare() + + +``` +OH_AVErrCode OH_AudioEncoder_Prepare (OH_AVCodec * codec) +``` +**描述:** +准备编码器内部资源，调用该接口前必须先调用Configure接口。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_PushInputData() + + +``` +OH_AVErrCode OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr ) +``` +**描述:** +将填充好数据的输入Buffer提交给音频编码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给编码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输入Buffer对应的索引值 | +| attr | 描述该Buffer内所包含数据的信息 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_Reset() + + +``` +OH_AVErrCode OH_AudioEncoder_Reset (OH_AVCodec * codec) +``` +**描述:** +重置编码器。如需继续编码工作，需要重新调用Configure接口以配置该编码器实例。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_SetCallback() + + +``` +OH_AVErrCode OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData ) +``` +**描述:** +设置异步回调函数，使得你的应用能够响应音频编码器产生的事件，该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| callback | 一个包含所有回调函数的集合体，参考[OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) | +| userData | 用户特定数据 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_SetParameter() + + +``` +OH_AVErrCode OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +向编码器设置动态参数，注意：该接口仅能在编码器被启动后调用，同时错误的参数设置，可能会导致编码失败。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | OH_AVFormat句柄指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_Start() + + +``` +OH_AVErrCode OH_AudioEncoder_Start (OH_AVCodec * codec) +``` +**描述:** +启动编码器，该接口必须在已经Prepare成功后调用。 在启动成功后，编码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_AudioEncoder_Stop() + + +``` +OH_AVErrCode OH_AudioEncoder_Stop (OH_AVCodec * codec) +``` +**描述:** +停止编码器。在停止后可通过Start重新进入Started状态。 + +@syscap SystemCapability.Multimedia.Media.AudioEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) diff --git a/zh-cn/application-dev/reference/native-apis/_codec_base.md b/zh-cn/application-dev/reference/native-apis/_codec_base.md new file mode 100644 index 0000000000000000000000000000000000000000..a19b89726fd1822cce7d8fceb602ce54972e5f14 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_codec_base.md @@ -0,0 +1,573 @@ +# CodecBase + + +## 概述 + +CodecBase模块提供运行音视频编解码通用的结构体、字符常量、枚举。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [native_avcodec_base.h](native__avcodec__base_8h.md) | 声明运行音视频编解码通用的结构体、字符常量、枚举。 | + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) | struct
定义OH_AVCodec的Buffer描述信息。 | +| [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) | struct
AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例，并处理通过该回调报告 的信息，以确保AVCodec正常运转。 | + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| **OHNativeWindow** | typedef struct NativeWindow | +| **OH_AVCodec** | typedef struct OH_AVCodec | +| [OH_AVCodecBufferFlags](#oh_avcodecbufferflags) | typedef enum [OH_AVCodecBufferFlags](#oh_avcodecbufferflags)
枚举OH_AVCodec的Buffer标记的类别。 | +| [OH_AVCodecBufferAttr](#oh_avcodecbufferattr) | typedef struct [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md)
定义OH_AVCodec的Buffer描述信息。 | +| [OH_AVCodecOnError](#oh_avcodeconerror)) (OH_AVCodec \*codec, int32_t errorCode, void \*userData) | typedef void(\*
当OH_AVCodec实例运行发生错误时，该函数指针会被调用以报告具体错误信息。 | +| [OH_AVCodecOnStreamChanged](#oh_avcodeconstreamchanged)) (OH_AVCodec \*codec, OH_AVFormat \*format, void \*userData) | typedef void(\*
当输出流发生变化时，该函数指针会被调用以报告新的流描述信息。 需要注意的时，OH_AVFormat指针的生命周期仅维持在该函数指针被调用时上有效，禁止在调用结束后继续访问。 | +| [OH_AVCodecOnNeedInputData](#oh_avcodeconneedinputdata)) (OH_AVCodec \*codec, uint32_t index, OH_AVMemory \*data, void \*userData) | typedef void(\*
当AVCodec运行过程中需要新的输入数据时，该函数指针会被调用，并携带一块可用的Buffer以供填入新的输入数据。 | +| [OH_AVCodecOnNewOutputData](#oh_avcodeconnewoutputdata)) (OH_AVCodec \*codec, uint32_t index, OH_AVMemory \*data, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) \*attr, void \*userData) | typedef void(\*
当AVCodec运行过程中产生了新的输出数据时，该函数指针会被调用，并携带一块包含新输出数据的Buffer， 需要注意的是，OH_AVCodecBufferAttr指针的生命周期仅维持在该函数指针被调用时有效，禁止调用结束后继续访问。 | +| [OH_AVCodecAsyncCallback](#oh_avcodecasynccallback) | typedef struct [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md)
AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例，并处理通过该回调报告 的信息，以确保AVCodec正常运转。 | +| [OH_MediaType](#oh_mediatype) | typedef enum [OH_MediaType](#oh_mediatype)
媒体类型。 | +| [OH_AVCProfile](#oh_avcprofile) | typedef enum [OH_AVCProfile](#oh_avcprofile)
AVC Profile枚举。 | +| [OH_AACProfile](#oh_aacprofile) | typedef enum [OH_AACProfile](#oh_aacprofile)
AAC Profile枚举。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVCodecBufferFlags](#oh_avcodecbufferflags) {
**AVCODEC_BUFFER_FLAGS_NONE** = 0, **AVCODEC_BUFFER_FLAGS_EOS** = 1 << 0, **AVCODEC_BUFFER_FLAGS_SYNC_FRAME** = 1 << 1, **AVCODEC_BUFFER_FLAGS_INCOMPLETE_FRAME** = 1 << 2, **AVCODEC_BUFFER_FLAGS_CODEC_DATA**= 1 << 3
} | 枚举OH_AVCodec的Buffer标记的类别。 | +| [OH_MediaType](#oh_mediatype) { **MEDIA_TYPE_AUD** = 0, **MEDIA_TYPE_VID** = 1 } | 媒体类型。 | +| [OH_AVCProfile](#oh_avcprofile) { **AVC_PROFILE_BASELINE** = 0, **AVC_PROFILE_HIGH** = 4, **AVC_PROFILE_MAIN** = 8 } | AVC Profile枚举。 | +| [OH_AACProfile](#oh_aacprofile) { **AAC_PROFILE_LC** = 0 } | AAC Profile枚举。 | + + +### 变量 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVCodecBufferAttr::pts](#pts) | int64_t
以微秒为单位表示的该Buffer的Presentation时间戳 | +| [OH_AVCodecBufferAttr::size](#size) | int32_t
以字节为单位表示的该Buffer内所包含数据的大小 | +| [OH_AVCodecBufferAttr::offset](#offset) | int32_t
有效数据在该Buffer内的起始偏移量 | +| [OH_AVCodecBufferAttr::flags](#flags) | uint32_t
该Buffer具有的标记，也是多个[OH_AVCodecBufferFlags](#oh_avcodecbufferflags)的组合 | +| **OH_AVCodecAsyncCallback::onError** | [OH_AVCodecOnError](#oh_avcodeconerror) | +| **OH_AVCodecAsyncCallback::onStreamChanged** | [OH_AVCodecOnStreamChanged](#oh_avcodeconstreamchanged) | +| **OH_AVCodecAsyncCallback::onNeedInputData** | [OH_AVCodecOnNeedInputData](#oh_avcodeconneedinputdata) | +| **OH_AVCodecAsyncCallback::onNeedOutputData** | [OH_AVCodecOnNewOutputData](#oh_avcodeconnewoutputdata) | +| [OH_AVCODEC_MIMETYPE_VIDEO_AVC](#oh_avcodec_mimetype_video_avc) | const char \*
AVC视频编解码器的MIME类型。 | +| [OH_AVCODEC_MIMETYPE_AUDIO_AAC](#oh_avcodec_mimetype_audio_aac) | const char \*
AAC音频编解码器的MIME类型。 | +| [OH_ED_KEY_TIME_STAMP](#oh_ed_key_time_stamp) | const char \*
提供统一的surface Buffer附属数据的字符描述符。 | +| [OH_ED_KEY_EOS](#oh_ed_key_eos) | const char \*
surface附属数据中结束流的字符描述符，值类型为bool | +| [OH_MD_KEY_TRACK_TYPE](#oh_md_key_track_type) | const char \*
为媒体播放框架提供统一的字符描述符。 | +| [OH_MD_KEY_CODEC_MIME](#oh_md_key_codec_mime) | const char \*
mime类型的字符描述符，值类型为string | +| [OH_MD_KEY_DURATION](#oh_md_key_duration) | const char \*
duration的字符描述符，值类型为int64_t | +| [OH_MD_KEY_BITRATE](#oh_md_key_bitrate) | const char \*
比特率的字符描述符，值类型为uint32_t | +| [OH_MD_KEY_MAX_INPUT_SIZE](#oh_md_key_max_input_size) | const char \*
最大输入尺寸的字符描述符，值类型为uint32_t | +| [OH_MD_KEY_WIDTH](#oh_md_key_width) | const char \*
视频宽度的字符描述符，值类型为uint32_t | +| [OH_MD_KEY_HEIGHT](#oh_md_key_height) | const char \*
视频高度的字符描述符，值类型为uint32_t | +| [OH_MD_KEY_PIXEL_FORMAT](#oh_md_key_pixel_format) | const char \*
视频像素格式的字符描述符，值类型为int32_t，具体见[OH_AVPixelFormat](_core.md#oh_avpixelformat) | +| [OH_MD_KEY_AUDIO_SAMPLE_FORMAT](#oh_md_key_audio_sample_format) | const char \*
音频采样格式的字符描述符，值类型为uint32_t | +| [OH_MD_KEY_FRAME_RATE](#oh_md_key_frame_rate) | const char \*
视频帧率的字符描述符，值类型为double | +| [OH_MD_KEY_VIDEO_ENCODE_BITRATE_MODE](#oh_md_key_video_encode_bitrate_mode) | const char \*
视频编码比特率模式的字符描述符，值类型为int32_t，具体见[OH_VideoEncodeBitrateMode](_video_encoder.md#oh_videoencodebitratemode) | +| [OH_MD_KEY_PROFILE](#oh_md_key_profile) | const char \*
音视频编码能力的字符描述符，值类型为int32_t，具体见[OH_AVCProfile](#oh_avcprofile)或[OH_AACProfile](#oh_aacprofile) | +| [OH_MD_KEY_AUD_CHANNEL_COUNT](#oh_md_key_aud_channel_count) | const char \*
音频声道数的字符描述符，值类型为uint32_t | +| [OH_MD_KEY_AUD_SAMPLE_RATE](#oh_md_key_aud_sample_rate) | const char \*
音频采样率的字符描述符，值类型为uint32_t | +| [OH_MD_KEY_I_FRAME_INTERVAL](#oh_md_key_i_frame_interval) | const char \*
I帧间隔时长的字符描述符，值类型为int32_t，单位是毫秒 | +| [OH_MD_KEY_ROTATION](#oh_md_key_rotation) | const char \*
surface旋转角度的字符描述符，值类型为int32_t，限于{0, 90, 180, 270}，默认值为0 | + + +## 类型定义说明 + + +### OH_AACProfile + + +``` +typedef enum OH_AACProfileOH_AACProfile +``` +**描述:** +AAC Profile枚举。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_AVCodecAsyncCallback + + +``` +typedef struct OH_AVCodecAsyncCallbackOH_AVCodecAsyncCallback +``` +**描述:** +AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例，并处理通过该回调报告 的信息，以确保AVCodec正常运转。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| onError | 监听AVCodec运行错误，参考[OH_AVCodecOnError](#oh_avcodeconerror) | +| onStreamChanged | 监听编解码流信息，参考[OH_AVCodecOnStreamChanged](#oh_avcodeconstreamchanged) | +| onNeedInputData | 监听编解码需要输入数据，参考[OH_AVCodecOnNeedInputData](#oh_avcodeconneedinputdata) | +| onNeedInputData | 监听编解码产生输出数据，参考[OH_AVCodecOnNewOutputData](#oh_avcodeconnewoutputdata) | + + +### OH_AVCodecBufferAttr + + +``` +typedef struct OH_AVCodecBufferAttrOH_AVCodecBufferAttr +``` +**描述:** +定义OH_AVCodec的Buffer描述信息。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_AVCodecBufferFlags + + +``` +typedef enum OH_AVCodecBufferFlagsOH_AVCodecBufferFlags +``` +**描述:** +枚举OH_AVCodec的Buffer标记的类别。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_AVCodecOnError + + +``` +typedef void(* OH_AVCodecOnError) (OH_AVCodec *codec, int32_t errorCode, void *userData) +``` +**描述:** +当OH_AVCodec实例运行发生错误时，该函数指针会被调用以报告具体错误信息。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | OH_AVCodec实例 | +| errorCode | 具体错误码 | +| userData | 用户特定数据 | + + +### OH_AVCodecOnNeedInputData + + +``` +typedef void(* OH_AVCodecOnNeedInputData) (OH_AVCodec *codec, uint32_t index, OH_AVMemory *data, void *userData) +``` +**描述:** +当AVCodec运行过程中需要新的输入数据时，该函数指针会被调用，并携带一块可用的Buffer以供填入新的输入数据。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | OH_AVCodec实例 | +| index | 新的可用的输入Buffer对应的索引 | +| data | 新的可用的输入Buffer | +| userData | 用户特定数据 | + + +### OH_AVCodecOnNewOutputData + + +``` +typedef void(* OH_AVCodecOnNewOutputData) (OH_AVCodec *codec, uint32_t index, OH_AVMemory *data, OH_AVCodecBufferAttr *attr, void *userData) +``` +**描述:** +当AVCodec运行过程中产生了新的输出数据时，该函数指针会被调用，并携带一块包含新输出数据的Buffer， 需要注意的是，OH_AVCodecBufferAttr指针的生命周期仅维持在该函数指针被调用时有效，禁止调用结束后继续访问。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | OH_AVCodec实例 | +| index | 新的输出Buffer对应的索引 | +| data | 包含新的输出数据的Buffer | +| attr | 新的输出Buffer的描述信息，具体参考[OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) | +| userData | specified data | + + +### OH_AVCodecOnStreamChanged + + +``` +typedef void(* OH_AVCodecOnStreamChanged) (OH_AVCodec *codec, OH_AVFormat *format, void *userData) +``` +**描述:** +当输出流发生变化时，该函数指针会被调用以报告新的流描述信息。 需要注意的时，OH_AVFormat指针的生命周期仅维持在该函数指针被调用时上有效，禁止在调用结束后继续访问。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | OH_AVCodec实例 | +| format | 新的输出流描述信息 | +| userData | 用户特定数据 | + + +### OH_AVCProfile + + +``` +typedef enum OH_AVCProfileOH_AVCProfile +``` +**描述:** +AVC Profile枚举。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_MediaType + + +``` +typedef enum OH_MediaTypeOH_MediaType +``` +**描述:** +媒体类型。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +## 枚举类型说明 + + +### OH_AACProfile + + +``` +enum OH_AACProfile +``` +**描述:** +AAC Profile枚举。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_AVCodecBufferFlags + + +``` +enum OH_AVCodecBufferFlags +``` +**描述:** +枚举OH_AVCodec的Buffer标记的类别。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + | 枚举值 | 描述 | +| -------- | -------- | +| AVCODEC_BUFFER_FLAGS_EOS | 表明该Buffer是End-of-Stream帧 | +| AVCODEC_BUFFER_FLAGS_SYNC_FRAME | 表明该Buffer内包含关键帧 | +| AVCODEC_BUFFER_FLAGS_INCOMPLETE_FRAME | 表明该Buffer内包含的数据仅仅为一帧的一部分 | +| AVCODEC_BUFFER_FLAGS_CODEC_DATA | 表明该Buffer包含Codec-Specific-Data | + + +### OH_AVCProfile + + +``` +enum OH_AVCProfile +``` +**描述:** +AVC Profile枚举。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_MediaType + + +``` +enum OH_MediaType +``` +**描述:** +媒体类型。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + | 枚举值 | 描述 | +| -------- | -------- | +| MEDIA_TYPE_AUD | 音频轨道 | +| MEDIA_TYPE_VID | 视频轨道 | + + +## 变量说明 + + +### flags + + +``` +uint32_t OH_AVCodecBufferAttr::flags +``` +**描述:** +该Buffer具有的标记，也是多个[OH_AVCodecBufferFlags](#oh_avcodecbufferflags)的组合 + + +### offset + + +``` +int32_t OH_AVCodecBufferAttr::offset +``` +**描述:** +有效数据在该Buffer内的起始偏移量 + + +### OH_AVCODEC_MIMETYPE_AUDIO_AAC + + +``` +const char* OH_AVCODEC_MIMETYPE_AUDIO_AAC +``` +**描述:** +AAC音频编解码器的MIME类型。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_AVCODEC_MIMETYPE_VIDEO_AVC + + +``` +const char* OH_AVCODEC_MIMETYPE_VIDEO_AVC +``` +**描述:** +AVC视频编解码器的MIME类型。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_ED_KEY_EOS + + +``` +const char* OH_ED_KEY_EOS +``` +**描述:** +surface附属数据中结束流的字符描述符，值类型为bool + + +### OH_ED_KEY_TIME_STAMP + + +``` +const char* OH_ED_KEY_TIME_STAMP +``` +**描述:** +提供统一的surface Buffer附属数据的字符描述符。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_MD_KEY_AUD_CHANNEL_COUNT + + +``` +const char* OH_MD_KEY_AUD_CHANNEL_COUNT +``` +**描述:** +音频声道数的字符描述符，值类型为uint32_t + + +### OH_MD_KEY_AUD_SAMPLE_RATE + + +``` +const char* OH_MD_KEY_AUD_SAMPLE_RATE +``` +**描述:** +音频采样率的字符描述符，值类型为uint32_t + + +### OH_MD_KEY_AUDIO_SAMPLE_FORMAT + + +``` +const char* OH_MD_KEY_AUDIO_SAMPLE_FORMAT +``` +**描述:** +音频采样格式的字符描述符，值类型为uint32_t + + +### OH_MD_KEY_BITRATE + + +``` +const char* OH_MD_KEY_BITRATE +``` +**描述:** +比特率的字符描述符，值类型为uint32_t + + +### OH_MD_KEY_CODEC_MIME + + +``` +const char* OH_MD_KEY_CODEC_MIME +``` +**描述:** +mime类型的字符描述符，值类型为string + + +### OH_MD_KEY_DURATION + + +``` +const char* OH_MD_KEY_DURATION +``` +**描述:** +duration的字符描述符，值类型为int64_t + + +### OH_MD_KEY_FRAME_RATE + + +``` +const char* OH_MD_KEY_FRAME_RATE +``` +**描述:** +视频帧率的字符描述符，值类型为double + + +### OH_MD_KEY_HEIGHT + + +``` +const char* OH_MD_KEY_HEIGHT +``` +**描述:** +视频高度的字符描述符，值类型为uint32_t + + +### OH_MD_KEY_I_FRAME_INTERVAL + + +``` +const char* OH_MD_KEY_I_FRAME_INTERVAL +``` +**描述:** +I帧间隔时长的字符描述符，值类型为int32_t，单位是毫秒 + + +### OH_MD_KEY_MAX_INPUT_SIZE + + +``` +const char* OH_MD_KEY_MAX_INPUT_SIZE +``` +**描述:** +最大输入尺寸的字符描述符，值类型为uint32_t + + +### OH_MD_KEY_PIXEL_FORMAT + + +``` +const char* OH_MD_KEY_PIXEL_FORMAT +``` +**描述:** +视频像素格式的字符描述符，值类型为int32_t，具体见[OH_AVPixelFormat](_core.md#oh_avpixelformat) + + +### OH_MD_KEY_PROFILE + + +``` +const char* OH_MD_KEY_PROFILE +``` +**描述:** +音视频编码能力的字符描述符，值类型为int32_t，具体见[OH_AVCProfile](#oh_avcprofile)或[OH_AACProfile](#oh_aacprofile) + + +### OH_MD_KEY_ROTATION + + +``` +const char* OH_MD_KEY_ROTATION +``` +**描述:** +surface旋转角度的字符描述符，值类型为int32_t，限于{0, 90, 180, 270}，默认值为0 + + +### OH_MD_KEY_TRACK_TYPE + + +``` +const char* OH_MD_KEY_TRACK_TYPE +``` +**描述:** +为媒体播放框架提供统一的字符描述符。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + + +### OH_MD_KEY_VIDEO_ENCODE_BITRATE_MODE + + +``` +const char* OH_MD_KEY_VIDEO_ENCODE_BITRATE_MODE +``` +**描述:** +视频编码比特率模式的字符描述符，值类型为int32_t，具体见[OH_VideoEncodeBitrateMode](_video_encoder.md#oh_videoencodebitratemode) + + +### OH_MD_KEY_WIDTH + + +``` +const char* OH_MD_KEY_WIDTH +``` +**描述:** +视频宽度的字符描述符，值类型为uint32_t + + +### pts + + +``` +int64_t OH_AVCodecBufferAttr::pts +``` +**描述:** +以微秒为单位表示的该Buffer的Presentation时间戳 + + +### size + + +``` +int32_t OH_AVCodecBufferAttr::size +``` +**描述:** +以字节为单位表示的该Buffer内所包含数据的大小 diff --git a/zh-cn/application-dev/reference/native-apis/_core.md b/zh-cn/application-dev/reference/native-apis/_core.md new file mode 100644 index 0000000000000000000000000000000000000000..93b290c3d4ffc206759d38e133b64b43657afa19 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_core.md @@ -0,0 +1,592 @@ +# Core + + +## 概述 + +Core模块提供用于播放框架的基础骨干能力，包含内存、错误码、格式载体等相关函数。 + +@syscap SystemCapability.Multimedia.Media.Core + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [native_averrors.h](native__averrors_8h.md) | 声明了媒体播放框架的错误码。 | +| [native_avformat.h](native__avformat_8h.md) | 声明了格式相关的函数和枚举。 | +| [native_avmemory.h](native__avmemory_8h.md) | 声明了AVMemory的函数接口。 | + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVErrCode](#oh_averrcode) | typedef enum [OH_AVErrCode](#oh_averrcode)
音视频错误码。 | +| **OH_AVFormat** | typedef struct OH_AVFormat | +| [OH_AVPixelFormat](#oh_avpixelformat) | typedef enum [OH_AVPixelFormat](#oh_avpixelformat)
AVPixel 格式的枚举。 | +| **OH_AVMemory** | typedef struct OH_AVMemory | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVErrCode](#oh_averrcode) {
**AV_ERR_OK** = 0, **AV_ERR_NO_MEMORY** = 1, **AV_ERR_OPERATE_NOT_PERMIT** = 2, **AV_ERR_INVALID_VAL** = 3, **AV_ERR_IO** = 4, **AV_ERR_TIMEOUT** = 5, **AV_ERR_UNKNOWN** = 6, **AV_ERR_SERVICE_DIED** = 7, **AV_ERR_INVALID_STATE** = 8, **AV_ERR_UNSUPPORT** = 9, **AV_ERR_EXTEND_START** = 100
} | 音视频错误码。 | +| [OH_AVPixelFormat](#oh_avpixelformat) {
**AV_PIXEL_FORMAT_YUVI420** = 1, **AV_PIXEL_FORMAT_NV12** = 2, **AV_PIXEL_FORMAT_NV21** = 3, **AV_PIXEL_FORMAT_SURFACE_FORMAT** = 4, **AV_PIXEL_FORMAT_RGBA** = 5
} | AVPixel 格式的枚举。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVFormat_Create](#oh_avformat_create) (void) | struct OH_AVFormat \*
创建一个OH_AVFormat句柄指针，用以读写数据。 | +| [OH_AVFormat_Destroy](#oh_avformat_destroy) (struct OH_AVFormat \*format) | void
销毁指定OH_AVFormat句柄资源。 | +| [OH_AVFormat_Copy](#oh_avformat_copy) (struct OH_AVFormat \*to, struct OH_AVFormat \*from) | bool
拷贝OH_AVFormat句柄资源. | +| [OH_AVFormat_SetIntValue](#oh_avformat_setintvalue) (struct OH_AVFormat \*format, const char \*key, int32_t value) | bool
向OH_AVFormat写入Int数据. | +| [OH_AVFormat_SetLongValue](#oh_avformat_setlongvalue) (struct OH_AVFormat \*format, const char \*key, int64_t value) | bool
向OH_AVFormat写入Long数据。 | +| [OH_AVFormat_SetFloatValue](#oh_avformat_setfloatvalue) (struct OH_AVFormat \*format, const char \*key, float value) | bool
向OH_AVFormat写入Float数据。 | +| [OH_AVFormat_SetDoubleValue](#oh_avformat_setdoublevalue) (struct OH_AVFormat \*format, const char \*key, double value) | bool
向OH_AVFormat写入Double数据。 | +| [OH_AVFormat_SetStringValue](#oh_avformat_setstringvalue) (struct OH_AVFormat \*format, const char \*key, const char \*value) | bool
向OH_AVFormat写入String数据。 | +| [OH_AVFormat_SetBuffer](#oh_avformat_setbuffer) (struct OH_AVFormat \*format, const char \*key, const uint8_t \*addr, size_t size) | bool
向OH_AVFormat写入一块指定长度的数据。 | +| [OH_AVFormat_GetIntValue](#oh_avformat_getintvalue) (struct OH_AVFormat \*format, const char \*key, int32_t \*out) | bool
从OH_AVFormat读取Int数据。 | +| [OH_AVFormat_GetLongValue](#oh_avformat_getlongvalue) (struct OH_AVFormat \*format, const char \*key, int64_t \*out) | bool
从OH_AVFormat读取Long数据。 | +| [OH_AVFormat_GetFloatValue](#oh_avformat_getfloatvalue) (struct OH_AVFormat \*format, const char \*key, float \*out) | bool
从OH_AVFormat读取Float数据。 | +| [OH_AVFormat_GetDoubleValue](#oh_avformat_getdoublevalue) (struct OH_AVFormat \*format, const char \*key, double \*out) | bool
从OH_AVFormat读取Double数据。 | +| [OH_AVFormat_GetStringValue](#oh_avformat_getstringvalue) (struct OH_AVFormat \*format, const char \*key, const char \*\*out) | bool
从OH_AVFormat读取Double数据。 | +| [OH_AVFormat_GetBuffer](#oh_avformat_getbuffer) (struct OH_AVFormat \*format, const char \*key, uint8_t \*\*addr, size_t \*size) | bool
从OH_AVFormat读取一块指定长度的数据。 | +| [OH_AVFormat_DumpInfo](#oh_avformat_dumpinfo) (struct OH_AVFormat \*format) | const char \*
以字符串的形式输出OH_AVFormat所包含的信息。 | +| [OH_AVMemory_GetAddr](#oh_avmemory_getaddr) (struct OH_AVMemory \*mem) | uint8_t \*
获取入参的内存虚拟地址。 | +| [OH_AVMemory_GetSize](#oh_avmemory_getsize) (struct OH_AVMemory \*mem) | int32_t
获取入参的内存长度。 | + + +## 类型定义说明 + + +### OH_AVErrCode + + +``` +typedef enum OH_AVErrCodeOH_AVErrCode +``` +**描述:** +音视频错误码。 + +@syscap SystemCapability.Multimedia.Media.Core + + +### OH_AVPixelFormat + + +``` +typedef enum OH_AVPixelFormatOH_AVPixelFormat +``` +**描述:** +AVPixel 格式的枚举。 + +@syscap SystemCapability.Multimedia.Media.Core + + +## 枚举类型说明 + + +### OH_AVErrCode + + +``` +enum OH_AVErrCode +``` +**描述:** +音视频错误码。 + +@syscap SystemCapability.Multimedia.Media.Core + + | 枚举值 | 描述 | +| -------- | -------- | +| AV_ERR_OK | 操作成功 | +| AV_ERR_NO_MEMORY | 无内存 | +| AV_ERR_OPERATE_NOT_PERMIT | 无效参数 | +| AV_ERR_INVALID_VAL | 无效值 | +| AV_ERR_IO | IO 错误 | +| AV_ERR_TIMEOUT | 超时错误 | +| AV_ERR_UNKNOWN | 未知错误 | +| AV_ERR_SERVICE_DIED | 媒体服务死亡 | +| AV_ERR_INVALID_STATE | 当前状态不支持此操作 | +| AV_ERR_UNSUPPORT | 未支持的接口 | +| AV_ERR_EXTEND_START | 扩展错误码初始值 | + + +### OH_AVPixelFormat + + +``` +enum OH_AVPixelFormat +``` +**描述:** +AVPixel 格式的枚举。 + +@syscap SystemCapability.Multimedia.Media.Core + + | 枚举值 | 描述 | +| -------- | -------- | +| AV_PIXEL_FORMAT_YUVI420 | yuv 420 planar | +| AV_PIXEL_FORMAT_NV12 | NV12. yuv 420 semiplanar | +| AV_PIXEL_FORMAT_NV21 | NV21. yvu 420 semiplanar | +| AV_PIXEL_FORMAT_SURFACE_FORMAT | surface格式 | +| AV_PIXEL_FORMAT_RGBA | RGBA8888 | + + +## 函数说明 + + +### OH_AVFormat_Copy() + + +``` +bool OH_AVFormat_Copy (struct OH_AVFormat * to, struct OH_AVFormat * from ) +``` +**描述:** +拷贝OH_AVFormat句柄资源. + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| to | 接收数据的OH_AVFormat句柄指针 | +| from | 被拷贝数据的OH_AVFormat句柄指针 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_Create() + + +``` +struct OH_AVFormat* OH_AVFormat_Create (void ) +``` +**描述:** +创建一个OH_AVFormat句柄指针，用以读写数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**返回:** + +返回OH_AVFormat实例的指针 + + +### OH_AVFormat_Destroy() + + +``` +void OH_AVFormat_Destroy (struct OH_AVFormat * format) +``` +**描述:** +销毁指定OH_AVFormat句柄资源。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | + +**返回:** + +void + + +### OH_AVFormat_DumpInfo() + + +``` +const char* OH_AVFormat_DumpInfo (struct OH_AVFormat * format) +``` +**描述:** +以字符串的形式输出OH_AVFormat所包含的信息。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | + +**返回:** + +返回由键值和数据组成的字符串指针 + + +### OH_AVFormat_GetBuffer() + + +``` +bool OH_AVFormat_GetBuffer (struct OH_AVFormat * format, const char * key, uint8_t ** addr, size_t * size ) +``` +**描述:** +从OH_AVFormat读取一块指定长度的数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 读写数据的键值 | +| addr | 生命周期是format持有，伴随format销毁，如果调用者需要长期持有，必须进行内存拷贝 | +| size | 读写数据的长度 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_GetDoubleValue() + + +``` +bool OH_AVFormat_GetDoubleValue (struct OH_AVFormat * format, const char * key, double * out ) +``` +**描述:** +从OH_AVFormat读取Double数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 读取数据的键值 | +| out | 读取的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_GetFloatValue() + + +``` +bool OH_AVFormat_GetFloatValue (struct OH_AVFormat * format, const char * key, float * out ) +``` +**描述:** +从OH_AVFormat读取Float数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 读取数据的键值 | +| out | 读取的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_GetIntValue() + + +``` +bool OH_AVFormat_GetIntValue (struct OH_AVFormat * format, const char * key, int32_t * out ) +``` +**描述:** +从OH_AVFormat读取Int数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 读取数据的键值 | +| out | 读取的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_GetLongValue() + + +``` +bool OH_AVFormat_GetLongValue (struct OH_AVFormat * format, const char * key, int64_t * out ) +``` +**描述:** +从OH_AVFormat读取Long数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 读取数据的键值 | +| out | 读取的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_GetStringValue() + + +``` +bool OH_AVFormat_GetStringValue (struct OH_AVFormat * format, const char * key, const char ** out ) +``` +**描述:** +从OH_AVFormat读取Double数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 读取数据的键值 | +| out | 读取的字符串指针，指向的数据生命周期伴随GetString更新，伴随format销毁，如果调用者需要长期持有，必须进行内存拷贝 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_SetBuffer() + + +``` +bool OH_AVFormat_SetBuffer (struct OH_AVFormat * format, const char * key, const uint8_t * addr, size_t size ) +``` +**描述:** +向OH_AVFormat写入一块指定长度的数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 写入数据的键值 | +| addr | 写入的数据地址 | +| size | 写入的数据长度 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_SetDoubleValue() + + +``` +bool OH_AVFormat_SetDoubleValue (struct OH_AVFormat * format, const char * key, double value ) +``` +**描述:** +向OH_AVFormat写入Double数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 写入数据的键值 | +| value | 写入的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_SetFloatValue() + + +``` +bool OH_AVFormat_SetFloatValue (struct OH_AVFormat * format, const char * key, float value ) +``` +**描述:** +向OH_AVFormat写入Float数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 写入数据的键值 | +| value | 写入的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_SetIntValue() + + +``` +bool OH_AVFormat_SetIntValue (struct OH_AVFormat * format, const char * key, int32_t value ) +``` +**描述:** +向OH_AVFormat写入Int数据. + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 写入数据的键值 | +| value | 写入的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_SetLongValue() + + +``` +bool OH_AVFormat_SetLongValue (struct OH_AVFormat * format, const char * key, int64_t value ) +``` +**描述:** +向OH_AVFormat写入Long数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 写入数据的键值 | +| value | 写入的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVFormat_SetStringValue() + + +``` +bool OH_AVFormat_SetStringValue (struct OH_AVFormat * format, const char * key, const char * value ) +``` +**描述:** +向OH_AVFormat写入String数据。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| format | 指向OH_AVFormat实例的指针 | +| key | 写入数据的键值 | +| value | 写入的数据 | + +**返回:** + +返回值为TRUE表示成功 + +返回值为FALSE表示失败 + + +### OH_AVMemory_GetAddr() + + +``` +uint8_t* OH_AVMemory_GetAddr (struct OH_AVMemory * mem) +``` +**描述:** +获取入参的内存虚拟地址。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mem | 指向OH_AVMemory实例的指针 | + +**返回:** + +如果内存有效，返回内存的虚拟地址 + +如果内存无效，返回nullptr + + +### OH_AVMemory_GetSize() + + +``` +int32_t OH_AVMemory_GetSize (struct OH_AVMemory * mem) +``` +**描述:** +获取入参的内存长度。 + +@syscap SystemCapability.Multimedia.Media.Core + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mem | 指向OH_AVMemory实例的指针 | + +**返回:** + +如果内存有效，返回内存长度 + +如果内存无效，返回-1 diff --git a/zh-cn/application-dev/reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md b/zh-cn/application-dev/reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..ef94d783a274a4d2e471008f5104a9de74c0629f --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md @@ -0,0 +1,138 @@ +# OHOS::AVSession::AVControllerCallback + + +## 概述 + +定义控制器相关回调操作的类的实现。 + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnSessionDestroy](#onsessiondestroy) ()=0 | AVSession会话销毁的抽象的回调方法。  | +| [OnPlaybackStateChange](#onplaybackstatechange) (const [AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 音视频的播放状态发生改变的抽象的回调方法。  | +| [OnMetaDataChange](#onmetadatachange) (const [AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &data)=0 | 会话元数据内容发生变化的抽象的回调方法。  | +| [OnActiveStateChange](#onactivestatechange) (bool isActive)=0 | 当前会话激活状态发生改变的抽象的回调方法。  | +| [OnValidCommandChange](#onvalidcommandchange) (const std::vector< int32_t > &cmds)=0 | 控制命令的有效性发生变化的抽象的回调方法。  | +| [OnOutputDeviceChange](#onoutputdevicechange) (const [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) &outputDeviceInfo)=0 | 注册会话输出设备更改。  | +| [~AVControllerCallback](#avcontrollercallback) ()=default | AVControllerCallback的默认的析构函数。  | + + +## 构造及析构函数说明 + + +### ~AVControllerCallback() + + +``` +virtual OHOS::AVSession::AVControllerCallback::~AVControllerCallback () +``` +**描述:** +AVControllerCallback的默认的析构函数。 + + +## 成员函数说明 + + +### OnActiveStateChange() + + +``` +virtual void OHOS::AVSession::AVControllerCallback::OnActiveStateChange (bool isActive) +``` +**描述:** +当前会话激活状态发生改变的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| isActive | 表示是否激活。  | + + +### OnMetaDataChange() + + +``` +virtual void OHOS::AVSession::AVControllerCallback::OnMetaDataChange (const AVMetaData & data) +``` +**描述:** +会话元数据内容发生变化的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 会话元数据内容，类型为[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)。  | + +**参见:** + +[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) + + +### OnOutputDeviceChange() + + +``` +virtual void OHOS::AVSession::AVControllerCallback::OnOutputDeviceChange (const OutputDeviceInfo & outputDeviceInfo) +``` +**描述:** +注册会话输出设备更改。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| outputDeviceInfo | 输出设备信息 [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md)。  | + + +### OnPlaybackStateChange() + + +``` +virtual void OHOS::AVSession::AVControllerCallback::OnPlaybackStateChange (const AVPlaybackState & state) +``` +**描述:** +音视频的播放状态发生改变的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| state | 音视频的播放状态的枚举值，类型为[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)。  | + + +### OnSessionDestroy() + + +``` +virtual void OHOS::AVSession::AVControllerCallback::OnSessionDestroy () +``` +**描述:** +AVSession会话销毁的抽象的回调方法。 + + +### OnValidCommandChange() + + +``` +virtual void OHOS::AVSession::AVControllerCallback::OnValidCommandChange (const std::vector< int32_t > & cmds) +``` +**描述:** +控制命令的有效性发生变化的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cmds，媒体有效的指令列表，范围为{ | | + + \ No newline at end of file diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___a_v_codec_async_callback.md b/zh-cn/application-dev/reference/native-apis/_o_h___a_v_codec_async_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..40ee60a6f27a2b5c43017bb7144013fa58a370d2 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h___a_v_codec_async_callback.md @@ -0,0 +1,29 @@ +# OH_AVCodecAsyncCallback + + +## 概述 + +AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例，并处理通过该回调报告 的信息，以确保AVCodec正常运转。 + +@syscap SystemCapability.Multimedia.Media.CodecBase +参数 +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[CodecBase](_codec_base.md) + + +## 汇总 + + +### 成员变量 + + | 名称 | 描述 | +| -------- | -------- | +| **onError** | [OH_AVCodecOnError](_codec_base.md#oh_avcodeconerror) | +| **onStreamChanged** | [OH_AVCodecOnStreamChanged](_codec_base.md#oh_avcodeconstreamchanged) | +| **onNeedInputData** | [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) | +| **onNeedOutputData** | [OH_AVCodecOnNewOutputData](_codec_base.md#oh_avcodeconnewoutputdata) | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___a_v_codec_buffer_attr.md b/zh-cn/application-dev/reference/native-apis/_o_h___a_v_codec_buffer_attr.md new file mode 100644 index 0000000000000000000000000000000000000000..967a2f545aa481f69218c07f84b53411b3e97eac --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h___a_v_codec_buffer_attr.md @@ -0,0 +1,29 @@ +# OH_AVCodecBufferAttr + + +## 概述 + +定义OH_AVCodec的Buffer描述信息。 + +@syscap SystemCapability.Multimedia.Media.CodecBase + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[CodecBase](_codec_base.md) + + +## 汇总 + + +### 成员变量 + + | 名称 | 描述 | +| -------- | -------- | +| [pts](_codec_base.md#pts) | int64_t | +| [size](_codec_base.md#size) | int32_t | +| [offset](_codec_base.md#offset) | int32_t | +| [flags](_codec_base.md#flags) | uint32_t | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md new file mode 100644 index 0000000000000000000000000000000000000000..b6af07bf0fac8b7b4a6f0fabae9205b57c8ebef5 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md @@ -0,0 +1,400 @@ +# OHOS::AVSession::AVControlCommand + + +## 概述 + +用于描述音视频播控命令工具类，播控命令的封装对象，支持设置和获取控制命令。 + + +## 汇总 + + +### Public 类型 + + | 名称 | 描述 | +| -------- | -------- | +| {
**SESSION_CMD_INVALID** = -1, **SESSION_CMD_PLAY** = 0, **SESSION_CMD_PAUSE** = 1, **SESSION_CMD_STOP** = 2, **SESSION_CMD_PLAY_NEXT** = 3, **SESSION_CMD_PLAY_PREVIOUS** = 4, **SESSION_CMD_FAST_FORWARD** = 5, **SESSION_CMD_REWIND** = 6, **SESSION_CMD_SEEK** = 7, **SESSION_CMD_SET_SPEED** = 8, **SESSION_CMD_SET_LOOP_MODE** = 9, **SESSION_CMD_TOGGLE_FAVORITE** = 10, **SESSION_CMD_MAX** = 11
} | 操作指令。 | + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Marshalling](#marshalling) (Parcel &parcel) const override | IPC通信数据序列化。 | + + +### 静态 Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Unmarshalling](#unmarshalling) (Parcel &data) | IPC通信数据反序列化。 | +| [localCapability](#localcapability) | 命令数组，用于分布式业务，判断是否支持某个命令。 | +| [IsValid](#isvalid) () const | 判断当前指令是否在有效范围内。 | +| [SetCommand](#setcommand) (int32_t cmd) | 设置操作指令。 | +| [GetCommand](#getcommand) () const | 获取操作指令。 | +| [SetSpeed](#setspeed) (double speed) | 设置媒体播放倍数。 | +| [GetSpeed](#getspeed) (double &speed) const | 获取媒体播放倍数 | +| [SetSeekTime](#setseektime) (int64_t time) | 设置媒体跳播时间。 | +| [GetSeekTime](#getseektime) (int64_t &time) const | 获取媒体跳播时间。 | +| [SetLoopMode](#setloopmode) (int32_t mode) | 设置媒体循环模式。 | +| [GetLoopMode](#getloopmode) (int32_t &mode) const | 获取媒体循环模式。 | +| [SetAssetId](#setassetid) (const std::string &assetId) | 设置媒体id。 | +| [GetAssetId](#getassetid) (std::string &assetId) const | 获取媒体id。 | + + +## 成员枚举类型说明 + + +### anonymous enum + + +``` +anonymous enum +``` +**描述:** +操作指令。 + + | 枚举值 | 描述 | +| -------- | -------- | +| SESSION_CMD_INVALID | 无效指令，内部用于判断指令是否有效 | +| SESSION_CMD_PLAY | 播放 | +| SESSION_CMD_PAUSE | 暂停 | +| SESSION_CMD_STOP | 停止 | +| SESSION_CMD_PLAY_NEXT | 播放下一首 | +| SESSION_CMD_PLAY_PREVIOUS | 播放上一首 | +| SESSION_CMD_FAST_FORWARD | 快进 | +| SESSION_CMD_REWIND | 快退 | +| SESSION_CMD_SEEK | 跳播 | +| SESSION_CMD_SET_SPEED | 设置播放倍数 | +| SESSION_CMD_SET_LOOP_MODE | 设置循环模式 | +| SESSION_CMD_TOGGLE_FAVORITE | 收藏 | +| SESSION_CMD_MAX | 无效指令，内部用于判断指令是否有效 | + + +## 成员函数说明 + + +### GetAssetId() + + +``` +int32_t OHOS::AVSession::AVControlCommand::GetAssetId (std::string & assetId) const +``` +**描述:** +获取媒体id。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| assetId | 保存媒体id。 | + +**参见:** + +[SetAssetId](#setassetid) + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### GetCommand() + + +``` +int32_t OHOS::AVSession::AVControlCommand::GetCommand () const +``` +**描述:** +获取操作指令。 + +**返回:** + +返回操作指令，范围在**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**之间。 + +**参见:** + +[SetCommand](#setcommand) + + +### GetLoopMode() + + +``` +int32_t OHOS::AVSession::AVControlCommand::GetLoopMode (int32_t & mode) const +``` +**描述:** +获取媒体循环模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mode | 保存媒体循环模式。 取值在[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)的**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | + +**参见:** + +[SetLoopMode](#setloopmode) + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### GetSeekTime() + + +``` +int32_t OHOS::AVSession::AVControlCommand::GetSeekTime (int64_t & time) const +``` +**描述:** +获取媒体跳播时间。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| time | 媒体资源的位置，从媒体资源开头开始计算，单位为ms。取值需大于等于0。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[SetSeekTime](#setseektime) + + +### GetSpeed() + + +``` +int32_t OHOS::AVSession::AVControlCommand::GetSpeed (double & speed) const +``` +**描述:** +获取媒体播放倍数 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| speed | 媒体播放倍数，返回值。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[SetSpeed](#setspeed) + + +### IsValid() + + +``` +bool OHOS::AVSession::AVControlCommand::IsValid () const +``` +**描述:** +判断当前指令是否在有效范围内。 + +**返回:** + +如果cmd_在有效范围内，范围在**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**之间， 返回true；否则，返回false。 + + +### Marshalling() + + +``` +bool OHOS::AVSession::AVControlCommand::Marshalling (Parcel & parcel) const +``` +**描述:** +IPC通信数据序列化。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| parcel | 保存序列化值的对象**Parcel**。 | + +**返回:** + +成功返回true；否则，返回false。 + +**参见:** + +[Unmarshalling](#unmarshalling) + + +### SetAssetId() + + +``` +int32_t OHOS::AVSession::AVControlCommand::SetAssetId (const std::string & assetId) +``` +**描述:** +设置媒体id。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| assetId | 媒体id，不可为空。 | + +**参见:** + +[GetAssetId](#getassetid) + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### SetCommand() + + +``` +int32_t OHOS::AVSession::AVControlCommand::SetCommand (int32_t cmd) +``` +**描述:** +设置操作指令。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cmd | 操作指令，范围在**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**之间。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[GetCommand](#getcommand) + + +### SetLoopMode() + + +``` +int32_t OHOS::AVSession::AVControlCommand::SetLoopMode (int32_t mode) +``` +**描述:** +设置媒体循环模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mode | 媒体循环模式， 取值在[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)的**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | + +**参见:** + +[GetLoopMode](#getloopmode) + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### SetSeekTime() + + +``` +int32_t OHOS::AVSession::AVControlCommand::SetSeekTime (int64_t time) +``` +**描述:** +设置媒体跳播时间。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| time | 媒体资源的位置，从媒体资源开头开始计算，单位为ms。取值需大于等于0。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[GetSeekTime](#getseektime) + + +### SetSpeed() + + +``` +int32_t OHOS::AVSession::AVControlCommand::SetSpeed (double speed) +``` +**描述:** +设置媒体播放倍数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| speed | 媒体播放倍数，需大于0。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[GetSpeed](#getspeed) + + +### Unmarshalling() + + +``` +static AVControlCommand* OHOS::AVSession::AVControlCommand::Unmarshalling (Parcel & data) +``` +**描述:** +IPC通信数据反序列化。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 序列化对象**Parcel**。 | + +**返回:** + +返回AVControlCommand的函数指针。 + +**参见:** + +[Marshalling](#marshalling) + + +## 结构体成员变量说明 + + +### localCapability + + +``` +const std::vector OHOS::AVSession::AVControlCommand::localCapability +``` +**Value:** + +``` +{ + SESSION_CMD_PLAY, + SESSION_CMD_PAUSE, + SESSION_CMD_STOP, + SESSION_CMD_PLAY_NEXT, + SESSION_CMD_PLAY_PREVIOUS, + SESSION_CMD_FAST_FORWARD, + SESSION_CMD_REWIND, + SESSION_CMD_SEEK, + SESSION_CMD_SET_SPEED, + SESSION_CMD_SET_LOOP_MODE, + SESSION_CMD_TOGGLE_FAVORITE, + } +``` +**描述:** +命令数组，用于分布式业务，判断是否支持某个命令。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md new file mode 100644 index 0000000000000000000000000000000000000000..2300db5d2dbd054a9a1ae2386c1f509c1447ff07 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md @@ -0,0 +1,926 @@ +# OHOS::AVSession::AVMetaData + + +## 概述 + +会话元数据类，提供获取metadata进程间传递的序列化和反序列话及数据拷贝的接口方法。 + + +## 汇总 + + +### Public 类型 + + | 名称 | 描述 | +| -------- | -------- | +| {
**META_KEY_ASSET_ID** = 0, **META_KEY_TITLE** = 1, **META_KEY_ARTIST** = 2, **META_KEY_AUTHOR** = 3, **META_KEY_ALBUM** = 4, **META_KEY_WRITER** = 5, **META_KEY_COMPOSER** = 6, **META_KEY_DURATION** = 7, **META_KEY_MEDIA_IMAGE** = 8, **META_KEY_MEDIA_IMAGE_URI** = 9, **META_KEY_PUBLISH_DATE** = 10, **META_KEY_SUBTITLE** = 11, **META_KEY_DESCRIPTION** = 12, **META_KEY_LYRIC** = 13, **META_KEY_PREVIOUS_ASSET_ID** = 14, **META_KEY_NEXT_ASSET_ID** = 15, **META_KEY_MAX** = 16
} | 会话元数据具体枚举项。 | +| [MetaMaskType](#metamasktype) = std::bitset< META_KEY_MAX > | 引入掩码标记需要拷贝的会话元数据。 | + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [AVMetaData](#avmetadata) ()=default | 会话元数据默认构造函数。 | +| [~AVMetaData](#avmetadata) () override | 会话元数据默认析构函数。 | +| [Marshalling](#marshalling) (Parcel &data) const override | 实现会话元数据进程间传递的序列化。 | +| [SetAssetId](#setassetid) (const std::string &assetId) | 设置曲目ID。 | +| [GetAssetId](#getassetid) () const | 获取曲目ID。 | +| [SetTitle](#settitle) (const std::string &title) | 设置标题。 | +| [GetTitle](#gettitle) () const | 获取标题。 | +| [SetArtist](#setartist) (const std::string &artist) | 设置艺术家名称。 | +| [GetArtist](#getartist) () const | 获取艺术家名称。 | +| [SetAuthor](#setauthor) (const std::string &author) | 设置制作人名称。 | +| [GetAuthor](#getauthor) () const | 获取制作人名称。 | +| [SetAlbum](#setalbum) (const std::string &album) | 设置专辑名称。 | +| [GetAlbum](#getalbum) () const | 获取专辑名称。 | +| [SetWriter](#setwriter) (const std::string &writer) | 设置作词名称。 | +| [GetWriter](#getwriter) () const | 获取作词名称。 | +| [SetComposer](#setcomposer) (const std::string &composer) | 设置作曲名称。 | +| [GetComposer](#getcomposer) () const | 获取作曲名称。 | +| [SetDuration](#setduration) (int64_t duration) | 设置媒体时长。 | +| [GetDuration](#getduration) () const | 获取媒体时长。 | +| [SetMediaImage](#setmediaimage) (const std::shared_ptr< [AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md) > &mediaImage) | 设置媒体图片。 | +| [GetMediaImage](#getmediaimage) () const | 获取媒体图片。 | +| [SetMediaImageUri](#setmediaimageuri) (const std::string &mediaImageUri) | 设置媒体图片URI。 | +| [GetMediaImageUri](#getmediaimageuri) () const | 获取媒体图片URI。 | +| [SetPublishDate](#setpublishdate) (double date) | 设置曲目发布日期，时间戳，单位为ms。 | +| [GetPublishDate](#getpublishdate) () const | 获取曲目发布日期，时间戳，单位为ms。 | +| [SetSubTitle](#setsubtitle) (const std::string &subTitle) | 设置子标题。 | +| [GetSubTitle](#getsubtitle) () const | 获取子标题。 | +| [SetDescription](#setdescription) (const std::string &description) | 设置曲目描述。 | +| [GetDescription](#getdescription) () const | 获取曲目描述。 | +| [SetLyric](#setlyric) (const std::string &lyric) | 设置歌词。 | +| [GetLyric](#getlyric) () const | 获取歌词。 | +| [SetPreviousAssetId](#setpreviousassetid) (const std::string &assetId) | 设置上一曲曲目ID。 | +| [GetPreviousAssetId](#getpreviousassetid) () const | 获取上一曲曲目ID。 | +| [SetNextAssetId](#setnextassetid) (const std::string &assetId) | 设置下一曲曲目ID。 | +| [GetNextAssetId](#getnextassetid) () const | 获取下一曲曲目ID。 | +| [Reset](#reset) () | 重置所有会话元数据项。 | +| [GetMetaMask](#getmetamask) () const | 获取掩码。 | +| [CopyToByMask](#copytobymask) ([MetaMaskType](#metamasktype) &mask, AVMetaData &metaOut) const | 根据metadata掩码,将metadata项复制到metaOut。 | +| [CopyFrom](#copyfrom) (const AVMetaData &metaIn) | 根据metaIn元掩码的设置位从metaIn复制metadata项。 | +| [IsValid](#isvalid) () const | 会话元数据有效性判断。 | + + +### 静态 Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Unmarshalling](#unmarshalling) (Parcel &data) | 实现会话元数据进程间传递的反序列化。 | + + +### 静态 Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [DURATION_ALWAYS_PLAY](#duration_always_play) = -1 | 持续时间全局变量宏定义。 | +| [localCapability](#localcapability) | 会话元数据数组，用于分布式业务，设置会话属性。 | + + +## 成员类型定义说明 + + +### MetaMaskType + + +``` +using OHOS::AVSession::AVMetaData::MetaMaskType = std::bitset +``` +**描述:** +引入掩码标记需要拷贝的会话元数据。 + + +## 成员枚举类型说明 + + +### anonymous enum + + +``` +anonymous enum +``` +**描述:** +会话元数据具体枚举项。 + + | 枚举值 | 描述 | +| -------- | -------- | +| META_KEY_ASSET_ID | 曲目ID | +| META_KEY_TITLE | 标题 | +| META_KEY_ARTIST | 艺术家 | +| META_KEY_AUTHOR | 制作人 | +| META_KEY_ALBUM | 专辑 | +| META_KEY_WRITER | 作词 | +| META_KEY_COMPOSER | 作曲 | +| META_KEY_DURATION | 媒体时长 | +| META_KEY_MEDIA_IMAGE | 媒体影像 | +| META_KEY_MEDIA_IMAGE_URI | 媒体影像路径 | +| META_KEY_PUBLISH_DATE | 曲目发布日期 | +| META_KEY_SUBTITLE | 子标题 | +| META_KEY_DESCRIPTION | 曲目描述 | +| META_KEY_LYRIC | 歌词 | +| META_KEY_PREVIOUS_ASSET_ID | 上一曲 | +| META_KEY_NEXT_ASSET_ID | 下一曲 | +| META_KEY_MAX | 无效指令，内部用来判断会话元数据是否有效 | + + +## 构造及析构函数说明 + + +### AVMetaData() + + +``` +OHOS::AVSession::AVMetaData::AVMetaData () +``` +**描述:** +会话元数据默认构造函数。 + + +### ~AVMetaData() + + +``` +OHOS::AVSession::AVMetaData::~AVMetaData () +``` +**描述:** +会话元数据默认析构函数。 + + +## 成员函数说明 + + +### CopyFrom() + + +``` +bool OHOS::AVSession::AVMetaData::CopyFrom (const AVMetaData & metaIn) +``` +**描述:** +根据metaIn元掩码的设置位从metaIn复制metadata项。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| metaIn | 会话元数据将要拷贝的入参。| + + +### CopyToByMask() + + +``` +bool OHOS::AVSession::AVMetaData::CopyToByMask (MetaMaskType & mask, AVMetaData & metaOut ) const +``` +**描述:** +根据metadata掩码,将metadata项复制到metaOut。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mask | metadata掩码[MetaMaskType](#metamasktype)。 | +| metaOut | metadata已拷贝成功的出参AVMetaData。 | + +**返回:** + +成功返回true；失败则返回false。 + + +### GetAlbum() + + +``` +std::string OHOS::AVSession::AVMetaData::GetAlbum () const +``` +**描述:** +获取专辑名称。 + +**返回:** + +返回专辑名称。 + +**参见:** + +[SetAlbum](#setalbum) + + +### GetArtist() + + +``` +std::string OHOS::AVSession::AVMetaData::GetArtist () const +``` +**描述:** +获取艺术家名称。 + +**返回:** + +返回艺术家名称。 + +**参见:** + +[SetArtist](#setartist) + + +### GetAssetId() + + +``` +std::string OHOS::AVSession::AVMetaData::GetAssetId () const +``` +**描述:** +获取曲目ID。 + +**返回:** + +返回曲目ID。 + +**参见:** + +[SetAssetId](#setassetid) + + +### GetAuthor() + + +``` +std::string OHOS::AVSession::AVMetaData::GetAuthor () const +``` +**描述:** +获取制作人名称。 + +**返回:** + +返回制作人名称。 + +**参见:** + +[SetAuthor](#setauthor) + + +### GetComposer() + + +``` +std::string OHOS::AVSession::AVMetaData::GetComposer () const +``` +**描述:** +获取作曲名称。 + +**返回:** + +返回作曲名称。 + +**参见:** + +[SetComposer](#setcomposer) + + +### GetDescription() + + +``` +std::string OHOS::AVSession::AVMetaData::GetDescription () const +``` +**描述:** +获取曲目描述。 + +**返回:** + +返回曲目描述。 + +**参见:** + +[SetDescription](#setdescription) + + +### GetDuration() + + +``` +int64_t OHOS::AVSession::AVMetaData::GetDuration () const +``` +**描述:** +获取媒体时长。 + +**返回:** + +返回媒体时长，单位为ms。 + +**参见:** + +[SetDuration](#setduration) + + +### GetLyric() + + +``` +std::string OHOS::AVSession::AVMetaData::GetLyric () const +``` +**描述:** +获取歌词。 + +**返回:** + +返回歌词。 + +**参见:** + +[SetLyric](#setlyric) + + +### GetMediaImage() + + +``` +std::shared_ptr OHOS::AVSession::AVMetaData::GetMediaImage () const +``` +**描述:** +获取媒体图片。 + +**返回:** + +返回媒体图片[AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md)。 + +**参见:** + +[SetMediaImage](#setmediaimage) + + +### GetMediaImageUri() + + +``` +std::string OHOS::AVSession::AVMetaData::GetMediaImageUri () const +``` +**描述:** +获取媒体图片URI。 + +**返回:** + +返回媒体图片URI。 + +**参见:** + +[SetMediaImageUri](#setmediaimageuri) + + +### GetMetaMask() + + +``` +MetaMaskType OHOS::AVSession::AVMetaData::GetMetaMask () const +``` +**描述:** +获取掩码。 + +**返回:** + +返回掩码[MetaMaskType](#metamasktype)。 + + +### GetNextAssetId() + + +``` +std::string OHOS::AVSession::AVMetaData::GetNextAssetId () const +``` +**描述:** +获取下一曲曲目ID。 + +**返回:** + +返回下一曲曲目ID。 + +**参见:** + +[SetNextAssetId](#setnextassetid) + + +### GetPreviousAssetId() + + +``` +std::string OHOS::AVSession::AVMetaData::GetPreviousAssetId () const +``` +**描述:** +获取上一曲曲目ID。 + +**返回:** + +返回上一曲曲目ID。 + +**参见:** + +[SetPreviousAssetId](#setpreviousassetid) + + +### GetPublishDate() + + +``` +double OHOS::AVSession::AVMetaData::GetPublishDate () const +``` +**描述:** +获取曲目发布日期，时间戳，单位为ms。 + +**返回:** + +返回曲目发布日期，时间戳，单位为ms。 + +**参见:** + +[SetPublishDate](#setpublishdate) + + +### GetSubTitle() + + +``` +std::string OHOS::AVSession::AVMetaData::GetSubTitle () const +``` +**描述:** +获取子标题。 + +**返回:** + +返回子标题。 + +**参见:** + +[SetSubTitle](#setsubtitle) + + +### GetTitle() + + +``` +std::string OHOS::AVSession::AVMetaData::GetTitle () const +``` +**描述:** +获取标题。 + +**返回:** + +返回标题。 + +**参见:** + +[SetTitle](#settitle) + + +### GetWriter() + + +``` +std::string OHOS::AVSession::AVMetaData::GetWriter () const +``` +**描述:** +获取作词名称。 + +**返回:** + +返回作词名称。 + +**参见:** + +[SetWriter](#setwriter) + + +### IsValid() + + +``` +bool OHOS::AVSession::AVMetaData::IsValid () const +``` +**描述:** +会话元数据有效性判断。 + +**返回:** + +有效返回true；无效则返回false。 + + +### Marshalling() + + +``` +bool OHOS::AVSession::AVMetaData::Marshalling (Parcel & data) const +``` +**描述:** +实现会话元数据进程间传递的序列化。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 保存序列化值的对象**Parcel**。 | + +**返回:** + +如果序列化成功，则返回true；如果操作失败，则返回false。 + +**参见:** + +[Unmarshalling](#unmarshalling) + + +### Reset() + + +``` +void OHOS::AVSession::AVMetaData::Reset () +``` +**描述:** +重置所有会话元数据项。 + + +### SetAlbum() + + +``` +void OHOS::AVSession::AVMetaData::SetAlbum (const std::string & album) +``` +**描述:** +设置专辑名称。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| album | 专辑名称。 | + +**参见:** + +[GetAlbum](#getalbum) + + +### SetArtist() + + +``` +void OHOS::AVSession::AVMetaData::SetArtist (const std::string & artist) +``` +**描述:** +设置艺术家名称。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| artist | 艺术家名称。 | + +**参见:** + +[GetArtist](#getartist) + + +### SetAssetId() + + +``` +void OHOS::AVSession::AVMetaData::SetAssetId (const std::string & assetId) +``` +**描述:** +设置曲目ID。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| assetId | 曲目ID,不可为空。 | + +**参见:** + +[GetAssetId](#getassetid) + + +### SetAuthor() + + +``` +void OHOS::AVSession::AVMetaData::SetAuthor (const std::string & author) +``` +**描述:** +设置制作人名称。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| author | 制作人名称。 | + +**参见:** + +[GetArtist](#getartist) + + +### SetComposer() + + +``` +void OHOS::AVSession::AVMetaData::SetComposer (const std::string & composer) +``` +**描述:** +设置作曲名称。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| composer | 作曲名称。 | + +**参见:** + +[GetComposer](#getcomposer) + + +### SetDescription() + + +``` +void OHOS::AVSession::AVMetaData::SetDescription (const std::string & description) +``` +**描述:** +设置曲目描述。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| description | 曲目描述。 | + +**参见:** + +[GetDescription](#getdescription) + + +### SetDuration() + + +``` +void OHOS::AVSession::AVMetaData::SetDuration (int64_t duration) +``` +**描述:** +设置媒体时长。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| duration | 媒体时长，必须大于等于-1，单位为ms 。 | + +**参见:** + +[GetDuration](#getduration) + + +### SetLyric() + + +``` +void OHOS::AVSession::AVMetaData::SetLyric (const std::string & lyric) +``` +**描述:** +设置歌词。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| lyric | 歌词。 | + +**参见:** + +[GetLyric](#getlyric) + + +### SetMediaImage() + + +``` +void OHOS::AVSession::AVMetaData::SetMediaImage (const std::shared_ptr< AVSessionPixelMap > & mediaImage) +``` +**描述:** +设置媒体图片。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mediaImage | 媒体图片[AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md)。 | + +**参见:** + +[GetMediaImage](#getmediaimage) + + +### SetMediaImageUri() + + +``` +void OHOS::AVSession::AVMetaData::SetMediaImageUri (const std::string & mediaImageUri) +``` +**描述:** +设置媒体图片URI。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mediaImageUri | 媒体图片URI。 | + +**参见:** + +[GetMediaImageUri](#getmediaimageuri) + + +### SetNextAssetId() + + +``` +void OHOS::AVSession::AVMetaData::SetNextAssetId (const std::string & assetId) +``` +**描述:** +设置下一曲曲目ID。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| assetId | 下一曲曲目ID。 | + +**参见:** + +[GetNextAssetId](#getnextassetid) + + +### SetPreviousAssetId() + + +``` +void OHOS::AVSession::AVMetaData::SetPreviousAssetId (const std::string & assetId) +``` +**描述:** +设置上一曲曲目ID。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| assetId | 上一曲曲目ID。 | + +**参见:** + +[GetPreviousAssetId](#getpreviousassetid) + + +### SetPublishDate() + + +``` +void OHOS::AVSession::AVMetaData::SetPublishDate (double date) +``` +**描述:** +设置曲目发布日期，时间戳，单位为ms。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| date | 曲目发布日期，时间戳，单位为ms。 | + +**参见:** + +[GetPublishDate](#getpublishdate) + + +### SetSubTitle() + + +``` +void OHOS::AVSession::AVMetaData::SetSubTitle (const std::string & subTitle) +``` +**描述:** +设置子标题。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| subTitle | 子标题。 | + +**参见:** + +[GetSubTitle](#getsubtitle) + + +### SetTitle() + + +``` +void OHOS::AVSession::AVMetaData::SetTitle (const std::string & title) +``` +**描述:** +设置标题。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| title | 标题。 | + +**参见:** + +[GetTitle](#gettitle) + + +### SetWriter() + + +``` +void OHOS::AVSession::AVMetaData::SetWriter (const std::string & writer) +``` +**描述:** +设置作词名称。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| writer | 作词名称。 | + +**参见:** + +[GetWriter](#getwriter) + + +### Unmarshalling() + + +``` +static AVMetaData* OHOS::AVSession::AVMetaData::Unmarshalling (Parcel & data) +``` +**描述:** +实现会话元数据进程间传递的反序列化。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 序列化对象**Parcel**。 | + +**返回:** + +如果反序列化成功，返回AVMetaData类型指针；失败则返回nullptr。 + +**参见:** + +[Marshalling](#marshalling) + + +## 结构体成员变量说明 + + +### DURATION_ALWAYS_PLAY + + +``` +constexpr std::int64_t OHOS::AVSession::AVMetaData::DURATION_ALWAYS_PLAY = -1 +``` +**描述:** +持续时间全局变量宏定义。 + + +### localCapability + + +``` +const std::vector OHOS::AVSession::AVMetaData::localCapability +``` +**Value:** + +``` +{ + META_KEY_ASSET_ID, + META_KEY_TITLE, + META_KEY_ARTIST, + META_KEY_AUTHOR, + META_KEY_ALBUM, + META_KEY_WRITER, + META_KEY_COMPOSER, + META_KEY_DURATION, + META_KEY_MEDIA_IMAGE, + META_KEY_MEDIA_IMAGE_URI, + META_KEY_PUBLISH_DATE, + META_KEY_SUBTITLE, + META_KEY_DESCRIPTION, + META_KEY_LYRIC, + META_KEY_PREVIOUS_ASSET_ID, + META_KEY_NEXT_ASSET_ID, + } +``` +**描述:** +会话元数据数组，用于分布式业务，设置会话属性。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md new file mode 100644 index 0000000000000000000000000000000000000000..8183b4b57c655174ae3ae217f72a88bec45020c1 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md @@ -0,0 +1,502 @@ +# OHOS::AVSession::AVPlaybackState + + +## 概述 + +音视频播放状态类，提供获取和设置播放界面的信息。 + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) | struct
播放位置的相关信息。 | + + +### Public 类型 + + | 名称 | 描述 | +| -------- | -------- | +| {
**PLAYBACK_STATE_INITIAL** = 0, **PLAYBACK_STATE_PREPARING** = 1, **PLAYBACK_STATE_PLAYING** = 2, **PLAYBACK_STATE_PAUSED** = 3, **PLAYBACK_STATE_FAST_FORWARD** = 4, **PLAYBACK_STATE_REWIND** = 5, **PLAYBACK_STATE_STOP** = 6, **PLAYBACK_STATE_MAX** = 7
} | 描述播放状态的枚举。 | +| {
**PLAYBACK_KEY_STATE** = 0, **PLAYBACK_KEY_SPEED** = 1, **PLAYBACK_KEY_POSITION** = 2, **PLAYBACK_KEY_BUFFERED_TIME** = 3, **PLAYBACK_KEY_LOOP_MODE** = 4, **PLAYBACK_KEY_IS_FAVORITE** = 5, **PLAYBACK_KEY_MAX** = 6
} | 播放界面信息的枚举。 | +| { **LOOP_MODE_SEQUENCE** = 0, **LOOP_MODE_SINGLE** = 1, **LOOP_MODE_LIST** = 2, **LOOP_MODE_SHUFFLE** = 3 } | 循环模式的枚举。 | +| **PlaybackStateMaskType** = std::bitset< PLAYBACK_KEY_MAX > | | + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Marshalling](#marshalling) (Parcel &parcel) const override | IPC通信数据序列化。 | +| [IsValid](#isvalid) () const | 验证当前信息的有效性。 | +| [SetState](#setstate) (int32_t state) | 设置音视频的播放状态。 | +| [GetState](#getstate) () const | 获取当前音视频的播放状态。 | +| [SetSpeed](#setspeed) (double speed) | 设置播放倍速。 | +| [GetSpeed](#getspeed) () const | 获取当前播放倍速。 | +| [SetPosition](#setposition) (const [Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) &position) | 设置播放位置，通过更新时间与经过时间来计算，单位ms。 | +| [GetPosition](#getposition) () const | 获取播放位置。 | +| [SetBufferedTime](#setbufferedtime) (int64_t time) | 设置缓冲时间，单位为ms。 | +| [GetBufferedTime](#getbufferedtime) () const | 获取当前缓冲时间，单位为ms。 | +| [SetLoopMode](#setloopmode) (int32_t mode) | 设置循环模式。 | +| [GetLoopMode](#getloopmode) () const | 获取当前循环模式。 | +| [SetFavorite](#setfavorite) (bool isFavorite) | 设置是否收藏。 | +| [GetFavorite](#getfavorite) () const | 获取是否收藏。 | +| [GetMask](#getmask) () const | 获取掩码。 | + + +### 静态 Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Unmarshalling](#unmarshalling) (Parcel &parcel) | IPC通信数据反序列化。 | +| [localCapability](#localcapability) | 内联函数指针数组AVPlaybackState，用于分布式业务，设置播放界面信息。 | +| [CopyToByMask](#copytobymask) (PlaybackStateMaskType &mask, AVPlaybackState &out) const | 通过掩码拷贝信息到新的AVPlaybackState对象。 | +| [CopyFrom](#copyfrom) (const AVPlaybackState &in) | 根据当前对象的mask_掩码，将输入的AVPlaybackState类型的信息复制到当前对象。 | + + +## 成员枚举类型说明 + + +### anonymous enum + + +``` +anonymous enum +``` +**描述:** +描述播放状态的枚举。 + + | 枚举值 | 描述 | +| -------- | -------- | +| PLAYBACK_STATE_INITIAL | 初始状态 | +| PLAYBACK_STATE_PREPARING | 缓冲状态 | +| PLAYBACK_STATE_PLAYING | 播放状态 | +| PLAYBACK_STATE_PAUSED | 暂停状态 | +| PLAYBACK_STATE_FAST_FORWARD | 快进状态 | +| PLAYBACK_STATE_REWIND | 快退状态 | +| PLAYBACK_STATE_STOP | 停止状态 | +| PLAYBACK_STATE_MAX | 无效类型，内部用于判断状态是否有效 | + + +### anonymous enum + + +``` +anonymous enum +``` +**描述:** +播放界面信息的枚举。 + + | 枚举值 | 描述 | +| -------- | -------- | +| PLAYBACK_KEY_STATE | 播放状态，包括正在播放、暂停、快进等 | +| PLAYBACK_KEY_SPEED | 播放倍数 | +| PLAYBACK_KEY_POSITION | 播放位置 | +| PLAYBACK_KEY_BUFFERED_TIME | 缓冲时间 | +| PLAYBACK_KEY_LOOP_MODE | 循环模式 | +| PLAYBACK_KEY_IS_FAVORITE | 设置喜欢(收藏) | +| PLAYBACK_KEY_MAX | 无效类型，内部用于判断key是否有效 | + + +### anonymous enum + + +``` +anonymous enum +``` +**描述:** +循环模式的枚举。 + + | 枚举值 | 描述 | +| -------- | -------- | +| LOOP_MODE_SEQUENCE | 顺序播放 | +| LOOP_MODE_SINGLE | 单曲循环 | +| LOOP_MODE_LIST | 列表循环 | +| LOOP_MODE_SHUFFLE | 随机播放 | + + +## 成员函数说明 + + +### CopyFrom() + + +``` +bool OHOS::AVSession::AVPlaybackState::CopyFrom (const AVPlaybackState & in) +``` +**描述:** +根据当前对象的mask_掩码，将输入的AVPlaybackState类型的信息复制到当前对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| in | AVPlaybackState类型。 | + +**返回:** + +如果有至少一个播放界面信息被拷贝，返回true；如果一个播放界面信息都没有被拷贝，返回false。 + +**参见:** + +[CopyToByMask](#copytobymask) + +[GetMask](#getmask) + + +### CopyToByMask() + + +``` +bool OHOS::AVSession::AVPlaybackState::CopyToByMask (PlaybackStateMaskType & mask, AVPlaybackState & out ) const +``` +**描述:** +通过掩码拷贝信息到新的AVPlaybackState对象。 + +mask对应位上有值的对象拷贝给out。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mask | 输入的掩码**}。 out 输出的音视频的播放状态 AVPlaybackState}。 如果有至少一个播放界面信息被拷贝，返回true；如果一个播放界面信息都没有被拷贝，返回false。 CopyFrom 9 1.0 ** | + + +### GetBufferedTime() + + +``` +int64_t OHOS::AVSession::AVPlaybackState::GetBufferedTime () const +``` +**描述:** +获取当前缓冲时间，单位为ms。 + +**返回:** + +返回缓冲时间。 + +**参见:** + +[SetBufferedTime](#setbufferedtime) + + +### GetFavorite() + + +``` +bool OHOS::AVSession::AVPlaybackState::GetFavorite () const +``` +**描述:** +获取是否收藏。 + +**返回:** + +是否收藏，是则返回true，否则返回false。 + +**参见:** + +[SetFavorite](#setfavorite) + + +### GetLoopMode() + + +``` +int32_t OHOS::AVSession::AVPlaybackState::GetLoopMode () const +``` +**描述:** +获取当前循环模式。 + +**返回:** + +返回循环模式，范围**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 + +**参见:** + +[SetLoopMode](#setloopmode) + + +### GetMask() + + +``` +PlaybackStateMaskType OHOS::AVSession::AVPlaybackState::GetMask () const +``` +**描述:** +获取掩码。 + +**返回:** + +返回播放界面信息的掩码**PlaybackStateMaskType**。 + +**参见:** + +[CopyFrom](#copyfrom) + + +### GetPosition() + + +``` +Position OHOS::AVSession::AVPlaybackState::GetPosition () const +``` +**描述:** +获取播放位置。 + +**返回:** + +返回播放位置[Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md)。 + +**参见:** + +[SetPosition](#setposition) + + +### GetSpeed() + + +``` +double OHOS::AVSession::AVPlaybackState::GetSpeed () const +``` +**描述:** +获取当前播放倍速。 + +**返回:** + +返回当前播放倍速。 + +**参见:** + +[SetSpeed](#setspeed) + + +### GetState() + + +``` +int32_t OHOS::AVSession::AVPlaybackState::GetState () const +``` +**描述:** +获取当前音视频的播放状态。 + +**返回:** + +返回当前音视频的播放状态，范围**PLAYBACK_STATE_INITIAL**到**PLAYBACK_STATE_MAX**之间。 + +**参见:** + +[SetState](#setstate) + + +### IsValid() + + +``` +bool OHOS::AVSession::AVPlaybackState::IsValid () const +``` +**描述:** +验证当前信息的有效性。 + +**返回:** + +有效返回true；无效则返回false。 + + +### Marshalling() + + +``` +bool OHOS::AVSession::AVPlaybackState::Marshalling (Parcel & parcel) const +``` +**描述:** +IPC通信数据序列化。 + +将AVPlaybackState类型的信息，序列化为**Parcel**类型的信息，用来进行IPC通信。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| parcel | 保存序列化值的对象**Parcel**。 | + +**返回:** + +成功返回true；失败返回false。 + +**参见:** + +[Unmarshalling](#unmarshalling) + + +### SetBufferedTime() + + +``` +void OHOS::AVSession::AVPlaybackState::SetBufferedTime (int64_t time) +``` +**描述:** +设置缓冲时间，单位为ms。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| time | 缓冲时间。 | + +**参见:** + +[GetBufferedTime](#getbufferedtime) + + +### SetFavorite() + + +``` +void OHOS::AVSession::AVPlaybackState::SetFavorite (bool isFavorite) +``` +**描述:** +设置是否收藏。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| isFavorite | 是否收藏，是则为true，否则false。 | + +**参见:** + +[GetFavorite](#getfavorite) + + +### SetLoopMode() + + +``` +void OHOS::AVSession::AVPlaybackState::SetLoopMode (int32_t mode) +``` +**描述:** +设置循环模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mode | 循环模式，范围**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | + +**参见:** + +[GetLoopMode](#getloopmode) + + +### SetPosition() + + +``` +void OHOS::AVSession::AVPlaybackState::SetPosition (const Position & position) +``` +**描述:** +设置播放位置，通过更新时间与经过时间来计算，单位ms。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| position | 播放位置[Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md)。 | + +**参见:** + +[GetPosition](#getposition) + + +### SetSpeed() + + +``` +void OHOS::AVSession::AVPlaybackState::SetSpeed (double speed) +``` +**描述:** +设置播放倍速。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| speed | 播放倍速。 | + +**参见:** + +[SetSpeed](#setspeed) + + +### SetState() + + +``` +void OHOS::AVSession::AVPlaybackState::SetState (int32_t state) +``` +**描述:** +设置音视频的播放状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| state | 音视频的播放状态，范围**PLAYBACK_STATE_INITIAL**到**PLAYBACK_STATE_MAX**之间。 | + +**参见:** + +[GetState](#getstate) + + +### Unmarshalling() + + +``` +static AVPlaybackState* OHOS::AVSession::AVPlaybackState::Unmarshalling (Parcel & parcel) +``` +**描述:** +IPC通信数据反序列化。 + +将通过IPC接收的**Parcel**类型的信息，反序列化为AVPlaybackState类型的信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| parcel | 序列化对象**Parcel**。 | + +**返回:** + +如果反序列化成功，则返回AVPlaybackState对象; 如果反序列化失败，则返回nullptr。 + +**参见:** + +[Marshalling](#marshalling) + + +## 结构体成员变量说明 + + +### localCapability + + +``` +const std::vector OHOS::AVSession::AVPlaybackState::localCapability +``` +**Value:** + +``` +{ + PLAYBACK_KEY_STATE, + PLAYBACK_KEY_SPEED, + PLAYBACK_KEY_POSITION, + PLAYBACK_KEY_BUFFERED_TIME, + PLAYBACK_KEY_LOOP_MODE, + PLAYBACK_KEY_IS_FAVORITE, + } +``` +**描述:** +内联函数指针数组AVPlaybackState，用于分布式业务，设置播放界面信息。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md new file mode 100644 index 0000000000000000000000000000000000000000..342eada497e7763e0364121dd6feece15889fa08 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md @@ -0,0 +1,346 @@ +# OHOS::AVSession::AVSession + + +## 概述 + +会话对象，支持配置会话属性，并可主动更新播放状态和会话元数据。 + + +## 汇总 + + +### Public 类型 + + | 名称 | 描述 | +| -------- | -------- | +| { **SESSION_TYPE_INVALID** = -1, **SESSION_TYPE_AUDIO** = 0, **SESSION_TYPE_VIDEO** = 1 } | 会话类型的枚举。 | + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetSessionId](#getsessionid) ()=0 | 获取会话的标识。 | +| [GetAVMetaData](#getavmetadata) ([AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &meta)=0 | 获取会话元数据。 | +| [SetAVMetaData](#setavmetadata) (const [AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &meta)=0 | 设置会话元数据。 | +| [GetAVPlaybackState](#getavplaybackstate) ([AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 获取音视频的播放状态。 | +| [SetAVPlaybackState](#setavplaybackstate) (const [AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 设置音视频的播放状态。 | +| [SetLaunchAbility](#setlaunchability) (const AbilityRuntime::WantAgent::WantAgent &ability)=0 | 设置一个WantAgent用于启动会话的Ability。 | +| [GetController](#getcontroller) ()=0 | 获取会话控制器。 | +| [RegisterCallback](#registercallback) (const std::shared_ptr< [AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md) > &callback)=0 | 注册会话回调。 | +| [Activate](#activate) ()=0 | 激活会话。 | +| [Deactivate](#deactivate) ()=0 | 去激活会话。 | +| [IsActive](#isactive) ()=0 | 获取会话是否被激活。 | +| [Destroy](#destroy) ()=0 | 销毁会话。 | +| [AddSupportCommand](#addsupportcommand) (const int32_t cmd)=0 | 添加支持的控制命令。 | +| [DeleteSupportCommand](#deletesupportcommand) (const int32_t cmd)=0 | 删除支持的控制命令。 | + + +## 成员枚举类型说明 + + +### anonymous enum + + +``` +anonymous enum +``` +**描述:** +会话类型的枚举。 + + | 枚举值 | 描述 | +| -------- | -------- | +| SESSION_TYPE_INVALID | 无效会话 | +| SESSION_TYPE_AUDIO | 音频会话 | +| SESSION_TYPE_VIDEO | 视频会话 | + + +## 成员函数说明 + + +### Activate() + + +``` +virtual int32_t OHOS::AVSession::AVSession::Activate () +``` +**描述:** +激活会话。 + +激活成功后，会话才可以接收控制指令。 + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[Deactivate](#deactivate) + +[IsActive](#isactive) + + +### AddSupportCommand() + + +``` +virtual int32_t OHOS::AVSession::AVSession::AddSupportCommand (const int32_t cmd) +``` +**描述:** +添加支持的控制命令。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cmd | 待添加的控制命令，范围为**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### Deactivate() + + +``` +virtual int32_t OHOS::AVSession::AVSession::Deactivate () +``` +**描述:** +去激活会话。 + +去激活成功后，表示会话还不能接收控制指令。 + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[Activate](#activate) + +[IsActive](#isactive) + + +### DeleteSupportCommand() + + +``` +virtual int32_t OHOS::AVSession::AVSession::DeleteSupportCommand (const int32_t cmd) +``` +**描述:** +删除支持的控制命令。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cmd | 待删除的控制命令，范围为**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### Destroy() + + +``` +virtual int32_t OHOS::AVSession::AVSession::Destroy () +``` +**描述:** +销毁会话。 + +如果应用要创建一个新会话，必须要销毁之前的会话，否则会创建失败。 + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### GetAVMetaData() + + +``` +virtual int32_t OHOS::AVSession::AVSession::GetAVMetaData (AVMetaData & meta) +``` +**描述:** +获取会话元数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| meta | 用于保存会话的元数据[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)对象。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[SetAVMetaData](#setavmetadata) + + +### GetAVPlaybackState() + + +``` +virtual int32_t OHOS::AVSession::AVSession::GetAVPlaybackState (AVPlaybackState & state) +``` +**描述:** +获取音视频的播放状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| state | 用于保存播放状态的[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)对象。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[SetAVPlaybackState](#setavplaybackstate) + + +### GetController() + + +``` +virtual std::shared_ptr OHOS::AVSession::AVSession::GetController () +``` +**描述:** +获取会话控制器。 + +**返回:** + +返回会话控制器，[AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md)类型智能指针。 + + +### GetSessionId() + + +``` +virtual std::string OHOS::AVSession::AVSession::GetSessionId () +``` +**描述:** +获取会话的标识。 + +**返回:** + +返回会话的标识。 + + +### IsActive() + + +``` +virtual bool OHOS::AVSession::AVSession::IsActive () +``` +**描述:** +获取会话是否被激活。 + +**返回:** + +如果是激活状态，则返回true；否则返回false。 + +**参见:** + +[Activate](#activate) + +[Deactivate](#deactivate) + + +### RegisterCallback() + + +``` +virtual int32_t OHOS::AVSession::AVSession::RegisterCallback (const std::shared_ptr< AVSessionCallback > & callback) +``` +**描述:** +注册会话回调。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callback | 用于注册会话回调的[AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md)对象。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### SetAVMetaData() + + +``` +virtual int32_t OHOS::AVSession::AVSession::SetAVMetaData (const AVMetaData & meta) +``` +**描述:** +设置会话元数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| meta | 用于修改会话的元数据[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)对象。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[GetAVMetaData](#getavmetadata) + + +### SetAVPlaybackState() + + +``` +virtual int32_t OHOS::AVSession::AVSession::SetAVPlaybackState (const AVPlaybackState & state) +``` +**描述:** +设置音视频的播放状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| state | 用于修改播放状态的[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)对象。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[GetAVPlaybackState](#getavplaybackstate) + + +### SetLaunchAbility() + + +``` +virtual int32_t OHOS::AVSession::AVSession::SetLaunchAbility (const AbilityRuntime::WantAgent::WantAgent & ability) +``` +**描述:** +设置一个WantAgent用于启动会话的Ability。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ability | 具体的应用对应的能力，类型为**AbilityRuntime::WantAgent::WantAgent**。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[AVSessionController::GetLaunchAbility](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md#getlaunchability) diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..334288527bd6ac67f8a8d1cdc177ee97cac1a4c2 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md @@ -0,0 +1,217 @@ +# OHOS::AVSession::AVSessionCallback + + +## 概述 + +定义AVSession回调类的实现 + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnPlay](#onplay) ()=0 | AVSession多媒体播放的抽象的回调方法。 | +| [OnPause](#onpause) ()=0 | AVSession多媒体播放暂停的抽象的回调方法。 | +| [OnStop](#onstop) ()=0 | AVSession多媒体播放停止的抽象的回调方法。 | +| [OnPlayNext](#onplaynext) ()=0 | AVSession播放下一首多媒体的抽象的回调方法。 | +| [OnPlayPrevious](#onplayprevious) ()=0 | AVSession播放上一首多媒体的抽象的回调方法。 | +| [OnFastForward](#onfastforward) ()=0 | AVSession快进播放多媒体的抽象的回调方法。 | +| [OnRewind](#onrewind) ()=0 | AVSession多媒体快退的抽象的回调方法。 | +| [OnSeek](#onseek) (int64_t time)=0 | AVSession多媒体跳播操作的抽象的回调方法。 | +| [OnSetSpeed](#onsetspeed) (double speed)=0 | AVSession设置多媒体倍速播放操作的抽象的回调方法。 | +| [OnSetLoopMode](#onsetloopmode) (int32_t loopMode)=0 | AVSession设置多媒体循环播放模式的抽象的回调方法。 | +| [OnToggleFavorite](#ontogglefavorite) (const std::string &mediald)=0 | AVSession设置多媒体切换收藏操作的抽象的回调方法。 | +| [OnMediaKeyEvent](#onmediakeyevent) (const MMI::KeyEvent &keyEvent)=0 | AVSession多媒体按键事件处理的抽象的回调方法。 | +| [OnOutputDeviceChange](#onoutputdevicechange) (const [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) &outputDeviceInfo)=0 | 注册会话输出设备变更监听。 | +| [~AVSessionCallback](#avsessioncallback) ()=default | AVSessionCallback的默认的析构函数。 | + + +## 构造及析构函数说明 + + +### ~AVSessionCallback() + + +``` +virtual OHOS::AVSession::AVSessionCallback::~AVSessionCallback () +``` +**描述:** +AVSessionCallback的默认的析构函数。 + + +## 成员函数说明 + + +### OnFastForward() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnFastForward () +``` +**描述:** +AVSession快进播放多媒体的抽象的回调方法。 + + +### OnMediaKeyEvent() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnMediaKeyEvent (const MMI::KeyEvent & keyEvent) +``` +**描述:** +AVSession多媒体按键事件处理的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| keyEvent | 按键事件码，类型为**MMI::KeyEvent**。 | + + +### OnOutputDeviceChange() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnOutputDeviceChange (const OutputDeviceInfo & outputDeviceInfo) +``` +**描述:** +注册会话输出设备变更监听。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| outputDeviceInfo | 输出设备信息 [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md)。 | + + +### OnPause() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnPause () +``` +**描述:** +AVSession多媒体播放暂停的抽象的回调方法。 + + +### OnPlay() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnPlay () +``` +**描述:** +AVSession多媒体播放的抽象的回调方法。 + + +### OnPlayNext() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnPlayNext () +``` +**描述:** +AVSession播放下一首多媒体的抽象的回调方法。 + + +### OnPlayPrevious() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnPlayPrevious () +``` +**描述:** +AVSession播放上一首多媒体的抽象的回调方法。 + + +### OnRewind() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnRewind () +``` +**描述:** +AVSession多媒体快退的抽象的回调方法。 + + +### OnSeek() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnSeek (int64_t time) +``` +**描述:** +AVSession多媒体跳播操作的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| time | 媒体资源的位置，从媒体资源开头开始计算，单位为ms。取值需大于等于0。 | + + +### OnSetLoopMode() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnSetLoopMode (int32_t loopMode) +``` +**描述:** +AVSession设置多媒体循环播放模式的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| loopMode | 多媒体循环播放模式， 范围在[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)的**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | + + +### OnSetSpeed() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnSetSpeed (double speed) +``` +**描述:** +AVSession设置多媒体倍速播放操作的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| speed | 多媒体播放的倍速值。 | + + +### OnStop() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnStop () +``` +**描述:** +AVSession多媒体播放停止的抽象的回调方法。 + + +### OnToggleFavorite() + + +``` +virtual void OHOS::AVSession::AVSessionCallback::OnToggleFavorite (const std::string & mediald) +``` +**描述:** +AVSession设置多媒体切换收藏操作的抽象的回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mediald | 多媒体ID号标识。 | + + diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md new file mode 100644 index 0000000000000000000000000000000000000000..b4c12aae829b192c2aec8b33945870e831887c2f --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md @@ -0,0 +1,302 @@ +# OHOS::AVSession::AVSessionManager + + +## 概述 + +实现会话管理器对外接口功能的类的实现。 + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [CreateSession](#createsession) (const std::string &tag, int32_t type, const AppExecFwk::ElementName &elementName)=0 | 创建AVSession会话的接口方法。 | +| [GetAllSessionDescriptors](#getallsessiondescriptors) (std::vector< [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) > &descriptors)=0 | 获取AVSession全部的会话描述的接口方法。 | +| [GetActivatedSessionDescriptors](#getactivatedsessiondescriptors) (std::vector< [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) > &activatedSessions)=0 | 获取AVSession全部处于活动状态的会话描述的接口方法。 | +| [GetSessionDescriptorsBySessionId](#getsessiondescriptorsbysessionid) (const std::string &sessionId, [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | 通过会话ID获得会话描述的方法。 | +| [CreateController](#createcontroller) (const std::string &sessionId, std::shared_ptr< [AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md) > &controller)=0 | 创建AVSession会话控制器的接口方法。 | +| [RegisterSessionListener](#registersessionlistener) (const std::shared_ptr< [SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md) > &listener)=0 | 注册AVSession会话监听器的接口方法。 | +| [RegisterServiceDeathCallback](#registerservicedeathcallback) (const [DeathCallback](avsession__info_8h.md#deathcallback) &callback)=0 | 注册AVSession服务器的死亡回调的接口方法。 | +| [UnregisterServiceDeathCallback](#unregisterservicedeathcallback) ()=0 | 注销AVSession服务器的死亡回调的接口方法。 | +| [SendSystemAVKeyEvent](#sendsystemavkeyevent) (const MMI::KeyEvent &keyEvent)=0 | 发送系统按键事件的接口方法。 | +| [SendSystemControlCommand](#sendsystemcontrolcommand) (const [AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) &command)=0 | 发送系统控制命令的接口方法。 | +| [CastAudio](#castaudio) (const [SessionToken](_o_h_o_s_1_1_a_v_session_1_1_session_token.md) &token, const std::vector< AudioStandard::AudioDeviceDescriptor > &descriptors)=0 | 将媒体会话投射到远程设备或投射回本地设备。 | +| [CastAudioForAll](#castaudioforall) (const std::vector< AudioStandard::AudioDeviceDescriptor > &descriptors)=0 | 将此设备的所有媒体会话投播到远程设备。 | + + +### 静态 Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetInstance](#getinstance) () | 获取会话管理器实例。 | + + +## 成员函数说明 + + +### CastAudio() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::CastAudio (const SessionToken & token, const std::vector< AudioStandard::AudioDeviceDescriptor > & descriptors ) +``` +**描述:** +将媒体会话投射到远程设备或投射回本地设备。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| token | 需要投播的会话令牌。 | +| descriptors | 指定要转换的音频设备。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### CastAudioForAll() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::CastAudioForAll (const std::vector< AudioStandard::AudioDeviceDescriptor > & descriptors) +``` +**描述:** +将此设备的所有媒体会话投播到远程设备。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| descriptors | 指定要转换的音频设备。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### CreateController() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::CreateController (const std::string & sessionId, std::shared_ptr< AVSessionController > & controller ) +``` +**描述:** +创建AVSession会话控制器的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| sessionId | AVSession的会话ID。 | +| controller | 会话控制器实例，类型为[AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md)。 | + +**返回:** + +返回成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### CreateSession() + + +``` +virtual std::shared_ptr OHOS::AVSession::AVSessionManager::CreateSession (const std::string & tag, int32_t type, const AppExecFwk::ElementName & elementName ) +``` +**描述:** +创建AVSession会话的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| tag | AVSession的会话标签，不可为空。 | +| type | AVSession的会话类型, 入参为[AVSession](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md)的**SESSION_TYPE_AUDIO**，**SESSION_TYPE_VIDEO**。 | +| elementName | AVSession的会话名称**AppExecFwk::ElementName**。 | + +**返回:** + +返回已创建的会话对象的智能指针。 + + +### GetActivatedSessionDescriptors() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::GetActivatedSessionDescriptors (std::vector< AVSessionDescriptor > & activatedSessions) +``` +**描述:** +获取AVSession全部处于活动状态的会话描述的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| activatedSessions | 处于活动状态的会话描述，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### GetAllSessionDescriptors() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::GetAllSessionDescriptors (std::vector< AVSessionDescriptor > & descriptors) +``` +**描述:** +获取AVSession全部的会话描述的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| descriptors | AVSession的会话描述，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### GetInstance() + + +``` +static AVSessionManager& OHOS::AVSession::AVSessionManager::GetInstance () +``` +**描述:** +获取会话管理器实例。 + +**返回:** + +返回会话管理器实例。 + + +### GetSessionDescriptorsBySessionId() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::GetSessionDescriptorsBySessionId (const std::string & sessionId, AVSessionDescriptor & descriptor ) +``` +**描述:** +通过会话ID获得会话描述的方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| sessionId | AVSession的会话标签。 | +| descriptor | AVSession的会话描述，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### RegisterServiceDeathCallback() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::RegisterServiceDeathCallback (const DeathCallback & callback) +``` +**描述:** +注册AVSession服务器的死亡回调的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callback | 死亡回调的方法，类型为**DeathCallback**。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[UnregisterServiceDeathCallback](#unregisterservicedeathcallback) + + +### RegisterSessionListener() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::RegisterSessionListener (const std::shared_ptr< SessionListener > & listener) +``` +**描述:** +注册AVSession会话监听器的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| listener | 会话监听器的智能指针，类型为[SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md)。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### SendSystemAVKeyEvent() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::SendSystemAVKeyEvent (const MMI::KeyEvent & keyEvent) +``` +**描述:** +发送系统按键事件的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| keyEvent | 按键事件码，类型为**MMI::KeyEvent**。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### SendSystemControlCommand() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::SendSystemControlCommand (const AVControlCommand & command) +``` +**描述:** +发送系统控制命令的接口方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| command | 系统控制命令[AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md)。 | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### UnregisterServiceDeathCallback() + + +``` +virtual int32_t OHOS::AVSession::AVSessionManager::UnregisterServiceDeathCallback () +``` +**描述:** +注销AVSession服务器的死亡回调的接口方法。 + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[RegisterServiceDeathCallback](#registerservicedeathcallback) diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md new file mode 100644 index 0000000000000000000000000000000000000000..39038f5b3f40ec407e99d33b60d2f7cd27113aae --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md @@ -0,0 +1,154 @@ +# OHOS::AVSession::AVSessionPixelMap + + +## 概述 + +读取、设置图片及图片信息。 + + +## 汇总 + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Marshalling](#marshalling) (Parcel &data) const override | 实现图片及图片信息的序列化。  | +| [GetPixelData](#getpixeldata) () const | 获取图片数据。  | +| [SetPixelData](#setpixeldata) (const std::vector< uint8_t > &data) | 设置图片数据。  | +| [GetImageInfo](#getimageinfo) () const | 获取图片信息。  | +| [SetImageInfo](#setimageinfo) (const std::vector< uint8_t > &imageInfo) | 设置图片信息。  | + + +### 静态 Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Unmarshalling](#unmarshalling) (Parcel &data) | 实现图片及图片信息的反序列化。  | + + +## 成员函数说明 + + +### GetImageInfo() + + +``` +std::vector OHOS::AVSession::AVSessionPixelMap::GetImageInfo () const +``` +**描述:** +获取图片信息。 + +**返回:** + +返回图片信息。 + +**参见:** + +[SetImageInfo](#setimageinfo) + + +### GetPixelData() + + +``` +std::vector OHOS::AVSession::AVSessionPixelMap::GetPixelData () const +``` +**描述:** +获取图片数据。 + +**返回:** + +返回图片数据。 + +**参见:** + +[SetPixelData](#setpixeldata) + + +### Marshalling() + + +``` +bool OHOS::AVSession::AVSessionPixelMap::Marshalling (Parcel & data) const +``` +**描述:** +实现图片及图片信息的序列化。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 保存序列化值的对象**Parcel**。  | + +**返回:** + +如果序列化成功，则返回true；失败则返回false。 + +**参见:** + +[Unmarshalling](#unmarshalling) + + +### SetImageInfo() + + +``` +void OHOS::AVSession::AVSessionPixelMap::SetImageInfo (const std::vector< uint8_t > & imageInfo) +``` +**描述:** +设置图片信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| imageInfo | 图片信息。  | + +**参见:** + +[GetImageInfo](#getimageinfo) + + +### SetPixelData() + + +``` +void OHOS::AVSession::AVSessionPixelMap::SetPixelData (const std::vector< uint8_t > & data) +``` +**描述:** +设置图片数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 图片数据。  | + +**参见:** + +[GetPixelData](#getpixeldata) + + +### Unmarshalling() + + +``` +static AVSessionPixelMap* OHOS::AVSession::AVSessionPixelMap::Unmarshalling (Parcel & data) +``` +**描述:** +实现图片及图片信息的反序列化。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 保存反序列化值的对象**Parcel**。  | + +**返回:** + +如果反序列化成功，则返回true；失败则返回false。 + +**参见:** + +[Marshalling](#marshalling) diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md new file mode 100644 index 0000000000000000000000000000000000000000..971babf6930164449f3c8651ea8eb940d11f95df --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md @@ -0,0 +1,26 @@ +# OHOS::AVSession::OutputDeviceInfo + + +## 概述 + +描述分布式设备的相关信息。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 成员变量 + + | 名称 | 描述 | +| -------- | -------- | +| [isRemote_](avsession.md#isremote) {} | bool | +| [deviceIds_](avsession.md#deviceids) | std::vector< std::string > | +| [deviceNames_](avsession.md#devicenames) | std::vector< std::string > | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md new file mode 100644 index 0000000000000000000000000000000000000000..9fb407a233510614c121ee465eb94a836c3807d7 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md @@ -0,0 +1,97 @@ +# OHOS::AVSession::SessionListener + + +## 概述 + +定义与AVSession相关监听器的类的实现。 + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnSessionCreate](#onsessioncreate) (const [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | 创建AVSession会话的抽象的接口回调方法。  | +| [OnSessionRelease](#onsessionrelease) (const [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | 释放AVSession会话的抽象的接口回调方法。  | +| [OnTopSessionChange](#ontopsessionchange) (const [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | AVSession的TOP会话发生变化的抽象的接口回调方法。  | +| [~SessionListener](#sessionlistener) ()=default | SessionListener的默认的析构函数。  | + + +## 构造及析构函数说明 + + +### ~SessionListener() + + +``` +virtual OHOS::AVSession::SessionListener::~SessionListener () +``` +**描述:** +SessionListener的默认的析构函数。 + + +## 成员函数说明 + + +### OnSessionCreate() + + +``` +virtual void OHOS::AVSession::SessionListener::OnSessionCreate (const AVSessionDescriptor & descriptor) +``` +**描述:** +创建AVSession会话的抽象的接口回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| descriptor | AVSession的会话描述对象，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。  | + +**参见:** + +[OnSessionRelease](#onsessionrelease) + + +### OnSessionRelease() + + +``` +virtual void OHOS::AVSession::SessionListener::OnSessionRelease (const AVSessionDescriptor & descriptor) +``` +**描述:** +释放AVSession会话的抽象的接口回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| descriptor | AVSession的会话描述对象，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。  | + +**参见:** + +[OnSessionCreate](#onsessioncreate) + + +### OnTopSessionChange() + + +``` +virtual void OHOS::AVSession::SessionListener::OnTopSessionChange (const AVSessionDescriptor & descriptor) +``` +**描述:** +AVSession的TOP会话发生变化的抽象的接口回调方法。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| descriptor | AVSession的会话描述对象，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。  | + + \ No newline at end of file diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md new file mode 100644 index 0000000000000000000000000000000000000000..a0b7eae295d926f591f5c76c1183a66bc5f446e8 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md @@ -0,0 +1,55 @@ +# OHOS::AVSession::SessionToken + + +## 概述 + +会话令牌的信息。 + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 成员变量 + + | 名称 | 描述 | +| -------- | -------- | +| [sessionId](#sessionid) | std::string
会话id  | +| [pid](#pid) | pid_t
会话的进程id  | +| [uid](#uid) | uid_t
用户id  | + + +## 结构体成员变量说明 + + +### pid + + +``` +pid_t OHOS::AVSession::SessionToken::pid +``` +**描述:** +会话的进程id + + +### sessionId + + +``` +std::string OHOS::AVSession::SessionToken::sessionId +``` +**描述:** +会话id + + +### uid + + +``` +uid_t OHOS::AVSession::SessionToken::uid +``` +**描述:** +用户id diff --git a/zh-cn/application-dev/reference/native-apis/_region.md b/zh-cn/application-dev/reference/native-apis/_region.md index d8b1024f340516c55758b875726864d86ad09dae..2123c25359fd86d73b2a6450582ff68eba1b1089 100644 --- a/zh-cn/application-dev/reference/native-apis/_region.md +++ b/zh-cn/application-dev/reference/native-apis/_region.md @@ -43,5 +43,3 @@ struct Rect Region::*rects **描述：** 结构体指针，类型为[Rect](_rect.md)。如果rects是空指针nullptr， 默认Buffer大小为脏区。 - - \ No newline at end of file diff --git a/zh-cn/application-dev/reference/native-apis/_video_decoder.md b/zh-cn/application-dev/reference/native-apis/_video_decoder.md new file mode 100644 index 0000000000000000000000000000000000000000..a5b1f9f8ed44f68ea530c7cf04380eb04f4e9f44 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_video_decoder.md @@ -0,0 +1,434 @@ +# VideoDecoder + + +## 概述 + +VideoDecoder模块提供用于视频解码功能的函数。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [native_avcodec_videodecoder.h](native__avcodec__videodecoder_8h.md) | 声明用于视频解码的Native API。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoDecoder_CreateByMime](#oh_videodecoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个视频解码器实例，大多数情况下推荐使用该接口。 | +| [OH_VideoDecoder_CreateByName](#oh_videodecoder_createbyname) (const char \*name) | OH_AVCodec \*
通过视频解码器名称创建一个视频解码器实例，使用这个接口的前提是必须清楚解码器准确的名称。 | +| [OH_VideoDecoder_Destroy](#oh_videodecoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部资源，并销毁解码器实例。 | +| [OH_VideoDecoder_SetCallback](#oh_videodecoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应视频解码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoDecoder_SetSurface](#oh_videodecoder_setsurface) (OH_AVCodec \*codec, OHNativeWindow \*window) | [OH_AVErrCode](_core.md#oh_averrcode)
指定输出Surface，以提供视频解码输出，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoDecoder_Configure](#oh_videodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置视频解码器，典型地，需要配置被解码视频轨道的描述信息，这些信息能够从容器中提取出来， 该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoDecoder_Prepare](#oh_videodecoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备解码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_VideoDecoder_Start](#oh_videodecoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动解码器，该接口必须在已经Prepare成功后调用。 在启动成功后，解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_VideoDecoder_Stop](#oh_videodecoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止解码器。在停止后可通过Start重新进入Started状态，但需要注意的是，若先前给解码器输入过 Codec-Specific-Data，则需要重新输入。 | +| [OH_VideoDecoder_Flush](#oh_videodecoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_VideoDecoder_Reset](#oh_videodecoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置解码器。如需继续解码工作，需要重新调用Configure接口以配置该解码器实例。 | +| [OH_VideoDecoder_GetOutputDescription](#oh_videodecoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该解码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例的生命周期 将会再下一次调用该接口时或者该OH_AVCodec实例被销毁时失效。 | +| [OH_VideoDecoder_SetParameter](#oh_videodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向解码器设置动态参数，注意：该接口仅能在解码器被启动后调用，同时错误的参数设置，可能会导致解码失败。 | +| [OH_VideoDecoder_PushInputData](#oh_videodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | [OH_AVErrCode](_core.md#oh_averrcode)
将填充好数据的输入Buffer提交给视频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。另外，对于部分解码器，要求在最开始给解码器输入 Codec-Specific-Data，用以初始化解码器的解码过程，例如H264格式的PPS/SPS数据。 | +| [OH_VideoDecoder_RenderOutputData](#oh_videodecoder_renderoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给解码器，并通知解码器完成将该Buffer内包含的解码后的数据在输出Surface上渲染。 如果先前未配置输出Surface，调用该接口仅仅将指定索引对应的输出Buffer交还给解码器。 | +| [OH_VideoDecoder_FreeOutputData](#oh_videodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给解码器。 | + + +## 函数说明 + + +### OH_VideoDecoder_Configure() + + +``` +OH_AVErrCode OH_VideoDecoder_Configure (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +配置视频解码器，典型地，需要配置被解码视频轨道的描述信息，这些信息能够从容器中提取出来， 该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | 指向OH_AVFormat的指针，用以给出待解码视频轨道的描述信息 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_CreateByMime() + + +``` +OH_AVCodec* OH_VideoDecoder_CreateByMime (const char * mime) +``` +**描述:** +通过mime类型创建一个视频解码器实例，大多数情况下推荐使用该接口。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mime | mime类型描述字符串，参考[OH_AVCODEC_MIMETYPE_VIDEO_AVC](_codec_base.md#oh_avcodec_mimetype_video_avc) | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_VideoDecoder_CreateByName() + + +``` +OH_AVCodec* OH_VideoDecoder_CreateByName (const char * name) +``` +**描述:** +通过视频解码器名称创建一个视频解码器实例，使用这个接口的前提是必须清楚解码器准确的名称。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| name | 视频解码器名称 | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_VideoDecoder_Destroy() + + +``` +OH_AVErrCode OH_VideoDecoder_Destroy (OH_AVCodec * codec) +``` +**描述:** +清空解码器内部资源，并销毁解码器实例。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_Flush() + + +``` +OH_AVErrCode OH_VideoDecoder_Flush (OH_AVCodec * codec) +``` +**描述:** +清空解码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_FreeOutputData() + + +``` +OH_AVErrCode OH_VideoDecoder_FreeOutputData (OH_AVCodec * codec, uint32_t index ) +``` +**描述:** +将处理结束的输出Buffer交还给解码器。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输出Buffer对应的索引值 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_GetOutputDescription() + + +``` +OH_AVFormat* OH_VideoDecoder_GetOutputDescription (OH_AVCodec * codec) +``` +**描述:** +获取该解码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例的生命周期 将会再下一次调用该接口时或者该OH_AVCodec实例被销毁时失效。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +返回AVFormat实例的指针 + + +### OH_VideoDecoder_Prepare() + + +``` +OH_AVErrCode OH_VideoDecoder_Prepare (OH_AVCodec * codec) +``` +**描述:** +准备解码器内部资源，调用该接口前必须先调用Configure接口。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_PushInputData() + + +``` +OH_AVErrCode OH_VideoDecoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr ) +``` +**描述:** +将填充好数据的输入Buffer提交给视频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。另外，对于部分解码器，要求在最开始给解码器输入 Codec-Specific-Data，用以初始化解码器的解码过程，例如H264格式的PPS/SPS数据。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输入Buffer对应的索引值 | +| attr | 描述该Buffer内所包含数据的信息 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_RenderOutputData() + + +``` +OH_AVErrCode OH_VideoDecoder_RenderOutputData (OH_AVCodec * codec, uint32_t index ) +``` +**描述:** +将处理结束的输出Buffer交还给解码器，并通知解码器完成将该Buffer内包含的解码后的数据在输出Surface上渲染。 如果先前未配置输出Surface，调用该接口仅仅将指定索引对应的输出Buffer交还给解码器。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输出Buffer对应的索引值 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_Reset() + + +``` +OH_AVErrCode OH_VideoDecoder_Reset (OH_AVCodec * codec) +``` +**描述:** +重置解码器。如需继续解码工作，需要重新调用Configure接口以配置该解码器实例。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_SetCallback() + + +``` +OH_AVErrCode OH_VideoDecoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData ) +``` +**描述:** +设置异步回调函数，使得你的应用能够响应视频解码器产生的事件，该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| callback | 一个包含所有回调函数的集合体，参考[OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) | +| userData | 用户特定数据 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_SetParameter() + + +``` +OH_AVErrCode OH_VideoDecoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +向解码器设置动态参数，注意：该接口仅能在解码器被启动后调用，同时错误的参数设置，可能会导致解码失败。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | 指向OH_AVFormat实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_SetSurface() + + +``` +OH_AVErrCode OH_VideoDecoder_SetSurface (OH_AVCodec * codec, OHNativeWindow * window ) +``` +**描述:** +指定输出Surface，以提供视频解码输出，该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| window | 指向一个OHNativeWindow实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_Start() + + +``` +OH_AVErrCode OH_VideoDecoder_Start (OH_AVCodec * codec) +``` +**描述:** +启动解码器，该接口必须在已经Prepare成功后调用。 在启动成功后，解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoDecoder_Stop() + + +``` +OH_AVErrCode OH_VideoDecoder_Stop (OH_AVCodec * codec) +``` +**描述:** +停止解码器。在停止后可通过Start重新进入Started状态，但需要注意的是，若先前给解码器输入过 Codec-Specific-Data，则需要重新输入。 + +@syscap SystemCapability.Multimedia.Media.VideoDecoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) diff --git a/zh-cn/application-dev/reference/native-apis/_video_encoder.md b/zh-cn/application-dev/reference/native-apis/_video_encoder.md new file mode 100644 index 0000000000000000000000000000000000000000..2ba39e6fdee3bb1e4ec71f8fd672b0ecb33d025a --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_video_encoder.md @@ -0,0 +1,456 @@ +# VideoEncoder + + +## 概述 + +VideoEncoder模块提供用于视频编码功能的函数和枚举。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**Since:** +9 +**Version:** +1.0 + +## 汇总 + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [native_avcodec_videoencoder.h](native__avcodec__videoencoder_8h.md) | 声明用于视频编码的Native API。 | + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoEncodeBitrateMode](#oh_videoencodebitratemode) | typedef enum [OH_VideoEncodeBitrateMode](#oh_videoencodebitratemode)
视频编码的比特率模式。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoEncodeBitrateMode](#oh_videoencodebitratemode) { **CBR** = 0, **VBR** = 1, **CQ** = 2 } | 视频编码的比特率模式。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoEncoder_CreateByMime](#oh_videoencoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个视频编码器实例，大多数情况下推荐使用该接口。 | +| [OH_VideoEncoder_CreateByName](#oh_videoencoder_createbyname) (const char \*name) | OH_AVCodec \*
通过视频编码器名称创建一个视频编码器实例，使用这个接口的前提是必须清楚编码器准确的名称。 | +| [OH_VideoEncoder_Destroy](#oh_videoencoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部资源，并销毁编码器实例。 | +| [OH_VideoEncoder_SetCallback](#oh_videoencoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应视频编码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoEncoder_Configure](#oh_videoencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置视频编码器，典型地，需要配置被编码视频轨道的描述信息，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoEncoder_Prepare](#oh_videoencoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备编码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_VideoEncoder_Start](#oh_videoencoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动编码器，该接口必须在已经Prepare成功后调用。 在启动成功后，编码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_VideoEncoder_Stop](#oh_videoencoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止编码器。在停止后可通过Start重新进入Started状态。 | +| [OH_VideoEncoder_Flush](#oh_videoencoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_VideoEncoder_Reset](#oh_videoencoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置编码器。如需继续编码工作，需要重新调用Configure接口以配置该编码器实例。 | +| [OH_VideoEncoder_GetOutputDescription](#oh_videoencoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该编码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例的生命周期 将会再下一次调用该接口时或者该OH_AVCodec实例被销毁时失效。 | +| [OH_VideoEncoder_SetParameter](#oh_videoencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向编码器设置动态参数，注意：该接口仅能在编码器被启动后调用，同时错误的参数设置，可能会导致编码失败。 | +| [OH_VideoEncoder_GetSurface](#oh_videoencoder_getsurface) (OH_AVCodec \*codec, OHNativeWindow \*\*window) | [OH_AVErrCode](_core.md#oh_averrcode)
从视频编码器获取输入Surface， 该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoEncoder_FreeOutputData](#oh_videoencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给编码器。 | +| [OH_VideoEncoder_NotifyEndOfStream](#oh_videoencoder_notifyendofstream) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
通知视频编码器输入码流已结束。surface模式推荐使用该接口通知编码器码流结束。 | + + +## 类型定义说明 + + +### OH_VideoEncodeBitrateMode + + +``` +typedef enum OH_VideoEncodeBitrateModeOH_VideoEncodeBitrateMode +``` +**描述:** +视频编码的比特率模式。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + + +## 枚举类型说明 + + +### OH_VideoEncodeBitrateMode + + +``` +enum OH_VideoEncodeBitrateMode +``` +**描述:** +视频编码的比特率模式。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + + | 枚举值 | 描述 | +| -------- | -------- | +| CBR | 恒定比特率模式 | +| VBR | 可变比特率模式 | +| CQ | 恒定质量模式 | + + +## 函数说明 + + +### OH_VideoEncoder_Configure() + + +``` +OH_AVErrCode OH_VideoEncoder_Configure (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +配置视频编码器，典型地，需要配置被编码视频轨道的描述信息，该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | 指向OH_AVFormat的指针，用以给出待编码视频轨道的描述信息 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_CreateByMime() + + +``` +OH_AVCodec* OH_VideoEncoder_CreateByMime (const char * mime) +``` +**描述:** +通过mime类型创建一个视频编码器实例，大多数情况下推荐使用该接口。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mime | mime类型描述字符串，参考[OH_AVCODEC_MIMETYPE_VIDEO_AVC](_codec_base.md#oh_avcodec_mimetype_video_avc) | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_VideoEncoder_CreateByName() + + +``` +OH_AVCodec* OH_VideoEncoder_CreateByName (const char * name) +``` +**描述:** +通过视频编码器名称创建一个视频编码器实例，使用这个接口的前提是必须清楚编码器准确的名称。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| name | 视频编码器名称 | + +**返回:** + +返回一个指向OH_AVCodec实例的指针 + + +### OH_VideoEncoder_Destroy() + + +``` +OH_AVErrCode OH_VideoEncoder_Destroy (OH_AVCodec * codec) +``` +**描述:** +清空编码器内部资源，并销毁编码器实例。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_Flush() + + +``` +OH_AVErrCode OH_VideoEncoder_Flush (OH_AVCodec * codec) +``` +**描述:** +清空编码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_FreeOutputData() + + +``` +OH_AVErrCode OH_VideoEncoder_FreeOutputData (OH_AVCodec * codec, uint32_t index ) +``` +**描述:** +将处理结束的输出Buffer交还给编码器。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| index | 输出Buffer对应的索引值 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_GetOutputDescription() + + +``` +OH_AVFormat* OH_VideoEncoder_GetOutputDescription (OH_AVCodec * codec) +``` +**描述:** +获取该编码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例的生命周期 将会再下一次调用该接口时或者该OH_AVCodec实例被销毁时失效。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +返回AVFormat实例的指针 + + +### OH_VideoEncoder_GetSurface() + + +``` +OH_AVErrCode OH_VideoEncoder_GetSurface (OH_AVCodec * codec, OHNativeWindow ** window ) +``` +**描述:** +从视频编码器获取输入Surface， 该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| window | 指向一个OHNativeWindow实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_NotifyEndOfStream() + + +``` +OH_AVErrCode OH_VideoEncoder_NotifyEndOfStream (OH_AVCodec * codec) +``` +**描述:** +通知视频编码器输入码流已结束。surface模式推荐使用该接口通知编码器码流结束。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_Prepare() + + +``` +OH_AVErrCode OH_VideoEncoder_Prepare (OH_AVCodec * codec) +``` +**描述:** +准备编码器内部资源，调用该接口前必须先调用Configure接口。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_Reset() + + +``` +OH_AVErrCode OH_VideoEncoder_Reset (OH_AVCodec * codec) +``` +**描述:** +重置编码器。如需继续编码工作，需要重新调用Configure接口以配置该编码器实例。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_SetCallback() + + +``` +OH_AVErrCode OH_VideoEncoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData ) +``` +**描述:** +设置异步回调函数，使得你的应用能够响应视频编码器产生的事件，该接口被调用必须是在Prepare被调用前。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| callback | 一个包含所有回调函数的集合体，参考[OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) | +| userData | 用户特定数据 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_SetParameter() + + +``` +OH_AVErrCode OH_VideoEncoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format ) +``` +**描述:** +向编码器设置动态参数，注意：该接口仅能在编码器被启动后调用，同时错误的参数设置，可能会导致编码失败。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | +| format | OH_AVFormat句柄指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_Start() + + +``` +OH_AVErrCode OH_VideoEncoder_Start (OH_AVCodec * codec) +``` +**描述:** +启动编码器，该接口必须在已经Prepare成功后调用。 在启动成功后，编码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) + + +### OH_VideoEncoder_Stop() + + +``` +OH_AVErrCode OH_VideoEncoder_Stop (OH_AVCodec * codec) +``` +**描述:** +停止编码器。在停止后可通过Start重新进入Started状态。 + +@syscap SystemCapability.Multimedia.Media.VideoEncoder + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| codec | 指向OH_AVCodec实例的指针 | + +**返回:** + +执行成功返回AV_ERR_OK + +执行失败返回具体错误码，参考[OH_AVErrCode](_core.md#oh_averrcode) diff --git a/zh-cn/application-dev/reference/native-apis/av__session_8h.md b/zh-cn/application-dev/reference/native-apis/av__session_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..e908100fe46e543251739f042219b870740c3c2c --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/av__session_8h.md @@ -0,0 +1,24 @@ +# av_session.h + + +## 概述 + +会话的设置、获取等声明。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVSession](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md) | class
会话对象，支持配置会话属性，并可主动更新播放状态和会话元数据。 | diff --git a/zh-cn/application-dev/reference/native-apis/avcontrol__command_8h.md b/zh-cn/application-dev/reference/native-apis/avcontrol__command_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..f8cc0b9f9d42295e1440833071c8e9e6b4d627c3 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avcontrol__command_8h.md @@ -0,0 +1,24 @@ +# avcontrol_command.h + + +## 概述 + +音视频控制指令的设置、获取、拷贝等声明。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) | class
用于描述音视频播控命令工具类，播控命令的封装对象，支持设置和获取控制命令。 | diff --git a/zh-cn/application-dev/reference/native-apis/avmeta__data_8h.md b/zh-cn/application-dev/reference/native-apis/avmeta__data_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..957d44d24c2739b41ac4b1f5cc98876281430179 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avmeta__data_8h.md @@ -0,0 +1,24 @@ +# avmeta_data.h + + +## 概述 + +会话元数据设置、获取、拷贝等接口声明。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) | class
会话元数据类，提供获取metadata进程间传递的序列化和反序列话及数据拷贝的接口方法。 | diff --git a/zh-cn/application-dev/reference/native-apis/avplayback__state_8h.md b/zh-cn/application-dev/reference/native-apis/avplayback__state_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..2a62e921e79d643a1b4560b0ad2bf72212d3d4db --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avplayback__state_8h.md @@ -0,0 +1,25 @@ +# avplayback_state.h + + +## 概述 + +音视频播放状态声明。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) | class
音视频播放状态类，提供获取和设置播放界面的信息。 | +| [OHOS::AVSession::AVPlaybackState::Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) | struct
播放位置的相关信息。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession.md b/zh-cn/application-dev/reference/native-apis/avsession.md new file mode 100644 index 0000000000000000000000000000000000000000..b30ac7ab72da3f28b3d5fee01f5f5c2e100a25cb --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avsession.md @@ -0,0 +1,469 @@ +# Avsession + + +## 概述 + +音视频媒体会话，提供系统内媒体的统一控制能力。 + +功能包括媒体会话，媒体会话管理，媒体会话控制。 + +@syscap SystemCapability.Multimedia.AVSession.Core + +**Since:** + +9 + +**Version:** + +1.0 + + +## 汇总 + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [av_session.h](av__session_8h.md) | 会话的设置、获取等声明。 | +| [avcontrol_command.h](avcontrol__command_8h.md) | 音视频控制指令的设置、获取、拷贝等声明。 | +| [avmeta_data.h](avmeta__data_8h.md) | 会话元数据设置、获取、拷贝等接口声明。 | +| [avplayback_state.h](avplayback__state_8h.md) | 音视频播放状态声明。 | +| [avsession_controller.h](avsession__controller_8h.md) | 控制器对象的描述，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 | +| [avsession_descriptor.h](avsession__descriptor_8h.md) | 会话的相关描述信息。 | +| [avsession_errors.h](avsession__errors_8h.md) | 定义了avsession错误码。 | +| [avsession_info.h](avsession__info_8h.md) | 定义了与avsession相关的监听器以及回调功能的实现。 | +| [avsession_manager.h](avsession__manager_8h.md) | 定义了会话管理器对外接口的功能的实现。 | +| [avsession_pixel_map.h](avsession__pixel__map_8h.md) | 读取、设置图片及图片信息。 | + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) | struct
描述分布式设备的相关信息。 | +| [OHOS::AVSession::AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) | struct
会话的相关描述信息。 | +| [OHOS::AVSession::AVSessionBasicInfo](o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md) | struct
会话基础信息描述。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVSessionDescriptor::WriteToParcel](#writetoparcel) (Parcel &out) const | bool
将会话相关描述信息写进包里。 | +| [OHOS::AVSession::AVSessionDescriptor::ReadFromParcel](#readfromparcel) (Parcel &in) | bool
对会话相关描述信息进行解包。 | + + +### 变量 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::OutputDeviceInfo::isRemote_](#isremote) {} | bool
是否连接 | +| [OHOS::AVSession::OutputDeviceInfo::deviceIds_](#deviceids) | std::vector< std::string >
分布式设备的id集合 | +| [OHOS::AVSession::OutputDeviceInfo::deviceNames_](#devicenames) | std::vector< std::string >
分布式设备的名称集合 | +| [OHOS::AVSession::AVSessionDescriptor::sessionId_](#sessionid) | std::string
会话的id | +| [OHOS::AVSession::AVSessionDescriptor::sessionType_](#sessiontype) {} | int32_t
会话的类型 | +| [OHOS::AVSession::AVSessionDescriptor::sessionTag_](#sessiontag) | std::string
会话的自定义名称 | +| [OHOS::AVSession::AVSessionDescriptor::elementName_](#elementname) | AppExecFwk::ElementName
会话所属应用的信息包含bundleName，abilityName等 | +| [OHOS::AVSession::AVSessionDescriptor::pid_](#pid) {} | pid_t
进程id | +| [OHOS::AVSession::AVSessionDescriptor::uid_](#uid) {} | pid_t
用户id | +| [OHOS::AVSession::AVSessionDescriptor::isActive_](#isactive) {} | bool
会话是否为激活状态 | +| [OHOS::AVSession::AVSessionDescriptor::isTopSession_](#istopsession) {} | bool
会话是否是最新的会话 | +| [OHOS::AVSession::AVSessionDescriptor::isThirdPartyApp_](#isthirdpartyapp) {} | bool
是否是第三方应用 | +| [OHOS::AVSession::AVSessionDescriptor::outputDeviceInfo_](#outputdeviceinfo) | [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md)
分布式设备相关信息 | +| [OHOS::AVSession::AVSessionBasicInfo::deviceName_](#devicename) {} | std::string
设备名称 | +| [OHOS::AVSession::AVSessionBasicInfo::networkId_](#networkid) {} | std::string
设备id | +| [OHOS::AVSession::AVSessionBasicInfo::vendorId_](#vendorid) {} | std::string
供应商id | +| [OHOS::AVSession::AVSessionBasicInfo::deviceType_](#devicetype) {} | std::string
设备类型 | +| [OHOS::AVSession::AVSessionBasicInfo::systemVersion_](#systemversion) {} | std::string
系统版本 | +| [OHOS::AVSession::AVSessionBasicInfo::sessionVersion_](#sessionversion) {} | int32_t
会话版本 | +| [OHOS::AVSession::AVSessionBasicInfo::reserve_](#reserve) {} | std::vector< int32_t >
备注信息 | +| [OHOS::AVSession::AVSessionBasicInfo::feature_](#feature) {} | std::vector< int32_t >
特征信息 | +| [OHOS::AVSession::AVSessionBasicInfo::metaDataCap_](#metadatacap) {} | std::vector< int32_t >
会话元数据 | +| [OHOS::AVSession::AVSessionBasicInfo::playBackStateCap_](#playbackstatecap) {} | std::vector< int32_t >
支持播放状态数组 | +| [OHOS::AVSession::AVSessionBasicInfo::controlCommandCap_](#controlcommandcap) {} | std::vector< int32_t >
系统控制命令 | +| [OHOS::AVSession::AVSessionBasicInfo::extendCapability_](#extendcapability) {} | std::vector< int32_t >
扩展能力 | +| [OHOS::AVSession::AVSessionBasicInfo::systemTime_](#systemtime) {} | int32_t
系统时间 | +| [OHOS::AVSession::AVSessionBasicInfo::extend_](#extend) {} | std::vector< int32_t >
扩展信息 | + + +## 函数说明 + + +### ReadFromParcel() + + +``` +bool OHOS::AVSession::AVSessionDescriptor::ReadFromParcel (Parcel & in) +``` + +**描述:** + +对会话相关描述信息进行解包。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| in | 读出的会话相关描述信息对象**Parcel**。 | + +**返回:** + +成功返回true；失败则返回false。 + +**参见:** + +[WriteToParcel](#writetoparcel) + + +### WriteToParcel() + + +``` +bool OHOS::AVSession::AVSessionDescriptor::WriteToParcel (Parcel & out) const +``` + +**描述:** + +将会话相关描述信息写进包里。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| out | 写入的会话相关描述信息对象**Parcel**。 | + +**返回:** + +成功返回true；失败则返回false。 + +**参见:** + +[ReadFromParcel](#readfromparcel) + + +## 变量说明 + + +### controlCommandCap_ + + +``` +std::vector OHOS::AVSession::AVSessionBasicInfo::controlCommandCap_ {} +``` + +**描述:** + +系统控制命令 + + +### deviceIds_ + + +``` +std::vector OHOS::AVSession::OutputDeviceInfo::deviceIds_ +``` + +**描述:** + +分布式设备的id集合 + + +### deviceName_ + + +``` +std::string OHOS::AVSession::AVSessionBasicInfo::deviceName_ {} +``` + +**描述:** + +设备名称 + + +### deviceNames_ + + +``` +std::vector OHOS::AVSession::OutputDeviceInfo::deviceNames_ +``` + +**描述:** + +分布式设备的名称集合 + + +### deviceType_ + + +``` +std::string OHOS::AVSession::AVSessionBasicInfo::deviceType_ {} +``` + +**描述:** + +设备类型 + + +### elementName_ + + +``` +AppExecFwk::ElementName OHOS::AVSession::AVSessionDescriptor::elementName_ +``` + +**描述:** + +会话所属应用的信息包含bundleName，abilityName等 + + +### extend_ + + +``` +std::vector OHOS::AVSession::AVSessionBasicInfo::extend_ {} +``` + +**描述:** + +扩展信息 + + +### extendCapability_ + + +``` +std::vector OHOS::AVSession::AVSessionBasicInfo::extendCapability_ {} +``` + +**描述:** + +扩展能力 + + +### feature_ + + +``` +std::vector OHOS::AVSession::AVSessionBasicInfo::feature_ {} +``` + +**描述:** + +特征信息 + + +### isActive_ + + +``` +bool OHOS::AVSession::AVSessionDescriptor::isActive_ {} +``` + +**描述:** + +会话是否为激活状态 + + +### isRemote_ + + +``` +bool OHOS::AVSession::OutputDeviceInfo::isRemote_ {} +``` + +**描述:** + +是否连接 + + +### isThirdPartyApp_ + + +``` +bool OHOS::AVSession::AVSessionDescriptor::isThirdPartyApp_ {} +``` + +**描述:** + +是否是第三方应用 + + +### isTopSession_ + + +``` +bool OHOS::AVSession::AVSessionDescriptor::isTopSession_ {} +``` + +**描述:** + +会话是否是最新的会话 + + +### metaDataCap_ + + +``` +std::vector OHOS::AVSession::AVSessionBasicInfo::metaDataCap_ {} +``` + +**描述:** + +会话元数据 + + +### networkId_ + + +``` +std::string OHOS::AVSession::AVSessionBasicInfo::networkId_ {} +``` + +**描述:** + +设备id + + +### outputDeviceInfo_ + + +``` +OutputDeviceInfo OHOS::AVSession::AVSessionDescriptor::outputDeviceInfo_ +``` + +**描述:** + +分布式设备相关信息 + + +### pid_ + + +``` +pid_t OHOS::AVSession::AVSessionDescriptor::pid_ {} +``` + +**描述:** + +进程id + + +### playBackStateCap_ + + +``` +std::vector OHOS::AVSession::AVSessionBasicInfo::playBackStateCap_ {} +``` + +**描述:** + +支持播放状态数组 + + +### reserve_ + + +``` +std::vector OHOS::AVSession::AVSessionBasicInfo::reserve_ {} +``` + +**描述:** + +备注信息 + + +### sessionId_ + + +``` +std::string OHOS::AVSession::AVSessionDescriptor::sessionId_ +``` + +**描述:** + +会话的id + + +### sessionTag_ + + +``` +std::string OHOS::AVSession::AVSessionDescriptor::sessionTag_ +``` + +**描述:** + +会话的自定义名称 + + +### sessionType_ + + +``` +int32_t OHOS::AVSession::AVSessionDescriptor::sessionType_ {} +``` + +**描述:** + +会话的类型 + + +### sessionVersion_ + + +``` +int32_t OHOS::AVSession::AVSessionBasicInfo::sessionVersion_ {} +``` + +**描述:** + +会话版本 + + +### systemTime_ + + +``` +int32_t OHOS::AVSession::AVSessionBasicInfo::systemTime_ {} +``` + +**描述:** + +系统时间 + + +### systemVersion_ + + +``` +std::string OHOS::AVSession::AVSessionBasicInfo::systemVersion_ {} +``` + +**描述:** + +系统版本 + + +### uid_ + + +``` +pid_t OHOS::AVSession::AVSessionDescriptor::uid_ {} +``` + +**描述:** + +用户id + + +### vendorId_ + + +``` +std::string OHOS::AVSession::AVSessionBasicInfo::vendorId_ {} +``` + +**描述:** + +供应商id diff --git a/zh-cn/application-dev/reference/native-apis/avsession__controller_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__controller_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..6a1b06aa8e1740e7fc52f029c1e8fa59247e2906 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avsession__controller_8h.md @@ -0,0 +1,24 @@ +# avsession_controller.h + + +## 概述 + +控制器对象的描述，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md) | class
控制器对象，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__descriptor_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__descriptor_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..e563c140ba298bdf2633b5492b95b35b7f02f001 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avsession__descriptor_8h.md @@ -0,0 +1,26 @@ +# avsession_descriptor.h + + +## 概述 + +会话的相关描述信息。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) | struct
描述分布式设备的相关信息。 | +| [OHOS::AVSession::AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) | struct
会话的相关描述信息。 | +| [OHOS::AVSession::AVSessionBasicInfo](o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md) | struct
会话基础信息描述。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__errors_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__errors_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..6f1ed54b1539c849e0ccbda9310df9c55e87eed9 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avsession__errors_8h.md @@ -0,0 +1,268 @@ +# avsession_errors.h + + +## 概述 + +定义了avsession错误码。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 变量 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVSESSION_ERROR](#avsession_error) = -1 | constexpr int32_t
存在错误 | +| [OHOS::AVSession::AVSESSION_SUCCESS](#avsession_success) = 0 | constexpr int32_t
操作成功 | +| [OHOS::AVSession::AVSESSION_ERROR_BASE](#avsession_error_base) = 1000 | constexpr int32_t
avsession错误码的基定义 | +| [OHOS::AVSession::ERR_NO_MEMORY](#err_no_memory) = -(AVSESSION_ERROR_BASE + 1) | constexpr int32_t
无可用内存 | +| [OHOS::AVSession::ERR_INVALID_PARAM](#err_invalid_param) = -(AVSESSION_ERROR_BASE + 2) | constexpr int32_t
传递的参数无效 | +| [OHOS::AVSession::ERR_SERVICE_NOT_EXIST](#err_service_not_exist) = -(AVSESSION_ERROR_BASE + 3) | constexpr int32_t
服务不存在 | +| [OHOS::AVSession::ERR_SESSION_LISTENER_EXIST](#err_session_listener_exist) = -(AVSESSION_ERROR_BASE + 4) | constexpr int32_t
Session监听器已存在 | +| [OHOS::AVSession::ERR_MARSHALLING](#err_marshalling) = -(AVSESSION_ERROR_BASE + 5) | constexpr int32_t
数据序列化操作错误 | +| [OHOS::AVSession::ERR_UNMARSHALLING](#err_unmarshalling) = -(AVSESSION_ERROR_BASE + 6) | constexpr int32_t
数据反序列化操作错误 | +| [OHOS::AVSession::ERR_IPC_SEND_REQUEST](#err_ipc_send_request) = -(AVSESSION_ERROR_BASE + 7) | constexpr int32_t
IPC发送数据失败 | +| [OHOS::AVSession::ERR_SESSION_EXCEED_MAX](#err_session_exceed_max) = -(AVSESSION_ERROR_BASE + 8) | constexpr int32_t
超过允许会话最大数量 | +| [OHOS::AVSession::ERR_SESSION_NOT_EXIST](#err_session_not_exist) = -(AVSESSION_ERROR_BASE + 9) | constexpr int32_t
会话不存在 | +| [OHOS::AVSession::ERR_COMMAND_NOT_SUPPORT](#err_command_not_support) = -(AVSESSION_ERROR_BASE + 10) | constexpr int32_t
会话命令不支持 | +| [OHOS::AVSession::ERR_CONTROLLER_NOT_EXIST](#err_controller_not_exist) = -(AVSESSION_ERROR_BASE + 11) | constexpr int32_t
控制器不存在 | +| [OHOS::AVSession::ERR_NO_PERMISSION](#err_no_permission) = -(AVSESSION_ERROR_BASE + 12) | constexpr int32_t
无权限 | +| [OHOS::AVSession::ERR_SESSION_DEACTIVE](#err_session_deactive) = -(AVSESSION_ERROR_BASE + 13) | constexpr int32_t
会话未激活 | +| [OHOS::AVSession::ERR_CONTROLLER_IS_EXIST](#err_controller_is_exist) = -(AVSESSION_ERROR_BASE + 14) | constexpr int32_t
控制器存在 | +| [OHOS::AVSession::ERR_START_ABILITY_IS_RUNNING](#err_start_ability_is_running) = -(AVSESSION_ERROR_BASE + 15) | constexpr int32_t
元能力正在运行 | +| [OHOS::AVSession::ERR_ABILITY_NOT_AVAILABLE](#err_ability_not_available) = -(AVSESSION_ERROR_BASE + 16) | constexpr int32_t
元能力启动超失败 | +| [OHOS::AVSession::ERR_START_ABILITY_TIMEOUT](#err_start_ability_timeout) = -(AVSESSION_ERROR_BASE + 17) | constexpr int32_t
元能力启动超时 | +| [OHOS::AVSession::ERR_COMMAND_SEND_EXCEED_MAX](#err_command_send_exceed_max) = -(AVSESSION_ERROR_BASE + 18) | constexpr int32_t
指令发送次数超过最大值 | +| [OHOS::AVSession::ERR_RPC_SEND_REQUEST](#err_rpc_send_request) = -(AVSESSION_ERROR_BASE + 19) | constexpr int32_t
RPC发送数据失败 | + + +## 变量说明 + + +### AVSESSION_ERROR + + +``` +constexpr int32_t OHOS::AVSession::AVSESSION_ERROR = -1 +``` +**描述:** +存在错误 + + +### AVSESSION_ERROR_BASE + + +``` +constexpr int32_t OHOS::AVSession::AVSESSION_ERROR_BASE = 1000 +``` +**描述:** +avsession错误码的基定义 + + +### AVSESSION_SUCCESS + + +``` +constexpr int32_t OHOS::AVSession::AVSESSION_SUCCESS = 0 +``` +**描述:** +操作成功 + + +### ERR_ABILITY_NOT_AVAILABLE + + +``` +constexpr int32_t OHOS::AVSession::ERR_ABILITY_NOT_AVAILABLE = -(AVSESSION_ERROR_BASE + 16) +``` +**描述:** +元能力启动超失败 + + +### ERR_COMMAND_NOT_SUPPORT + + +``` +constexpr int32_t OHOS::AVSession::ERR_COMMAND_NOT_SUPPORT = -(AVSESSION_ERROR_BASE + 10) +``` +**描述:** +会话命令不支持 + + +### ERR_COMMAND_SEND_EXCEED_MAX + + +``` +constexpr int32_t OHOS::AVSession::ERR_COMMAND_SEND_EXCEED_MAX = -(AVSESSION_ERROR_BASE + 18) +``` +**描述:** +指令发送次数超过最大值 + + +### ERR_CONTROLLER_IS_EXIST + + +``` +constexpr int32_t OHOS::AVSession::ERR_CONTROLLER_IS_EXIST = -(AVSESSION_ERROR_BASE + 14) +``` +**描述:** +控制器存在 + + +### ERR_CONTROLLER_NOT_EXIST + + +``` +constexpr int32_t OHOS::AVSession::ERR_CONTROLLER_NOT_EXIST = -(AVSESSION_ERROR_BASE + 11) +``` +**描述:** +控制器不存在 + + +### ERR_INVALID_PARAM + + +``` +constexpr int32_t OHOS::AVSession::ERR_INVALID_PARAM = -(AVSESSION_ERROR_BASE + 2) +``` +**描述:** +传递的参数无效 + + +### ERR_IPC_SEND_REQUEST + + +``` +constexpr int32_t OHOS::AVSession::ERR_IPC_SEND_REQUEST = -(AVSESSION_ERROR_BASE + 7) +``` +**描述:** +IPC发送数据失败 + + +### ERR_MARSHALLING + + +``` +constexpr int32_t OHOS::AVSession::ERR_MARSHALLING = -(AVSESSION_ERROR_BASE + 5) +``` +**描述:** +数据序列化操作错误 + + +### ERR_NO_MEMORY + + +``` +constexpr int32_t OHOS::AVSession::ERR_NO_MEMORY = -(AVSESSION_ERROR_BASE + 1) +``` +**描述:** +无可用内存 + + +### ERR_NO_PERMISSION + + +``` +constexpr int32_t OHOS::AVSession::ERR_NO_PERMISSION = -(AVSESSION_ERROR_BASE + 12) +``` +**描述:** +无权限 + + +### ERR_RPC_SEND_REQUEST + + +``` +constexpr int32_t OHOS::AVSession::ERR_RPC_SEND_REQUEST = -(AVSESSION_ERROR_BASE + 19) +``` +**描述:** +RPC发送数据失败 + + +### ERR_SERVICE_NOT_EXIST + + +``` +constexpr int32_t OHOS::AVSession::ERR_SERVICE_NOT_EXIST = -(AVSESSION_ERROR_BASE + 3) +``` +**描述:** +服务不存在 + + +### ERR_SESSION_DEACTIVE + + +``` +constexpr int32_t OHOS::AVSession::ERR_SESSION_DEACTIVE = -(AVSESSION_ERROR_BASE + 13) +``` +**描述:** +会话未激活 + + +### ERR_SESSION_EXCEED_MAX + + +``` +constexpr int32_t OHOS::AVSession::ERR_SESSION_EXCEED_MAX = -(AVSESSION_ERROR_BASE + 8) +``` +**描述:** +超过允许会话最大数量 + + +### ERR_SESSION_LISTENER_EXIST + + +``` +constexpr int32_t OHOS::AVSession::ERR_SESSION_LISTENER_EXIST = -(AVSESSION_ERROR_BASE + 4) +``` +**描述:** +Session监听器已存在 + + +### ERR_SESSION_NOT_EXIST + + +``` +constexpr int32_t OHOS::AVSession::ERR_SESSION_NOT_EXIST = -(AVSESSION_ERROR_BASE + 9) +``` +**描述:** +会话不存在 + + +### ERR_START_ABILITY_IS_RUNNING + + +``` +constexpr int32_t OHOS::AVSession::ERR_START_ABILITY_IS_RUNNING = -(AVSESSION_ERROR_BASE + 15) +``` +**描述:** +元能力正在运行 + + +### ERR_START_ABILITY_TIMEOUT + + +``` +constexpr int32_t OHOS::AVSession::ERR_START_ABILITY_TIMEOUT = -(AVSESSION_ERROR_BASE + 17) +``` +**描述:** +元能力启动超时 + + +### ERR_UNMARSHALLING + + +``` +constexpr int32_t OHOS::AVSession::ERR_UNMARSHALLING = -(AVSESSION_ERROR_BASE + 6) +``` +**描述:** +数据反序列化操作错误 diff --git a/zh-cn/application-dev/reference/native-apis/avsession__info_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__info_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..6a557b7d385140bed174ff4da5f808046c00409d --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avsession__info_8h.md @@ -0,0 +1,75 @@ +# avsession_info.h + + +## 概述 + +定义了与avsession相关的监听器以及回调功能的实现。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md) | class
定义与AVSession相关监听器的类的实现。 | +| [OHOS::AVSession::AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md) | class
定义AVSession回调类的实现 | +| [OHOS::AVSession::AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md) | class
定义控制器相关回调操作的类的实现。 | +| [OHOS::AVSession::SessionToken](_o_h_o_s_1_1_a_v_session_1_1_session_token.md) | struct
会话令牌的信息。 | + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::DeathCallback](#deathcallback) = std::function< void()> | using | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::SessionDataCategory](#sessiondatacategory) {
**OHOS::AVSession::SESSION_DATA_CATEGORY_INVALID** = -1, **OHOS::AVSession::SESSION_DATA_META** = 0, **OHOS::AVSession::SESSION_DATA_PLAYBACK_STATE** = 1, **OHOS::AVSession::SESSION_DATA_CONTROL_COMMAND** = 2, **OHOS::AVSession::SESSION_DATA_CATEGORY_MAX** = 3
} | 会话元数据处理标识 | + + +## 类型定义说明 + + +### DeathCallback + + +``` +using OHOS::AVSession::DeathCallback = typedef std::function +``` +**描述:** +AVSession死亡回调 + + +## 枚举类型说明 + + +### SessionDataCategory + + +``` +enum OHOS::AVSession::SessionDataCategory +``` +**描述:** +会话元数据处理标识 + + | 枚举值 | 描述 | +| -------- | -------- | +| SESSION_DATA_CATEGORY_INVALID | 无效类型，内部用于类型是否有效 | +| SESSION_DATA_META | 会话元数据 | +| SESSION_DATA_PLAYBACK_STATE | 会话播放状态 | +| SESSION_DATA_CONTROL_COMMAND | 会话控制命令 | +| SESSION_DATA_CATEGORY_MAX | 会话数据类型的数量 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__manager_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__manager_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..7b2ebbd07e351368fe938453be904b5f56181319 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avsession__manager_8h.md @@ -0,0 +1,24 @@ +# avsession_manager.h + + +## 概述 + +定义了会话管理器对外接口的功能的实现。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVSessionManager](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md) | class
实现会话管理器对外接口功能的类的实现。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__pixel__map_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__pixel__map_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..8d5d6f7dad1a7aac3bd8908ed4d5ef32f47088c3 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/avsession__pixel__map_8h.md @@ -0,0 +1,44 @@ +# avsession_pixel_map.h + + +## 概述 + +读取、设置图片及图片信息。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md) | class
读取、设置图片及图片信息。 | + + +### 变量 + + | 名称 | 描述 | +| -------- | -------- | +| [OHOS::AVSession::DEFAULT_BUFFER_SIZE](#default_buffer_size) = 160 \* 1024 | constexpr size_t
初始化容器大小为160KB | + + +## 变量说明 + + +### DEFAULT_BUFFER_SIZE + + +``` +constexpr size_t OHOS::AVSession::DEFAULT_BUFFER_SIZE = 160 * 1024 +``` +**描述:** +初始化容器大小为160KB diff --git a/zh-cn/application-dev/reference/native-apis/native__avcodec__audiodecoder_8h.md b/zh-cn/application-dev/reference/native-apis/native__avcodec__audiodecoder_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..372e9ea1c95bd30792f40f4a542c6cb56de96867 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__avcodec__audiodecoder_8h.md @@ -0,0 +1,37 @@ +# native_avcodec_audiodecoder.h + + +## 概述 + +声明用于音频解码的Native API。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[AudioDecoder](_audio_decoder.md) + + +## 汇总 + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AudioDecoder_CreateByMime](_audio_decoder.md#oh_audiodecoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个音频解码器实例，大多数情况下推荐使用该接口。 | +| [OH_AudioDecoder_CreateByName](_audio_decoder.md#oh_audiodecoder_createbyname) (const char \*name) | OH_AVCodec \*
通过音频解码器名称创建一个音频解码器实例，使用这个接口的前提是必须清楚解码器准确的名称。 | +| [OH_AudioDecoder_Destroy](_audio_decoder.md#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部资源，并销毁解码器实例 | +| [OH_AudioDecoder_SetCallback](_audio_decoder.md#oh_audiodecoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应音频解码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioDecoder_Configure](_audio_decoder.md#oh_audiodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置音频解码器，典型地，需要配置被解码音频轨道的描述信息，这些信息能够从容器中提取出来， 该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioDecoder_Prepare](_audio_decoder.md#oh_audiodecoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备解码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_AudioDecoder_Start](_audio_decoder.md#oh_audiodecoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动解码器，该接口必须在已经Prepare成功后调用。 在启动成功后，解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_AudioDecoder_Stop](_audio_decoder.md#oh_audiodecoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止解码器。在停止后可通过Start重新进入Started状态，但需要注意的是，若先前给解码器输入过 Codec-Specific-Data，则需要重新输入。 | +| [OH_AudioDecoder_Flush](_audio_decoder.md#oh_audiodecoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_AudioDecoder_Reset](_audio_decoder.md#oh_audiodecoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置解码器。如需继续解码工作，需要重新调用Configure接口以配置该解码器实例。 | +| [OH_AudioDecoder_GetOutputDescription](_audio_decoder.md#oh_audiodecoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该解码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例需调用者手动释放。 | +| [OH_AudioDecoder_SetParameter](_audio_decoder.md#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向解码器设置动态参数，注意：该接口仅能在解码器被启动后调用，同时错误的参数设置，可能会导致解码失败。 | +| [OH_AudioDecoder_PushInputData](_audio_decoder.md#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | [OH_AVErrCode](_core.md#oh_averrcode)
将填充好数据的输入Buffer提交给音频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。另外，对于部分解码器，要求在最开始给解码器输入 Codec-Specific-Data，用以初始化解码器的解码过程。 | +| [OH_AudioDecoder_FreeOutputData](_audio_decoder.md#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给解码器。 | diff --git a/zh-cn/application-dev/reference/native-apis/native__avcodec__audioencoder_8h.md b/zh-cn/application-dev/reference/native-apis/native__avcodec__audioencoder_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..80e6048b45a42b9f82d194525a0963132358022b --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__avcodec__audioencoder_8h.md @@ -0,0 +1,37 @@ +# native_avcodec_audioencoder.h + + +## 概述 + +声明用于音频编码的Native API。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[AudioEncoder](_audio_encoder.md) + + +## 汇总 + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AudioEncoder_CreateByMime](_audio_encoder.md#oh_audioencoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个音频编码器实例，大多数情况下推荐使用该接口。 | +| [OH_AudioEncoder_CreateByName](_audio_encoder.md#oh_audioencoder_createbyname) (const char \*name) | OH_AVCodec \*
通过音频编码器名称创建一个音频编码器实例，使用这个接口的前提是必须清楚编码器准确的名称。 | +| [OH_AudioEncoder_Destroy](_audio_encoder.md#oh_audioencoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部资源，并销毁编码器实例。 | +| [OH_AudioEncoder_SetCallback](_audio_encoder.md#oh_audioencoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应音频编码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioEncoder_Configure](_audio_encoder.md#oh_audioencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置音频编码器，典型地，需要配置被编码音频轨道的描述信息，该接口被调用必须是在Prepare被调用前。 | +| [OH_AudioEncoder_Prepare](_audio_encoder.md#oh_audioencoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备编码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_AudioEncoder_Start](_audio_encoder.md#oh_audioencoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动编码器，该接口必须在已经Prepare成功后调用。 在启动成功后，编码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_AudioEncoder_Stop](_audio_encoder.md#oh_audioencoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止编码器。在停止后可通过Start重新进入Started状态。 | +| [OH_AudioEncoder_Flush](_audio_encoder.md#oh_audioencoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_AudioEncoder_Reset](_audio_encoder.md#oh_audioencoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置编码器。如需继续编码工作，需要重新调用Configure接口以配置该编码器实例。 | +| [OH_AudioEncoder_GetOutputDescription](_audio_encoder.md#oh_audioencoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该编码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例需调用者手动释放。 | +| [OH_AudioEncoder_SetParameter](_audio_encoder.md#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向编码器设置动态参数，注意：该接口仅能在编码器被启动后调用，同时错误的参数设置，可能会导致编码失败。 | +| [OH_AudioEncoder_PushInputData](_audio_encoder.md#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | [OH_AVErrCode](_core.md#oh_averrcode)
将填充好数据的输入Buffer提交给音频编码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给编码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。 | +| [OH_AudioEncoder_FreeOutputData](_audio_encoder.md#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给编码器。 | diff --git a/zh-cn/application-dev/reference/native-apis/native__avcodec__base_8h.md b/zh-cn/application-dev/reference/native-apis/native__avcodec__base_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..3bf1d9f0890141e6995ac0a70e86195ef83ee295 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__avcodec__base_8h.md @@ -0,0 +1,79 @@ +# native_avcodec_base.h + + +## 概述 + +声明运行音视频编解码通用的结构体、字符常量、枚举。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[CodecBase](_codec_base.md) + + +## 汇总 + + +### 结构体 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) | struct
定义OH_AVCodec的Buffer描述信息。 | +| [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) | struct
AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例，并处理通过该回调报告 的信息，以确保AVCodec正常运转。 | + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| **OHNativeWindow** | typedef struct NativeWindow | +| **OH_AVCodec** | typedef struct OH_AVCodec | +| [OH_AVCodecBufferFlags](_codec_base.md#oh_avcodecbufferflags) | typedef enum [OH_AVCodecBufferFlags](_codec_base.md#oh_avcodecbufferflags)
枚举OH_AVCodec的Buffer标记的类别。 | +| [OH_AVCodecBufferAttr](_codec_base.md#oh_avcodecbufferattr) | typedef struct [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md)
定义OH_AVCodec的Buffer描述信息。 | +| [OH_AVCodecOnError](_codec_base.md#oh_avcodeconerror)) (OH_AVCodec \*codec, int32_t errorCode, void \*userData) | typedef void(\*
当OH_AVCodec实例运行发生错误时，该函数指针会被调用以报告具体错误信息。 | +| [OH_AVCodecOnStreamChanged](_codec_base.md#oh_avcodeconstreamchanged)) (OH_AVCodec \*codec, OH_AVFormat \*format, void \*userData) | typedef void(\*
当输出流发生变化时，该函数指针会被调用以报告新的流描述信息。 需要注意的时，OH_AVFormat指针的生命周期仅维持在该函数指针被调用时上有效，禁止在调用结束后继续访问。 | +| [OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)) (OH_AVCodec \*codec, uint32_t index, OH_AVMemory \*data, void \*userData) | typedef void(\*
当AVCodec运行过程中需要新的输入数据时，该函数指针会被调用，并携带一块可用的Buffer以供填入新的输入数据。 | +| [OH_AVCodecOnNewOutputData](_codec_base.md#oh_avcodeconnewoutputdata)) (OH_AVCodec \*codec, uint32_t index, OH_AVMemory \*data, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) \*attr, void \*userData) | typedef void(\*
当AVCodec运行过程中产生了新的输出数据时，该函数指针会被调用，并携带一块包含新输出数据的Buffer， 需要注意的是，OH_AVCodecBufferAttr指针的生命周期仅维持在该函数指针被调用时有效，禁止调用结束后继续访问。 | +| [OH_AVCodecAsyncCallback](_codec_base.md#oh_avcodecasynccallback) | typedef struct [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md)
AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例，并处理通过该回调报告 的信息，以确保AVCodec正常运转。 | +| [OH_MediaType](_codec_base.md#oh_mediatype) | typedef enum [OH_MediaType](_codec_base.md#oh_mediatype)
媒体类型。 | +| [OH_AVCProfile](_codec_base.md#oh_avcprofile) | typedef enum [OH_AVCProfile](_codec_base.md#oh_avcprofile)
AVC Profile枚举。 | +| [OH_AACProfile](_codec_base.md#oh_aacprofile) | typedef enum [OH_AACProfile](_codec_base.md#oh_aacprofile)
AAC Profile枚举。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVCodecBufferFlags](_codec_base.md#oh_avcodecbufferflags) {
**AVCODEC_BUFFER_FLAGS_NONE** = 0, **AVCODEC_BUFFER_FLAGS_EOS** = 1 << 0, **AVCODEC_BUFFER_FLAGS_SYNC_FRAME** = 1 << 1, **AVCODEC_BUFFER_FLAGS_INCOMPLETE_FRAME** = 1 << 2,
**AVCODEC_BUFFER_FLAGS_CODEC_DATA** = 1 << 3
} | 枚举OH_AVCodec的Buffer标记的类别。 | +| [OH_MediaType](_codec_base.md#oh_mediatype) { **MEDIA_TYPE_AUD** = 0, **MEDIA_TYPE_VID** = 1 } | 媒体类型。 | +| [OH_AVCProfile](_codec_base.md#oh_avcprofile) { **AVC_PROFILE_BASELINE** = 0, **AVC_PROFILE_HIGH** = 4, **AVC_PROFILE_MAIN** = 8 } | AVC Profile枚举。 | +| [OH_AACProfile](_codec_base.md#oh_aacprofile) { **AAC_PROFILE_LC** = 0 } | AAC Profile枚举。 | + + +### 变量 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVCODEC_MIMETYPE_VIDEO_AVC](_codec_base.md#oh_avcodec_mimetype_video_avc) | const char \*
AVC视频编解码器的MIME类型。 | +| [OH_AVCODEC_MIMETYPE_AUDIO_AAC](_codec_base.md#oh_avcodec_mimetype_audio_aac) | const char \*
AAC音频编解码器的MIME类型。 | +| [OH_ED_KEY_TIME_STAMP](_codec_base.md#oh_ed_key_time_stamp) | const char \*
提供统一的surface Buffer附属数据的字符描述符。 | +| [OH_ED_KEY_EOS](_codec_base.md#oh_ed_key_eos) | const char \* | +| [OH_MD_KEY_TRACK_TYPE](_codec_base.md#oh_md_key_track_type) | const char \*
为媒体播放框架提供统一的字符描述符。 | +| [OH_MD_KEY_CODEC_MIME](_codec_base.md#oh_md_key_codec_mime) | const char \* | +| [OH_MD_KEY_DURATION](_codec_base.md#oh_md_key_duration) | const char \* | +| [OH_MD_KEY_BITRATE](_codec_base.md#oh_md_key_bitrate) | const char \* | +| [OH_MD_KEY_MAX_INPUT_SIZE](_codec_base.md#oh_md_key_max_input_size) | const char \* | +| [OH_MD_KEY_WIDTH](_codec_base.md#oh_md_key_width) | const char \* | +| [OH_MD_KEY_HEIGHT](_codec_base.md#oh_md_key_height) | const char \* | +| [OH_MD_KEY_PIXEL_FORMAT](_codec_base.md#oh_md_key_pixel_format) | const char \* | +| [OH_MD_KEY_AUDIO_SAMPLE_FORMAT](_codec_base.md#oh_md_key_audio_sample_format) | const char \* | +| [OH_MD_KEY_FRAME_RATE](_codec_base.md#oh_md_key_frame_rate) | const char \* | +| [OH_MD_KEY_VIDEO_ENCODE_BITRATE_MODE](_codec_base.md#oh_md_key_video_encode_bitrate_mode) | const char \* | +| [OH_MD_KEY_PROFILE](_codec_base.md#oh_md_key_profile) | const char \* | +| [OH_MD_KEY_AUD_CHANNEL_COUNT](_codec_base.md#oh_md_key_aud_channel_count) | const char \* | +| [OH_MD_KEY_AUD_SAMPLE_RATE](_codec_base.md#oh_md_key_aud_sample_rate) | const char \* | +| [OH_MD_KEY_I_FRAME_INTERVAL](_codec_base.md#oh_md_key_i_frame_interval) | const char \* | +| [OH_MD_KEY_ROTATION](_codec_base.md#oh_md_key_rotation) | const char \* | diff --git a/zh-cn/application-dev/reference/native-apis/native__avcodec__videodecoder_8h.md b/zh-cn/application-dev/reference/native-apis/native__avcodec__videodecoder_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..f562886c1013f6b5bd4ac6530cb300790374bdad --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__avcodec__videodecoder_8h.md @@ -0,0 +1,39 @@ +# native_avcodec_videodecoder.h + + +## 概述 + +声明用于视频解码的Native API。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[VideoDecoder](_video_decoder.md) + + +## 汇总 + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoDecoder_CreateByMime](_video_decoder.md#oh_videodecoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个视频解码器实例，大多数情况下推荐使用该接口。 | +| [OH_VideoDecoder_CreateByName](_video_decoder.md#oh_videodecoder_createbyname) (const char \*name) | OH_AVCodec \*
通过视频解码器名称创建一个视频解码器实例，使用这个接口的前提是必须清楚解码器准确的名称。 | +| [OH_VideoDecoder_Destroy](_video_decoder.md#oh_videodecoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部资源，并销毁解码器实例。 | +| [OH_VideoDecoder_SetCallback](_video_decoder.md#oh_videodecoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应视频解码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoDecoder_SetSurface](_video_decoder.md#oh_videodecoder_setsurface) (OH_AVCodec \*codec, OHNativeWindow \*window) | [OH_AVErrCode](_core.md#oh_averrcode)
指定输出Surface，以提供视频解码输出，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoDecoder_Configure](_video_decoder.md#oh_videodecoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置视频解码器，典型地，需要配置被解码视频轨道的描述信息，这些信息能够从容器中提取出来， 该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoDecoder_Prepare](_video_decoder.md#oh_videodecoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备解码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_VideoDecoder_Start](_video_decoder.md#oh_videodecoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动解码器，该接口必须在已经Prepare成功后调用。 在启动成功后，解码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_VideoDecoder_Stop](_video_decoder.md#oh_videodecoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止解码器。在停止后可通过Start重新进入Started状态，但需要注意的是，若先前给解码器输入过 Codec-Specific-Data，则需要重新输入。 | +| [OH_VideoDecoder_Flush](_video_decoder.md#oh_videodecoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空解码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_VideoDecoder_Reset](_video_decoder.md#oh_videodecoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置解码器。如需继续解码工作，需要重新调用Configure接口以配置该解码器实例。 | +| [OH_VideoDecoder_GetOutputDescription](_video_decoder.md#oh_videodecoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该解码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例的生命周期 将会再下一次调用该接口时或者该OH_AVCodec实例被销毁时失效。 | +| [OH_VideoDecoder_SetParameter](_video_decoder.md#oh_videodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向解码器设置动态参数，注意：该接口仅能在解码器被启动后调用，同时错误的参数设置，可能会导致解码失败。 | +| [OH_VideoDecoder_PushInputData](_video_decoder.md#oh_videodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) attr) | [OH_AVErrCode](_core.md#oh_averrcode)
将填充好数据的输入Buffer提交给视频解码器。[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器，直到再一次收到[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata) 回调报告相同索引的Buffer可用前，该Buffer都不可以再次被访问。另外，对于部分解码器，要求在最开始给解码器输入 Codec-Specific-Data，用以初始化解码器的解码过程，例如H264格式的PPS/SPS数据。 | +| [OH_VideoDecoder_RenderOutputData](_video_decoder.md#oh_videodecoder_renderoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给解码器，并通知解码器完成将该Buffer内包含的解码后的数据在输出Surface上渲染。 如果先前未配置输出Surface，调用该接口仅仅将指定索引对应的输出Buffer交还给解码器。 | +| [OH_VideoDecoder_FreeOutputData](_video_decoder.md#oh_videodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给解码器。 | diff --git a/zh-cn/application-dev/reference/native-apis/native__avcodec__videoencoder_8h.md b/zh-cn/application-dev/reference/native-apis/native__avcodec__videoencoder_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..50cb054e61babe666a5cc1f1da4c470cd1c64594 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__avcodec__videoencoder_8h.md @@ -0,0 +1,52 @@ +# native_avcodec_videoencoder.h + + +## 概述 + +声明用于视频编码的Native API。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[VideoEncoder](_video_encoder.md) + + +## 汇总 + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoEncodeBitrateMode](_video_encoder.md#oh_videoencodebitratemode) | typedef enum [OH_VideoEncodeBitrateMode](_video_encoder.md#oh_videoencodebitratemode)
视频编码的比特率模式。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoEncodeBitrateMode](_video_encoder.md#oh_videoencodebitratemode) { **CBR** = 0, **VBR** = 1, **CQ** = 2 } | 视频编码的比特率模式。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_VideoEncoder_CreateByMime](_video_encoder.md#oh_videoencoder_createbymime) (const char \*mime) | OH_AVCodec \*
通过mime类型创建一个视频编码器实例，大多数情况下推荐使用该接口。 | +| [OH_VideoEncoder_CreateByName](_video_encoder.md#oh_videoencoder_createbyname) (const char \*name) | OH_AVCodec \*
通过视频编码器名称创建一个视频编码器实例，使用这个接口的前提是必须清楚编码器准确的名称。 | +| [OH_VideoEncoder_Destroy](_video_encoder.md#oh_videoencoder_destroy) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部资源，并销毁编码器实例。 | +| [OH_VideoEncoder_SetCallback](_video_encoder.md#oh_videoencoder_setcallback) (OH_AVCodec \*codec, [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) callback, void \*userData) | [OH_AVErrCode](_core.md#oh_averrcode)
设置异步回调函数，使得你的应用能够响应视频编码器产生的事件，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoEncoder_Configure](_video_encoder.md#oh_videoencoder_configure) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
配置视频编码器，典型地，需要配置被编码视频轨道的描述信息，该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoEncoder_Prepare](_video_encoder.md#oh_videoencoder_prepare) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
准备编码器内部资源，调用该接口前必须先调用Configure接口。 | +| [OH_VideoEncoder_Start](_video_encoder.md#oh_videoencoder_start) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
启动编码器，该接口必须在已经Prepare成功后调用。 在启动成功后，编码器将开始报告[OH_AVCodecOnNeedInputData](_codec_base.md#oh_avcodeconneedinputdata)事件。 | +| [OH_VideoEncoder_Stop](_video_encoder.md#oh_videoencoder_stop) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
停止编码器。在停止后可通过Start重新进入Started状态。 | +| [OH_VideoEncoder_Flush](_video_encoder.md#oh_videoencoder_flush) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
清空编码器内部缓存的输入输出数据。在该接口被调用后，所有先前通过异步回调报告的Buffer的索引都将 失效，确保不要再访问这些索引对应的Buffers。 | +| [OH_VideoEncoder_Reset](_video_encoder.md#oh_videoencoder_reset) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
重置编码器。如需继续编码工作，需要重新调用Configure接口以配置该编码器实例。 | +| [OH_VideoEncoder_GetOutputDescription](_video_encoder.md#oh_videoencoder_getoutputdescription) (OH_AVCodec \*codec) | OH_AVFormat \*
获取该编码器输出数据的描述信息，需要注意的是，返回值所指向的OH_AVFormat实例的生命周期 将会再下一次调用该接口时或者该OH_AVCodec实例被销毁时失效。 | +| [OH_VideoEncoder_SetParameter](_video_encoder.md#oh_videoencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | [OH_AVErrCode](_core.md#oh_averrcode)
向编码器设置动态参数，注意：该接口仅能在编码器被启动后调用，同时错误的参数设置，可能会导致编码失败。 | +| [OH_VideoEncoder_GetSurface](_video_encoder.md#oh_videoencoder_getsurface) (OH_AVCodec \*codec, OHNativeWindow \*\*window) | [OH_AVErrCode](_core.md#oh_averrcode)
从视频编码器获取输入Surface， 该接口被调用必须是在Prepare被调用前。 | +| [OH_VideoEncoder_FreeOutputData](_video_encoder.md#oh_videoencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | [OH_AVErrCode](_core.md#oh_averrcode)
将处理结束的输出Buffer交还给编码器。 | +| [OH_VideoEncoder_NotifyEndOfStream](_video_encoder.md#oh_videoencoder_notifyendofstream) (OH_AVCodec \*codec) | [OH_AVErrCode](_core.md#oh_averrcode)
通知视频编码器输入码流已结束。surface模式推荐使用该接口通知编码器码流结束。 | diff --git a/zh-cn/application-dev/reference/native-apis/native__averrors_8h.md b/zh-cn/application-dev/reference/native-apis/native__averrors_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..269d3a898d6261307b32f5833a037036279811aa --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__averrors_8h.md @@ -0,0 +1,31 @@ +# native_averrors.h + + +## 概述 + +声明了媒体播放框架的错误码。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Core](_core.md) + + +## 汇总 + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVErrCode](_core.md#oh_averrcode) | typedef enum [OH_AVErrCode](_core.md#oh_averrcode)
音视频错误码。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVErrCode](_core.md#oh_averrcode) {
**AV_ERR_OK** = 0, **AV_ERR_NO_MEMORY** = 1, **AV_ERR_OPERATE_NOT_PERMIT** = 2, **AV_ERR_INVALID_VAL** = 3, **AV_ERR_IO** = 4, **AV_ERR_TIMEOUT** = 5, **AV_ERR_UNKNOWN** = 6, **AV_ERR_SERVICE_DIED** = 7, **AV_ERR_INVALID_STATE** = 8, **AV_ERR_UNSUPPORT** = 9, **AV_ERR_EXTEND_START** = 100
} | 音视频错误码。 | diff --git a/zh-cn/application-dev/reference/native-apis/native__avformat_8h.md b/zh-cn/application-dev/reference/native-apis/native__avformat_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..4f22a67c0a508766a730251facad472e7b708b32 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__avformat_8h.md @@ -0,0 +1,54 @@ +# native_avformat.h + + +## 概述 + +声明了格式相关的函数和枚举。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Core](_core.md) + + +## 汇总 + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| **OH_AVFormat** | typedef struct OH_AVFormat | +| [OH_AVPixelFormat](_core.md#oh_avpixelformat) | typedef enum [OH_AVPixelFormat](_core.md#oh_avpixelformat)
AVPixel 格式的枚举。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVPixelFormat](_core.md#oh_avpixelformat) {
**AV_PIXEL_FORMAT_YUVI420** = 1, **AV_PIXEL_FORMAT_NV12** = 2, **AV_PIXEL_FORMAT_NV21** = 3, **AV_PIXEL_FORMAT_SURFACE_FORMAT** = 4, **AV_PIXEL_FORMAT_RGBA** = 5
} | AVPixel 格式的枚举。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVFormat_Create](_core.md#oh_avformat_create) (void) | struct OH_AVFormat \*
创建一个OH_AVFormat句柄指针，用以读写数据。 | +| [OH_AVFormat_Destroy](_core.md#oh_avformat_destroy) (struct OH_AVFormat \*format) | void
销毁指定OH_AVFormat句柄资源。 | +| [OH_AVFormat_Copy](_core.md#oh_avformat_copy) (struct OH_AVFormat \*to, struct OH_AVFormat \*from) | bool
拷贝OH_AVFormat句柄资源. | +| [OH_AVFormat_SetIntValue](_core.md#oh_avformat_setintvalue) (struct OH_AVFormat \*format, const char \*key, int32_t value) | bool
向OH_AVFormat写入Int数据. | +| [OH_AVFormat_SetLongValue](_core.md#oh_avformat_setlongvalue) (struct OH_AVFormat \*format, const char \*key, int64_t value) | bool
向OH_AVFormat写入Long数据。 | +| [OH_AVFormat_SetFloatValue](_core.md#oh_avformat_setfloatvalue) (struct OH_AVFormat \*format, const char \*key, float value) | bool
向OH_AVFormat写入Float数据。 | +| [OH_AVFormat_SetDoubleValue](_core.md#oh_avformat_setdoublevalue) (struct OH_AVFormat \*format, const char \*key, double value) | bool
向OH_AVFormat写入Double数据。 | +| [OH_AVFormat_SetStringValue](_core.md#oh_avformat_setstringvalue) (struct OH_AVFormat \*format, const char \*key, const char \*value) | bool
向OH_AVFormat写入String数据。 | +| [OH_AVFormat_SetBuffer](_core.md#oh_avformat_setbuffer) (struct OH_AVFormat \*format, const char \*key, const uint8_t \*addr, size_t size) | bool
向OH_AVFormat写入一块指定长度的数据。 | +| [OH_AVFormat_GetIntValue](_core.md#oh_avformat_getintvalue) (struct OH_AVFormat \*format, const char \*key, int32_t \*out) | bool
从OH_AVFormat读取Int数据。 | +| [OH_AVFormat_GetLongValue](_core.md#oh_avformat_getlongvalue) (struct OH_AVFormat \*format, const char \*key, int64_t \*out) | bool
从OH_AVFormat读取Long数据。 | +| [OH_AVFormat_GetFloatValue](_core.md#oh_avformat_getfloatvalue) (struct OH_AVFormat \*format, const char \*key, float \*out) | bool
从OH_AVFormat读取Float数据。 | +| [OH_AVFormat_GetDoubleValue](_core.md#oh_avformat_getdoublevalue) (struct OH_AVFormat \*format, const char \*key, double \*out) | bool
从OH_AVFormat读取Double数据。 | +| [OH_AVFormat_GetStringValue](_core.md#oh_avformat_getstringvalue) (struct OH_AVFormat \*format, const char \*key, const char \*\*out) | bool
从OH_AVFormat读取Double数据。 | +| [OH_AVFormat_GetBuffer](_core.md#oh_avformat_getbuffer) (struct OH_AVFormat \*format, const char \*key, uint8_t \*\*addr, size_t \*size) | bool
从OH_AVFormat读取一块指定长度的数据。 | +| [OH_AVFormat_DumpInfo](_core.md#oh_avformat_dumpinfo) (struct OH_AVFormat \*format) | const char \*
以字符串的形式输出OH_AVFormat所包含的信息。 | diff --git a/zh-cn/application-dev/reference/native-apis/native__avmemory_8h.md b/zh-cn/application-dev/reference/native-apis/native__avmemory_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..18bdc665ff9fca8c6ed284718b6f10adee48bc86 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/native__avmemory_8h.md @@ -0,0 +1,32 @@ +# native_avmemory.h + + +## 概述 + +声明了AVMemory的函数接口。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Core](_core.md) + + +## 汇总 + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| **OH_AVMemory** | typedef struct OH_AVMemory | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OH_AVMemory_GetAddr](_core.md#oh_avmemory_getaddr) (struct OH_AVMemory \*mem) | uint8_t \*
获取入参的内存虚拟地址。 | +| [OH_AVMemory_GetSize](_core.md#oh_avmemory_getsize) (struct OH_AVMemory \*mem) | int32_t
获取入参的内存长度。 | diff --git a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md new file mode 100644 index 0000000000000000000000000000000000000000..914cd75fe533935144971e0a8d0cfbaaeff13a72 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md @@ -0,0 +1,37 @@ +# OHOS::AVSession::AVSessionBasicInfo + + +## 概述 + +会话基础信息描述。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### 成员变量 + + | 名称 | 描述 | +| -------- | -------- | +| [deviceName_](avsession.md#devicename) {} | std::string | +| [networkId_](avsession.md#networkid) {} | std::string | +| [vendorId_](avsession.md#vendorid) {} | std::string | +| [deviceType_](avsession.md#devicetype) {} | std::string | +| [systemVersion_](avsession.md#systemversion) {} | std::string | +| [sessionVersion_](avsession.md#sessionversion) {} | int32_t | +| [reserve_](avsession.md#reserve) {} | std::vector< int32_t > | +| [feature_](avsession.md#feature) {} | std::vector< int32_t > | +| [metaDataCap_](avsession.md#metadatacap) {} | std::vector< int32_t > | +| [playBackStateCap_](avsession.md#playbackstatecap) {} | std::vector< int32_t > | +| [controlCommandCap_](avsession.md#controlcommandcap) {} | std::vector< int32_t > | +| [extendCapability_](avsession.md#extendcapability) {} | std::vector< int32_t > | +| [systemTime_](avsession.md#systemtime) {} | int32_t | +| [extend_](avsession.md#extend) {} | std::vector< int32_t > | diff --git a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md new file mode 100644 index 0000000000000000000000000000000000000000..337f6045d9771b88cc7e253a8a5ae616ca95aa3b --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md @@ -0,0 +1,328 @@ +# OHOS::AVSession::AVSessionController + + +## 概述 + +控制器对象，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 + + +## 汇总 + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetAVPlaybackState](#getavplaybackstate) ([AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 获取音视频的播放状态。  | +| [GetAVMetaData](#getavmetadata) ([AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &data)=0 | 获取会话元数据。  | +| [SendAVKeyEvent](#sendavkeyevent) (const MMI::KeyEvent &keyEvent)=0 | 发送系统按键事件。  | +| [GetLaunchAbility](#getlaunchability) (AbilityRuntime::WantAgent::WantAgent &ability)=0 | 获取Ability。  | +| [GetValidCommands](#getvalidcommands) (std::vector< int32_t > &cmds)=0 | 获取媒体有效的指令。  | +| [IsSessionActive](#issessionactive) (bool &isActive)=0 | 获取session的激活状态。  | +| [SendControlCommand](#sendcontrolcommand) (const [AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) &cmd)=0 | 发送媒体控制指令。  | +| [RegisterCallback](#registercallback) (const std::shared_ptr< [AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md) > &callback)=0 | 注册回调。  | +| [SetMetaFilter](#setmetafilter) (const [AVMetaData::MetaMaskType](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md#metamasktype) &filter)=0 | 设置会话元数据过滤。  | +| [SetPlaybackFilter](#setplaybackfilter) (const AVPlaybackState::PlaybackStateMaskType &filter)=0 | 设置音视频的播放状态回调过滤。  | +| [Destroy](#destroy) ()=0 | 释放控制器。  | +| [GetSessionId](#getsessionid) ()=0 | 获取sessionId。  | +| [GetRealPlaybackPosition](#getrealplaybackposition) ()=0 | 获取播放的实时位置，第 x ms。  | +| [IsDestroy](#isdestroy) ()=0 | 是否释放控制器。  | + + +## 成员函数说明 + + +### Destroy() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::Destroy () +``` +**描述:** +释放控制器。 + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### GetAVMetaData() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::GetAVMetaData (AVMetaData & data) +``` +**描述:** +获取会话元数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| data | 会话元数据[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[AVSession::SetAVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#setavmetadata) + +[AVSession::GetAVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#getavmetadata) + + +### GetAVPlaybackState() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::GetAVPlaybackState (AVPlaybackState & state) +``` +**描述:** +获取音视频的播放状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| state | 音视频的播放状态[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[AVSession::SetAVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#setavplaybackstate) + +[AVSession::GetAVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#getavplaybackstate) + + +### GetLaunchAbility() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::GetLaunchAbility (AbilityRuntime::WantAgent::WantAgent & ability) +``` +**描述:** +获取Ability。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ability | 类型为**AbilityRuntime::WantAgent::WantAgent**。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[AVSession::SetLaunchAbility](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#setlaunchability) + + +### GetRealPlaybackPosition() + + +``` +virtual int64_t OHOS::AVSession::AVSessionController::GetRealPlaybackPosition () +``` +**描述:** +获取播放的实时位置，第 x ms。 + +**返回:** + +返回播放的实时位置，第x ms，经过校正过的时间，单位为ms。 + + +### GetSessionId() + + +``` +virtual std::string OHOS::AVSession::AVSessionController::GetSessionId () +``` +**描述:** +获取sessionId。 + +**返回:** + +返回sessionId。 + + +### GetValidCommands() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::GetValidCommands (std::vector< int32_t > & cmds) +``` +**描述:** +获取媒体有效的指令。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cmds | 媒体有效的指令列表，范围为**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[SendControlCommand](#sendcontrolcommand) + +[AVSession::AddSupportCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#addsupportcommand) + +[AVSession::DeleteSupportCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#deletesupportcommand) + + +### IsDestroy() + + +``` +virtual bool OHOS::AVSession::AVSessionController::IsDestroy () +``` +**描述:** +是否释放控制器。 + +**返回:** + +true：释放；false：不释放。 + + +### IsSessionActive() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::IsSessionActive (bool & isActive) +``` +**描述:** +获取session的激活状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| isActive | session是否激活。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[AVSession::Activate](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#activate) + +[AVSession::Deactivate](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#deactivate) + +[AVSession::IsActive](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#isactive) + + +### RegisterCallback() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::RegisterCallback (const std::shared_ptr< AVControllerCallback > & callback) +``` +**描述:** +注册回调。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callback | 需要注册的回调，类型为[AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md)。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### SendAVKeyEvent() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::SendAVKeyEvent (const MMI::KeyEvent & keyEvent) +``` +**描述:** +发送系统按键事件。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| keyEvent | 按键事件码，类型为**MMI::KeyEvent**。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[AVSessionManager::SendSystemAVKeyEvent](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md#sendsystemavkeyevent) + + +### SendControlCommand() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::SendControlCommand (const AVControlCommand & cmd) +``` +**描述:** +发送媒体控制指令。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cmd | 媒体控制指令，类型为[AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md)。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + +**参见:** + +[GetValidCommands](#getvalidcommands) + + +### SetMetaFilter() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::SetMetaFilter (const AVMetaData::MetaMaskType & filter) +``` +**描述:** +设置会话元数据过滤。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| filter | 会话元数据过滤，类型为[AVMetaData#MetaMaskType](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md#metamasktype)。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 + + +### SetPlaybackFilter() + + +``` +virtual int32_t OHOS::AVSession::AVSessionController::SetPlaybackFilter (const AVPlaybackState::PlaybackStateMaskType & filter) +``` +**描述:** +设置音视频的播放状态回调过滤。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| filter | 音视频播放状态回调过滤，类型为**AVPlaybackState\#PlaybackStateMaskType**。  | + +**返回:** + +成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 diff --git a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md new file mode 100644 index 0000000000000000000000000000000000000000..57780778a727a5b2e364d426a5392c20f8951ac5 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md @@ -0,0 +1,41 @@ +# OHOS::AVSession::AVSessionDescriptor + + +## 概述 + +会话的相关描述信息。 + +**Since:** +9 +**Version:** +1.0 +**相关模块:** + +[Avsession](avsession.md) + + +## 汇总 + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [WriteToParcel](avsession.md#writetoparcel) (Parcel &out) const | 将会话相关描述信息写进包里。  | +| [ReadFromParcel](avsession.md#readfromparcel) (Parcel &in) | 对会话相关描述信息进行解包。  | + + +### 成员变量 + + | 名称 | 描述 | +| -------- | -------- | +| [sessionId_](avsession.md#sessionid) | std::string | +| [sessionType_](avsession.md#sessiontype) {} | int32_t | +| [sessionTag_](avsession.md#sessiontag) | std::string | +| [elementName_](avsession.md#elementname) | AppExecFwk::ElementName | +| [pid_](avsession.md#pid) {} | pid_t | +| [uid_](avsession.md#uid) {} | pid_t | +| [isActive_](avsession.md#isactive) {} | bool | +| [isTopSession_](avsession.md#istopsession) {} | bool | +| [isThirdPartyApp_](avsession.md#isthirdpartyapp) {} | bool | +| [outputDeviceInfo_](avsession.md#outputdeviceinfo) | [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) | diff --git a/zh-cn/application-dev/security/permission-list.md b/zh-cn/application-dev/security/permission-list.md index d395484316a430fe66996c6d314e5f8352a14186..9404c136465c37575491443e2835532c177ea43c 100644 --- a/zh-cn/application-dev/security/permission-list.md +++ b/zh-cn/application-dev/security/permission-list.md @@ -1,166 +1,1585 @@ # 应用权限列表 -在申请目标权限前，建议开发者先阅读[访问控制开发概述-权限的工作流程](accesstoken-overview.md#权限的工作流程)。对权限的工作流程有基本的了解后，再结合下表判断应用能否申请目标权限，提高开发效率。 +在申请目标权限前，建议开发者先阅读[访问控制开发概述-权限的工作流程](accesstoken-overview.md#权限的工作流程)。对权限的工作流程有基本的了解后，再结合以下权限的具体说明，判断应用能否申请目标权限，提高开发效率。 权限的使用示例请参考[访问控制开发指导](accesstoken-guidelines.md)。 -| 权限名 | 权限级别 | 授权方式 | ACL使能 | 权限说明 | -| -------------------------------------------------------- | ------------ | ------------ | ------- | ------------------------------------------- | -| ohos.permission.USE_BLUETOOTH | normal | system_grant | TRUE | 允许应用查看蓝牙的配置。 | -| ohos.permission.DISCOVER_BLUETOOTH | normal | system_grant | TRUE | 允许应用配置本地蓝牙，查找远端设备且与之配对连接。 | -| ohos.permission.MANAGE_BLUETOOTH | system_basic | system_grant | TRUE | 允许应用配对蓝牙设备，并对设备的电话簿或消息进行访问。 | -| ohos.permission.INTERNET | normal | system_grant | TRUE | 允许使用Internet网络。 | -| ohos.permission.
MODIFY_AUDIO_SETTINGS | normal | system_grant | TRUE | 允许应用修改音频设置。 | -| ohos.permission.
ACCESS_NOTIFICATION_POLICY | normal | system_grant | FALSE | 在本设备上允许应用访问通知策略。 | -| ohos.permission.GET_TELEPHONY_STATE | system_basic | system_grant | TRUE | 允许应用读取电话信息。 | -| ohos.permission.REQUIRE_FORM | system_basic | system_grant | TRUE | 允许应用获取Ability Form。 | -| ohos.permission.GET_NETWORK_INFO | normal | system_grant | TRUE | 允许应用获取数据网络信息。 | -| ohos.permission.PLACE_CALL | system_basic | system_grant | TRUE | 允许应用直接拨打电话。 | -| ohos.permission.SET_NETWORK_INFO | normal | system_grant | TRUE | 允许应用配置数据网络。 | -| ohos.permission.REMOVE_CACHE_FILES | system_basic | system_grant | TRUE | 允许清理指定应用的缓存。 | -| ohos.permission.REBOOT | system_basic | system_grant | TRUE | 允许应用重启设备。 | -| ohos.permission.RUNNING_LOCK | normal | system_grant | TRUE | 允许应用获取运行锁，保证应用在后台的持续运行。 | -| ohos.permission.SET_TIME | system_basic | system_grant | TRUE | 允许应用修改系统时间。 | -| ohos.permission.SET_TIME_ZONE | system_basic | system_grant | TRUE | 允许应用修改系统时区。 | -| ohos.permission.
DOWNLOAD_SESSION_MANAGER | system_core | system_grant | TRUE | 允许应用管理下载任务会话。 | -| ohos.permission.COMMONEVENT_STICKY | normal | system_grant | TRUE | 允许应用发布粘性公共事件。 | -| ohos.permission.SYSTEM_FLOAT_WINDOW | system_basic | system_grant | TRUE | 允许应用使用悬浮窗的能力。 | -| ohos.permission.PRIVACY_WINDOW | system_basic | system_grant | TRUE | 允许应用将窗口设置为隐私窗口，禁止截屏录屏。 | -| ohos.permission.POWER_MANAGER | system_core | system_grant | TRUE | 允许应用调用电源管理子系统的接口，休眠或者唤醒设备。 | -| ohos.permission.REFRESH_USER_ACTION | system_basic | system_grant | TRUE | 允许应用在收到用户事件时，重新计算超时时间。 | -| ohos.permission.POWER_OPTIMIZATION | system_basic | system_grant | TRUE | 允许系统应用设置省电模式、获取省电模式的配置信息并接收配置变化的通知。 | -| ohos.permission.REBOOT_RECOVERY | system_basic | system_grant | TRUE | 允许系统应用重启设备并进入恢复模式。 | -| ohos.permission.
MANAGE_LOCAL_ACCOUNTS | system_basic | system_grant | TRUE | 允许应用管理本地用户账号。 | -| ohos.permission.
INTERACT_ACROSS_LOCAL_ACCOUNTS | system_basic | system_grant | TRUE | 允许多个系统账号之间相互访问。 | -| ohos.permission.VIBRATE | normal | system_grant | TRUE | 允许应用控制马达振动。 | -| ohos.permission.CONNECT_IME_ABILITY | system_core | system_grant | TRUE | 允许绑定输入法Ability(InputMethodAbility)。 | -| ohos.permission.
CONNECT_SCREEN_SAVER_ABILITY | system_core | system_grant | TRUE | 允许绑定屏保Ability(ScreenSaverAbility)。 | -| ohos.permission.
READ_SCREEN_SAVER | system_basic | system_grant | TRUE | 允许应用查询屏保状态信息。 | -| ohos.permission.
WRITE_SCREEN_SAVER | system_basic | system_grant | TRUE | 允许应用修改屏保状态信息。 | -| ohos.permission.SET_WALLPAPER | normal | system_grant | TRUE | 允许应用设置静态壁纸。 | -| ohos.permission.GET_WALLPAPER | system_basic | system_grant | TRUE | 允许应用读取壁纸文件。 | -| ohos.permission.
CHANGE_ABILITY_ENABLED_STATE | system_basic | system_grant | TRUE | 允许改变应用或者组件的使能状态。 | -| ohos.permission.ACCESS_MISSIONS | system_basic | system_grant | TRUE | 允许应用访问任务栈信息。 | -| ohos.permission.
CLEAN_BACKGROUND_PROCESSES | normal | system_grant | TRUE | 允许应用根据包名清理相关后台进程。 | -| ohos.permission.
KEEP_BACKGROUND_RUNNING | normal | system_grant | TRUE | 允许Service Ability在后台持续运行。 | -| ohos.permission.
UPDATE_CONFIGURATION | system_basic | system_grant | TRUE | 允许更新系统配置。 | -| ohos.permission.UPDATE_SYSTEM | system_basic | system_grant | TRUE | 允许调用升级接口。 | -| ohos.permission.FACTORY_RESET | system_basic | system_grant | TRUE | 允许调用回复出厂接口。 | -| ohos.permission.
GRANT_SENSITIVE_PERMISSIONS | system_core | system_grant | TRUE | 允许应用为其他应用授予敏感权限。 | -| ohos.permission.
REVOKE_SENSITIVE_PERMISSIONS | system_core | system_grant | TRUE | 允许应用撤销给其他应用授予的敏感信息。 | -| ohos.permission.
GET_SENSITIVE_PERMISSIONS | system_core | system_grant | TRUE | 允许应用读取其他应用的敏感权限的状态。 | -| ohos.permission.INTERACT_
ACROSS_LOCAL_ACCOUNTS_EXTENSION | system_core | system_grant | TRUE | 允许应用跨用户对其他应用的属性进行设置。 | -| ohos.permission.LISTEN_BUNDLE_CHANGE | system_basic | system_grant | TRUE | 允许应用监听其他应用安装、更新、卸载状态的变化。 | -| ohos.permission.GET_BUNDLE_INFO | normal | system_grant | TRUE | 允许应用查询其他应用的信息。 | -| ohos.permission.ACCELEROMETER | normal | system_grant | TRUE | 允许应用读取加速度传感器的数据。 | -| ohos.permission.GYROSCOPE | normal | system_grant | TRUE | 允许应用读取陀螺仪传感器的数据。 | -| ohos.permission.
GET_BUNDLE_INFO_PRIVILEGED | system_basic | system_grant | TRUE | 允许应用查询其他应用的信息。 | -| ohos.permission.INSTALL_BUNDLE | system_core | system_grant | TRUE | 允许应用安装、卸载其他应用。 | -| ohos.permission.MANAGE_SHORTCUTS | system_core | system_grant | TRUE | 允许应用查询其他应用的快捷方式信息、启动其他应用的快捷方式。 | -| ohos.permission.radio.ACCESS_FM_AM | system_core | system_grant | TRUE | 允许应用获取收音机相关服务。 | -| ohos.permission.SET_TELEPHONY_STATE | system_basic | system_grant | TRUE | 允许应用修改telephone的状态。 | -| ohos.permission.
START_ABILIIES_FROM_BACKGROUND | system_basic | system_grant | TRUE | 允许应用在后台启动FA。 | -| ohos.permission.BUNDLE_ACTIVE_INFO | system_basic | system_grant | TRUE | 允许系统应用查询其他应用在前台或后台的运行时间。 | -| ohos.permission.
START_INVISIBLE_ABILITY | system_core | system_grant | TRUE | 无论Ability是否可见，都允许应用进行调用。 | -| ohos.permission.sec.ACCESS_UDID | system_basic | system_grant | TRUE | 允许系统应用获取UDID。 | -| ohos.permission.
LAUNCH_DATA_PRIVACY_CENTER | system_basic | system_grant | TRUE | 允许应用从其隐私声明页面跳转至"数据与隐私"页面。 | -| ohos.permission.MANAGE_MEDIA_RESOURCES | system_basic | system_grant | TRUE | 允许应用程序获取当前设备正在播放的媒体资源，并对其进行管理。 | -| ohos.permission.PUBLISH_AGENT_REMINDER | normal | system_grant | TRUE | 允许该应用使用后台代理提醒。 | -| ohos.permission.
CONTROL_TASK_SYNC_ANIMATOR | system_core | system_grant | TRUE | 允许应用使用同步任务动画。 | -| ohos.permission.INPUT_MONITORING | system_core | system_grant | TRUE | 允许应用监听输入事件，仅系统签名应用可申请此权限。 | -| ohos.permission.MANAGE_MISSIONS | system_core | system_grant | TRUE | 允许用户管理元能力任务栈。 | -| ohos.permission.
NOTIFICATION_CONTROLLER | system_core | system_grant | TRUE | 允许应用管理通知和订阅通知。 | -| ohos.permission.CONNECTIVITY_INTERNAL | system_basic | system_grant | TRUE | 允许应用程序获取网络相关的信息或修改网络相关设置。 | -| ohos.permission.SET_ABILITY_CONTROLLER | system_basic | system_grant | TRUE | 允许设置ability组件启动和停止控制权。 | -| ohos.permission.USE_USER_IDM | system_basic | system_grant | FALSE | 允许应用访问系统身份凭据信息。 | -| ohos.permission.MANAGE_USER_IDM | system_basic | system_grant | FALSE | 允许应用使用系统身份凭据管理能力进行口令、人脸、指纹等录入、修改、删除等操作。 | -| ohos.permission.ACCESS_BIOMETRIC | normal | system_grant | TRUE | 允许应用使用生物特征识别能力进行身份认证。 | -| ohos.permission.
ACCESS_USER_AUTH_INTERNAL | system_basic | system_grant | FALSE | 允许应用使用系统身份认证能力进行用户身份认证或身份识别。 | -| ohos.permission.ACCESS_PIN_AUTH | system_basic | system_grant | FALSE | 允许应用使用口令输入接口，用于系统应用完成口令输入框绘制场景。 | -| ohos.permission.GET_RUNNING_INFO | system_basic | system_grant | TRUE | 允许应用获取运行态信息。 | -| ohos.permission.CLEAN_APPLICATION_DATA | system_basic | system_grant | TRUE | 允许应用清理应用数据。 | -| ohos.permission.RUNNING_STATE_OBSERVER | system_basic | system_grant | TRUE | 允许应用观察应用状态。 | -| ohos.permission.CAPTURE_SCREEN | system_core | system_grant | TRUE | 允许应用截取屏幕图像。 | -| ohos.permission.GET_WIFI_INFO | normal | system_grant | TRUE | 允许应用获取WLAN信息。 | -| ohos.permission.GET_WIFI_INFO_INTERNAL | system_core | system_grant | TRUE | 允许应用获取WLAN信息。 | -| ohos.permission.SET_WIFI_INFO | normal | system_grant | TRUE | 允许应用配置WLAN设备。 | -| ohos.permission.GET_WIFI_PEERS_MAC | system_core | system_grant | TRUE | 允许应用获取对端WLAN或者蓝牙设备的MAC地址。 | -| ohos.permission.GET_WIFI_LOCAL_MAC | system_basic | system_grant | TRUE | 允许应用获取本机WLAN或者蓝牙设备的MAC地址。 | -| ohos.permission.GET_WIFI_CONFIG | system_basic | system_grant | TRUE | 允许应用获取WLAN配置信息。 | -| ohos.permission.SET_WIFI_CONFIG | system_basic | system_grant | TRUE | 允许应用配置WLAN信息。 | -| ohos.permission.
MANAGE_WIFI_CONNECTION | system_core | system_grant | TRUE | 允许应用管理WLAN连接。 | -| ohos.permission.MANAGE_WIFI_HOTSPOT | system_core | system_grant | TRUE | 允许应用开启或者关闭WLAN热点。 | -| ohos.permission.GET_ALL_APP_ACCOUNTS | system_core | system_grant | FALSE | 允许应用获取所有应用账户信息。 | -| ohos.permission.MANAGE_SECURE_SETTINGS | system_basic | system_grant | TRUE | 允许应用修改安全类系统设置。 | -| ohos.permission.READ_DFX_SYSEVENT | system_basic | system_grant | TRUE | 允许应用访问系统事件打点数据。 | -| ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN | system_core | system_grant | TRUE | 允许应用激活设备管理员应用。 | -| ohos.permission.SET_ENTERPRISE_INFO | system_basic | system_grant | TRUE | 允许设备管理员应用设置企业信息。 | -| ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT | system_basic | system_grant | TRUE | 允许设备管理员应用订阅管理事件。 | -| ohos.permission.ENTERPRISE_SET_DATETIME | system_basic | system_grant | TRUE | 允许设备管理员应用设置系统时间。 | -| ohos.permission.ENTERPRISE_GET_DEVICE_INFO | system_basic | system_grant | TRUE | 允许设备管理员读取设备信息。 | -| ohos.permission.NFC_TAG | normal | system_grant | FALSE | 允许应用读取Tag卡片。 | -| ohos.permission.NFC_CARD_EMULATION | normal | system_grant | FALSE | 允许应用实现卡模拟功能。 | -| ohos.permission.PERMISSION_USED_STATS | system_basic | system_grant | TRUE | 允许系统应用访问权限使用记录。 | -| ohos.permission.
NOTIFICATION_AGENT_CONTROLLER | system_core | system_grant | TRUE | 允许应用发送代理通知。 | -| ohos.permission.ANSWER_CALL | system_basic | user_grant | TRUE | 允许应用接听来电。 | -| ohos.permission.READ_CALENDAR | normal | user_grant | TRUE | 允许应用读取日历信息。 | -| ohos.permission.READ_CALL_LOG | system_basic | user_grant | TRUE | 允许应用读取通话记录。 | -| ohos.permission.READ_CELL_MESSAGES | system_basic | user_grant | TRUE | 允许应用读取设备收到的小区广播信息。 | -| ohos.permission.READ_CONTACTS | system_basic | user_grant | TRUE | 允许应用读取联系人数据。 | -| ohos.permission.READ_MESSAGES | system_basic | user_grant | TRUE | 允许应用读取短信息。 | -| ohos.permission.RECEIVE_MMS | system_basic | user_grant | TRUE | 允许应用接收和处理彩信。 | -| ohos.permission.RECEIVE_SMS | system_basic | user_grant | TRUE | 允许应用接收和处理短信。 | -| ohos.permission.RECEIVE_WAP_MESSAGES | system_basic | user_grant | TRUE | 允许应用接收和处理WAP消息。 | -| ohos.permission.MICROPHONE | normal | user_grant | TRUE | 允许应用使用麦克风。 | -| ohos.permission.SEND_MESSAGES | system_basic | user_grant | TRUE | 允许应用发送短信。 | -| ohos.permission.WRITE_CALENDAR | normal | user_grant | TRUE | 允许应用添加、移除或更改日历活动。 | -| ohos.permission.WRITE_CALL_LOG | system_basic | user_grant | TRUE | 允许应用添加、移除或更改通话记录。 | -| ohos.permission.WRITE_CONTACTS | system_basic | user_grant | TRUE | 允许应用添加、移除或更改联系人数据。 | -| ohos.permission.DISTRIBUTED_DATASYNC | normal | user_grant | TRUE | 允许不同设备间的数据交换。 | -| ohos.permission.MANAGE_VOICEMAIL | system_basic | user_grant | TRUE | 允许应用在语音信箱中留言 | -| ohos.permission.
LOCATION_IN_BACKGROUND | normal | user_grant | FALSE | 允许应用在后台运行时获取设备位置信息。 | -| ohos.permission.LOCATION | normal | user_grant | TRUE | 允许应用获取设备位置信息。 | -| ohos.permission.APPROXIMATELY_LOCATION | normal | user_grant | FALSE | 允许应用获取设备模糊位置信息。 | -| ohos.permission.MEDIA_LOCATION | normal | user_grant | TRUE | 允许应用访问用户媒体文件中的地理位置信息。 | -| ohos.permission.CAMERA | normal | user_grant | TRUE | 允许应用使用相机拍摄照片和录制视频。 | -| ohos.permission.READ_MEDIA | normal | user_grant | TRUE | 允许应用读取用户外部存储中的媒体文件信息。 | -| ohos.permission.WRITE_MEDIA | normal | user_grant | TRUE | 允许应用读写用户外部存储中的媒体文件信息。 | -| ohos.permission.ACTIVITY_MOTION | normal | user_grant | TRUE | 允许应用读取用户当前的运动状态。 | -| ohos.permission.READ_HEALTH_DATA | normal | user_grant | TRUE | 允许应用读取用户的健康数据。 | -| ohos.permission.GET_DEFAULT_APPLICATION | system_core | system_grant | TRUE | 允许应用查询默认应用。 | -| ohos.permission.SET_DEFAULT_APPLICATION | system_core | system_grant | TRUE | 允许应用设置、重置默认应用。 | -| ohos.permission.
MANAGE_DISPOSED_APP_STATUS | system_core | system_grant | TRUE | 允许设置和查询应用的处置状态。 | -| ohos.permission.ACCESS_IDS | system_core | system_grant | TRUE | 允许应用查询设备的唯一标识符信息。 | -| ohos.permission.DUMP | system_core | system_grant | TRUE | 允许导出系统基础信息和SA服务信息。 | -| ohos.permission.
DISTRIBUTED_SOFTBUS_CENTER | system_basic | system_grant | FALSE | 允许不同设备之间进行组网处理。 | -| ohos.permission.ACCESS_DLP_FILE | system_core | system_grant | TRUE | 允许对DLP文件进行权限配置和管理。 | -| ohos.permission.PROVISIONING_MESSAGE | system_core | system_grant | TRUE | 允许激活超级设备管理器应用。 | -| ohos.permission.
ACCESS_SYSTEM_SETTINGS | system_basic | system_grant | TRUE | 允许应用接入或拉起系统设置界面。 | -| ohos.permission.READ_IMAGEVIDEO | system_basic | user_grant | TRUE | 允许读取用户公共目录的图片或视频文件。 | -| ohos.permission.READ_AUDIO | system_basic | user_grant | TRUE | 允许读取用户公共目录的音频文件。 | -| ohos.permission.READ_DOCUMENT | system_basic | user_grant | TRUE | 允许读取用户公共目录的文档。 | -| ohos.permission.WRITE_IMAGEVIDEO | system_basic | user_grant | TRUE | 允许修改用户公共目录的图片或视频文件。 | -| ohos.permission.WRITE_AUDIO | system_basic | user_grant | TRUE | 允许修改用户公共目录的音频文件。 | -| ohos.permission.WRITE_DOCUMENT | system_basic | user_grant | TRUE | 允许修改用户公共目录的文档。 | -| ohos.permission.
ABILITY_BACKGROUND_COMMUNICATION | system_basic | system_grant | TRUE | 允许应用将Ability组件在后台启动并与该Ability建立通信连接。 | -| ohos.permission.
securityguard.REPORT_SECURITY_INFO | system_basic | system_grant | FALSE | 允许应用上报风险数据至设备风险管理平台。 | -| ohos.permission.
securityguard.REQUEST_SECURITY_MODEL_RESULT | system_basic | system_grant | TRUE | 允许应用获取设备风险状态。 | -| ohos.permission.
securityguard.REQUEST_SECURITY_EVENT_INFO | system_core | system_grant | FALSE | 允许应用获取风险详细数据。 | -| ohos.permission.
READ_ACCESSIBILITY_CONFIG | system_basic | system_grant | FALSE | 允许应用读取无障碍配置信息。 | -| ohos.permission.
WRITE_ACCESSIBILITY_CONFIG | system_basic | system_grant | FALSE | 允许应用设置无障碍配置信息。 | -| ohos.permission.
ACCESS_CERT_MANAGER_INTERNAL | system_basic | system_grant | FALSE | 允许应用进行证书及凭据的安装、卸载、启用、禁用等操作。 | -| ohos.permission.
ACCESS_CERT_MANAGER | normal | system_grant | FALSE | 允许应用进行私有凭据的相关操作、查询证书状态等操作。 | -| ohos.permission.
ACCESS_PUSH_SERVICE | system_basic | system_grant | TRUE | 允许应用访问推送服务的Ability。 | -| ohos.permission.
RECEIVER_STARTUP_COMPLETED | system_basic | system_grant | FALSE | 允许应用订阅开机广播。 | -| ohos.permission.
MANAGE_CAMERA_CONFIG | system_basic | system_grant | FALSE | 允许应用进行全局相机开关等操作。 | -| ohos.permission.READ_WHOLE_CALENDAR | system_basic | uesr_grant | TRUE | 允许应用读取所有的日历信息。 | -| ohos.permission.WRITE_WHOLE_CALENDAR | system_basic | uesr_grant | TRUE | 允许应用添加、移除或更改所有的日历活动。 | -| ohos.permission.ENFORCE_USER_IAM | system_core | system_grant | TRUE | 允许SA无token删除IAM子系统用户信息。 | -| ohos.permission.ACCESS_AUTH_RESPOOL | system_core | system_grant | TRUE | 允许SA注册执行器。 | -| ohos.permission.MOUNT_UNMOUNT_MANAGER | system_basic | system_grant | FALSE | 允许应用对外卡进行挂载卸载操作。 | -| ohos.permission.MOUNT_FORMAT_MANAGER | system_basic | system_grant | FALSE | 允许应用对外卡进行格式化操作。 | -| ohos.permission.STORAGE_MANAGER | system_basic | system_grant | TRUE | 允许应用调用storage manager服务中对空间统计以及卷信息的查询接口。 | -| ohos.permission.BACKUP | system_basic | system_grant | TRUE | 允许应用拥有备份恢复能力。 | -| ohos.permission.FILE_ACCESS_MANAGER | system_basic | system_grant | TRUE | 允许文件管理类应用通过FAF框架访问公共数据文件。 | -| ohos.permission.MANAGE_AUDIO_CONFIG | system_basic | system_grant | TRUE | 允许应用进行全局麦克风静音等操作。 | -| ohos.permission.ACCESS_SERVICE_DM | system_basic | system_grant | TRUE | 允许系统应用获取分布式设备的认证组网能力。 | +## ohos.permission.USE_BLUETOOTH + +允许应用查看蓝牙的配置。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.DISCOVER_BLUETOOTH + +允许应用配置本地蓝牙，查找远端设备且与之配对连接。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_BLUETOOTH + +允许应用配对蓝牙设备，并对设备的电话簿或消息进行访问。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.INTERNET + +允许使用Internet网络。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MODIFY_AUDIO_SETTINGS + +允许应用修改音频设置。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCESS_NOTIFICATION_POLICY + +在本设备上允许应用访问通知策略。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.GET_TELEPHONY_STATE + +允许应用读取电话信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.REQUIRE_FORM + +允许应用获取Ability Form。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_NETWORK_INFO + +允许应用获取数据网络信息。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.PLACE_CALL + +允许应用直接拨打电话。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_NETWORK_INFO + +允许应用配置数据网络。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.REMOVE_CACHE_FILES + +允许清理指定应用的缓存。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.REBOOT + +允许应用重启设备。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.RUNNING_LOCK + +允许应用获取运行锁，保证应用在后台的持续运行。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_TIME + +允许应用修改系统时间。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_TIME_ZONE + +允许应用修改系统时区。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.DOWNLOAD_SESSION_MANAGER + +允许应用管理下载任务会话。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.COMMONEVENT_STICKY + +允许应用发布粘性公共事件。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SYSTEM_FLOAT_WINDOW + +允许应用使用悬浮窗的能力。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.PRIVACY_WINDOW + +允许应用将窗口设置为隐私窗口，禁止截屏录屏。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.POWER_MANAGER + +允许应用调用电源管理子系统的接口休眠或者唤醒设备。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.REFRESH_USER_ACTION + +允许应用在收到用户事件时，重新计算超时时间。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.POWER_OPTIMIZATION + +允许系统应用设置省电模式、获取省电模式的配置信息并接收配置变化的通知。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.REBOOT_RECOVERY + +允许系统应用重启设备并进入恢复模式。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_LOCAL_ACCOUNTS + +允许应用管理本地用户账号。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +允许多个系统账号之间相互访问。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.VIBRATE + +允许应用控制马达振动。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CONNECT_IME_ABILITY + +允许绑定输入法Ability（InputMethodAbility）。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CONNECT_SCREEN_SAVER_ABILITY + +允许绑定屏保Ability（ScreenSaverAbility）。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_SCREEN_SAVER + +允许应用查询屏保状态信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_SCREEN_SAVER + +允许应用修改屏保状态信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_WALLPAPER + +允许应用设置静态壁纸。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_WALLPAPER + +允许应用读取壁纸文件。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CHANGE_ABILITY_ENABLED_STATE + +允许改变应用或者组件的使能状态。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCESS_MISSIONS + +允许应用访问任务栈信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CLEAN_BACKGROUND_PROCESSES + +允许应用根据包名清理相关后台进程。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.KEEP_BACKGROUND_RUNNING + +允许Service Ability在后台持续运行。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.UPDATE_CONFIGURATION + +允许更新系统配置。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.UPDATE_SYSTEM + +允许调用升级接口。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.FACTORY_RESET + +允许调用恢复出厂接口。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GRANT_SENSITIVE_PERMISSIONS + +允许应用为其他应用授予敏感权限。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.REVOKE_SENSITIVE_PERMISSIONS + +允许应用撤销给其他应用授予的敏感信息。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_SENSITIVE_PERMISSIONS + +允许应用读取其他应用的敏感权限的状态。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION + +允许应用跨用户对其他应用的属性进行设置。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.LISTEN_BUNDLE_CHANGE + +允许应用监听其他应用安装、更新、卸载状态的变化。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_BUNDLE_INFO + +允许应用查询其他单个应用的信息。该权限仅适用于三方应用。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +允许应用同时查询其他多个应用的信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCELEROMETER + +允许应用读取加速度传感器的数据。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GYROSCOPE + +允许应用读取陀螺仪传感器的数据。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.INSTALL_BUNDLE + +允许应用安装、卸载其他应用。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_SHORTCUTS + +允许应用查询其他应用的快捷方式信息、启动其他应用的快捷方式。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.radio.ACCESS_FM_AM + +允许应用获取收音机相关服务。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_TELEPHONY_STATE + +允许应用修改telephone的状态。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.START_ABILIIES_FROM_BACKGROUND + +允许应用在后台启动FA。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.BUNDLE_ACTIVE_INFO + +允许系统应用查询其他应用在前台或后台的运行时间。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.START_INVISIBLE_ABILITY + +无论Ability是否可见，都允许应用进行调用。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.sec.ACCESS_UDID + +允许系统应用获取UDID。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.LAUNCH_DATA_PRIVACY_CENTER + +允许应用从其隐私声明页面跳转至"数据与隐私"页面。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_MEDIA_RESOURCES + +允许应用程序获取当前设备正在播放的媒体资源，并对其进行管理。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.PUBLISH_AGENT_REMINDER + +允许该应用使用后台代理提醒。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CONTROL_TASK_SYNC_ANIMATOR + +允许应用使用同步任务动画。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.INPUT_MONITORING + +允许应用监听输入事件，仅系统签名应用可申请此权限。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_MISSIONS + +允许用户管理元能力任务栈。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.NOTIFICATION_CONTROLLER + +允许应用管理通知和订阅通知。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CONNECTIVITY_INTERNAL + +允许应用程序获取网络相关的信息或修改网络相关设置。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_ABILITY_CONTROLLER + +允许设置ability组件启动和停止控制权。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.USE_USER_IDM + +允许应用访问系统身份凭据信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.MANAGE_USER_IDM + +允许应用使用系统身份凭据管理能力进行口令、人脸、指纹等录入、修改、删除等操作。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.ACCESS_BIOMETRIC + +允许应用使用生物特征识别能力进行身份认证。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCESS_USER_AUTH_INTERNAL + +允许应用使用系统身份认证能力进行用户身份认证或身份识别。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.ACCESS_PIN_AUTH + +允许应用使用口令输入接口，用于系统应用完成口令输入框绘制场景。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.GET_RUNNING_INFO + +允许应用获取运行态信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CLEAN_APPLICATION_DATA + +允许应用清理应用数据。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.RUNNING_STATE_OBSERVER + +允许应用观察应用状态。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.CAPTURE_SCREEN + +允许应用截取屏幕图像。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_WIFI_INFO + +允许应用获取WLAN信息。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_WIFI_INFO_INTERNAL + +允许应用获取WLAN信息。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_WIFI_INFO + +允许应用配置WLAN设备。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_WIFI_PEERS_MAC + +允许应用获取对端WLAN或者蓝牙设备的MAC地址。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_WIFI_LOCAL_MAC + +允许应用获取本机WLAN或者蓝牙设备的MAC地址。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_WIFI_CONFIG + +允许应用获取WLAN配置信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_WIFI_CONFIG + +允许应用配置WLAN信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_WIFI_CONNECTION + +允许应用管理WLAN连接。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_WIFI_HOTSPOT + +允许应用开启或者关闭WLAN热点。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_ALL_APP_ACCOUNTS + +允许应用获取所有应用账户信息。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.MANAGE_SECURE_SETTINGS + +允许应用修改安全类系统设置。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_DFX_SYSEVENT + +允许应用访问系统事件打点数据。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN + +允许应用激活设备管理员应用。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_ENTERPRISE_INFO + +允许设备管理员应用设置企业信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT + +允许设备管理员应用订阅管理事件。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ENTERPRISE_SET_DATETIME + +允许设备管理员应用设置系统时间。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ENTERPRISE_GET_DEVICE_INFO + +允许设备管理员读取设备信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.NFC_TAG + +允许应用读取Tag卡片。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.NFC_CARD_EMULATION + +允许应用实现卡模拟功能。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.PERMISSION_USED_STATS + +允许系统应用访问权限使用记录。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.NOTIFICATION_AGENT_CONTROLLER + +允许应用发送代理通知。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ANSWER_CALL + +允许应用接听来电。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_CALENDAR + +允许应用读取日历信息。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_CALL_LOG + +允许应用读取通话记录。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_CELL_MESSAGES + +允许应用读取设备收到的小区广播信息。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_CONTACTS + +允许应用读取联系人数据。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_MESSAGES + +允许应用读取短信息。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.RECEIVE_MMS + +允许应用接收和处理彩信。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.RECEIVE_SMS + +允许应用接收和处理短信。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.RECEIVE_WAP_MESSAGES + +允许应用接收和处理WAP消息。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.MICROPHONE + +允许应用使用麦克风。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.SEND_MESSAGES + +允许应用发送短信。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_CALENDAR + +允许应用添加、移除或更改日历活动。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_CALL_LOG + +允许应用添加、移除或更改通话记录。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_CONTACTS + +允许应用添加、移除或更改联系人数据。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.DISTRIBUTED_DATASYNC + +允许不同设备间的数据交换。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_VOICEMAIL + +允许应用在语音信箱中留言。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.LOCATION_IN_BACKGROUND + +允许应用在后台运行时获取设备位置信息。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：FALSE + +## ohos.permission.LOCATION + +允许应用获取设备位置信息。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.APPROXIMATELY_LOCATION + +允许应用获取设备模糊位置信息。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：FALSE + +## ohos.permission.MEDIA_LOCATION + +允许应用访问用户媒体文件中的地理位置信息。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.CAMERA + +允许应用使用相机拍摄照片和录制视频。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_MEDIA + +允许应用读取用户外部存储中的媒体文件信息。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_MEDIA + +允许应用读写用户外部存储中的媒体文件信息。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.ACTIVITY_MOTION + +允许应用读取用户当前的运动状态。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_HEALTH_DATA + +允许应用读取用户的健康数据。 + +**权限级别**：normal + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.GET_DEFAULT_APPLICATION + +允许应用查询默认应用。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.SET_DEFAULT_APPLICATION + +允许应用设置、重置默认应用。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_DISPOSED_APP_STATUS + +允许设置和查询应用的处置状态。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCESS_IDS + +允许应用查询设备的唯一标识符信息。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.DUMP + +允许导出系统基础信息和SA服务信息。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.DISTRIBUTED_SOFTBUS_CENTER + +允许不同设备之间进行组网处理。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.ACCESS_DLP_FILE + +允许对DLP文件进行权限配置和管理。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.PROVISIONING_MESSAGE + +允许激活超级设备管理器应用。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCESS_SYSTEM_SETTINGS + +允许应用接入或拉起系统设置界面。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_IMAGEVIDEO + +允许读取用户公共目录的图片或视频文件。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_AUDIO + +允许读取用户公共目录的音频文件。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.READ_DOCUMENT + +允许读取用户公共目录的文档。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_IMAGEVIDEO + +允许修改用户公共目录的图片或视频文件。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_AUDIO + +允许修改用户公共目录的音频文件。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_DOCUMENT + +允许修改用户公共目录的文档。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.ABILITY_BACKGROUND_COMMUNICATION + +允许应用将Ability组件在后台启动并与该Ability建立通信连接。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.securityguard.REPORT_SECURITY_INFO + +允许应用上报风险数据至设备风险管理平台。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.securityguard.REQUEST_SECURITY_MODEL_RESULT + +允许应用获取设备风险状态。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.securityguard.REQUEST_SECURITY_EVENT_INFO + +允许应用获取风险详细数据。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.READ_ACCESSIBILITY_CONFIG + +允许应用读取无障碍配置信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.WRITE_ACCESSIBILITY_CONFIG + +允许应用设置无障碍配置信息。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.ACCESS_CERT_MANAGER_INTERNAL + +允许应用进行证书及凭据的安装、卸载、启用、禁用等操作。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.ACCESS_CERT_MANAGER + +允许应用进行私有凭据的相关操作、查询证书状态等操作。 + +**权限级别**：normal + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.ACCESS_PUSH_SERVICE + +允许应用访问推送服务的Ability。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.RECEIVER_STARTUP_COMPLETED + +允许应用订阅开机广播。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.MANAGE_CAMERA_CONFIG + +允许应用进行全局相机开关等操作。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.READ_WHOLE_CALENDAR + +允许应用读取所有的日历信息。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.WRITE_WHOLE_CALENDAR + +允许应用添加、移除或更改所有的日历活动。 + +**权限级别**：system_basic + +**授权方式**：user_grant + +**ACL使能**：TRUE + +## ohos.permission.ENFORCE_USER_IAM + +允许SA无token删除IAM子系统用户信息。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCESS_AUTH_RESPOOL + +允许SA注册执行器。 + +**权限级别**：system_core + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MOUNT_UNMOUNT_MANAGER + +允许应用对外卡进行挂载卸载操作。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.MOUNT_FORMAT_MANAGER + +允许应用对外卡进行格式化操作。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：FALSE + +## ohos.permission.STORAGE_MANAGER + +允许应用调用storage manager服务中对空间统计以及卷信息的查询接口。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.BACKUP + +允许应用拥有备份恢复能力。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.FILE_ACCESS_MANAGER + +允许文件管理类应用通过FAF框架访问公共数据文件。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.MANAGE_AUDIO_CONFIG + +允许应用进行全局麦克风静音等操作。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE + +## ohos.permission.ACCESS_SERVICE_DM + +允许系统应用获取分布式设备的认证组网能力。 + +**权限级别**：system_basic + +**授权方式**：system_grant + +**ACL使能**：TRUE diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index 36a50595c91d121c2e94ae0eec96704685f135c7..696b37cdbe8cf8e81a6bfd593c1537e232918c1b 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -588,7 +588,6 @@ - [Counter](reference/arkui-ts/ts-container-counter.md) - [Flex](reference/arkui-ts/ts-container-flex.md) - [FlowItem](reference/arkui-ts/ts-container-flowitem.md) - - [GridContainer](reference/arkui-ts/ts-container-gridcontainer.md) - [GridCol](reference/arkui-ts/ts-container-gridcol.md) - [GridRow](reference/arkui-ts/ts-container-gridrow.md) - [Grid](reference/arkui-ts/ts-container-grid.md) @@ -651,7 +650,7 @@ - [枚举说明](reference/arkui-ts/ts-appendix-enums.md) - [类型说明](reference/arkui-ts/ts-types.md) - 已停止维护的组件 - - [GridContainer(栅格)](reference/arkui-ts/ts-container-gridcontainer.md) + - [GridContainer](reference/arkui-ts/ts-container-gridcontainer.md) - 组件参考（兼容JS的类Web开发范式） - 组件通用信息 - [通用属性](reference/arkui-js/js-components-common-attributes.md) @@ -1155,7 +1154,6 @@ - [@ohos.reminderAgent (后台代理提醒)](reference/apis/js-apis-reminderAgent.md) - [@ohos.systemParameter (系统属性)](reference/apis/js-apis-system-parameter.md) - [@ohos.usb (USB管理)](reference/apis/js-apis-usb-deprecated.md) - - [@ohos.workScheduler (延迟任务调度)](reference/apis/js-apis-workScheduler.md) - [@system.app (应用上下文)](reference/apis/js-apis-system-app.md) - [@system.battery (电量信息)](reference/apis/js-apis-system-battery.md) - [@system.bluetooth (蓝牙)](reference/apis/js-apis-system-bluetooth.md) @@ -1285,6 +1283,13 @@ - [Rawfile](reference/native-apis/rawfile.md) - [MindSpore](reference/native-apis/_mind_spore.md) - [NeuralNeworkRuntime](reference/native-apis/_neural_nework_runtime.md) + - [Avsession](reference/native-apis/avsession.md) + - [AudioDecoder](reference/native-apis/_audio_decoder.md) + - [AudioEncoder](reference/native-apis/_audio_encoder.md) + - [CodecBase](reference/native-apis/_codec_base.md) + - [VideoDecoder](reference/native-apis/_video_decoder.md) + - [VideoEncoder](reference/native-apis/_video_encoder.md) + - [Core](reference/native-apis/_core.md) - 头文件 - [drawing_bitmap.h](reference/native-apis/drawing__bitmap_8h.md) - [drawing_brush.h](reference/native-apis/drawing__brush_8h.md) @@ -1315,7 +1320,25 @@ - [types.h](reference/native-apis/types_8h.md) - [neural_network_runtime_type.h](reference/native-apis/neural__network__runtime__type_8h.md) - [neural_network_runtime.h](reference/native-apis/neural__network__runtime_8h.md) - - 结构体 + - [av_session.h](reference/native-apis/av__session_8h.md) + - [avcontrol_command.h](reference/native-apis/avcontrol__command_8h.md) + - [avmeta_data.h](reference/native-apis/avmeta__data_8h.md) + - [avplayback_state.h](reference/native-apis/avplayback__state_8h.md) + - [avsession_controller.h](reference/native-apis/avsession__controller_8h.md) + - [avsession_descriptor.h](reference/native-apis/avsession__descriptor_8h.md) + - [avsession_errors.h](reference/native-apis/avsession__errors_8h.md) + - [avsession_info.h](reference/native-apis/avsession__info_8h.md) + - [avsession_manager.h](reference/native-apis/avsession__manager_8h.md) + - [avsession_pixel_map.h](reference/native-apis/avsession__pixel__map_8h.md) + - [native_avcodec_audiodecoder.h](reference/native-apis/native__avcodec__audiodecoder_8h.md) + - [native_avcodec_audioencoder.h](reference/native-apis/native__avcodec__audioencoder_8h.md) + - [native_avcodec_base.h](reference/native-apis/native__avcodec__base_8h.md) + - [native_avcodec_videodecoder.h](reference/native-apis/native__avcodec__videodecoder_8h.md) + - [native_avcodec_videoencoder.h](reference/native-apis/native__avcodec__videoencoder_8h.md) + - [native_averrors.h](reference/native-apis/native__averrors_8h.md) + - [native_avformat.h](reference/native-apis/native__avformat_8h.md) + - [native_avmemory.h](reference/native-apis/native__avmemory_8h.md) + - 结构体 - [OH_Drawing_BitmapFormat](reference/native-apis/_o_h___drawing___bitmap_format.md) - [OH_NativeBuffer_Config](reference/native-apis/_o_h___native_buffer___config.md) - [OH_NativeXComponent_Callback](reference/native-apis/_o_h___native_x_component___callback.md) @@ -1336,6 +1359,23 @@ - [OH_NN_QuantParam](reference/native-apis/_o_h___n_n___quant_param.md) - [OH_NN_Tensor](reference/native-apis/_o_h___n_n___tensor.md) - [OH_NN_UInt32Array](reference/native-apis/_o_h___n_n___u_int32_array.md) + - [OH_AVCodecAsyncCallback](reference/native-apis/_o_h___a_v_codec_async_callback.md) + - [OH_AVCodecBufferAttr](reference/native-apis/_o_h___a_v_codec_buffer_attr.md) + - [OHOS::AVSession::AVControlCommand](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) + - [OHOS::AVSession::AVControllerCallback](reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md) + - [OHOS::AVSession::AVMetaData](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) + - [OHOS::AVSession::AVPlaybackState](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) + - [OHOS::AVSession::AVPlaybackState::Position](reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) + - [OHOS::AVSession::AVSession](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md) + - [OHOS::AVSession::AVSessionBasicInfo](reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md) + - [OHOS::AVSession::AVSessionCallback](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md) + - [OHOS::AVSession::AVSessionController](reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md) + - [OHOS::AVSession::AVSessionDescriptor](reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) + - [OHOS::AVSession::AVSessionManager](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md) + - [OHOS::AVSession::AVSessionPixelMap](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md) + - [OHOS::AVSession::OutputDeviceInfo](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) + - [OHOS::AVSession::SessionListener](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md) + - [OHOS::AVSession::SessionToken](reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md) - 标准库 - [Node_API](reference/native-lib/third_party_napi/napi.md) - [libuv](reference/native-lib/third_party_libuv/libuv.md) diff --git a/zh-cn/release-notes/changelogs/OpenHarmony_3.2.8.1/changelogs-resource-manager.md b/zh-cn/release-notes/changelogs/OpenHarmony_3.2.8.1/changelogs-resource-manager.md new file mode 100644 index 0000000000000000000000000000000000000000..304f2b27682745110b7f0b355fbf6cbff78487e7 --- /dev/null +++ b/zh-cn/release-notes/changelogs/OpenHarmony_3.2.8.1/changelogs-resource-manager.md @@ -0,0 +1,66 @@ +# 资源管理changeLog + +## cl.resourceManager.1 资源API9部分多工程接口命名变更 + +资源管理从API9开始提供接口的错误码和错误信息返回，涉及API9提供的部分多工程接口需要适配。从API9开始作以下变更： + +资源API部分多工程接口需要用新的接口替换，参数不变。 + +**变更影响** + +基于此前版本开发的应用，涉及下面多工程接口的JS接口需要替换为新的接口。 + +**关键接口/组件变更** + +| **涉及接口** | **对应替换接口** | +| ---------------- | ------------ | +| getString(resource: Resource,
callback: AsyncCallback\): void; | getStringValue(resource: Resource,
callback: AsyncCallback\): void; | +| getString(resource: Resource): Promise\; | getStringValue(resource: Resource): Promise\; | +| getStringArray(resource: Resource,
callback: AsyncCallback\>): void; | getStringArrayValue(resource: Resource,
callback: AsyncCallback\>): void; | +| getStringArray(resource: Resource): Promise\>; | getStringArrayValue(resource: Resource): Promise\>; | +| getMedia(resource: Resource,
callback: AsyncCallback\): void; | getMediaContent(resource: Resource,
callback: AsyncCallback\): void; | +| getMedia(resource: Resource): Promise\; | getMediaContent(resource: Resource): Promise\; | +| getMediaBase64(resource: Resource,
callback: AsyncCallback\): void; | getMediaContentBase64(resource: Resource,
callback: AsyncCallback\): void; | +| getMediaBase64(resource: Resource): Promise\; | getMediaContentBase64(resource: Resource): Promise\; | +| getPluralString(resource: Resource, num: number,
callback: AsyncCallback): void; | getPluralStringValue(resource: Resource, num: number,
callback: AsyncCallback\): void; | +| getPluralString(resource: Resource, num: number): Promise\; | getPluralStringValue(resource: Resource, num: number): Promise\; | + +**适配指导** + +以getMedia修改为getMediaContent的callback调用为例，其promise方式类似，只需修改函数名，且增加错误码和错误信息返回，其它不变。示例代码如下： + +- 变更前：getMedia(resource: Resource, callback: AsyncCallback): void; +```ts +let resource = { + bundleName: "com.example.myapplication", + moduleName: "entry", + id: $r('app.media.test').id +}; +this.context.resourceManager.getMedia(resource, (error, value) => { + if (error != null) { + console.log("error is " + error); + } else { + let media = value; + } +}); +``` + +- 变更后：getMediaContent(resource: Resource, callback: AsyncCallback): void; +```ts +let resource = { + bundleName: "com.example.myapplication", + moduleName: "entry", + id: $r('app.media.test').id +}; +try { + this.context.resourceManager.getMediaContent(resource, (error, value) => { + if (error != null) { + console.log("error is " + error); + } else { + let media = value; + } + }); +} catch (error) { + console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`) +} +```