提交 6676dcc2 编写于 作者: Z zengyawen

update window napis

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 90805894
...@@ -66,7 +66,7 @@ activateOsAccount(localId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -66,7 +66,7 @@ activateOsAccount(localId: number, callback: AsyncCallback&lt;void&gt;): void
| localId | number | 是 | 要激活的系统帐号ID。 | | localId | number | 是 | 要激活的系统帐号ID。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**示例:**激活ID为100的系统帐号 **示例:** 激活ID为100的系统帐号
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
let localId = 100; let localId = 100;
...@@ -99,7 +99,7 @@ activateOsAccount(localId: number): Promise&lt;void&gt; ...@@ -99,7 +99,7 @@ activateOsAccount(localId: number): Promise&lt;void&gt;
| :------------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
**示例:**激活ID为100的系统帐号 **示例:** 激活ID为100的系统帐号
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
let localId = 100; let localId = 100;
...@@ -176,7 +176,7 @@ isOsAccountActived(localId: number, callback: AsyncCallback&lt;boolean&gt;): voi ...@@ -176,7 +176,7 @@ isOsAccountActived(localId: number, callback: AsyncCallback&lt;boolean&gt;): voi
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果,处于激活状态则返回true,否则返回false。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果,处于激活状态则返回true,否则返回false。 |
**示例:**判断ID为100的系统帐号是否处于激活状态 **示例:** 判断ID为100的系统帐号是否处于激活状态
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -209,7 +209,7 @@ isOsAccountActived(localId: number): Promise&lt;boolean&gt; ...@@ -209,7 +209,7 @@ isOsAccountActived(localId: number): Promise&lt;boolean&gt;
| :--------------------- | :----------------------------------------------------------- | | :--------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例,用于获取异步返回结果,处于激活状态则返回true,否则返回false。 | | Promise&lt;boolean&gt; | Promise实例,用于获取异步返回结果,处于激活状态则返回true,否则返回false。 |
**示例:**判断ID为100的系统帐号是否处于激活状态 **示例:** 判断ID为100的系统帐号是否处于激活状态
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -239,7 +239,7 @@ isOsAccountConstraintEnable(localId: number, constraint: string, callback: Async ...@@ -239,7 +239,7 @@ isOsAccountConstraintEnable(localId: number, constraint: string, callback: Async
| constraint | string | 是 | 指定的[约束](#系统帐号约束列表)名称。 | | constraint | string | 是 | 指定的[约束](#系统帐号约束列表)名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果,具有指定约束则返回true,否则返回false。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果,具有指定约束则返回true,否则返回false。 |
**示例:**判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束 **示例:** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -273,7 +273,7 @@ isOsAccountConstraintEnable(localId: number, constraint: string): Promise&lt;boo ...@@ -273,7 +273,7 @@ isOsAccountConstraintEnable(localId: number, constraint: string): Promise&lt;boo
| :--------------------- | :----------------------------------------------------------- | | :--------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例,用于获取异步返回结果,具有指定约束则返回true,否则返回false。 | | Promise&lt;boolean&gt; | Promise实例,用于获取异步返回结果,具有指定约束则返回true,否则返回false。 |
**示例:**判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束 **示例:** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -506,7 +506,7 @@ setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enabl ...@@ -506,7 +506,7 @@ setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enabl
| enable | boolean | 是 | 设置(true)/删除(false) | | enable | boolean | 是 | 设置(true)/删除(false) |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**示例:**给ID为100的系统帐号设置禁止使用Wi-Fi的约束 **示例:** 给ID为100的系统帐号设置禁止使用Wi-Fi的约束
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -542,7 +542,7 @@ setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enabl ...@@ -542,7 +542,7 @@ setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enabl
| :------------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
**示例:**删除ID为100的系统帐号的禁止使用Wi-Fi的约束 **示例:** 删除ID为100的系统帐号的禁止使用Wi-Fi的约束
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -574,7 +574,7 @@ setOsAccountName(localId: number, localName: string, callback: AsyncCallback&lt; ...@@ -574,7 +574,7 @@ setOsAccountName(localId: number, localName: string, callback: AsyncCallback&lt;
| localName | string | 是 | 帐号名。 | | localName | string | 是 | 帐号名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**示例:**将ID为100的系统帐号的帐号名设置成demoName **示例:** 将ID为100的系统帐号的帐号名设置成demoName
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -610,7 +610,7 @@ setOsAccountName(localId: number, localName: string): Promise&lt;void&gt; ...@@ -610,7 +610,7 @@ setOsAccountName(localId: number, localName: string): Promise&lt;void&gt;
| :------------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
**示例:**将ID为100的系统帐号的帐号名设置成demoName **示例:** 将ID为100的系统帐号的帐号名设置成demoName
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -740,7 +740,7 @@ getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;): ...@@ -740,7 +740,7 @@ getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;):
| uid | number | 是 | 进程uid。 | | uid | number | 是 | 进程uid。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果,返回的是uid所属的系统帐号的帐号ID。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调结果,返回的是uid所属的系统帐号的帐号ID。 |
**示例:**查询值为12345678的uid所属的系统帐号的帐号ID **示例:** 查询值为12345678的uid所属的系统帐号的帐号ID
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -771,7 +771,7 @@ getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt; ...@@ -771,7 +771,7 @@ getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt;
| :-------------------- | :----------------------------------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是uid所属的系统帐号的帐号ID。 | | Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是uid所属的系统帐号的帐号ID。 |
**示例:**查询值为12345678的uid所属的系统帐号的帐号ID **示例:** 查询值为12345678的uid所属的系统帐号的帐号ID
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -915,7 +915,7 @@ getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt; ...@@ -915,7 +915,7 @@ getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调结果,返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调结果,返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |
**示例:**获取ID为100的系统帐号的全部约束 **示例:** 获取ID为100的系统帐号的全部约束
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -948,7 +948,7 @@ getOsAccountAllConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt; ...@@ -948,7 +948,7 @@ getOsAccountAllConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt;
| :--------------------------------- | :----------------------------------------------------------- | | :--------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例,用于获取异步返回结果,返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 | | Promise&lt;Array&lt;string&gt;&gt; | Promise实例,用于获取异步返回结果,返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |
**示例:**获取ID为100的系统帐号的全部约束 **示例:** 获取ID为100的系统帐号的全部约束
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1275,7 +1275,7 @@ queryOsAccountById(localId: number, callback: AsyncCallback&lt;OsAccountInfo&gt; ...@@ -1275,7 +1275,7 @@ queryOsAccountById(localId: number, callback: AsyncCallback&lt;OsAccountInfo&gt;
| localId | number | 是 | 要查询的系统帐号的ID | | localId | number | 是 | 要查询的系统帐号的ID |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果,返回的是查到的系统帐号的信息。 | | callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果,返回的是查到的系统帐号的信息。 |
**示例:**查询ID为100的系统帐号信息 **示例:** 查询ID为100的系统帐号信息
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1310,7 +1310,7 @@ queryOsAccountById(localId: number): Promise&lt;OsAccountInfo&gt; ...@@ -1310,7 +1310,7 @@ queryOsAccountById(localId: number): Promise&lt;OsAccountInfo&gt;
| :--------------------------------------------- | :----------------------------------------------------------- | | :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例,用于获取异步返回结果,返回的是查到的系统帐号的信息。 | | Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例,用于获取异步返回结果,返回的是查到的系统帐号的信息。 |
**示例:**查询ID为100的系统帐号信息 **示例:** 查询ID为100的系统帐号信息
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1443,7 +1443,7 @@ getOsAccountProfilePhoto(localId: number, callback: AsyncCallback&lt;string&gt;) ...@@ -1443,7 +1443,7 @@ getOsAccountProfilePhoto(localId: number, callback: AsyncCallback&lt;string&gt;)
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调结果,返回的是该系统帐号的头像信息。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调结果,返回的是该系统帐号的头像信息。 |
**示例:**获取ID为100的系统帐号的头像 **示例:** 获取ID为100的系统帐号的头像
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1478,7 +1478,7 @@ getOsAccountProfilePhoto(localId: number): Promise&lt;string&gt; ...@@ -1478,7 +1478,7 @@ getOsAccountProfilePhoto(localId: number): Promise&lt;string&gt;
| :-------------------- | :----------------------------------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;string&gt; | Promise实例,用于获取异步返回结果,返回的是该系统帐号的头像信息。 | | Promise&lt;string&gt; | Promise实例,用于获取异步返回结果,返回的是该系统帐号的头像信息。 |
**示例:**获取ID为100的系统帐号的头像 **示例:** 获取ID为100的系统帐号的头像
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1510,7 +1510,7 @@ setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback ...@@ -1510,7 +1510,7 @@ setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback
| photo | string | 是 | 头像信息。 | | photo | string | 是 | 头像信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**示例:**给ID为100的系统帐号设置头像 **示例:** 给ID为100的系统帐号设置头像
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1549,7 +1549,7 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt; ...@@ -1549,7 +1549,7 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt;
| :------------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
**示例:**给ID为100的系统帐号设置头像 **示例:** 给ID为100的系统帐号设置头像
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1580,7 +1580,7 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback& ...@@ -1580,7 +1580,7 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&
| serialNumber | number | 是 | 帐号SN码。 | | serialNumber | number | 是 | 帐号SN码。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果,返回的是与SN码关联的系统帐号的帐号ID。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调结果,返回的是与SN码关联的系统帐号的帐号ID。 |
**示例:**查询与SN码12345关联的系统帐号的ID **示例:** 查询与SN码12345关联的系统帐号的ID
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1611,7 +1611,7 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt; ...@@ -1611,7 +1611,7 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt;
| :-------------------- | :----------------------------------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是与SN码关联的系统帐号的帐号ID。 | | Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是与SN码关联的系统帐号的帐号ID。 |
**示例:**查询与SN码12345关联的系统帐号的ID **示例:** 查询与SN码12345关联的系统帐号的ID
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1638,7 +1638,7 @@ getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;nu ...@@ -1638,7 +1638,7 @@ getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;nu
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果,返回的是与该系统帐号关联的SN码。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调结果,返回的是与该系统帐号关联的SN码。 |
**示例:**获取ID为100的系统帐号关联的SN码 **示例:** 获取ID为100的系统帐号关联的SN码
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
...@@ -1669,7 +1669,7 @@ getSerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt; ...@@ -1669,7 +1669,7 @@ getSerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt;
| :-------------------- | :----------------------------------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是与该系统帐号关联的SN码。 | | Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是与该系统帐号关联的SN码。 |
**示例:**获取ID为100的系统帐号关联的SN码 **示例:** 获取ID为100的系统帐号关联的SN码
```js ```js
let accountManager = account_osAccount.getAccountManager(); let accountManager = account_osAccount.getAccountManager();
......
...@@ -39,5 +39,9 @@ ...@@ -39,5 +39,9 @@
- [OH_NativeXComponent_MouseEvent_Callback](_o_h___native_x_component___mouse_event___callback.md) - [OH_NativeXComponent_MouseEvent_Callback](_o_h___native_x_component___mouse_event___callback.md)
- [OH_NativeXComponent_TouchEvent](_o_h___native_x_component___touch_event.md) - [OH_NativeXComponent_TouchEvent](_o_h___native_x_component___touch_event.md)
- [OH_NativeXComponent_TouchPoint](_o_h___native_x_component___touch_point.md) - [OH_NativeXComponent_TouchPoint](_o_h___native_x_component___touch_point.md)
- [OHExtDataHandle](_o_h_ext_data_handle.md)
- [OHHDRMetaData](_o_h_h_d_r_meta_data.md)
- [OhosPixelMapInfo](_ohos_pixel_map_info.md) - [OhosPixelMapInfo](_ohos_pixel_map_info.md)
- [RawFileDescriptor](_raw_file_descriptor.md) - [RawFileDescriptor](_raw_file_descriptor.md)
- [Region](_region.md)
- [Rect](_rect.md)
...@@ -110,7 +110,7 @@ DEBUG级别写日志,宏封装接口。 ...@@ -110,7 +110,7 @@ DEBUG级别写日志,宏封装接口。
**参数:** **参数:**
| Name | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 | | type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | | fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...@@ -140,7 +140,7 @@ ERROR级别写日志,宏封装接口。 ...@@ -140,7 +140,7 @@ ERROR级别写日志,宏封装接口。
**参数:** **参数:**
| Name | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 | | type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | | fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...@@ -170,7 +170,7 @@ FATAL级别写日志,宏封装接口。 ...@@ -170,7 +170,7 @@ FATAL级别写日志,宏封装接口。
**参数:** **参数:**
| Name | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 | | type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | | fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...@@ -200,7 +200,7 @@ INFO级别写日志,宏封装接口。 ...@@ -200,7 +200,7 @@ INFO级别写日志,宏封装接口。
**参数:** **参数:**
| Name | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 | | type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | | fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...@@ -230,7 +230,7 @@ WARN级别写日志,宏封装接口。 ...@@ -230,7 +230,7 @@ WARN级别写日志,宏封装接口。
**参数:** **参数:**
| Name | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 | | type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 | | fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...@@ -324,7 +324,7 @@ bool OH_LOG_IsLoggable (unsigned int domain, const char * tag, LogLevel level ) ...@@ -324,7 +324,7 @@ bool OH_LOG_IsLoggable (unsigned int domain, const char * tag, LogLevel level )
**参数:** **参数:**
| Name | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| domain | 指定日志业务领域。 | | domain | 指定日志业务领域。 |
| tag | 指定日志TAG。 | | tag | 指定日志TAG。 |
...@@ -354,7 +354,7 @@ int OH_LOG_Print (LogType type, LogLevel level, unsigned int domain, const char ...@@ -354,7 +354,7 @@ int OH_LOG_Print (LogType type, LogLevel level, unsigned int domain, const char
**参数:** **参数:**
| Name | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 | | type | 日志类型,三方应用日志类型为LOG_APP。 |
| level | 日志级别,日志级别包括LOG_DEBUG、LOG_INFO、LOG_WARN、LOG_ERROR、LOG_FATAL。 | | level | 日志级别,日志级别包括LOG_DEBUG、LOG_INFO、LOG_WARN、LOG_ERROR、LOG_FATAL。 |
......
# OHExtDataHandle
## 概述
扩展数据句柄结构体定义。
**相关模块:**
[NativeWindow](_native_window.md)
## 汇总
### 成员变量
| 成员变量名称 | 描述 |
| -------- | -------- |
| [fd](#fd) | 句柄 Fd, -1代表不支持 |
| [reserveInts](#reserveints) | Reserve数组的个数 |
| [reserve](#reserve) [0] | Reserve数组 |
## 结构体成员变量说明
### fd
```
int32_t OHExtDataHandle::fd
```
**描述:**
句柄 Fd, -1代表不支持
### reserve
```
int32_t OHExtDataHandle::reserve[0]
```
**描述:**
Reserve数组
### reserveInts
```
uint32_t OHExtDataHandle::reserveInts
```
**描述:**
Reserve数组的个数
# OHHDRMetaData
## 概述
扩展数据句柄结构体定义。
**相关模块:**
[NativeWindow](_native_window.md)
## 汇总
### 成员变量
| 成员变量名称 | 描述 |
| -------- | -------- |
| [key](#key) | HDR元数据关键字 |
| [value](#value) | 关键字对应的值 |
## 结构体成员变量说明
### key
```
OHHDRMetadataKey OHHDRMetaData::key
```
**描述:**
HDR元数据关键字
### value
```
float OHHDRMetaData::value
```
**描述:**
关键字对应的值
# Rect
## 概述
矩形区域。
**相关模块:**
[NativeWindow](_native_window.md)
## 汇总
### 成员变量
| 成员变量名称 | 描述 |
| -------- | -------- |
| [x](#x) | 矩形框起始x坐标。 |
| [y](#y) | 矩形框起始y坐标。 |
| [w](#w) | 矩形框宽度。 |
| [h](#h) | 矩形框高度。 |
### x
```
int32_t Rect::x
```
**描述:**
矩形框起始x坐标。
### y
```
int32_t Rect::y
```
**描述:**
矩形框起始y坐标。
### w
```
uint32_t Rext::w
```
**描述:**
矩形框宽度。
### h
```
uint32_t Rect::h
```
**描述:**
矩形框高度。
# Region
## 概述
表示本地窗口NativeWindow需要更新内容的矩形区域(脏区)。
**相关模块:**
[NativeWindow](_native_window.md)
## 汇总
### 成员变量
| 成员变量名称 | 描述 |
| -------- | -------- |
| [*rects](#rects) | 如果rects是空指针nullptr, 默认Buffer大小为脏区。 |
| [rectNumber](#rectnumber) | 如果rectNumber为0,默认Buffer大小为脏区。 |
### rectNumber
```
int32_t Region::rectNumber
```
**描述:**
如果rectNumber为0,默认Buffer大小为脏区。
### \*rects
```
struct Rect Region::*rects
```
**描述:**
结构体指针,类型为[Rect](_rect.md)。如果rects是空指针nullptr, 默认Buffer大小为脏区。
<!--no_check-->
\ No newline at end of file
...@@ -17,19 +17,51 @@ ...@@ -17,19 +17,51 @@
## 汇总 ## 汇总
### 结构体
| 结构体名称 | 描述 |
| -------- | -------- |
| [Region](_region.md) | 表示本地窗口NativeWindow需要更新内容的矩形区域(脏区)。 |
| [Region::Rect](_rect.md) | 矩形区域。 |
| [OHHDRMetaData](_o_h_h_d_r_meta_data.md) | HDR元数据结构体定义 。 |
| [OHExtDataHandle](_o_h_ext_data_handle.md) | 扩展数据句柄结构体定义 。 |
### 类型定义
| 类型定义名称 | 描述 |
| -------- | -------- |
| OHNativeWindow | 提供对NativeWindow的访问功能 |
| OHNativeWindowBuffer | 提供对NativeWindowBuffer的访问功能 |
| [Region](_region.md) | 表示本地窗口NativeWindow需要更新内容的矩形区域(脏区) |
### 枚举
| 枚举名称 | 描述 |
| -------- | -------- |
| [NativeWindowOperation](_native_window.md#nativewindowoperation) { SET_BUFFER_GEOMETRY, GET_BUFFER_GEOMETRY, GET_FORMAT, SET_FORMAT, GET_USAGE, SET_USAGE, SET_STRIDE, GET_STRIDE, SET_SWAP_INTERVAL, GET_SWAP_INTERVAL, SET_TIMEOUT, GET_TIMEOUT, SET_COLOR_GAMUT, GET_COLOR_GAMUT, SET_TRANSFORM, GET_TRANSFORM, SET_UI_TIMESTAMP } | OH_NativeWindow_NativeWindowHandleOpt函数中的操作码 |
| [OHScalingMode](_native_window.md#ohscalingmode) { OH_SCALING_MODE_FREEZE = 0, OH_SCALING_MODE_SCALE_TO_WINDOW, OH_SCALING_MODE_SCALE_CROP, OH_SCALING_MODE_NO_SCALE_CROP } | 缩放模式 Scaling Mode |
| [OHHDRMetadataKey](_native_window.md#ohhdrmetadatakey) { OH_METAKEY_RED_PRIMARY_X = 0, OH_METAKEY_RED_PRIMARY_Y = 1, OH_METAKEY_GREEN_PRIMARY_X = 2, OH_METAKEY_GREEN_PRIMARY_Y = 3, OH_METAKEY_BLUE_PRIMARY_X = 4, OH_METAKEY_BLUE_PRIMARY_Y = 5, OH_METAKEY_WHITE_PRIMARY_X = 6, OH_METAKEY_WHITE_PRIMARY_Y = 7, OH_METAKEY_MAX_LUMINANCE = 8, OH_METAKEY_MIN_LUMINANCE = 9, OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11, OH_METAKEY_HDR10_PLUS = 12, OH_METAKEY_HDR_VIVID = 13 } | 枚举HDR元数据关键字 |
### 函数 ### 函数
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_NativeWindow_CreateNativeWindowFromSurface](_native_window.md#oh_nativewindow_createnativewindowfromsurface) (void \*pSurface) | 创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例 | | [OH_NativeWindow_CreateNativeWindow](_native_window.md#oh_nativewindow_createnativewindow) (void \*pSurface) | 创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例 |
| [OH_NativeWindow_DestroyNativeWindow](_native_window.md#oh_nativewindow_destroynativewindow) (struct NativeWindow \*window) | 将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉 | | [OH_NativeWindow_DestroyNativeWindow](_native_window.md#oh_nativewindow_destroynativewindow) (OHNativeWindow \*window) | 将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉 |
| [OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer](_native_window.md#oh_nativewindow_createnativewindowbufferfromsurfacebuffer) (void \*pSurfaceBuffer) | 创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例 | | [OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer](_native_window.md#oh_nativewindow_createnativewindowbufferfromsurfacebuffer) (void \*pSurfaceBuffer) | 创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例 |
| [OH_NativeWindow_DestroyNativeWindowBuffer](_native_window.md#oh_nativewindow_destroynativewindowbuffer) (struct NativeWindowBuffer \*buffer) | 将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉 | | [OH_NativeWindow_DestroyNativeWindowBuffer](_native_window.md#oh_nativewindow_destroynativewindowbuffer) (OHNativeWindowBuffer \*buffer) | 将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉 |
| [OH_NativeWindow_NativeWindowRequestBuffer](_native_window.md#oh_nativewindow_nativewindowrequestbuffer) (struct NativeWindow \*window, struct NativeWindowBuffer \*\*buffer, int \*fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产 | | [OH_NativeWindow_NativeWindowRequestBuffer](_native_window.md#oh_nativewindow_nativewindowrequestbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*\*buffer, int \*fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产 |
| [OH_NativeWindow_NativeWindowFlushBuffer](_native_window.md#oh_nativewindow_nativewindowflushbuffer) (struct NativeWindow \*window, struct NativeWindowBuffer \*buffer, int fenceFd, Region region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费 | | [OH_NativeWindow_NativeWindowFlushBuffer](_native_window.md#oh_nativewindow_nativewindowflushbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer, int fenceFd, [Region](_region.md) region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费 |
| [OH_NativeWindow_NativeWindowCancelBuffer](_native_window.md#oh_nativewindow_nativewindowcancelbuffer) (struct NativeWindow \*window, struct NativeWindowBuffer \*buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请 | | [OH_NativeWindow_NativeWindowAbortBuffer](_native_window.md#oh_nativewindow_nativewindowabortbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请 |
| [OH_NativeWindow_NativeWindowHandleOpt](_native_window.md#oh_nativewindow_nativewindowhandleopt) (struct NativeWindow \*window, int code,...) | 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等 | | [OH_NativeWindow_NativeWindowHandleOpt](_native_window.md#oh_nativewindow_nativewindowhandleopt) (OHNativeWindow \*window, int code,...) | 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等 |
| [OH_NativeWindow_GetBufferHandleFromNative](_native_window.md#oh_nativewindow_getbufferhandlefromnative) (struct NativeWindowBuffer \*buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 | | [OH_NativeWindow_GetBufferHandleFromNative](_native_window.md#oh_nativewindow_getbufferhandlefromnative) (OHNativeWindowBuffer \*buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 |
| [OH_NativeWindow_NativeObjectReference](_native_window.md#oh_nativewindow_nativeobjectreference) (void \*obj) | 增加一个NativeObject的引用计数 | | [OH_NativeWindow_NativeObjectReference](_native_window.md#oh_nativewindow_nativeobjectreference) (void \*obj) | 增加一个NativeObject的引用计数 |
| [OH_NativeWindow_NativeObjectUnreference](_native_window.md#oh_nativewindow_nativeobjectunreference) (void \*obj) | 减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉 | | [OH_NativeWindow_NativeObjectUnreference](_native_window.md#oh_nativewindow_nativeobjectunreference) (void \*obj) | 减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉 |
| [OH_NativeWindow_GetNativeObjectMagic](_native_window.md#oh_nativewindow_getnativeobjectmagic) (void \*obj) | 获取NativeObject的MagicId | | [OH_NativeWindow_GetNativeObjectMagic](_native_window.md#oh_nativewindow_getnativeobjectmagic) (void \*obj) | 获取NativeObject的MagicId |
| [OH_NativeWindow_NativeWindowSetScalingMode](_native_window.md#oh_nativewindow_nativewindowsetscalingmode) (OHNativeWindow \*window, uint32_t sequence, [OHScalingMode](_native_window.md#ohscalingmode) scalingMode) | 设置NativeWindow的ScalingMode |
| [OH_NativeWindow_NativeWindowSetMetaData](_native_window.md#oh_nativewindow_nativewindowsetmetadata) (OHNativeWindow \*window, uint32_t sequence, int32_t size, const [OHHDRMetaData](_o_h_h_d_r_meta_data.md) \*metaData) | 设置NativeWindow的元数据 |
| [OH_NativeWindow_NativeWindowSetMetaDataSet](_native_window.md#oh_nativewindow_nativewindowsetmetadataset) (OHNativeWindow \*window, uint32_t sequence, [OHHDRMetadataKey](_native_window.md#ohhdrmetadatakey) key, int32_t size, const uint8_t \*metaData) | 设置NativeWindow的元数据集。 |
| [OH_NativeWindow_NativeWindowSetTunnelHandle](_native_window.md#oh_nativewindow_nativewindowsettunnelhandle) (OHNativeWindow \*window, const [OHExtDataHandle](_o_h_ext_data_handle.md) \*handle) | 设置NativeWindow的TunnelHandle。 |
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册