diff options
Diffstat (limited to 'includes/audiomanagertypes.h')
| -rw-r--r-- | includes/audiomanagertypes.h | 304 |
1 files changed, 199 insertions, 105 deletions
diff --git a/includes/audiomanagertypes.h b/includes/audiomanagertypes.h index e0a6c21..c29afd6 100644 --- a/includes/audiomanagertypes.h +++ b/includes/audiomanagertypes.h @@ -22,8 +22,8 @@ *
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_2D7F1C82_8717_47ce_B755_51DDED15BC18__INCLUDED_)
-#define EA_2D7F1C82_8717_47ce_B755_51DDED15BC18__INCLUDED_
+#if !defined(EA_BB47505C_A541_4063_AF54_010D0AC22821__INCLUDED_)
+#define EA_BB47505C_A541_4063_AF54_010D0AC22821__INCLUDED_
#include <stdint.h>
#include "projecttypes.h"
@@ -124,56 +124,56 @@ namespace am { * After the buildup of a connection the first timing information needs to be sent within 5 seconds, the timing information from the routing adaptors need to be sent via 4 seconds. If the latency for a connection is variable and changes over lifetime of the connection, the routing adaptors shall resend the value and the audiomanger will correct the over all latency.\n * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:00 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_domainID_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:00 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_sourceID_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:00 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_sinkID_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:00 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_gatewayID_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:00 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_crossfaderID_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:00 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_connectionID_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:00 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_mainConnectionID_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_speed_t; @@ -181,7 +181,7 @@ namespace am { * The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE). The minimum and maximum can be limited by actual project. * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef int16_t am_volume_t; @@ -190,21 +190,21 @@ namespace am { * The range of this type is customer specific. * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef int16_t am_mainVolume_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_sourceClass_t; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_sinkClass_t; @@ -212,7 +212,7 @@ namespace am { * time in ms! * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef uint16_t am_time_t; @@ -220,7 +220,7 @@ namespace am { * offset time that is introduced in milli seconds. * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ typedef int16_t am_timeSync_t; @@ -228,197 +228,291 @@ namespace am { * with the help of this enum, sinks and sources can report their availability state * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_Availablility_e { - A_AVAILABLE = 0, - A_UNAVAILABLE = 1, - A_UNKNOWN = 2, - A_MAX = 3, - A_MIN = A_AVAILABLE + /** + * default + */ + A_UNKNOWN = 0, + /** + * The source / sink is available + */ + A_AVAILABLE = 1, + /** + * the source / sink is not available + */ + A_UNAVAILABLE = 2, + A_MAX }; /** * represents the connection state * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_ConnectionState_e { + CS_UNKNOWN = 0, /** * This means the connection is just building up */ - CS_CONNECTING = 0, + CS_CONNECTING = 1, /** * the connection is ready to be used */ - CS_CONNECTED = 1, + CS_CONNECTED = 2, /** * the connection is in the course to be knocked down */ - CS_DISCONNECTING = 2, + CS_DISCONNECTING = 3, /** * only relevant for connectionStatechanged. Is send after the connection was removed */ - CS_DISCONNECTED = 3, + CS_DISCONNECTED = 4, /** * this means the connection is still build up but unused at the moment */ - CS_SUSPENDED = 4, - CS_MAX = 5, - CS_MIN = CS_CONNECTING + CS_SUSPENDED = 5, + CS_MAX }; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_DomainState_e { - DS_CONTROLLED = 0, + /** + * default + */ + DS_UNKNOWN = 0, + /** + * the domain is controlled by the daemon + */ + DS_CONTROLLED = 1, + /** + * the domain is independent starting up + */ DS_INDEPENDENT_STARTUP = 1, + /** + * the domain is independent running down + */ DS_INDEPENDENT_RUNDOWN = 2, - DS_MAX = 3, - DS_MIN = DS_CONTROLLED + DS_MAX }; /** * This enum characterizes the data of the EarlyData_t * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_EarlyDataType_e { - ED_SOURCE_VOLUME = 0, - ED_SINK_VOLUME = 1, - ED_SOURCE_PROPERTY = 2, - ED_SINK_PROPERTY = 3, - ED_MAX = 4, - ES_MIN = ED_SOURCE_VOLUME + /** + * default + */ + ES_UNKNOWN = 0, + /** + * the source volume + */ + ED_SOURCE_VOLUME = 1, + /** + * the sink volume + */ + ED_SINK_VOLUME = 2, + /** + * a source property + */ + ED_SOURCE_PROPERTY = 3, + /** + * a sink property + */ + ED_SINK_PROPERTY = 4, + ED_MAX }; /** * the errors of the audiomanager. All possible errors are in here. This enum is used widely as return parameter. * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_Error_e { - E_OK = 0, - E_UNKNOWN = 1, + /** + * default + */ + E_UNKNOWN = 0, + /** + * no error - positive reply + */ + E_OK = 1, + /** + * value out of range + */ E_OUT_OF_RANGE = 2, + /** + * not used + */ E_NOT_USED = 3, + /** + * a database error occurred + */ E_DATABASE_ERROR = 4, + /** + * the desired object already exists + */ E_ALREADY_EXISTS = 5, + /** + * there is no change + */ E_NO_CHANGE = 6, + /** + * the desired action is not possible + */ E_NOT_POSSIBLE = 7, + /** + * the desired object is non existent + */ E_NON_EXISTENT = 8, + /** + * the asynchronous action was aborted + */ E_ABORTED = 9, /** * This error is returned in case a connect is issued with a connectionFormat that cannot be selected for the connection. This could be either due to the capabilities of a source or a sink or gateway compatibilities for example */ E_WRONG_FORMAT = 10, - E_MAX = 11, - E_MIN = E_OK + E_MAX }; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_MuteState_e { - MS_MUTED = 0, - MS_UNMUTED = 1, - MS_MAX = 2, - MS_MIN = MS_MUTED + /** + * default + */ + MS_UNKNOWN = 0, + /** + * the source / sink is muted + */ + MS_MUTED = 1, + /** + * the source / sink is unmuted + */ + MS_UNMUTED = 2, + MS_MAX }; /** * The source state reflects the state of the source * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_SourceState_e { + SS_UNKNNOWN = 0, /** * The source can be activly heared */ - SS_ON = 0, + SS_ON = 1, /** * The source cannot be heared */ - SS_OFF = 1, + SS_OFF = 2, /** * The source is paused. Meaning it cannot be heared but should be prepared to play again soon. */ - SS_PAUSED = 2, - SS_MAX = 3, - SS_MIN = SS_ON + SS_PAUSED = 3, + SS_MAX }; /** * This enumeration is used to define the type of the action that is correlated to a handle. * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_Handle_e { - H_CONNECT = 0, - H_DISCONNECT = 1, - H_SETSOURCESTATE = 2, - H_SETSINKVOLUME = 3, - H_SETSOURCEVOLUME = 4, - H_SETSINKSOUNDPROPERTY = 5, - H_SETSOURCESOUNDPROPERTY = 6, - H_SETSINKSOUNDPROPERTIES = 7, - H_SETSOURCESOUNDPROPERTIES = 8, - H_CROSSFADE = 9, - H_MAX = 10, - H_MIN = H_CONNECT + H_UNKNOWN = 0, + H_CONNECT = 1, + H_DISCONNECT = 2, + H_SETSOURCESTATE = 3, + H_SETSINKVOLUME = 4, + H_SETSOURCEVOLUME = 5, + H_SETSINKSOUNDPROPERTY = 6, + H_SETSOURCESOUNDPROPERTY = 7, + H_SETSINKSOUNDPROPERTIES = 8, + H_SETSOURCESOUNDPROPERTIES = 9, + H_CROSSFADE = 10, + H_MAX }; /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_InterruptState_e { - IS_OFF = 0, - IS_INTERRUPTED = 1, - IS_MAX = 2, - IS_MIN = IS_OFF + /** + * default + */ + IS_UNKNOWN = 0, + /** + * the interrupt state is off - no interrupt + */ + IS_OFF = 1, + /** + * the interrupt state is interrupted - the interrupt is active + */ + IS_INTERRUPTED = 2, + IS_MAX }; /** * describes the active sink of a crossfader. * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ enum am_HotSink_e { - HS_SINKA = 0, - HS_SINKB = 1, - HS_INTERMEDIATE = 2, - HS_MAX = 3, - HS_MIN = HS_SINKA + /** + * default + */ + HS_UNKNOWN = 0, + /** + * sinkA is active + */ + HS_SINKA = 1, + /** + * sinkB is active + */ + HS_SINKB = 2, + /** + * the crossfader is in the transition state + */ + HS_INTERMEDIATE = 3, + HS_MAX }; /** * this describes the availability of a sink or a source together with the latest change * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ struct am_Availability_s { @@ -438,7 +532,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:50 AM */ struct am_ClassProperty_s { @@ -452,7 +546,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_Crossfader_s { @@ -470,7 +564,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_Gateway_s { @@ -511,7 +605,7 @@ namespace am { * This represents one "hopp" in a route * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:01 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_RoutingElement_s { @@ -527,7 +621,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:02 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_Route_s { @@ -542,7 +636,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:02 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_SoundProperty_s { @@ -556,7 +650,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:02 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_SystemProperty_s { @@ -576,7 +670,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:02 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_SinkClass_s { @@ -591,7 +685,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:02 PM + * @created 21-Feb-2012 10:06:51 AM */ struct am_SourceClass_s { @@ -610,7 +704,7 @@ namespace am { * this type holds all information of sources relevant to the HMI * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:02 PM + * @created 21-Feb-2012 10:06:52 AM */ struct am_SourceType_s { @@ -627,7 +721,7 @@ namespace am { * this type holds all information of sinks relevant to the HMI * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:02 PM + * @created 21-Feb-2012 10:06:52 AM */ struct am_SinkType_s { @@ -645,7 +739,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:03 PM + * @created 21-Feb-2012 10:06:52 AM */ struct am_Handle_s { @@ -659,7 +753,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:03 PM + * @created 21-Feb-2012 10:06:52 AM */ struct am_MainSoundProperty_s { @@ -674,7 +768,7 @@ namespace am { * this type holds all information of connections relevant to the HMI * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:03 PM + * @created 21-Feb-2012 10:06:52 AM */ struct am_MainConnectionType_s { @@ -691,7 +785,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:03 PM + * @created 21-Feb-2012 10:06:52 AM */ struct am_MainConnection_s { @@ -715,7 +809,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:03 PM + * @created 21-Feb-2012 10:06:52 AM */ struct am_Sink_s { @@ -739,7 +833,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:03 PM + * @created 21-Feb-2012 10:06:53 AM */ struct am_Source_s { @@ -772,7 +866,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:03 PM + * @created 21-Feb-2012 10:06:53 AM */ struct am_Domain_s { @@ -791,7 +885,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:04 PM + * @created 21-Feb-2012 10:06:53 AM */ struct am_Connection_s { @@ -811,7 +905,7 @@ namespace am { * soundProperty_t in case of ED_SOURCE_PROPERTY, ED_SINK_PROPERTY * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:04 PM + * @created 21-Feb-2012 10:06:53 AM */ union am_EarlyData_u { @@ -828,7 +922,7 @@ namespace am { * sinkID in case of ED_SINK_VOLUME, ED_SINK_PROPERTY * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:04 PM + * @created 21-Feb-2012 10:06:53 AM */ union am_DataType_u { @@ -842,7 +936,7 @@ namespace am { /** * @author christian * @version 1.0 - * @created 10-Feb-2012 1:31:04 PM + * @created 21-Feb-2012 10:06:53 AM */ struct am_EarlyData_s { @@ -854,4 +948,4 @@ namespace am { }; } -#endif // !defined(EA_2D7F1C82_8717_47ce_B755_51DDED15BC18__INCLUDED_) +#endif // !defined(EA_BB47505C_A541_4063_AF54_010D0AC22821__INCLUDED_) |