Merge pull request #1263 from abidrahmank:pyCLAHE_24
[profile/ivi/opencv.git] / platforms / android / service / doc / JavaHelper.rst
1 ******************
2 Java OpenCV Loader
3 ******************
4
5 .. highlight:: java
6 .. Class:: OpenCVLoader
7
8 Helper class provides common initialization methods for OpenCV library.
9
10 boolean initDebug()
11 -------------------
12
13 .. method:: static boolean initDebug()
14
15     Loads and initializes OpenCV library from within current application package. Roughly it is
16     analog of ``system.loadLibrary("opencv_java")``.
17
18     :rtype: boolean;
19     :return: returns true if initialization of OpenCV was successful.
20
21 .. note:: This method is deprecated for production code. It is designed for experimental and local
22           development purposes only. If you want to publish your app use approach with async
23           initialization.
24
25 boolean initAsync()
26 -------------------
27
28 .. method:: static boolean initAsync(String Version, Context AppContext, LoaderCallbackInterface Callback)
29
30     Loads and initializes OpenCV library using OpenCV Manager.
31
32     :param Version: OpenCV Library version.
33     :param AppContext: application context for connecting to the service.
34     :param Callback: object, that implements ``LoaderCallbackInterface`` for handling connection
35                      status (see ``BaseLoaderCallback``).
36
37     :rtype: boolean;
38     :return: returns true if initialization of OpenCV starts successfully.
39
40 OpenCV version constants
41 -------------------------
42
43 .. data:: OPENCV_VERSION_2_4_2
44
45     OpenCV Library version 2.4.2
46
47 .. data:: OPENCV_VERSION_2_4_3
48
49     OpenCV Library version 2.4.3
50
51 .. data:: OPENCV_VERSION_2_4_4
52
53     OpenCV Library version 2.4.4
54
55 .. data:: OPENCV_VERSION_2_4_5
56
57     OpenCV Library version 2.4.5
58
59 .. data:: OPENCV_VERSION_2_4_6
60
61     OpenCV Library version 2.4.6