• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit ArkUI
19 */
20
21/**
22 * Defines the image analyze type.
23 *
24 * @enum { number }
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @atomicservice
27 * @since arkts {'1.1':'12','1.2':'20'}
28 * @arkts 1.1&1.2
29 */
30declare enum ImageAnalyzerType {
31  /**
32   * Image analyze type subject.
33   *
34   * @syscap SystemCapability.ArkUI.ArkUI.Full
35   * @atomicservice
36   * @since arkts {'1.1':'12','1.2':'20'}
37   * @arkts 1.1&1.2
38   */
39  SUBJECT = 0,
40
41  /**
42   * Image analyze type text.
43   *
44   * @syscap SystemCapability.ArkUI.ArkUI.Full
45   * @atomicservice
46   * @since arkts {'1.1':'12','1.2':'20'}
47   * @arkts 1.1&1.2
48   */
49  TEXT,
50
51  /**
52   * Image analyze type object lookup.
53   *
54   * @syscap SystemCapability.ArkUI.ArkUI.Full
55   * @atomicservice
56   * @since arkts {'1.1':'12','1.2':'20'}
57   * @arkts 1.1&1.2
58   */
59  OBJECT_LOOKUP,
60}
61
62/**
63 * Image analyzer controller.
64 *
65 * @syscap SystemCapability.ArkUI.ArkUI.Full
66 * @atomicservice
67 * @since arkts {'1.1':'12','1.2':'20'}
68 * @arkts 1.1&1.2
69 */
70declare class ImageAnalyzerController {
71  /**
72   * Constructor.
73   *
74   * @syscap SystemCapability.ArkUI.ArkUI.Full
75   * @atomicservice
76   * @since arkts {'1.1':'12','1.2':'20'}
77   * @arkts 1.1&1.2
78   */
79  constructor();
80
81  /**
82   * Get image analyzer support types.
83   *
84   * @returns { ImageAnalyzerType[] }
85   * @syscap SystemCapability.ArkUI.ArkUI.Full
86   * @atomicservice
87   * @since arkts {'1.1':'12','1.2':'20'}
88   * @arkts 1.1&1.2
89   */
90  getImageAnalyzerSupportTypes(): ImageAnalyzerType[];
91}
92
93/**
94 * Image analyzer config.
95 *
96 * @interface ImageAnalyzerConfig
97 * @syscap SystemCapability.ArkUI.ArkUI.Full
98 * @atomicservice
99 * @since arkts {'1.1':'12','1.2':'20'}
100 * @arkts 1.1&1.2
101 */
102declare interface ImageAnalyzerConfig {
103  /**
104   * Image analyze types.
105   *
106   * @type { ImageAnalyzerType[] }
107   * @syscap SystemCapability.ArkUI.ArkUI.Full
108   * @atomicservice
109   * @since arkts {'1.1':'12','1.2':'20'}
110   * @arkts 1.1&1.2
111   */
112  types: ImageAnalyzerType[];
113}
114
115/**
116 * Image ai options.
117 *
118 * @interface ImageAIOptions
119 * @syscap SystemCapability.ArkUI.ArkUI.Full
120 * @atomicservice
121 * @since arkts {'1.1':'12','1.2':'20'}
122 * @arkts 1.1&1.2
123 */
124declare interface ImageAIOptions {
125  /**
126   * Image analyze types.
127   *
128   * @type { ?ImageAnalyzerType[] }
129   * @syscap SystemCapability.ArkUI.ArkUI.Full
130   * @atomicservice
131   * @since arkts {'1.1':'12','1.2':'20'}
132   * @arkts 1.1&1.2
133   */
134  types?: ImageAnalyzerType[];
135
136  /**
137   * Image analyze types.
138   *
139   * @type { ?ImageAnalyzerController }
140   * @syscap SystemCapability.ArkUI.ArkUI.Full
141   * @atomicservice
142   * @since arkts {'1.1':'12','1.2':'20'}
143   * @arkts 1.1&1.2
144   */
145  aiController?: ImageAnalyzerController;
146}