提交 cc012fe6 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 bbc6c2c0
...@@ -283,7 +283,7 @@ For details about the audio playback demo, see [Audio Playback Development](../. ...@@ -283,7 +283,7 @@ For details about the audio playback demo, see [Audio Playback Development](../.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ | | ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| src | string | Yes | Yes | Audio media URI. The mainstream audio formats (MPEG-4, AAC, MPEG-3, OGG, and WAV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.| | src | string | Yes | Yes | Audio media URI. The mainstream audio formats (MPEG-4, AAC, MPEG-3, OGG, and WAV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly. |
| loop | boolean | Yes | Yes | Whether to loop audio playback. The value **true** means to loop audio playback, and **false** means the opposite. | | loop | boolean | Yes | Yes | Whether to loop audio playback. The value **true** means to loop audio playback, and **false** means the opposite. |
| currentTime | number | Yes | No | Current audio playback position. | | currentTime | number | Yes | No | Current audio playback position. |
| duration | number | Yes | No | Audio duration. | | duration | number | Yes | No | Audio duration. |
...@@ -677,7 +677,7 @@ For details about the video playback demo, see [Video Playback Development](../. ...@@ -677,7 +677,7 @@ For details about the video playback demo, see [Video Playback Development](../.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ | | ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| url<sup>8+</sup> | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.| | url<sup>8+</sup> | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly. |
| loop<sup>8+</sup> | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. | | loop<sup>8+</sup> | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. |
| currentTime<sup>8+</sup> | number | Yes | No | Current video playback position. | | currentTime<sup>8+</sup> | number | Yes | No | Current video playback position. |
| duration<sup>8+</sup> | number | Yes | No | Video duration. The value **-1** indicates the live streaming mode. | | duration<sup>8+</sup> | number | Yes | No | Video duration. The value **-1** indicates the live streaming mode. |
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
......
...@@ -39,7 +39,7 @@ image.createPixelMap(Color, opts) ...@@ -39,7 +39,7 @@ image.createPixelMap(Color, opts)
## image.createPixelMap<sup>8+</sup> ## image.createPixelMap<sup>8+</sup>
createPixelMap(colors: ArrayBuffer, opts: InitializetionOptions) callback: AsyncCallback\<PixelMap>): void createPixelMap(colors: ArrayBuffer, options: InitializetionOptions, callback: AsyncCallback\<PixelMap>): void
通过属性创建PixelMap,通过回调函数返回结果。 通过属性创建PixelMap,通过回调函数返回结果。
...@@ -799,7 +799,7 @@ const imagePackerApi = image.createImagePacker(); ...@@ -799,7 +799,7 @@ const imagePackerApi = image.createImagePacker();
### packing ### packing
packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Array\<number>>): void packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Array\<ArrayBuffer>>): void
图片压缩或重新打包,使用callback形式返回结果。 图片压缩或重新打包,使用callback形式返回结果。
...@@ -807,11 +807,11 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Arra ...@@ -807,11 +807,11 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Arra
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------- | | -------- | ---------------------------------- | ---- | ---------------------------------- |
| source | [ImageSource](#imagesource) | 是 | 打包的图片源。 | | source | [ImageSource](#imagesource) | 是 | 打包的图片源。 |
| option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 |
| callback | AsyncCallback<Array\<number>> | 是 | 获取图片打包回调,返回打包后数据。 | | callback | AsyncCallback<Array\<ArrayBuffer>> | 是 | 获取图片打包回调,返回打包后数据。 |
**示例:** **示例:**
...@@ -822,7 +822,7 @@ imagePackerApi.packing(imageSourceApi, packOpts, data => {}) ...@@ -822,7 +822,7 @@ imagePackerApi.packing(imageSourceApi, packOpts, data => {})
### packing ### packing
packing(source: ImageSource, option: PackingOption): Promise<Array\<number>> packing(source: ImageSource, option: PackingOption): Promise<Array\<ArrayBuffer>>
图片压缩或重新打包,使用Promise形式返回结果。 图片压缩或重新打包,使用Promise形式返回结果。
...@@ -837,9 +837,9 @@ packing(source: ImageSource, option: PackingOption): Promise<Array\<number>> ...@@ -837,9 +837,9 @@ packing(source: ImageSource, option: PackingOption): Promise<Array\<number>>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :---------------------- | :-------------------------------------------- | | :--------------------------- | :-------------------------------------------- |
| Promise<Array\<number>> | Promise实例,用于异步获取压缩或打包后的数据。 | | Promise<Array\<ArrayBuffer>> | Promise实例,用于异步获取压缩或打包后的数据。 |
**示例:** **示例:**
...@@ -852,7 +852,7 @@ imagePackerApi.packing(imageSourceApi, packOpts) ...@@ -852,7 +852,7 @@ imagePackerApi.packing(imageSourceApi, packOpts)
### packing ### packing
packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBuffer>): void; packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\<ArrayBuffer>): void
图片压缩或重新打包,使用callback形式返回结果。 图片压缩或重新打包,使用callback形式返回结果。
...@@ -864,7 +864,7 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBu ...@@ -864,7 +864,7 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBu
| -------- | ------------------------------- | ---- | ---------------------------------- | | -------- | ------------------------------- | ---- | ---------------------------------- |
| source | [PixelMap](#pixelmap) | 是 | 打包的PixelMap资源。 | | source | [PixelMap](#pixelmap) | 是 | 打包的PixelMap资源。 |
| option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 |
| callback | AsyncCallback<ArrayBuffer> | 是 | 获取图片打包回调,返回打包后数据。 | | callback | AsyncCallback\<ArrayBuffer> | 是 | 获取图片打包回调,返回打包后数据。 |
**示例:** **示例:**
...@@ -875,7 +875,7 @@ imagePackerApi.packing(pixelMapApi, packOpts, data => {}) ...@@ -875,7 +875,7 @@ imagePackerApi.packing(pixelMapApi, packOpts, data => {})
### packing ### packing
packing(source: PixelMap, option: PackingOption): Promise<Array\<number>> packing(source: PixelMap, option: PackingOption): Promise<Array\<ArrayBuffer>>
图片压缩或重新打包,使用Promise形式返回结果。 图片压缩或重新打包,使用Promise形式返回结果。
...@@ -890,9 +890,9 @@ packing(source: PixelMap, option: PackingOption): Promise<Array\<number>> ...@@ -890,9 +890,9 @@ packing(source: PixelMap, option: PackingOption): Promise<Array\<number>>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :---------------------- | :-------------------------------------------- | | :--------------------------- | :-------------------------------------------- |
| Promise<Array\<number>> | Promise实例,用于异步获取压缩或打包后的数据。 | | Promise<Array\<ArrayBuffer>> | Promise实例,用于异步获取压缩或打包后的数据。 |
**示例:** **示例:**
......
...@@ -1733,23 +1733,23 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number ...@@ -1733,23 +1733,23 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------------------ | ---- | --------------------------------- | | ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------- |
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| localName | string | 是 | 系统帐号名称。 | | localName | string | 是 | 系统帐号名称。 |
| type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 | | type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 |
| constraints | Array&lt;string&gt; | 否 | 系统帐号[约束](#系统帐号约束列表) | | constraints | Array&lt;string&gt; | 否 | 系统帐号[约束](#系统帐号约束列表) |
| isVerified | boolean | 是 | 帐号是否锁屏 | | isVerified<sup>8+</sup> | boolean | 是 | 帐号是否锁屏 |
| photo | string | 否 | 系统帐号头像 | | photo<sup>8+</sup> | string | 否 | 系统帐号头像 |
| createTime | number | 是 | 系统帐号创建时间 | | createTime<sup>8+</sup> | number | 是 | 系统帐号创建时间 |
| lastLoginTime | number | 否 | 系统帐号最后一次登录时间 | | lastLoginTime<sup>8+</sup> | number | 否 | 系统帐号最后一次登录时间 |
| serialNumber | number | 是 | 系统帐号SN码 | | serialNumber<sup>8+</sup> | number | 是 | 系统帐号SN码 |
| isActived | boolean | 是 | 系统帐号激活状态 | | isActived<sup>8+</sup> | boolean | 是 | 系统帐号激活状态 |
| isCreateCompleted | boolean | 是 | 系统帐号创建是否完整 | | isCreateCompleted<sup>8+</sup> | boolean | 是 | 系统帐号创建是否完整 |
| distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 | | distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 | | domainInfo<sup>8+</sup> | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 |
## DomainAccountInfo ## DomainAccountInfo<sup>8+</sup>
域帐号信息。 域帐号信息。
......
...@@ -329,6 +329,8 @@ that.parse(options); ...@@ -329,6 +329,8 @@ that.parse(options);
xml解析选项。 xml解析选项。
### 属性
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| supportDoctype | boolean | 否 | 是否忽略Doctype&nbsp;,&nbsp;默认false。 | | supportDoctype | boolean | 否 | 是否忽略Doctype&nbsp;,&nbsp;默认false。 |
...@@ -337,7 +339,6 @@ xml解析选项。 ...@@ -337,7 +339,6 @@ xml解析选项。
| attributeValueCallbackFunction | (name:&nbsp;string,&nbsp;value:&nbsp;string)=&gt;&nbsp;boolean | 否 | 获取attributeValue回调函数。 | | attributeValueCallbackFunction | (name:&nbsp;string,&nbsp;value:&nbsp;string)=&gt;&nbsp;boolean | 否 | 获取attributeValue回调函数。 |
| tokenValueCallbackFunction | (eventType:&nbsp;[EventType](#eventtype),&nbsp;value:&nbsp;[ParseInfo](#parseinfo))=&gt;&nbsp;boolean | 否 | 获取tokenValue回调函数。 | | tokenValueCallbackFunction | (eventType:&nbsp;[EventType](#eventtype),&nbsp;value:&nbsp;[ParseInfo](#parseinfo))=&gt;&nbsp;boolean | 否 | 获取tokenValue回调函数。 |
## ParseInfo ## ParseInfo
当前xml解析信息。 当前xml解析信息。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册