1/*
2 * Copyright (c) 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 iimage_process_session.h
18 *
19 * @brief Declares APIs for image process session.
20 *
21 * @since 4.1
22 * @version 1.2
23 */
24
25package ohos.hdi.camera.v1_2;
26
27import ohos.hdi.camera.v1_2.Types;
28
29interface IImageProcessSession {
30    /**
31     * @brief Get coucurrency task count of the process session with the spacific post-procession execution mode.
32     *
33     * @param mode Indicates execution mode.
34     * @param taskCount Indicates coucurrency task count.
35     *
36     * @since 4.1
37     * @version 1.2
38     */
39    GetCoucurrency([in] enum ExecutionMode mode, [out] int taskCount);
40
41    /**
42     * @brief Get the IDs of the pending images which are unprocessed.
43     *
44     * @param imageIds Indicates the IDs of the pending images.
45     *
46     * @since 4.1
47     * @version 1.2
48     */
49    GetPendingImages([out] List<String> imageIds);
50
51    /**
52     * @brief Set the post-procession execution mode.
53     *
54     * @param mode Indicates the execution mode.
55     *
56     * @since 4.1
57     * @version 1.2
58     */
59    SetExecutionMode([in] ExecutionMode mode);
60
61    /**
62     * @brief Process the specific image by image ID.
63     *
64     * @param imageId Indicates image ID.
65     *
66     * @since 4.1
67     * @version 1.2
68     */
69    ProcessImage([in] String imageId);
70
71    /**
72     * @brief Remove the specific image by image ID.
73     *
74     * @param imageId Indicates image ID.
75     *
76     * @since 4.1
77     * @version 1.2
78     */
79    RemoveImage([in] String imageId);
80
81    /**
82     * @brief Interrupt the process session.
83     *
84     * @since 4.1
85     * @version 1.2
86     */
87    Interrupt();
88
89    /**
90     * @brief Reset the process session.
91     *
92     * @since 4.1
93     * @version 1.2
94     */
95    Reset();
96}