|
AudioManager
7.6.6
Native Application Runtime Environment
|
|
AudioManager
7.6.6
Native Application Runtime Environment
|
This struct describes the attribiutes of a source. More...
#include <audiomanagertypes.h>
Public Attributes | |
| am_sourceID_t | sourceID |
| This is the ID of the source, it is unique in the system. More... | |
| am_domainID_t | domainID |
| The domainID is the domain the source belongs to. More... | |
| std::string | name |
| The name of the source. More... | |
| am_sourceClass_t | sourceClassID |
| the sourceClassID, indicates the class the source is in. More... | |
| am_SourceState_e | sourceState |
| The source state is an indication towards the source if it is actively heard or not. More... | |
| am_volume_t | volume |
| This is the volume of the source. More... | |
| bool | visible |
| This Boolean flag indicates whether a source is visible to the commandInterface or not. More... | |
| am_Availability_s | available |
| This attribute reflects the availability of the source. More... | |
| am_InterruptState_e | interruptState |
| Some special sources can have special behaviors, the are so called "Low Level
Interrupts". More... | |
| std::vector< am_SoundProperty_s > | listSoundProperties |
| This is the list of soundProperties, that the source is capable of. More... | |
| std::vector< am_CustomConnectionFormat_t > | listConnectionFormats |
| This list holds information about the formats that the Source is capable of supporting when delivering audio. More... | |
| std::vector< am_MainSoundProperty_s > | listMainSoundProperties |
| This is the list of the available mainSoundProperties. More... | |
| std::vector< am_NotificationConfiguration_s > | listMainNotificationConfigurations |
| The list of MainNotificationConfigurations. More... | |
| std::vector< am_NotificationConfiguration_s > | listNotificationConfigurations |
| The list of MainNotificationConfigurations. More... | |
This struct describes the attribiutes of a source.
Definition at line 1232 of file audiomanagertypes.h.
| am_Availability_s am::am_Source_s::available |
This attribute reflects the availability of the source.
There are several reasons why a source could be not available for the moment. For example a CD player which has no CD entered in the slot can be unavailable, or a USB player with no or unreadable stick attached. Other scenarios involve the shutdown of a source because of overtemperature or over- & undervoltage. The availability consists of two informations:
Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
Definition at line 1298 of file audiomanagertypes.h.
| am_domainID_t am::am_Source_s::domainID |
The domainID is the domain the source belongs to.
A source can only be in one domain.
Definition at line 1247 of file audiomanagertypes.h.
| am_InterruptState_e am::am_Source_s::interruptState |
Some special sources can have special behaviors, the are so called "Low Level Interrupts".
Here the current status is documented. The information can be used by the AudioManagerController to react to the changes by for example lowering the volume of the mainSources. The two states are
IS_OFF: the interrupt is not active at the moment IS_INTERRUPTED: the interrupt is playing at the moment.
Definition at line 1308 of file audiomanagertypes.h.
| std::vector<am_CustomConnectionFormat_t> am::am_Source_s::listConnectionFormats |
This list holds information about the formats that the Source is capable of supporting when delivering audio.
Definition at line 1319 of file audiomanagertypes.h.
| std::vector<am_NotificationConfiguration_s> am::am_Source_s::listMainNotificationConfigurations |
The list of MainNotificationConfigurations.
These notifications work on the level of CommandInterface.
Definition at line 1330 of file audiomanagertypes.h.
| std::vector<am_MainSoundProperty_s> am::am_Source_s::listMainSoundProperties |
This is the list of the available mainSoundProperties.
The principle is the same than with soundProperties, but they are only visible to the CommandInterface.
Definition at line 1325 of file audiomanagertypes.h.
| std::vector<am_NotificationConfiguration_s> am::am_Source_s::listNotificationConfigurations |
The list of MainNotificationConfigurations.
These notifications work on the level of RoutingInterface.
Definition at line 1335 of file audiomanagertypes.h.
| std::vector<am_SoundProperty_s> am::am_Source_s::listSoundProperties |
This is the list of soundProperties, that the source is capable of.
The soundProperties itself are project specific. For sources, a possible soundProperty could be navigation volume offset, for example.
Definition at line 1314 of file audiomanagertypes.h.
| std::string am::am_Source_s::name |
The name of the source.
Must be unique in the whole system.
Definition at line 1251 of file audiomanagertypes.h.
| am_sourceClass_t am::am_Source_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 1257 of file audiomanagertypes.h.
| am_sourceID_t am::am_Source_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 1242 of file audiomanagertypes.h.
| am_SourceState_e am::am_Source_s::sourceState |
The source state is an indication towards the source if it is actively heard or not.
The source can use this information to implement features like automatic spin down of CD's in case the CD is not the active source or AF following of a tuner that is not actively heard. The source state is set by the AudioManagerController.There are 3 possible states:
SS_ON: the source is active SS_OFF: the source is off SS_PAUSED: the source is paused and not active.
Definition at line 1269 of file audiomanagertypes.h.
| bool am::am_Source_s::visible |
This Boolean flag indicates whether a source is visible to the commandInterface or not.
If the User must have the possibility to choose the source in the HMI, it must be visible. But there are also good reasons for invisible sources, for example if the source is part of a crossfader or gateway. HMI relevant changes in visible sources will be automatically reported by the daemon to the commandInterface.
Definition at line 1284 of file audiomanagertypes.h.
| am_volume_t am::am_Source_s::volume |
This is the volume of the source.
It is set by the AudioManagerController. It is used to adopt different audiolevels in a system and mixing of sources (e.g. navigation hints & music).
Definition at line 1275 of file audiomanagertypes.h.
1.8.11 
