this type holds all information of sinks relevant to the HMI 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_Availability_s	availability
	This attribute reflects the availability of the sink. More...

am_mainVolume_t	volume
	This is the representation of the Volume for the commandInterface. More...

am_MuteState_e	muteState

am_sinkClass_t	sinkClassID
	The sinkClassID references to a sinkClass. More...

Detailed Description

this type holds all information of sinks relevant to the HMI

Definition at line 945 of file audiomanagertypes.h.

Member Data Documentation

am_Availability_s am::am_SinkType_s::availability

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 971 of file audiomanagertypes.h.

am_MuteState_e am::am_SinkType_s::muteState

Definition at line 978 of file audiomanagertypes.h.

std::string am::am_SinkType_s::name

The name of the sink.

Must be unique in the whole system.

Definition at line 959 of file audiomanagertypes.h.

am_sinkClass_t am::am_SinkType_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 983 of file audiomanagertypes.h.

am_sinkID_t am::am_SinkType_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 955 of file audiomanagertypes.h.

am_mainVolume_t am::am_SinkType_s::volume

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 977 of file audiomanagertypes.h.

The documentation for this struct was generated from the following file:

include/audiomanagertypes.h

Public Attributes

Detailed Description

Member Data Documentation