|
AudioManager
7.6.6
Native Application Runtime Environment
|
|
AudioManager
7.6.6
Native Application Runtime Environment
|
This struct describes the attribiutes of a sink. More...
#include <audiomanagertypes.h>
Public Attributes | |
| am_sinkID_t | sinkID |
| This is the ID of the sink, it is unique in the system. More... | |
| std::string | name |
| The name of the sink. More... | |
| am_domainID_t | domainID |
| The domainID is the domain the sink belongs to. More... | |
| am_sinkClass_t | sinkClassID |
| The sinkClassID references to a sinkClass. More... | |
| am_volume_t | volume |
| This is the volume of the sink. More... | |
| bool | visible |
| This Boolean flag indicates whether a sink is visible to the commandInterface or not. More... | |
| am_Availability_s | available |
| This attribute reflects the availability of the sink. More... | |
| am_MuteState_e | muteState |
| This attribute reflects the muteState of the sink. More... | |
| am_mainVolume_t | mainVolume |
| This is the representation of the Volume for the commandInterface. More... | |
| std::vector< am_SoundProperty_s > | listSoundProperties |
| This is the list of soundProperties, that the sink 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 |
| This is the list of the MainNotificationConfigurations. More... | |
| std::vector< am_NotificationConfiguration_s > | listNotificationConfigurations |
| This is the list of the NotificationConfigurations. More... | |
This struct describes the attribiutes of a sink.
Definition at line 1137 of file audiomanagertypes.h.
| am_Availability_s am::am_Sink_s::available |
This attribute reflects the availability of the sink.
There are several reasons why a sink could be not available for the moment: for example the shutdown of a sink because of overtemperature or over- & undervoltage. The availability consists of two pieces of information:
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 1186 of file audiomanagertypes.h.
| am_domainID_t am::am_Sink_s::domainID |
The domainID is the domain the sink belongs to.
A sink can only be in one domain.
Definition at line 1156 of file audiomanagertypes.h.
| std::vector<am_CustomConnectionFormat_t> am::am_Sink_s::listConnectionFormats |
This list holds information about the formats that the Source is capable of supporting when delivering audio.
Definition at line 1209 of file audiomanagertypes.h.
| std::vector<am_NotificationConfiguration_s> am::am_Sink_s::listMainNotificationConfigurations |
This is the list of the MainNotificationConfigurations.
These notifications work on the level of command interface.
Definition at line 1220 of file audiomanagertypes.h.
| std::vector<am_MainSoundProperty_s> am::am_Sink_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 1215 of file audiomanagertypes.h.
| std::vector<am_NotificationConfiguration_s> am::am_Sink_s::listNotificationConfigurations |
This is the list of the NotificationConfigurations.
These notifications work on the level of RoutingPlugins.
Definition at line 1225 of file audiomanagertypes.h.
| std::vector<am_SoundProperty_s> am::am_Sink_s::listSoundProperties |
This is the list of soundProperties, that the sink is capable of.
The soundProperties itself are project specific. For sinks, a possible soundProperty could be for example settings.
Definition at line 1204 of file audiomanagertypes.h.
| am_mainVolume_t am::am_Sink_s::mainVolume |
This is the representation of the Volume for the commandInterface.
It is used by the HMI to set the volume of a sink, the AudioManagerController has to transform this into real source and sink volumes.
Definition at line 1198 of file audiomanagertypes.h.
| am_MuteState_e am::am_Sink_s::muteState |
This attribute reflects the muteState of the sink.
The information is not the "real" state of the sink, but the HMI representation for he commandInterface controlled by the AudioManagerController.
Definition at line 1192 of file audiomanagertypes.h.
| std::string am::am_Sink_s::name |
The name of the sink.
Must be unique in the whole system.
Definition at line 1151 of file audiomanagertypes.h.
| am_sinkClass_t am::am_Sink_s::sinkClassID |
The sinkClassID references to a sinkClass.
With the help of classification, rules can be setup to define the system behaviour.
Definition at line 1161 of file audiomanagertypes.h.
| am_sinkID_t am::am_Sink_s::sinkID |
This is the ID of the sink, 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 1147 of file audiomanagertypes.h.
| bool am::am_Sink_s::visible |
This Boolean flag indicates whether a sink 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 sinks, for example if the sink is part of a crossfader or gateway. HMI relevant changes in visible sinks will be automatically reported by the daemon to the commandInterface.
Definition at line 1174 of file audiomanagertypes.h.
| am_volume_t am::am_Sink_s::volume |
This is the volume of the sink.
It is set by the AudioManagerController.
Definition at line 1165 of file audiomanagertypes.h.
1.8.11 
