.. highlight:: java
.. class:: BaseLoaderCallback
- Basic implementation of LoaderCallbackInterface. Implementation logic is described by diagram.
+ Basic implementation of LoaderCallbackInterface. Logic of this implementation is well-described by the following scheme:
.. image:: img/AndroidAppUsageModel.png
.. method:: String getPackageName()
- Get name of a package to be installed
+ Get name of a package to be installed.
- :rtype: String
- :return: Return package name, i.e. "OpenCV Manager Service" or "OpenCV library"
+ :rtype: string;
+ :return: returns package name, i.e. "OpenCV Manager Service" or "OpenCV library".
void install()
--------------
.. method:: void install()
- Installation of package is approved
+ Installation of package has been approved.
void cancel()
-------------
.. method:: void cancel()
- Installation if package was canceled
+ Installation if package has been canceled.
OpenCV Manager is an Android service targeted to manage OpenCV library binaries on end users devices. It allows sharing the OpenCV dynamic libraries of different versions between applications on the same device. The Manager provides the following benefits\:
-#. Less memory usage. All apps use the same binaries from service and do not keep native libs inside them self;
+#. Less memory usage. All apps use the same binaries from service and do not keep native libs inside themselves;
#. Hardware specific optimizations for all supported platforms;
#. Trusted OpenCV library source. All packages with OpenCV are published on Google Play service;
#. Regular updates and bug fixes;
First OpenCV app\:
-#. User downloads app dependent from OpenCV from Google Play or installs it manually;
-#. User starts application. Application asks user to install OpenCV Manager;
-#. User installs OpenCV Manager from Google Play Service;
-#. User starts application. Application proposes to user to install OpenCV library for target device and runs Google Play;
-#. User runs app in the third time and gets what he or she wants.
+#. OpenCV app is downloaded as an dependency on Google Play marketplace or manually;
+#. When the app starts, it suggests installing OpenCV Manager;
+#. Then OpenCV Manager is downloaded and installed, using Google Play marketplace service.
+#. When started, the application suggests installing OpenCV library for the target device trough Google Play marketplace;
+#. After installation is finished, the app may be launched to perform common tasks.
Next OpenCV app\:
-#. User downloads app dependent from OpenCV from Google Play or installs it manually;
-#. User starts application.
-#. If selected version is not installed Manager asks user to install OpenCV library package and runs Google Play;
-#. User runs app in the second time and gets what he or she wants.
+#. OpenCV app is downloaded as an dependency on Google Play marketplace or manually;
+#. After the installation is finished, the app may be launched.
+#. If the selected version is not installed, OpenCV Manager suggests installing OpenCV library for the target device trough Google Play marketplace;
+#. After installation is finished, the app may be launched to perform common tasks.
OpenCV Manager structure
------------------------
.. highlight:: java
.. Class:: OpenCVLoader
-Helper class provides common initialization methods for OpenCV library
+Helper class provides common initialization methods for OpenCV library.
boolean initDebug()
-------------------
.. method:: static boolean initDebug()
- Load and initialize OpenCV library from current application package. Roughly it is analog of system.loadLibrary("opencv_java")
+ Loads and initializes OpenCV library from within current application package. Roughly it is analog of ``system.loadLibrary("opencv_java")``.
- :rtype: boolean
- :return: Return true if initialization of OpenCV was successful
+ :rtype: boolean;
+ :return: returns true if initialization of OpenCV was successful.
-.. note:: This way is deprecated for production code. It is designed for experimantal and local development purposes only. If you want to publish your app use approach with async initialization
+.. note:: This method is deprecated for production code. It is designed for experimantal and local development purposes only. If you want to publish your app use approach with async initialization.
boolean initAsync()
-------------------
.. method:: static boolean initAsync(String Version, Context AppContext, LoaderCallbackInterface Callback)
- Load and initialize OpenCV library using OpenCV Manager service.
+ Loads and initializes OpenCV library using OpenCV Manager service.
- :param Version: OpenCV Library version
- :param AppContext: Application context for connecting to service
- :param Callback: Object, that implements LoaderCallbackInterface for handling Connection status. See BaseLoaderCallback.
- :rtype: boolean
- :return: Return true if initialization of OpenCV starts successfully
+ :param Version: OpenCV Library version.
+ :param AppContext: application context for connecting to the service.
+ :param Callback: object, that implements LoaderCallbackInterface for handling connection status (see BaseLoaderCallback).
+
+ :rtype: boolean;
+ :return: returns true if initialization of OpenCV starts successfully.
OpenCV version constants
-------------------------
.. highlight:: java
.. class:: LoaderCallbackInterface
- Interface for callback object in case of asynchronous initialization of OpenCV
+ Interface for a callback object in case of asynchronous initialization of OpenCV.
void onManagerConnected()
-------------------------
.. method:: void onManagerConnected(int status)
- Callback method that is called after OpenCV library initialization
+ Callback method that is called after OpenCV Library initialization.
- :param status: Status of initialization. See Initialization status constants
+ :param status: status of initialization (see Initialization Status Constants).
void onPackageInstall()
-----------------------
.. method:: void onPackageInstall(InstallCallbackInterface Callback)
- Callback method that is called in case when package installation is needed
+ Callback method that is called in case when package installation is needed.
- :param callback: Answer object with approve and cancel methods and package description
+ :param callback: answer object with approve and cancel methods and package description.
Initialization status constants
-------------------------------
.. data:: SUCCESS
- OpenCV initialization finished successfully
+ OpenCV initialization finished successfully.
.. data:: RESTART_REQUIRED
First application start
-----------------------
-There is no OpenCV Manager and OpenCV libraries.
+There is no OpenCV Manager or OpenCV libraries:
.. image:: img/NoService.png
Second application start
------------------------
-There is OpenCV Manager service, but there is no OpenCV library.
-If OpenCV library installation approved\:
+There is an OpenCV Manager service, but there is no OpenCV library.
+If OpenCV library installation has been approved\:
.. image:: img/LibInstallAproved.png
-If OpenCV library installation canceled\:
+If OpenCV library installation has been canceled\:
.. image:: img/LibInstallCanceled.png
Regular application start
-------------------------
-OpenCV Manager and OpenCV library has bee already installed.
+OpenCV Manager and OpenCV library has been already installed.
.. image:: img/LibInstalled.png
\ No newline at end of file
projects / platform / upstream / opencv.git / commitdiff