Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
feb1a534
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
feb1a534
编写于
9月 27, 2022
作者:
O
openharmony_ci
提交者:
Gitee
9月 27, 2022
浏览文件
操作
浏览文件
下载
差异文件
!10014 window native api更新,同步beta分支
Merge pull request !10014 from zengyawen/OpenHarmony-3.2-Beta3
上级
0d69c9a8
6676dcc2
变更
9
隐藏空白更改
内联
并排
Showing
9 changed file
with
704 addition
and
204 deletion
+704
-204
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
+95
-95
zh-cn/application-dev/reference/native-apis/Readme-CN.md
zh-cn/application-dev/reference/native-apis/Readme-CN.md
+4
-0
zh-cn/application-dev/reference/native-apis/_hi_log.md
zh-cn/application-dev/reference/native-apis/_hi_log.md
+7
-7
zh-cn/application-dev/reference/native-apis/_native_window.md
...n/application-dev/reference/native-apis/_native_window.md
+326
-89
zh-cn/application-dev/reference/native-apis/_o_h_ext_data_handle.md
...ication-dev/reference/native-apis/_o_h_ext_data_handle.md
+61
-0
zh-cn/application-dev/reference/native-apis/_o_h_h_d_r_meta_data.md
...ication-dev/reference/native-apis/_o_h_h_d_r_meta_data.md
+48
-0
zh-cn/application-dev/reference/native-apis/_rect.md
zh-cn/application-dev/reference/native-apis/_rect.md
+71
-0
zh-cn/application-dev/reference/native-apis/_region.md
zh-cn/application-dev/reference/native-apis/_region.md
+47
-0
zh-cn/application-dev/reference/native-apis/external__window_8h.md
...lication-dev/reference/native-apis/external__window_8h.md
+45
-13
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @
feb1a534
...
...
@@ -26,7 +26,7 @@ getAccountManager(): AccountManager
| --------------------------------- | ------------------------ |
|
[
AccountManager
](
#accountmanager
)
| 获取系统帐号能力的实例。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
```
...
...
@@ -66,7 +66,7 @@ activateOsAccount(localId: number, callback: AsyncCallback<void>): void
| localId | number | 是 | 要激活的系统帐号ID。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调结果。 |
**示例:**
激活ID为100的系统帐号
**示例:**
激活ID为100的系统帐号
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
let
localId
=
100
;
...
...
@@ -99,7 +99,7 @@ activateOsAccount(localId: number): Promise<void>
| :------------------ | :---------------------------------- |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
激活ID为100的系统帐号
**示例:**
激活ID为100的系统帐号
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
let
localId
=
100
;
...
...
@@ -124,7 +124,7 @@ isMultiOsAccountEnable(callback: AsyncCallback<boolean>): void
| -------- | ---------------------------- | ---- | --------------------------------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调结果,支持多系统帐号则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -148,7 +148,7 @@ isMultiOsAccountEnable(): Promise<boolean>
| :--------------------- | :----------------------------------------------------------- |
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果,支持多系统帐号则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -176,7 +176,7 @@ isOsAccountActived(localId: number, callback: AsyncCallback<boolean>): voi
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调结果,处于激活状态则返回true,否则返回false。 |
**示例:**
判断ID为100的系统帐号是否处于激活状态
**示例:**
判断ID为100的系统帐号是否处于激活状态
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -209,7 +209,7 @@ isOsAccountActived(localId: number): Promise<boolean>
| :--------------------- | :----------------------------------------------------------- |
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果,处于激活状态则返回true,否则返回false。 |
**示例:**
判断ID为100的系统帐号是否处于激活状态
**示例:**
判断ID为100的系统帐号是否处于激活状态
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -239,7 +239,7 @@ isOsAccountConstraintEnable(localId: number, constraint: string, callback: Async
| constraint | string | 是 | 指定的
[
约束
](
#系统帐号约束列表
)
名称。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调结果,具有指定约束则返回true,否则返回false。 |
**示例:**
判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
**示例:**
判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -273,7 +273,7 @@ isOsAccountConstraintEnable(localId: number, constraint: string): Promise<boo
| :--------------------- | :----------------------------------------------------------- |
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果,具有指定约束则返回true,否则返回false。 |
**示例:**
判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
**示例:**
判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -299,7 +299,7 @@ isTestOsAccount(callback: AsyncCallback<boolean>): void
| -------- | ---------------------------- | ---- | ----------------------------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调结果,是测试帐号则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -323,7 +323,7 @@ isTestOsAccount(): Promise<boolean>
| :--------------------- | :----------------------------------------------------------- |
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果,是测试帐号则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -348,7 +348,7 @@ isOsAccountVerified(callback: AsyncCallback<boolean>): void
| -------- | ---------------------------- | ---- | ------------------------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调结果,已验证则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -375,7 +375,7 @@ isOsAccountVerified(localId: number, callback: AsyncCallback<boolean>): vo
| localId | number | 否 | 指定的系统帐号ID。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调结果,已验证则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -407,7 +407,7 @@ isOsAccountVerified(localId?: number): Promise<boolean>
| :--------------------- | :----------------------------------------------------------- |
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果,已验证则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -437,7 +437,7 @@ removeOsAccount(localId: number, callback: AsyncCallback<void>): void
| localId | number | 是 | 要删除的系统帐号ID。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调结果。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -472,7 +472,7 @@ removeOsAccount(localId: number): Promise<void>
| :------------------ | :---------------------------------- |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -506,7 +506,7 @@ setOsAccountConstraints(localId: number, constraints: Array<string>, enabl
| enable | boolean | 是 | 设置(true)/删除(false) |
| callback | AsyncCallback
<
void
>
| 是 | 回调结果。 |
**示例:**
给ID为100的系统帐号设置禁止使用Wi-Fi的约束
**示例:**
给ID为100的系统帐号设置禁止使用Wi-Fi的约束
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -542,7 +542,7 @@ setOsAccountConstraints(localId: number, constraints: Array<string>, enabl
| :------------------ | :---------------------------------- |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
删除ID为100的系统帐号的禁止使用Wi-Fi的约束
**示例:**
删除ID为100的系统帐号的禁止使用Wi-Fi的约束
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -574,7 +574,7 @@ setOsAccountName(localId: number, localName: string, callback: AsyncCallback<
| localName | string | 是 | 帐号名。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调结果。 |
**示例:**
将ID为100的系统帐号的帐号名设置成demoName
**示例:**
将ID为100的系统帐号的帐号名设置成demoName
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -610,7 +610,7 @@ setOsAccountName(localId: number, localName: string): Promise<void>
| :------------------ | :---------------------------------- |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
将ID为100的系统帐号的帐号名设置成demoName
**示例:**
将ID为100的系统帐号的帐号名设置成demoName
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -639,7 +639,7 @@ getCreatedOsAccountsCount(callback: AsyncCallback<number>): void
| -------- | --------------------------- | ---- | ------------------------------------------ |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是已创建的系统帐号的数量。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -665,7 +665,7 @@ getCreatedOsAccountsCount(): Promise<number>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是已创建的系统帐号的数量。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -690,7 +690,7 @@ getOsAccountLocalIdFromProcess(callback: AsyncCallback<number>): void
| -------- | --------------------------- | ---- | -------------------------------------------------- |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是当前进程所属的系统帐号的帐号ID。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -714,7 +714,7 @@ getOsAccountLocalIdFromProcess(): Promise<number>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是当前进程所属的系统帐号的帐号ID。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -740,7 +740,7 @@ getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback<number>):
| uid | number | 是 | 进程uid。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是uid所属的系统帐号的帐号ID。 |
**示例:**
查询值为12345678的uid所属的系统帐号的帐号ID
**示例:**
查询值为12345678的uid所属的系统帐号的帐号ID
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -771,7 +771,7 @@ getOsAccountLocalIdFromUid(uid: number): Promise<number>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是uid所属的系统帐号的帐号ID。 |
**示例:**
查询值为12345678的uid所属的系统帐号的帐号ID
**示例:**
查询值为12345678的uid所属的系统帐号的帐号ID
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -800,7 +800,7 @@ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCall
| domainInfo |
[
DomainAccountInfo
](
#domainaccountinfo8
)
| 是 | 域帐号信息。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是和域帐号关联的系统帐号ID。 |
**示例:**
**示例:**
```
js
let
domainInfo
=
{
domain
:
'
testDomain
'
,
accountName
:
'
testAccountName
'
};
...
...
@@ -833,7 +833,7 @@ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise<number&
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是和域帐号关联的系统帐号ID。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -861,7 +861,7 @@ queryMaxOsAccountNumber(callback: AsyncCallback<number>): void
| -------- | --------------------------- | ---- | ------------------------------------------------ |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是允许创建的系统帐号的最大数量。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -887,7 +887,7 @@ queryMaxOsAccountNumber(): Promise<number>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是允许创建的系统帐号的最大数量。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -915,7 +915,7 @@ getOsAccountAllConstraints(localId: number, callback: AsyncCallback<Array<
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback
<
Array
<
string
>>
| 是 | 回调结果,返回的是该系统帐号的全部
[
约束
](
#系统帐号约束列表
)
。 |
**示例:**
获取ID为100的系统帐号的全部约束
**示例:**
获取ID为100的系统帐号的全部约束
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -948,7 +948,7 @@ getOsAccountAllConstraints(localId: number): Promise<Array<string>>
| :--------------------------------- | :----------------------------------------------------------- |
| Promise
<
Array
<
string
>>
| Promise实例,用于获取异步返回结果,返回的是该系统帐号的全部
[
约束
](
#系统帐号约束列表
)
。 |
**示例:**
获取ID为100的系统帐号的全部约束
**示例:**
获取ID为100的系统帐号的全部约束
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -978,7 +978,7 @@ queryAllCreatedOsAccounts(callback: AsyncCallback<Array<OsAccountInfo>&
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- |
| callback | AsyncCallback
<
Array
<
[OsAccountInfo](#osaccountinfo)
>>
| 是 | 回调结果,返回的是已创建的所有系统帐号的信息列表。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1006,7 +1006,7 @@ queryAllCreatedOsAccounts(): Promise<Array<OsAccountInfo>>
| :---------------------------------------------------------- | :----------------------------------------------------------- |
| Promise
<
Array
<
[OsAccountInfo](#osaccountinfo)
>>
| Promise实例,用于获取异步返回结果,返回的是已创建的所有系统帐号的信息列表。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1031,7 +1031,7 @@ queryActivatedOsAccountIds(callback: AsyncCallback<Array<number>>):
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback
<
Array
<
number
>>
| 是 | 回调结果,返回的是当前处于激活状态的系统帐号的ID列表。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1058,7 +1058,7 @@ queryActivatedOsAccountIds(): Promise<Array<number>>
| :--------------------------------- | :----------------------------------------------------------- |
| Promise
<
Array
<
number
>>
| Promise实例,用于获取异步返回结果,返回的是当前处于激活状态的系统帐号的ID列表。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1089,7 +1089,7 @@ createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback&
| type |
[
OsAccountType
](
#osaccounttype
)
| 是 | 创建的系统帐号的类型。 |
| callback | AsyncCallback
<
[OsAccountInfo](#osaccountinfo)
>
| 是 | 回调结果,返回的是新创建的系统帐号的信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1124,7 +1124,7 @@ createOsAccount(localName: string, type: OsAccountType): Promise<OsAccountInf
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise
<
[OsAccountInfo](#osaccountinfo)
>
| Promise实例,用于获取异步返回结果,返回的是新创建的系统帐号的信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1155,7 +1155,7 @@ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, cal
| domainInfo |
[
DomainAccountInfo
](
#domainaccountinfo8
)
| 是 | 域帐号信息。 |
| callback | AsyncCallback
<
[OsAccountInfo](#osaccountinfo)
>
| 是 | 回调结果,返回的是新创建的系统帐号的信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1191,7 +1191,7 @@ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Pr
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise
<
[OsAccountInfo](#osaccountinfo)
>
| Promise实例,用于获取异步返回结果,返回的是新创建的系统帐号的信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1219,7 +1219,7 @@ queryCurrentOsAccount(callback: AsyncCallback<OsAccountInfo>): void
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback
<
[OsAccountInfo](#osaccountinfo)
>
| 是 | 回调结果,返回的是当前进程所属的系统帐号信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1245,7 +1245,7 @@ queryCurrentOsAccount(): Promise<OsAccountInfo>
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise
<
[OsAccountInfo](#osaccountinfo)
>
| Promise实例,用于获取异步返回结果,返回的是当前进程所属的系统帐号信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1275,7 +1275,7 @@ queryOsAccountById(localId: number, callback: AsyncCallback<OsAccountInfo>
| localId | number | 是 | 要查询的系统帐号的ID |
| callback | AsyncCallback
<
[OsAccountInfo](#osaccountinfo)
>
| 是 | 回调结果,返回的是查到的系统帐号的信息。 |
**示例:**
查询ID为100的系统帐号信息
**示例:**
查询ID为100的系统帐号信息
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1310,7 +1310,7 @@ queryOsAccountById(localId: number): Promise<OsAccountInfo>
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise
<
[OsAccountInfo](#osaccountinfo)
>
| Promise实例,用于获取异步返回结果,返回的是查到的系统帐号的信息。 |
**示例:**
查询ID为100的系统帐号信息
**示例:**
查询ID为100的系统帐号信息
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1336,7 +1336,7 @@ getOsAccountTypeFromProcess(callback: AsyncCallback<OsAccountType>): void
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback
<
[OsAccountType](#osaccounttype)
>
| 是 | 回调结果,返回的是当前进程所属的系统帐号的帐号类型。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1360,7 +1360,7 @@ getOsAccountTypeFromProcess(): Promise<OsAccountType>
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise
<
[OsAccountType](#osaccounttype)
>
| Promise实例,用于获取异步返回结果,返回的是当前进程所属的系统帐号的帐号类型。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1387,7 +1387,7 @@ getDistributedVirtualDeviceId(callback: AsyncCallback<string>): void
| -------- | --------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback
<
string
>
| 是 | 回调结果,返回的是分布式虚拟设备ID。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1413,7 +1413,7 @@ getDistributedVirtualDeviceId(): Promise<string>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
string
>
| Promise实例,用于获取异步返回结果,返回的是分布式虚拟设备ID。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1443,7 +1443,7 @@ getOsAccountProfilePhoto(localId: number, callback: AsyncCallback<string>)
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback
<
string
>
| 是 | 回调结果,返回的是该系统帐号的头像信息。 |
**示例:**
获取ID为100的系统帐号的头像
**示例:**
获取ID为100的系统帐号的头像
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1478,7 +1478,7 @@ getOsAccountProfilePhoto(localId: number): Promise<string>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
string
>
| Promise实例,用于获取异步返回结果,返回的是该系统帐号的头像信息。 |
**示例:**
获取ID为100的系统帐号的头像
**示例:**
获取ID为100的系统帐号的头像
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1510,7 +1510,7 @@ setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback
| photo | string | 是 | 头像信息。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调结果。 |
**示例:**
给ID为100的系统帐号设置头像
**示例:**
给ID为100的系统帐号设置头像
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1549,7 +1549,7 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise<void>
| :------------------ | :---------------------------------- |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
给ID为100的系统帐号设置头像
**示例:**
给ID为100的系统帐号设置头像
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1580,7 +1580,7 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&
| serialNumber | number | 是 | 帐号SN码。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是与SN码关联的系统帐号的帐号ID。 |
**示例:**
查询与SN码12345关联的系统帐号的ID
**示例:**
查询与SN码12345关联的系统帐号的ID
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1611,7 +1611,7 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise<number>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是与SN码关联的系统帐号的帐号ID。 |
**示例:**
查询与SN码12345关联的系统帐号的ID
**示例:**
查询与SN码12345关联的系统帐号的ID
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1638,7 +1638,7 @@ getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback<nu
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是与该系统帐号关联的SN码。 |
**示例:**
获取ID为100的系统帐号关联的SN码
**示例:**
获取ID为100的系统帐号关联的SN码
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1669,7 +1669,7 @@ getSerialNumberByOsAccountLocalId(localId: number): Promise<number>
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是与该系统帐号关联的SN码。 |
**示例:**
获取ID为100的系统帐号关联的SN码
**示例:**
获取ID为100的系统帐号关联的SN码
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1701,7 +1701,7 @@ on(type: 'activate' | 'activating', name: string, callback: Callback<number&g
| name | string | 是 | 订阅名称,可自定义,要求非空且长度不超过1024字节。 |
| callback | Callback
<
number
>
| 是 | 订阅系统帐号变动信息的回调,表示当前事件对应的系统帐号ID。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1731,7 +1731,7 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback<number
| name | string | 是 | 订阅名称,可自定义,,要求非空且长度不超过1024字节,需要与订阅接口传入的值保持一致。 |
| callback | Callback
<
number
>
| 否 | 取消订阅系统帐号变化的回调,默认返回0。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1758,7 +1758,7 @@ getBundleIdFromUid(uid: number, callback: AsyncCallback<number>): void;
| uid | number | 是 | 进程uid。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回的是与uid对应的bundleId。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1790,7 +1790,7 @@ getBundleIdFromUid(uid: number): Promise<number>;
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回的是与uid对应的bundleId。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1820,7 +1820,7 @@ isMainOsAccount(callback: AsyncCallback<boolean>): void;
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调结果,返回的是当前进程是否处于主用户,是则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1847,7 +1847,7 @@ isMainOsAccount(): Promise<boolean>;
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果,回调结果,返回的是当前进程是否处于主用户,是则返回true,否则返回false。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1877,7 +1877,7 @@ queryOsAccountConstraintSourceTypes(localId: number, constraint: string, callbac
| constraint | string | 是 | 要查询的
[
约束
](
#系统帐号约束列表
)
名称 |
| callback | AsyncCallback
<
Array
<
[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)
>>
| 是 | 回调结果,返回的是指定系统帐号的指定
[
约束
](
#系统帐号约束列表
)
来源信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1912,7 +1912,7 @@ queryOsAccountConstraintSourceTypes(localId: number, constraint: string): Promis
| :-------------------- | :----------------------------------------------------------- |
| Promise
<
Array
<
[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)
>>
| Promise实例,用于获取异步返回结果,返回的是指定系统帐号的指定
[
约束
](
#系统帐号约束列表
)
来源信息。 |
**示例:**
**示例:**
```
js
let
accountManager
=
account_osAccount
.
getAccountManager
();
...
...
@@ -1939,7 +1939,7 @@ constructor()
**系统能力**
:SystemCapability.Account.OsAccount
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
```
...
...
@@ -1961,7 +1961,7 @@ getVersion(): number;
| :----- | :----------- |
| number | 返回版本信息。|
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
version
=
userAuth
.
getVersion
();
...
...
@@ -1993,7 +1993,7 @@ getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;
| :----- | :---------------------------------------- |
| number | 返回验证
[
结果
](
#resultcode8
)
。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
authType
=
account_osAccount
.
AuthType
.
PIN
;
...
...
@@ -2021,7 +2021,7 @@ getProperty(request: GetPropertyRequest, callback: AsyncCallback<ExecutorProp
| request |
[
GetPropertyRequest
](
#getpropertyrequest8
)
| 是 | 请求信息,包括认证类型和属性类型列表。 |
| callback | AsyncCallback
<
[ExecutorProperty](#executorproperty8)
>
| 是 | 回调结果,返回的是调用者属性。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
keys
=
[
...
...
@@ -2063,7 +2063,7 @@ getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>;
| :---------------------------------------------------------------- | :-------------------------------------------------- |
| Promise
<
[ExecutorProperty](#executorproperty8)
>
| Promise实例,用于获取异步返回结果,返回的是调用者属性。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
keys
=
[
...
...
@@ -2101,7 +2101,7 @@ setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>):
| request |
[
SetPropertyRequest
](
#setpropertyrequest8
)
| 是 | 请求信息,包括认证类型和要设置的密钥值。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调结果,返回一个
[
数值
](
#resultcode8
)
,指示属性设置是否成功。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
request
=
{
...
...
@@ -2139,7 +2139,7 @@ setProperty(request: SetPropertyRequest): Promise<number>;
| :-------------------- | :-------------------------------------------------------------------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回结果,返回一个
[
数值
](
#resultcode8
)
,指示属性设置是否成功。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
request
=
{
...
...
@@ -2182,7 +2182,7 @@ auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel,
| :--------- | :----------------- |
| Uint8Array | 返回取消的上下文ID。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
challenge
=
new
Uint8Array
([
0
]);
...
...
@@ -2225,7 +2225,7 @@ authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLev
| :--------- | :----------------- |
| Uint8Array | 返回取消的上下文ID。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
userID
=
100
;
...
...
@@ -2264,7 +2264,7 @@ cancelAuth(contextID: Uint8Array): number;
| :----- | :-------------------------------------------------------- |
| number | 返回一个
[
数字
](
#resultcode8
)
,指示取消是否成功。 |
**示例:**
**示例:**
```
js
let
userAuth
=
new
account_osAccount
.
UserAuth
();
let
pinAuth
=
new
account_osAccount
.
PINAuth
();
...
...
@@ -2295,7 +2295,7 @@ constructor()
**系统能力**
:SystemCapability.Account.OsAccount
**示例:**
**示例:**
```
js
let
pinAuth
=
new
account_osAccount
.
PINAuth
();
```
...
...
@@ -2324,7 +2324,7 @@ registerInputer(inputer: IInputer): boolean;
| :------ | :-------------------------------------------- |
| boolean | 返回布尔值,true表示注册成功,false表示注册失败。 |
**示例:**
**示例:**
```
js
let
pinAuth
=
new
account_osAccount
.
PINAuth
();
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
]);
...
...
@@ -2348,7 +2348,7 @@ unregisterInputer(): void;
**需要权限:**
ohos.permission.ACCESS_PIN_AUTH
**示例:**
**示例:**
```
js
let
pinAuth
=
new
account_osAccount
.
PINAuth
();
pinAuth
.
unregisterInputer
();
...
...
@@ -2370,7 +2370,7 @@ constructor()
**系统能力**
:SystemCapability.Account.OsAccount
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
```
...
...
@@ -2393,7 +2393,7 @@ openSession(callback: AsyncCallback<Uint8Array>): void;
| -------- | -------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback
<
Uint8Array
>
| 是 | 回调结果,返回的是挑战值,非0即成功,为0则失败。|
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
userIDM
.
openSession
((
err
,
challenge
)
=>
{
...
...
@@ -2420,7 +2420,7 @@ openSession(): Promise<Uint8Array>;
| :------------------------ | :------------------------------------------------------- |
| Promise
<
Uint8Array
>
| Promise实例,用于获取异步返回结果,返回的是挑战值,非0即成功,为0则失败。|
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
userIDM
.
openSession
().
then
((
challenge
)
=>
{
...
...
@@ -2449,7 +2449,7 @@ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
| credentialInfo |
[
CredentialInfo
](
#credentialinfo8
)
| 是 | 指示凭据信息。 |
| callback |
[
IIdmCallback
](
#iidmcallback8
)
| 是 | 回调结果,返回的是结果和获取信息。 |
**示例:**
**示例:**
```
js
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
,
0
]);
let
pinAuth
=
new
account_osAccount
.
PINAuth
();
...
...
@@ -2493,7 +2493,7 @@ updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
| credentialInfo |
[
CredentialInfo
](
#credentialinfo8
)
| 是 | 指示凭据信息。 |
| callback |
[
IIdmCallback
](
#iidmcallback8
)
| 是 | 回调结果,返回的是结果和获取信息。 |
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
let
userAuth
=
new
account_osAccount
.
UserAuth
();
...
...
@@ -2539,7 +2539,7 @@ closeSession(): void;
**需要权限:**
ohos.permission.MANAGE_USER_IDM
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
userIDM
.
closeSession
();
...
...
@@ -2569,7 +2569,7 @@ cancel(challenge: Uint8Array): number;
| :----- | :-------------------------------------------------------- |
| number | 返回一个
[
数字
](
#resultcode8
)
,指示取消是否成功。 |
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
let
challenge
=
new
Uint8Array
([
0
]);
...
...
@@ -2596,7 +2596,7 @@ delUser(token: Uint8Array, callback: IIdmCallback): void;
| token | Uint8Array | 是 | 身份验证令牌。 |
| callback |
[
IIdmCallback
](
#iidmcallback8
)
| 是 | 回调结果,返回的是删除结果。|
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
let
token
=
new
Uint8Array
([
0
]);
...
...
@@ -2628,7 +2628,7 @@ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): vo
| token | Uint8Array | 是 | 身份验证令牌。 |
| callback |
[
IIdmCallback
](
#iidmcallback8
)
| 是 | 回调结果,返回的是删除结果。 |
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
let
credentialId
=
new
Uint8Array
([
0
]);
...
...
@@ -2660,7 +2660,7 @@ getAuthInfo(callback: AsyncCallback<Array<EnrolledCredInfo>>): void;
| callback | AsyncCallback
<
Array
<
[EnrolledCredInfo](#enrolledcredinfo8)
>>
| 是 | 回调结果,返回的是当前用户指定类型的所有已注册凭据信息。|
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
userIDM
.
getAuthInfo
((
err
,
result
)
=>
{
...
...
@@ -2688,7 +2688,7 @@ getAuthInfo(authType: AuthType, callback: AsyncCallback<Array<EnrolledCred
| authType |
[
AuthType
](
#authtype8
)
| 是 | 认证类型。 |
| callback | AsyncCallback
<
Array
<
[EnrolledCredInfo](#enrolledcredinfo8)
>>
| 是 | 回调结果,返回的是当前用户指定类型的所有已注册凭据信息。|
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
userIDM
.
getAuthInfo
(
account_osAccount
.
AuthType
.
PIN
,
(
err
,
result
)
=>
{
...
...
@@ -2721,7 +2721,7 @@ getAuthInfo(authType?: AuthType): Promise<Array<EnrolledCredInfo>>;
| :------------------------------------------- | :------------------------------------------------------------------------ |
| Promise
<
Array
<
[EnrolledCredInfo](#enrolledcredinfo8)
>>
| Promise实例,用于获取异步返回结果,返回的是当前用户指定类型的所有已注册凭据信息。|
**示例:**
**示例:**
```
js
let
userIDM
=
new
account_osAccount
.
UserIdentityManager
();
userIDM
.
getAuthInfo
(
account_osAccount
.
AuthType
.
PIN
).
then
((
result
)
=>
{
...
...
@@ -2754,7 +2754,7 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;
| pinSubType |
[
AuthSubType
](
#authsubtype8
)
| 是 | 用于认证的凭据子类型。 |
| data | Uint8Array | 是 | 要设置的数据是凭据,用来在认证、添加、修改凭据操作。 |
**示例:**
**示例:**
```
js
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
,
0
]);
let
passwordNumber
=
new
Uint8Array
([
1
,
2
,
3
,
4
]);
...
...
@@ -2791,7 +2791,7 @@ onGetData: (pinSubType: AuthSubType, callback: IInputData) => void;
| ---------- | --------------------------------------- | ---- | --------------- |
| callback |
[
IInputData
](
#iinputdata8
)
| 是 | 指示密码数据回调。|
**示例:**
**示例:**
```
js
let
password
=
new
Uint8Array
([
0
,
0
,
0
,
0
,
0
,
0
]);
let
passwordNumber
=
new
Uint8Array
([
1
,
2
,
3
,
4
]);
...
...
@@ -2832,7 +2832,7 @@ onResult: (result: number, extraInfo: AuthResult) => void;
| result | number | 是 | 表示身份认证结果代码。|
| extraInfo |
[
AuthResult
](
#authresult8
)
| 是 | 表示不同情况下的具体信息,如果认证通过,则在extrainfo中返回认证令牌,如果身份验证失败,则在extrainfo中返回剩余的身份验证时间,如果身份验证执行器被锁定,冻结时间将在extrainfo中返回。|
**示例:**
**示例:**
```
js
let
authCallback
=
{
onResult
:
(
result
,
extraInfo
)
=>
{
...
...
@@ -2860,7 +2860,7 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
| acquire | number | 是 | 指示不同身份验证执行器的tip代码。|
| extraInfo | any | 是 | 保留参数。 |
**示例:**
**示例:**
```
js
let
authCallback
=
{
onResult
:
(
result
,
extraInfo
)
=>
{
...
...
@@ -2898,7 +2898,7 @@ onResult: (result: number, extraInfo: RequestResult) => void;
| result | number | 是 | 表示身份认证结果代码。 |
| extraInfo |
[
AuthResult
](
#authresult8
)
| 是 | 针对不同情况传递具体信息。|
**示例:**
**示例:**
```
js
let
idmCallback
=
{
onResult
:
(
result
,
extraInfo
)
=>
{
...
...
@@ -2926,7 +2926,7 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
| acquire | number | 是 | 指示不同身份验证执行器的tip代码。|
| extraInfo | any | 是 | 保留参数。 |
**示例:**
**示例:**
```
js
let
idmCallback
=
{
onResult
:
(
result
,
extraInfo
)
=>
{
...
...
zh-cn/application-dev/reference/native-apis/Readme-CN.md
浏览文件 @
feb1a534
...
...
@@ -39,5 +39,9 @@
-
[
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_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
)
-
[
RawFileDescriptor
](
_raw_file_descriptor.md
)
-
[
Region
](
_region.md
)
-
[
Rect
](
_rect.md
)
zh-cn/application-dev/reference/native-apis/_hi_log.md
浏览文件 @
feb1a534
...
...
@@ -110,7 +110,7 @@ DEBUG级别写日志,宏封装接口。
**参数:**
|
Name
| 描述 |
|
名称
| 描述 |
| -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...
...
@@ -140,7 +140,7 @@ ERROR级别写日志,宏封装接口。
**参数:**
|
Name
| 描述 |
|
名称
| 描述 |
| -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...
...
@@ -170,7 +170,7 @@ FATAL级别写日志,宏封装接口。
**参数:**
|
Name
| 描述 |
|
名称
| 描述 |
| -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...
...
@@ -200,7 +200,7 @@ INFO级别写日志,宏封装接口。
**参数:**
|
Name
| 描述 |
|
名称
| 描述 |
| -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...
...
@@ -230,7 +230,7 @@ WARN级别写日志,宏封装接口。
**参数:**
|
Name
| 描述 |
|
名称
| 描述 |
| -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 |
| fmt | 格式化字符串,基于类printf格式的增强,支持隐私参数标识,即在格式字符串每个参数中符号后类型前增加{public}、{private}标识。 |
...
...
@@ -324,7 +324,7 @@ bool OH_LOG_IsLoggable (unsigned int domain, const char * tag, LogLevel level )
**参数:**
|
Name
| 描述 |
|
名称
| 描述 |
| -------- | -------- |
| domain | 指定日志业务领域。 |
| tag | 指定日志TAG。 |
...
...
@@ -354,7 +354,7 @@ int OH_LOG_Print (LogType type, LogLevel level, unsigned int domain, const char
**参数:**
|
Name
| 描述 |
|
名称
| 描述 |
| -------- | -------- |
| type | 日志类型,三方应用日志类型为LOG_APP。 |
| level | 日志级别,日志级别包括LOG_DEBUG、LOG_INFO、LOG_WARN、LOG_ERROR、LOG_FATAL。 |
...
...
zh-cn/application-dev/reference/native-apis/_native_window.md
浏览文件 @
feb1a534
# NativeWindow
提供NativeWindow功能,主要用来和egl对接
提供NativeWindow功能,主要用来和egl对接
。
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**自从:**
...
...
@@ -18,85 +18,199 @@
### 文件
| 文件名称 | 描述 |
| 文件名称 | 描述 |
| -------- | -------- |
|
[
external_window.h
](
external__window_8h.md
)
| 定义获取和使用NativeWindow的相关函数 |
|
[
external_window.h
](
external__window_8h.md
)
| 定义获取和使用NativeWindow的相关函数 |
### 结构体
| 结构体名称 | 描述 |
| -------- | -------- |
|
[
Region
](
_region.md
)
| 表示本地窗口NativeWindow需要更新内容的矩形区域(脏区) |
|
[
OHHDRMetaData
](
_o_h_h_d_r_meta_data.md
)
| HDR元数据结构体定义 |
|
[
OHExtDataHandle
](
_o_h_ext_data_handle.md
)
| 扩展数据句柄结构体定义 |
### 类型定义
| 类型定义名称 | 描述 |
| -------- | -------- |
| OHNativeWindow | 提供对NativeWindow的访问功能 |
| OHNativeWindowBuffer | 提供对NativeWindow的访问功能 |
| Region | 表示本地窗口NativeWindow需要更新内容的矩形区域(脏区) |
### 枚举
| 枚举名称 | 描述 |
| -------- | -------- |
|
[
NativeWindowOperation
](
#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
](
#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
](
#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
](
#oh_nativewindow_createnativewindowfromsurface
)
(
void
\*
pSurface) | 创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例 |
|
[
OH_NativeWindow_DestroyNativeWindow
](
#oh_nativewindow_destroynativewindow
)
(
struct
NativeWindow
\*
window) | 将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉 |
|
[
OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer
](
#oh_nativewindow_createnativewindowbufferfromsurfacebuffer
)
(
void
\*
pSurfaceBuffer) | 创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例 |
|
[
OH_NativeWindow_DestroyNativeWindowBuffer
](
#oh_nativewindow_destroynativewindowbuffer
)
(
struct
NativeWindowBuffer
\*
buffer) | 将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉 |
|
[
OH_NativeWindow_NativeWindowRequestBuffer
](
#oh_nativewindow_nativewindowrequestbuffer
)
(
struct
NativeWindow
\*
window, struct NativeWindowBuffer
\*\*
buffer, int
\*
fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产 |
|
[
OH_NativeWindow_NativeWindowFlushBuffer
](
#oh_nativewindow_nativewindowflushbuffer
)
(
struct
NativeWindow
\*
window, struct NativeWindowBuffer
\*
buffer, int fenceFd, Region region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费 |
|
[
OH_NativeWindow_NativeWindowCancelBuffer
](
#oh_nativewindow_nativewindowcancelbuffer
)
(
struct
NativeWindow
\*
window, struct NativeWindowBuffer
\*
buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请 |
|
[
OH_NativeWindow_NativeWindowHandleOpt
](
#oh_nativewindow_nativewindowhandleopt
)
(
struct
NativeWindow
\*
window, int code,...) | 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等 |
|
[
OH_NativeWindow_GetBufferHandleFromNative
](
#oh_nativewindow_getbufferhandlefromnative
)
(
struct
NativeWindowBuffer
\*
buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 |
|
[
OH_NativeWindow_NativeObjectReference
](
#oh_nativewindow_nativeobjectreference
)
(
void
\*
obj) | 增加一个NativeObject的引用计数 |
|
[
OH_NativeWindow_NativeObjectUnreference
](
#oh_nativewindow_nativeobjectunreference
)
(
void
\*
obj) | 减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉 |
|
[
OH_NativeWindow_GetNativeObjectMagic
](
#oh_nativewindow_getnativeobjectmagic
)
(
void
\*
obj) | 获取NativeObject的MagicId |
|
[
OH_NativeWindow_CreateNativeWindow
](
#oh_nativewindow_createnativewindow
)
(
void
\*
pSurface) | 创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例 |
|
[
OH_NativeWindow_DestroyNativeWindow
](
#oh_nativewindow_destroynativewindow
)
(
OHNativeWindow
\*
window) | 将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉 |
|
[
OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer
](
#oh_nativewindow_createnativewindowbufferfromsurfacebuffer
)
(
void
\*
pSurfaceBuffer) | 创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例 |
|
[
OH_NativeWindow_DestroyNativeWindowBuffer
](
#oh_nativewindow_destroynativewindowbuffer
)
(
OHNativeWindowBuffer
\*
buffer) | 将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉 |
|
[
OH_NativeWindow_NativeWindowRequestBuffer
](
#oh_nativewindow_nativewindowrequestbuffer
)
(
OHNativeWindow
\*
window, OHNativeWindowBuffer
\*\*
buffer, int
\*
fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产 |
|
[
OH_NativeWindow_NativeWindowFlushBuffer
](
#oh_nativewindow_nativewindowflushbuffer
)
(
OHNativeWindow
\*
window, OHNativeWindowBuffer
\*
buffer, int fenceFd,
[
Region
](
_region.md
)
region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费 |
|
[
OH_NativeWindow_NativeWindowAbortBuffer
](
#oh_nativewindow_nativewindowabortbuffer
)
(
OHNativeWindow
\*
window, OHNativeWindowBuffer
\*
buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请 |
|
[
OH_NativeWindow_NativeWindowHandleOpt
](
#oh_nativewindow_nativewindowhandleopt
)
(
OHNativeWindow
\*
window, int code,...) | 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等 |
|
[
OH_NativeWindow_GetBufferHandleFromNative
](
#oh_nativewindow_getbufferhandlefromnative
)
(
OHNativeWindowBuffer
\*
buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 |
|
[
OH_NativeWindow_NativeObjectReference
](
#oh_nativewindow_nativeobjectreference
)
(
void
\*
obj) | 增加一个NativeObject的引用计数 |
|
[
OH_NativeWindow_NativeObjectUnreference
](
#oh_nativewindow_nativeobjectunreference
)
(
void
\*
obj) | 减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉 |
|
[
OH_NativeWindow_GetNativeObjectMagic
](
#oh_nativewindow_getnativeobjectmagic
)
(
void
\*
obj) | 获取NativeObject的MagicId |
|
[
OH_NativeWindow_NativeWindowSetScalingMode
](
#oh_nativewindow_nativewindowsetscalingmode
)
(
OHNativeWindow
\*
window, uint32_t sequence,
[
OHScalingMode
](
#ohscalingmode
)
scalingMode) | 设置NativeWindow的ScalingMode |
|
[
OH_NativeWindow_NativeWindowSetMetaData
](
#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
](
#oh_nativewindow_nativewindowsetmetadataset
)
(
OHNativeWindow
\*
window, uint32_t sequence,
[
OHHDRMetadataKey
](
#ohhdrmetadatakey
)
key, int32_t size, const uint8_t
\*
metaData) | 设置NativeWindow的元数据集。 |
|
[
OH_NativeWindow_NativeWindowSetTunnelHandle
](
#oh_nativewindow_nativewindowsettunnelhandle
)
(
OHNativeWindow
\*
window, const
[
OHExtDataHandle
](
_o_h_ext_data_handle.md
)
\*
handle) | 设置NativeWindow的TunnelHandle。 |
## 详细描述
##
函数
说明
##
枚举类型
说明
### OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer()
### NativeWindowOperation
```
enum NativeWindowOperation
```
**描述:**
OH_NativeWindow_NativeWindowHandleOpt函数中的操作码
| 枚举值 | 说明 |
| -------- | -------- |
| SET_BUFFER_GEOMETRY | 设置本地窗口缓冲区几何图形, 函数中的可变参数是 [输入] int32_t height,[输入] int32_t width。 |
| GET_BUFFER_GEOMETRY | 获取本地窗口缓冲区几何图形, 函数中的可变参数是 [输出] int32_t
\*
height, [输出] int32_t
\*
width。 |
| GET_FORMAT | 获取本地窗口缓冲区格式, 函数中的可变参数是 [输出] int32_t
\*
format。 |
| SET_FORMAT | 设置本地窗口缓冲区格式, 函数中的可变参数是 [输入] int32_t format。 |
| GET_USAGE | 获取本地窗口缓冲区格式, 函数中的可变参数是 [输出] int32_t
\*
usage。 |
| SET_USAGE | 设置本地窗口缓冲区使用方式, 函数中的可变参数是 [输入] int32_t usage。 |
| SET_STRIDE | 设置本地窗口缓冲区步幅, 函数中的可变参数是 [输入] int32_t stride。 |
| GET_STRIDE | 获取本地窗口缓冲区步幅, 函数中的可变参数是 [输出] int32_t
\*
stride。 |
| SET_SWAP_INTERVAL | 设置本地窗口缓冲区交换间隔, 函数中的可变参数是 [输入] int32_t interval。 |
| GET_SWAP_INTERVAL | 获取本地窗口缓冲区交换间隔, 函数中的可变参数是 [输出] int32_t
\*
interval。 |
| SET_TIMEOUT | 设置请求本地窗口缓冲区的超时等待时间, 函数中的可变参数是 [输入] int32_t timeout。 |
| GET_TIMEOUT | 获取请求本地窗口缓冲区的超时等待时间, 函数中的可变参数是 [输出] int32_t
\*
timeout。 |
| SET_COLOR_GAMUT | 设置本地窗口缓冲区色彩空间, 函数中的可变参数是 [输入] int32_t colorGamut。 |
| GET_COLOR_GAMUT | 获取本地窗口缓冲区色彩空间, 函数中的可变参数是 [out int32_t
\*
colorGamut]。 |
| SET_TRANSFORM | 设置本地窗口缓冲区变换, 函数中的可变参数是 [输入] int32_t transform。 |
| GET_TRANSFORM | 获取本地窗口缓冲区变换, 函数中的可变参数是 [输出] int32_t
\*
transform。 |
| SET_UI_TIMESTAMP | 设置本地窗口缓冲区UI时间戳, 函数中的可变参数是 [输入] uint64_t uiTimestamp。 |
### OHHDRMetadataKey
```
struct NativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void * pSurfaceBuffer)
enum OHHDRMetadataKey
```
**描述:**
创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例
枚举HDR元数据关键字
| 枚举值 | 描述 |
| -------- | -------- |
| OH_METAKEY_RED_PRIMARY_X | 红基色X坐标 |
| OH_METAKEY_RED_PRIMARY_Y | 红基色Y坐标 |
| OH_METAKEY_GREEN_PRIMARY_X | 绿基色X坐标 |
| OH_METAKEY_GREEN_PRIMARY_Y | 绿基色Y坐标 |
| OH_METAKEY_BLUE_PRIMARY_X | 蓝基色X坐标 |
| OH_METAKEY_BLUE_PRIMARY_Y | 蓝基色Y坐标 |
| OH_METAKEY_WHITE_PRIMARY_X | 白点X坐标 |
| OH_METAKEY_WHITE_PRIMARY_Y | 白点Y坐标 |
| OH_METAKEY_MAX_LUMINANCE | 最大的光亮度 |
| OH_METAKEY_MIN_LUMINANCE | 最小的光亮度 |
| OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL | 最大的内容亮度水平 |
| OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL | 最大的帧平均亮度水平 |
| OH_METAKEY_HDR10_PLUS | HDR10 Plus |
| OH_METAKEY_HDR_VIVID | Vivid |
### OHScalingMode
```
enum OHScalingMode
```
**描述:**
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
缩放模式 Scaling Mode
| 枚举值 | 描述 |
| -------- | -------- |
| OH_SCALING_MODE_FREEZE | 在接收到窗口大小的缓冲区之前,不可以更新窗口内容 |
| OH_SCALING_MODE_SCALE_TO_WINDOW | 缓冲区在二维中缩放以匹配窗口大小 |
| OH_SCALING_MODE_SCALE_CROP | 缓冲区被统一缩放,使得缓冲区的较小尺寸与窗口大小匹配 |
| OH_SCALING_MODE_NO_SCALE_CROP | 窗口被裁剪为缓冲区裁剪矩形的大小,裁剪矩形之外的像素被视为完全透明 |
## 函数说明
### OH_NativeWindow_CreateNativeWindow()
```
OHNativeWindow* OH_NativeWindow_CreateNativeWindow (void * pSurface)
```
**描述:**
创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例
\@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| pSurface
Buffer | 参数是一个指向生产者buffer的指针,类型为sptr
<
OHOS::SurfaceBuffer
>
|
| pSurface
| 参数是一个指向生产者ProduceSurface的指针,类型为sptr
<
OHOS::Surface
>
|
**返回:**
返回一个指针,指向NativeWindow
Buffer
的结构体实例
返回一个指针,指向NativeWindow的结构体实例
**自从:**
8
### OH_NativeWindow_CreateNativeWindowFromSurface()
### OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer()
```
struct NativeWindow* OH_NativeWindow_CreateNativeWindowFromSurface (void * pSurface
)
OHNativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void * pSurfaceBuffer
)
```
**描述:**
创建NativeWindow
实例,每次调用都会产生一个新的NativeWindow
实例
创建NativeWindow
Buffer实例,每次调用都会产生一个新的NativeWindowBuffer
实例
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| pSurface
| 参数是一个指向生产者ProduceSurface的指针,类型为sptr
<
OHOS::Surface
>
|
| pSurface
Buffer | 参数是一个指向生产者buffer的指针,类型为sptr
<
OHOS::SurfaceBuffer
>
|
**返回:**
返回一个指针,指向NativeWindow的结构体实例
返回一个指针,指向NativeWindow
Buffer
的结构体实例
**自从:**
...
...
@@ -105,22 +219,22 @@ struct NativeWindow* OH_NativeWindow_CreateNativeWindowFromSurface (void * pSurf
### OH_NativeWindow_DestroyNativeWindow()
```
void OH_NativeWindow_DestroyNativeWindow (
struct
NativeWindow * window)
void OH_NativeWindow_DestroyNativeWindow (
OH
NativeWindow * window)
```
**描述:**
将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| window | 参数是一个NativeWindow的结构体实例的指针 |
**自从:**
...
...
@@ -129,22 +243,22 @@ void OH_NativeWindow_DestroyNativeWindow (struct NativeWindow * window)
### OH_NativeWindow_DestroyNativeWindowBuffer()
```
void OH_NativeWindow_DestroyNativeWindowBuffer (
struct
NativeWindowBuffer * buffer)
void OH_NativeWindow_DestroyNativeWindowBuffer (
OH
NativeWindowBuffer * buffer)
```
**描述:**
将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
**自从:**
...
...
@@ -153,22 +267,22 @@ void OH_NativeWindow_DestroyNativeWindowBuffer (struct NativeWindowBuffer * buff
### OH_NativeWindow_GetBufferHandleFromNative()
```
BufferHandle* OH_NativeWindow_GetBufferHandleFromNative (
struct
NativeWindowBuffer * buffer)
BufferHandle* OH_NativeWindow_GetBufferHandleFromNative (
OH
NativeWindowBuffer * buffer)
```
**描述:**
通过NativeWindowBuffer获取该buffer的BufferHandle指针
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
**返回:**
...
...
@@ -181,7 +295,7 @@ BufferHandle 返回一个指针,指向BufferHandle的结构体实例
### OH_NativeWindow_GetNativeObjectMagic()
```
int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj)
```
...
...
@@ -190,13 +304,13 @@ int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj)
获取NativeObject的MagicId
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
**返回:**
...
...
@@ -209,7 +323,7 @@ MagicId 返回值为魔鬼数字,每个NativeObject唯一
### OH_NativeWindow_NativeObjectReference()
```
int32_t OH_NativeWindow_NativeObjectReference (void * obj)
```
...
...
@@ -218,13 +332,13 @@ int32_t OH_NativeWindow_NativeObjectReference (void * obj)
增加一个NativeObject的引用计数
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
**返回:**
...
...
@@ -237,7 +351,7 @@ GSError 返回值为错误码
### OH_NativeWindow_NativeObjectUnreference()
```
int32_t OH_NativeWindow_NativeObjectUnreference (void * obj)
```
...
...
@@ -246,42 +360,42 @@ int32_t OH_NativeWindow_NativeObjectUnreference (void * obj)
减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
**返回:**
GSError
GSError
返回值为错误码
**自从:**
8
### OH_NativeWindow_NativeWindowCancelBuffer()
### OH_NativeWindow_NativeWindowAbortBuffer()
```
int32_t OH_NativeWindow_NativeWindow
CancelBuffer (struct NativeWindow * window, struct
NativeWindowBuffer * buffer )
int32_t OH_NativeWindow_NativeWindow
AbortBuffer (OHNativeWindow * window, OH
NativeWindowBuffer * buffer )
```
**描述:**
通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
**返回:**
...
...
@@ -294,25 +408,25 @@ GSError 返回值为错误码
### OH_NativeWindow_NativeWindowFlushBuffer()
```
int32_t OH_NativeWindow_NativeWindowFlushBuffer (
struct NativeWindow * window, struct
NativeWindowBuffer * buffer, int fenceFd, Region region )
int32_t OH_NativeWindow_NativeWindowFlushBuffer (
OHNativeWindow * window, OH
NativeWindowBuffer * buffer, int fenceFd, Region region )
```
**描述:**
通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
| fenceFd | 参数是一个文件描述符句柄,用以同步时序 |
| region | 参数表示一块脏区域,该区域有内容更新 |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 |
| fenceFd | 参数是一个文件描述符句柄,用以同步时序 |
| region | 参数表示一块脏区域,该区域有内容更新 |
**返回:**
...
...
@@ -325,23 +439,24 @@ GSError 返回值为错误码
### OH_NativeWindow_NativeWindowHandleOpt()
```
int32_t OH_NativeWindow_NativeWindowHandleOpt (
struct
NativeWindow * window, int code, ... )
int32_t OH_NativeWindow_NativeWindowHandleOpt (
OH
NativeWindow * window, int code, ... )
```
**描述:**
设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| code | 操作码 |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| code | 表示操作码,详见
[
NativeWindowOperation
](
#nativewindowoperation
)
|
| ... | 可变参数,必须与操作码一一对应 |
**返回:**
...
...
@@ -354,24 +469,24 @@ GSError 返回值为错误码
### OH_NativeWindow_NativeWindowRequestBuffer()
```
int32_t OH_NativeWindow_NativeWindowRequestBuffer (
struct NativeWindow * window, struct
NativeWindowBuffer ** buffer, int * fenceFd )
int32_t OH_NativeWindow_NativeWindowRequestBuffer (
OHNativeWindow * window, OH
NativeWindowBuffer ** buffer, int * fenceFd )
```
**描述:**
通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产
@syscap SystemCapability.Graphic.Graphic2D.NativeWindow
\
@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| Name | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的二级指针 |
| fenceFd | 参数是一个文件描述符句柄 |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| buffer | 参数是一个NativeWindowBuffer的结构体实例的二级指针 |
| fenceFd | 参数是一个文件描述符句柄 |
**返回:**
...
...
@@ -380,3 +495,125 @@ GSError 返回值为错误码
**自从:**
8
### OH_NativeWindow_NativeWindowSetMetaData()
```
int32_t OH_NativeWindow_NativeWindowSetMetaData (OHNativeWindow * window, uint32_t sequence, int32_t size, const OHHDRMetaData * metaData )
```
**描述:**
设置NativeWindow的元数据.
\@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| sequence | 生产缓冲区的序列 |
| size | OHHDRMetaData数组的大小 |
| metaDate | 指向OHHDRMetaData数组的指针 |
**返回:**
GSError 返回值为错误码
**自从:**
9
### OH_NativeWindow_NativeWindowSetMetaDataSet()
```
int32_t OH_NativeWindow_NativeWindowSetMetaDataSet (OHNativeWindow * window, uint32_t sequence, OHHDRMetadataKey key, int32_t size, const uint8_t * metaData )
```
**描述:**
设置NativeWindow的元数据集。
\@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针。 |
| sequence | 生产缓冲区的序列。 |
| key | 枚举值OHHDRMetadataKey |
| size | uint8_t向量的大小 |
| metaDate | 指向uint8_t向量的指针 |
**返回:**
GSError 返回值为错误码
**自从:**
9
### OH_NativeWindow_NativeWindowSetScalingMode()
```
int32_t OH_NativeWindow_NativeWindowSetScalingMode (OHNativeWindow * window, uint32_t sequence, OHScalingMode scalingMode )
```
**描述:**
设置NativeWindow的ScalingMode
\@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| sequence | 生产缓冲区的序列 |
| scalingMode | 枚举值OHScalingMode |
**返回:**
GSError 返回值为错误码
**自从:**
9
### OH_NativeWindow_NativeWindowSetTunnelHandle()
```
int32_t OH_NativeWindow_NativeWindowSetTunnelHandle (OHNativeWindow * window, const OHExtDataHandle * handle )
```
**描述:**
设置NativeWindow的TunnelHandle。
\@
syscap SystemCapability.Graphic.Graphic2D.NativeWindow
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| window | 参数是一个NativeWindow的结构体实例的指针 |
| handle | 指向OHExtDataHandle的指针 |
**返回:**
GSError 返回值为错误码
**自从:**
9
zh-cn/application-dev/reference/native-apis/_o_h_ext_data_handle.md
0 → 100644
浏览文件 @
feb1a534
# 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数组的个数
zh-cn/application-dev/reference/native-apis/_o_h_h_d_r_meta_data.md
0 → 100644
浏览文件 @
feb1a534
# OHHDRMetaData
## 概述
扩展数据句柄结构体定义。
**相关模块:**
[
NativeWindow
](
_native_window.md
)
## 汇总
### 成员变量
| 成员变量名称 | 描述 |
| -------- | -------- |
|
[
key
](
#key
)
| HDR元数据关键字 |
|
[
value
](
#value
)
| 关键字对应的值 |
## 结构体成员变量说明
### key
```
OHHDRMetadataKey OHHDRMetaData::key
```
**描述:**
HDR元数据关键字
### value
```
float OHHDRMetaData::value
```
**描述:**
关键字对应的值
zh-cn/application-dev/reference/native-apis/_rect.md
0 → 100644
浏览文件 @
feb1a534
# 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
```
**描述:**
矩形框高度。
zh-cn/application-dev/reference/native-apis/_region.md
0 → 100644
浏览文件 @
feb1a534
# 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
zh-cn/application-dev/reference/native-apis/external__window_8h.md
浏览文件 @
feb1a534
...
...
@@ -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_DestroyNativeWindow
](
_native_window.md#oh_nativewindow_destroynativewindow
)
(
struct
NativeWindow
\*
window) | 将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉 |
|
[
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_NativeWindowRequestBuffer
](
_native_window.md#oh_nativewindow_nativewindowrequestbuffer
)
(
struct
NativeWindow
\*
window, struct NativeWindowBuffer
\*\*
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_NativeWindowCancelBuffer
](
_native_window.md#oh_nativewindow_nativewindowcancelbuffer
)
(
struct
NativeWindow
\*
window, struct NativeWindowBuffer
\*
buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请 |
|
[
OH_NativeWindow_NativeWindowHandleOpt
](
_native_window.md#oh_nativewindow_nativewindowhandleopt
)
(
struct
NativeWindow
\*
window, int code,...) | 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等 |
|
[
OH_NativeWindow_GetBufferHandleFromNative
](
_native_window.md#oh_nativewindow_getbufferhandlefromnative
)
(
struct
NativeWindowBuffer
\*
buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 |
|
[
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_GetNativeObjectMagic
](
_native_window.md#oh_nativewindow_getnativeobjectmagic
)
(
void
\*
obj) | 获取NativeObject的MagicId |
|
[
OH_NativeWindow_CreateNativeWindow
](
_native_window.md#oh_nativewindow_createnativewindow
)
(
void
\*
pSurface) | 创建NativeWindow实例,每次调用都会产生一个新的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_DestroyNativeWindowBuffer
](
_native_window.md#oh_nativewindow_destroynativewindowbuffer
)
(
OHNativeWindowBuffer
\*
buffer) | 将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该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
)
(
OHNativeWindow
\*
window, OHNativeWindowBuffer
\*
buffer, int fenceFd,
[
Region
](
_region.md
)
region) | 通过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
)
(
OHNativeWindow
\*
window, int code,...) | 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等 |
|
[
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_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_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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录