WebCameraName - English
========================

.. toctree::
   :hidden:

   index_j


Introduction
============


For a full list of classes and functions, see the `API documentation`_.

.. _`API Documentation`:
   doxygen/html/index.html

Requirements
============

WebCamera uses the `CMake build system`. You will need at least version
2.8 to be able to build the component.

.. _`CMAke build system`:
   http://www.cmake.org


Installation
============

Binary
------

Users of Windows can install the component using the binary installer. This
will install the component and all its necessary dependencies. It is the
recommended method of installation in Windows.

- Download the installer from the website.
- Double-click the executable file to begin installation.
- Follow the instructions to install the component.
- You may need to restart your computer for environment variable changes
  to take effect before using the component.

The component can be launched by double-clicking the
``WebCameraComp`` executable. The ``WebCamera`` library
is available for loading into a manager, using the initialisation function
``WebCameraInit``.

From source
-----------

Follow these steps to install WebCamera from source in any operating
system:

- Download the source, either from the repository or a source archive,
  and extract it somewhere::

    tar -xvzf WebCamera-1.0.0.tar.gz

- Change to the directory containing the extracted source::

    cd WebCamera-1.0.0

- Create a directory called ``build``::

    mkdir build

- Change to that directory::

    cd build

- Run cmake or cmake-gui::

    cmake ../

- If no errors occurred, run make::

    make

- Finally, install the component. Ensure the necessary permissions to
  install into the chosen prefix are available::

    make install

- The install destination can be changed by executing ccmake and changing
  the variable ``CMAKE_INSTALL_PREFIX``::

    ccmake ../

The component is now ready for use. See the next section for instructions on
configuring the component.

WebCamera can be launched in stand-alone mode by executing the
``WebCameraComp`` executable (installed into ``${prefix}/components/bin``).
Alternatively, ``libWebCamera.so`` can be loaded into a manager, using the
initialisation function ``WebCameraInit``. This shared object can be found in
``${prefix}/components/lib`` or ``${prefix}/components/lib64``.


Configuration
=============

The available configuration parameters are described below:

================ ================== ================ ======
Parameter        Data type          Default Value    Effect
================ ================== ================ ======
camera_id        int                0                
output_color_format string             RGB              
camera_param_filename string             ..\..\camera.yml 
undistortion_flag string             false            
cap_continuous_flag string             false            
compression_ratio int                75               This parameter can control the compression ratio for JPEG and PNG color format.
================ ================== ================ ======

Ports
=====

The ports provided by the component are described below:

=============== =========== ============================== =======
Name            Type        Data type                      Purpose
=============== =========== ============================== =======
CameraImage     OutPort     Img::TimedCameraImage          
CameraCaptureService ServicePort Img::CameraCaptureService      
=============== =========== ============================== =======

Examples
========

An example configuration file is provided in the
``${prefix}/components/share/WebCamera/examples/conf/`` directory.

Changelog
=========



License
=======

This software is developed at the National Institute of Advanced
Industrial Science and Technology. Approval number H23PRO-????. This
software is licensed under the Lesser General Public License. See
COPYING.LESSER.

