From 1111f28e3693ee0f296819654a5c35fe147c395d Mon Sep 17 00:00:00 2001 From: Christian as GENIVI Maintainer Date: Fri, 30 Sep 2016 08:11:30 -0700 Subject: add doxygen documentation for github Signed-off-by: Christian as GENIVI Maintainer --- docs/elementspage.html | 169 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 docs/elementspage.html (limited to 'docs/elementspage.html') diff --git a/docs/elementspage.html b/docs/elementspage.html new file mode 100644 index 0000000..6cd7f3d --- /dev/null +++ b/docs/elementspage.html @@ -0,0 +1,169 @@ + + + + + + +AudioManager: Elements of the AudioManagement + + + + + + + + + + + + + +
+
+ + + + + + +
+
AudioManager +  7.5.11 +
+
Native Application Runtime Environment
+
+
+ + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+
Elements of the AudioManagement
+
+
+

+Overview Class Diagram

+

This class diagram shows a logical overview of the relevant elements in the AudioManager with their relations.

+
+ClassDiagramm.png +
+

The audiomanagement in principle consists of the following elements:

+

+Sources

+

This is where audio comes from, for examples tuner, mediaplayer. But sources can also be part of a building block that processes audio, examples are here crossfaders or gateways. Several Sinks can be connected to one source.
+

+

+Attributes

+ +

+Sinks

+

This is where audio flows to, for examples amplifier, headphones. But sources can also be part of a building block that processes audio, examples are here crossfaders or gateways. Several Sources can be connected to one sink.
+

+

+Attributes

+
    +
  • am::am_SinkType_s describes the attribiutes that are accessible form the AudioManagerCommandPlugins.
    +
    • +
  • am::am_Sink_s describes the general attributes.
    +
    • +
+

+Gateways

+

Gateways are described here: Gateway A specialitry of a gateways is the convertionmatrix. It indicates which sinksoundformats can be transferred in which sourcesoundformats. A convertion matrix looks like this:

+
+GatewayMatrix.png +
+

+Attributes

+ +

+Crossfaders

+

Cross-faders are special elements that can perform cross-fading between two sources connected to the sinks of the crossfader. The audio of either source or both (mixed, during the fade) is put out at the source of the fader. Cross-fading within a source (for example from one song to another) is out of scope audio management and must be performed in the source.
+ A crossfader has two sinks and one source, where one sink is the "hot" one. It is in the duty of the AudioManagerController to connect the correct sources to the sinks in order to perform a cross-fade. When fading is started, the hotSink changes from either HS_SINKA or HS_SINKB to HS_INTERMEDIATE, when the fading is finished, it changes to HS_SINKA or HS_SINKB (the sink that was "cold" before).Fading itself is done in the RoutingAdapters, the implementation has to ensure the smooth and synchronous change of volumes. With different rampTypes, different kinds of cross-fade ramps can be supported. The actual status of the "hot" sink is reported by the routingAdapter. Care has to be taken that the correct "hot" end of the crossfader is given at registration time.
+

+

+Attributes

+ +
+
+ + + + -- cgit v1.2.1