summaryrefslogtreecommitdiff
path: root/docx/08_connections.dox
blob: fd8a194864e77b86a7141a6e2c4ffbae1f7b49a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 /*
 * Copyright (C) 2012, BMW AG
 *
 * This file is part of GENIVI Project AudioManager.
 *
 * Contributions are licensed to the GENIVI Alliance under one or more
 * Contribution License Agreements.
 *
 * \copyright
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * \\author Christian Linke (christian.linke@bmw.de)
 *
 */
 /*!
 \page connpage Connections & MainConnections
 \section con Connections
 A connection connects a source to a sink to let audio data flow. The direction of the flow is always source to sink. For each connection the connectionFormat
 must be defined when the connection is demanded, if source or sink is not capable of supporting this format, the connection cannot be established.
 ConnectionFormats are product specific, also are some standard formats defined within GENIVI that can be enhanced in the product area. Examples of formats:
 analog, autodefined, stereo 48khz 16bit PCM, ....

 \section maincon Mainconnections
 is visible to the HMI and consists out of one or more connections. A MainConnection shall always connect a Source and a Sink visible to the HMI.
 In contradiction to connections, the MainConnection does not know about connectionFormat. MainConnections are demanded by the commandInterface.
 This picture demonstrates the relation between MainConnections and connections:
 \image html Levels.png

 \section att Attributes
 - am::am_Connection_s describes the attributes of a conenction
 - */