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/structam_1_1am__SourceType__s.html | 224 ++++++++++++++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 docs/structam_1_1am__SourceType__s.html (limited to 'docs/structam_1_1am__SourceType__s.html') diff --git a/docs/structam_1_1am__SourceType__s.html b/docs/structam_1_1am__SourceType__s.html new file mode 100644 index 0000000..60fb2c6 --- /dev/null +++ b/docs/structam_1_1am__SourceType__s.html @@ -0,0 +1,224 @@ + + + + + + +AudioManager: am::am_SourceType_s Struct Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
AudioManager +  7.5.11 +
+
Native Application Runtime Environment
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Attributes | +List of all members
+
+
am::am_SourceType_s Struct Reference
+
+
+ +

this type holds all information of sources relevant to the HMI + More...

+ +

#include <audiomanagertypes.h>

+ + + + + + + + + + + + + + +

+Public Attributes

am_sourceID_t sourceID
 This is the ID of the source, it is unique in the system. More...
 
std::string name
 The name of the source. More...
 
am_Availability_s availability
 the availability of the source More...
 
am_sourceClass_t sourceClassID
 the sourceClassID, indicates the class the source is in. More...
 
+

Detailed Description

+

this type holds all information of sources relevant to the HMI

+ +

Definition at line 914 of file audiomanagertypes.h.

+

Member Data Documentation

+ +
+
+ + + + +
am_Availability_s am::am_SourceType_s::availability
+
+ +

the availability of the source

+ +

Definition at line 932 of file audiomanagertypes.h.

+ +
+
+ +
+
+ + + + +
std::string am::am_SourceType_s::name
+
+ +

The name of the source.

+

Must be unique in the whole system.

+ +

Definition at line 928 of file audiomanagertypes.h.

+ +
+
+ +
+
+ + + + +
am_sourceClass_t am::am_SourceType_s::sourceClassID
+
+ +

the sourceClassID, indicates the class the source is in.

+

This information can be used by the Controller to implement different behaviour for different classes.

+ +

Definition at line 938 of file audiomanagertypes.h.

+ +
+
+ +
+
+ + + + +
am_sourceID_t am::am_SourceType_s::sourceID
+
+ +

This is the ID of the source, it is unique in the system.

+

There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).

+ +

Definition at line 924 of file audiomanagertypes.h.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + -- cgit v1.2.1