Welcome to Awox Audio Striim's documentation!
============================================

The documentation is organized into a few different sections below:

* :ref:`quick-overview`
* :ref:`technical-doc`


.. _quick-overview:

Quick overview
--------------

This documentation is to be considered as a base for beginning to work and interact with the web API ``WAPI`` (Web API)
exposed by the Awox Audio Striim Products. This API provides great means for a client, such as a smartphone, 
to interact with the device.


The documentation is divided into several pages and aspects each being a different part of the integration of the WAPI
into client applications. The very first page every new developer needs to take care of is the 
:doc:`Understanding the API<understanding-the-api>` 
page which basically explains how the API is being exposed, through which means, and for what reasons. It also provides useful
pieces of informations about the prerequisites for using the API, what responses format you should be expecting and what are
the best practices for interacting with it. 


.. _technical-doc:

Technical Specification
-----------------------

.. toctree::
    :maxdepth: 3

    api-reference

