• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Interface (WhiteBalanceQuery)
2<!--Kit: Camera Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @qano-->
5<!--Designer: @leo_ysl-->
6<!--Tester: @xchaosioda-->
7<!--Adviser: @zengyawen-->
8
9> **说明：**
10>
11> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
12> - 本Interface首批接口从API version 20开始支持。
13
14提供了查询设备对指定的白平衡模式是否支持，以及获取设备支持的白平衡模式范围的方法。
15
16## 导入模块
17
18```ts
19import { camera } from '@kit.CameraKit';
20```
21
22## isWhiteBalanceModeSupported<sup>20+</sup>
23
24isWhiteBalanceModeSupported(mode: WhiteBalanceMode): boolean
25
26检测是否支持当前传入的白平衡模式。
27
28**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
29
30**系统能力：** SystemCapability.Multimedia.Camera.Core
31
32**参数：**
33
34| 参数名      | 类型                                      | 必填  | 说明                           |
35| -------- |-----------------------------------------| ---- | ----------------------------- |
36| mode   | [WhiteBalanceMode](arkts-apis-camera-e.md#whitebalancemode20) | 是   | 白平衡模式。                      |
37
38**返回值：**
39
40| 类型        | 说明                          |
41| ---------- | ----------------------------- |
42| boolean    | 表示是否支持白平衡模式。true表示支持，false表示不支持。 |
43
44**错误码：**
45
46以下错误码的详细介绍请参见[Camera错误码](errorcode-camera.md)。
47
48| 错误码ID         | 错误信息        |
49| --------------- | --------------- |
50| 7400101                |  Parameter missing or parameter type incorrect.        |
51| 7400103                |  Session not config, only throw in session usage.                                  |
52
53**示例：**
54
55```ts
56import { BusinessError } from '@kit.BasicServicesKit';
57
58function isWhiteBalanceModeSupported(session: camera.PhotoSession | camera.VideoSession): boolean {
59  let status: boolean = false;
60  try {
61  let mode: camera.WhiteBalanceMode = camera.WhiteBalanceMode.DAYLIGHT;
62    status = session.isWhiteBalanceModeSupported(mode);
63  } catch (error) {
64    let err = error as BusinessError;
65    console.error(`The isWhiteBalanceModeSupported call failed. error code: ${err.code}`);
66  }
67  return status;
68}
69```
70
71## getWhiteBalanceRange<sup>20+</sup>
72
73getWhiteBalanceRange(): Array\<number\>
74
75获取手动白平衡模式下，白平衡值的范围。
76
77**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。
78
79**系统能力：** SystemCapability.Multimedia.Camera.Core
80
81**返回值：**
82
83| 类型        | 说明                          |
84| ---------- | ----------------------------- |
85| Array\<number\>   | 用于获取手动白平衡值的可调范围，如[2800，10000]，单位为K（Kelvin，温度单位），实际情况根据底层能力返回为准。 |
86
87**错误码：**
88
89以下错误码的详细介绍请参见[Camera错误码](errorcode-camera.md)。
90
91| 错误码ID         | 错误信息        |
92| --------------- | --------------- |
93| 7400103                |  Session not config, only throw in session usage.                                  |
94
95**示例：**
96
97```ts
98import { BusinessError } from '@kit.BasicServicesKit';
99
100function getWhiteBalanceRange(session: camera.PhotoSession | camera.VideoSession): Array<number> {
101  let range: Array<number> = [];
102  try {
103    range = session.getWhiteBalanceRange();
104  } catch (error) {
105    let err = error as BusinessError;
106    console.error(`The getWhiteBalanceRange call failed. error code: ${err.code}`);
107  }
108  return range;
109}
110```
111