diff options
Diffstat (limited to 'doc/ApplicationGuide.md')
| -rw-r--r-- | doc/ApplicationGuide.md | 64 |
1 files changed, 31 insertions, 33 deletions
diff --git a/doc/ApplicationGuide.md b/doc/ApplicationGuide.md index 19c82af..3bcde53 100644 --- a/doc/ApplicationGuide.md +++ b/doc/ApplicationGuide.md @@ -14,28 +14,28 @@ - [Target reader of this document](#Target\ reader\ of\ this\ document) - [Overview](#Overview) - [Getting Start](#Getting\ Start) - - [Supported environment](#Supported\ environment) - - [Build](#Build) - - [Configuring](#Configuring) - - [Additional work](#Additional\ work) - - [How to call Sound Manager's APIs from your Application?](#How\ to\ call\ Sound\ Manager\ APIs\ from\ your\ Application?) + - [Supported environment](#Supported\ environment) + - [Build](#Build) + - [Configuring](#Configuring) + - [Additional work](#Additional\ work) + - [How to call Sound Manager's APIs from your Application?](#How\ to\ call\ Sound\ Manager\ APIs\ from\ your\ Application?) - [Supported usecase](#Supported\ usecase) - [Software Architecture](#Software\ Architecture) - [API reference](#API\ reference) - - [APIs](#APIs) - - [Events](#Events) + - [APIs](#APIs) + - [Events](#Events) - [Sequence](#Sequence) - - [StartUp](#StartUp) - - [Registration](#Registration) - - [Request Sound Right](#Request\ Sound\ Right) - - [Connect Sound Route](#Connect\ Sound\ Route) - - [Start Sound Streaming](#Start\ Sound\ Streaming) - - [Stop Sound Streaming](#Stop\ Sound\ Streaming) - - [Disconnect Sound Route](#Disconnect\ Sound\ Route) - - [Change Volume](#Change\ Volume) - - [Set Mute State](#Set\ Mute\ State) - - [Release Sound Right](#Release\ Sound\ Right) - - [Audio Domain](#Audio\ Domain) + - [StartUp](#StartUp) + - [Registration](#Registration) + - [Request Sound Right](#Request\ Sound\ Right) + - [Connect Sound Route](#Connect\ Sound\ Route) + - [Start Sound Streaming](#Start\ Sound\ Streaming) + - [Stop Sound Streaming](#Stop\ Sound\ Streaming) + - [Disconnect Sound Route](#Disconnect\ Sound\ Route) + - [Change Volume](#Change\ Volume) + - [Set Mute State](#Set\ Mute\ State) + - [Release Sound Right](#Release\ Sound\ Right) + - [Audio Domain](#Audio\ Domain) - [Sample code](#Sample\ code) - [Limitation](#Limitation) @@ -59,10 +59,12 @@ The reason why this service is based on GENIVI Audio Manager is because GENIVI A In order to understand, the below figure shows the one of typical usecases. In this example, there are four sound mode. + 1. Audio Off 1. Media Player 1. Tel (Ring and talking) 1. TTS (Text To Speech; typically it's used by Navigation sound) +  The important points are: @@ -104,7 +106,8 @@ Of course user can customize shortcut menu, but since it's too many states so th You can make Sound Manager object files by the following two stage operations. -**Download recipe** +#### Download recipe + If repo is already done, please start with git clone ```bash @@ -114,7 +117,7 @@ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo repo sync ``` -**Bitbake** +#### Bitbake ```bash source meta-agl/scripts/aglsetup.sh -m m3ulcb agl-demo agl-devel agl-appfw-smack agl-hmi-framework @@ -172,8 +175,6 @@ Please also refer sample application and template. See also our [Sample code](#Sample\ code). -<br /> - * * * <div id="Supported\ usecase"></div> @@ -227,14 +228,15 @@ The communication protocols between libsoundmanager and upper binder, upper bind "libsoundmanager" and "soundmanager_binding" provides several kinds of APIs, and these APIs basically correspond to GENIVI Audio Manager API. (Some APIs are Sound Manager original functions.) For understanding, GENIVI Audio Manager stands for one core module and three plug-ins. + 1. AudioManagerDaemon - This is a core module of Audio Manager. + This is a core module of Audio Manager. 2. AudioManagerCommandPlugin - This is a command interface for Audio Manager. + This is a command interface for Audio Manager. 3. AudioManagerController - This plug-in can be used for sound-right management. + This plug-in can be used for sound-right management. 4. AudioManagerRountingPlugin - This plug-in abstracts the hardware and software. And sometimes there may be multiple plug-ins. + This plug-in abstracts the hardware and software. And sometimes there may be multiple plug-ins. *) [See also GENIVI AudioManager Components](http://docs.projects.genivi.org/AudioManager/audiomanagercomponentspage.html) @@ -363,7 +365,7 @@ Although strongly recommended to read whole pages, but you can get quick underst <div id="Sample\ code"></div> -# Sample code +## Sample code You can find samples using Sound Manager as below. @@ -372,10 +374,6 @@ You can find samples using Sound Manager as below. <div id="Limitation"></div> -# Limitation - -- Minimum APIs and Events are prepared for RC2, the following APIs will be available for final version of EE. - -- getListMainSinks +## Limitation -- Sound of application is not automatically muted for now because Audio Manager doesn't automatically stop with current plugins. +- Sound of application is not automatically muted for now because Audio Manager doesn't stop with current plugins. Just notify stop/pause/play. |