diff options
author | christian mueller <christian.ei.mueller@bmw.de> | 2012-03-07 10:15:47 +0100 |
---|---|---|
committer | christian mueller <christian.ei.mueller@bmw.de> | 2012-03-07 10:15:47 +0100 |
commit | 62773dc7e9076d57764f3e823366697eb8a19060 (patch) | |
tree | ae7fca7c0e8f44d18fc4f9da11b8b0a5557e3bfe /AudioManagerDaemon/docx/08_connections.dox | |
parent | f23f9c3ecf40636f176107f6098c308f72fdbd5d (diff) | |
download | audiomanager-62773dc7e9076d57764f3e823366697eb8a19060.tar.gz |
* forgot to check in the documentation
Diffstat (limited to 'AudioManagerDaemon/docx/08_connections.dox')
-rw-r--r-- | AudioManagerDaemon/docx/08_connections.dox | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/AudioManagerDaemon/docx/08_connections.dox b/AudioManagerDaemon/docx/08_connections.dox new file mode 100644 index 0000000..f57f9a3 --- /dev/null +++ b/AudioManagerDaemon/docx/08_connections.dox @@ -0,0 +1,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 Mueller (christian.ei.mueller@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 + - */
\ No newline at end of file |