AudioManager  7.6.6
Native Application Runtime Environment
audiomanagertypes.h File Reference

Copyright (C) 2012 - 2014, BMW AG. More...

#include <stdint.h>
#include <string>
#include <vector>

Go to the source code of this file.

Classes

struct  am::am_Availability_s
 this describes the availability of a sink or a source together with the latest change More...
 
struct  am::am_ClassProperty_s
 describes class properties More...
 
struct  am::am_Crossfader_s
 This struct describes the attribiutes of a crossfader. More...
 
struct  am::am_Converter_s
 This struct describes the attributes of a converter. More...
 
struct  am::am_Gateway_s
 This struct describes the attributes of a gateway. More...
 
struct  am::am_RoutingElement_s
 This represents one "hopp" in a route. More...
 
struct  am::am_Route_s
 a list of routing elements that lead from source to sink More...
 
struct  am::am_SoundProperty_s
 struct describing the sound property More...
 
struct  am::am_SystemProperty_s
 struct describing system properties More...
 
struct  am::am_SinkClass_s
 struct describing sinkclasses More...
 
struct  am::am_SourceClass_s
 struct describing source classes More...
 
struct  am::am_SourceType_s
 this type holds all information of sources relevant to the HMI More...
 
struct  am::am_SinkType_s
 this type holds all information of sinks relevant to the HMI More...
 
struct  am::am_Handle_s
 a handle is used for asynchronous operations and is uniquely assigned for each of this operations More...
 
struct  am::am_MainSoundProperty_s
 struct describung mainsound property More...
 
struct  am::am_MainConnectionType_s
 this type holds all information of connections relevant to the HMI More...
 
struct  am::am_MainConnection_s
 struct that holds attribiutes of a mainconnection More...
 
struct  am::am_NotificationPayload_s
 This struct holds the payload of a notification. More...
 
struct  am::am_NotificationConfiguration_s
 This struct holds information about the configuration for notifications. More...
 
struct  am::am_Sink_s
 This struct describes the attribiutes of a sink. More...
 
struct  am::am_Source_s
 This struct describes the attribiutes of a source. More...
 
struct  am::am_Domain_s
 This struct describes the attribiutes of a domain. More...
 
struct  am::am_Connection_s
 a connection More...
 
union  am::am_EarlyData_u
 data type depends of am_EarlyDataType_e: volume_t in case of ED_SOURCE_VOLUME, ED_SINK_VOLUME soundProperty_t in case of ED_SOURCE_PROPERTY, ED_SINK_PROPERTY More...
 
union  am::am_DataType_u
 data type depends of am_EarlyDataType_e: sourceID in case of ED_SOURCE_VOLUME, ED_SOURCE_PROPERTY sinkID in case of ED_SINK_VOLUME, ED_SINK_PROPERTY More...
 
struct  am::am_EarlyData_s
 
struct  am::am_Volumes_s
 This types describe a mixed description for source and sinks volumes. More...
 

Namespaces

 am
 A Common-API wrapper class, which loads the common-api runtime and instantiates all necessary objects.
 

Macros

#define A_CONST   static const
 

Typedefs

typedef uint16_t am::am_domainID_t
 a domain ID More...
 
typedef uint16_t am::am_crossfaderID_t
 a crossfader ID More...
 
typedef uint16_t am::am_connectionID_t
 a connection ID More...
 
typedef uint16_t am::am_sourceID_t
 a source ID More...
 
typedef uint16_t am::am_sinkID_t
 a sink ID More...
 
typedef uint16_t am::am_converterID_t
 a converter ID More...
 
typedef uint16_t am::am_gatewayID_t
 a gateway ID More...
 
typedef uint16_t am::am_mainConnectionID_t
 a mainConnection ID More...
 
typedef uint16_t am::am_speed_t
 speed More...
 
typedef int16_t am::am_volume_t
 The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE). More...
 
typedef int16_t am::am_mainVolume_t
 This is the volume presented on the command interface. More...
 
typedef uint16_t am::am_sourceClass_t
 
typedef uint16_t am::am_sinkClass_t
 
typedef uint16_t am::am_time_t
 time in ms! More...
 
typedef int16_t am::am_timeSync_t
 offset time that is introduced in milli seconds. More...
 
typedef uint16_t am::am_CustomAvailabilityReason_t
 This type gives the information about reason for reason for Source/Sink change. More...
 
typedef uint16_t am::am_CustomClassProperty_t
 This is a custom specific identifier of property. More...
 
typedef uint16_t am::am_CustomConnectionFormat_t
 This type classifies the format in which data is exchanged within a connection. More...
 
typedef uint16_t am::am_CustomMainSoundPropertyType_t
 Here are all SoundProperties that can be set via the CommandInterface. More...
 
typedef uint16_t am::am_CustomNotificationType_t
 The notification types are project specific. More...
 
typedef uint16_t am::am_CustomRampType_t
 The given ramp types here are just examples. More...
 
typedef uint16_t am::am_CustomSoundPropertyType_t
 Within genivi only the some example properties are defined. More...
 
typedef uint16_t am::am_CustomSystemPropertyType_t
 Describes the different system properties which are project specific. More...
 

Enumerations

enum  am::am_HotSink_e {
  am::HS_UNKNOWN = 0, am::HS_SINKA = 1, am::HS_SINKB = 2, am::HS_INTERMEDIATE = 3,
  am::HS_MAX
}
 describes the active sink of a crossfader. More...
 
enum  am::am_Availability_e { am::A_UNKNOWN = 0, am::A_AVAILABLE = 1, am::A_UNAVAILABLE = 2, am::A_MAX }
 with the help of this enum, sinks and sources can report their availability state More...
 
enum  am::am_ConnectionState_e {
  am::CS_UNKNOWN = 0, am::CS_CONNECTING = 1, am::CS_CONNECTED = 2, am::CS_DISCONNECTING = 3,
  am::CS_DISCONNECTED = 4, am::CS_SUSPENDED = 5, am::CS_MAX
}
 represents the connection state More...
 
enum  am::am_DomainState_e {
  am::DS_UNKNOWN = 0, am::DS_CONTROLLED = 1, am::DS_INDEPENDENT_STARTUP = 2, am::DS_INDEPENDENT_RUNDOWN = 3,
  am::DS_MAX
}
 
enum  am::am_EarlyDataType_e {
  am::ES_UNKNOWN = 0, am::ED_SOURCE_VOLUME = 1, am::ED_SINK_VOLUME = 2, am::ED_SOURCE_PROPERTY = 3,
  am::ED_SINK_PROPERTY = 4, am::ED_INTERRUPT_STATE = 5, am::ED_MAX
}
 This enum characterizes the data of the EarlyData_t. More...
 
enum  am::am_Error_e {
  am::E_OK = 0, am::E_UNKNOWN = 1, am::E_OUT_OF_RANGE = 2, am::E_NOT_USED = 3,
  am::E_DATABASE_ERROR = 4, am::E_ALREADY_EXISTS = 5, am::E_NO_CHANGE = 6, am::E_NOT_POSSIBLE = 7,
  am::E_NON_EXISTENT = 8, am::E_ABORTED = 9, am::E_WRONG_FORMAT = 10, am::E_COMMUNICATION = 11,
  am::E_MAX
}
 the errors of the audiomanager. More...
 
enum  am::am_MuteState_e { am::MS_UNKNOWN = 0, am::MS_MUTED = 1, am::MS_UNMUTED = 2, am::MS_MAX }
 
enum  am::am_SourceState_e {
  am::SS_UNKNNOWN = 0, am::SS_ON = 1, am::SS_OFF = 2, am::SS_PAUSED = 3,
  am::SS_MAX
}
 The source state reflects the state of the source. More...
 
enum  am::am_Handle_e {
  am::H_UNKNOWN = 0, am::H_CONNECT = 1, am::H_DISCONNECT = 2, am::H_SETSOURCESTATE = 3,
  am::H_SETSINKVOLUME = 4, am::H_SETSOURCEVOLUME = 5, am::H_SETSINKSOUNDPROPERTY = 6, am::H_SETSOURCESOUNDPROPERTY = 7,
  am::H_SETSINKSOUNDPROPERTIES = 8, am::H_SETSOURCESOUNDPROPERTIES = 9, am::H_CROSSFADE = 10, am::H_SETVOLUMES = 11,
  am::H_SETSINKNOTIFICATION = 12, am::H_SETSOURCENOTIFICATION = 13, am::H_MAX
}
 This enumeration is used to define the type of the action that is correlated to a handle. More...
 
enum  am::am_InterruptState_e { am::IS_UNKNOWN = 0, am::IS_OFF = 1, am::IS_INTERRUPTED = 2, am::IS_MAX }
 
enum  am::am_VolumeType_e { am::VT_UNKNOWN = 0, am::VT_SINK = 1, am::VT_SOURCE = 2, am::VT_MAX }
 This datatype determines if a sourceID or a sinkID is used in the union following. More...
 
enum  am::am_NotificationStatus_e {
  am::NS_UNKNOWN = 0, am::NS_OFF = 1, am::NS_PERIODIC = 2, am::NS_MINIMUM = 3,
  am::NS_MAXIMUM = 4, am::NS_CHANGE = 5, am::NS_MAX
}
 

Variables

A_CONST am_volume_t am::AM_MUTE = -3000
 
A_CONST am_CustomAvailabilityReason_t am::AR_UNKNOWN = 0
 
A_CONST am_CustomAvailabilityReason_t am::AR_GENIVI_NEWMEDIA = 1
 new media was entered More...
 
A_CONST am_CustomAvailabilityReason_t am::AR_GENIVI_SAMEMEDIA = 2
 same media was entered More...
 
A_CONST am_CustomAvailabilityReason_t am::AR_GENIVI_NOMEDIA = 3
 there is no media or media is removed More...
 
A_CONST am_CustomAvailabilityReason_t am::AR_GENIVI_TEMPERATURE = 4
 there was a temperature event More...
 
A_CONST am_CustomAvailabilityReason_t am::AR_GENIVI_VOLTAGE = 5
 there was a voltage event More...
 
A_CONST am_CustomAvailabilityReason_t am::AR_GENIVI_ERRORMEDIA = 6
 fatal errors on reading or accessing media More...
 
A_CONST am_CustomClassProperty_t am::CP_UNKNOWN = 0
 
A_CONST am_CustomClassProperty_t am::CP_GENIVI_SOURCE_TYPE = 1
 
A_CONST am_CustomClassProperty_t am::CP_GENIVI_SINK_TYPE = 2
 
A_CONST am_CustomConnectionFormat_t am::CF_UNKNOWN = 0
 
A_CONST am_CustomConnectionFormat_t am::CF_GENIVI_MONO = 1
 
A_CONST am_CustomConnectionFormat_t am::CF_GENIVI_STEREO = 2
 
A_CONST am_CustomConnectionFormat_t am::CF_GENIVI_ANALOG = 3
 
A_CONST am_CustomConnectionFormat_t am::CF_GENIVI_AUTO = 4
 
A_CONST am_CustomMainSoundPropertyType_t am::MSP_UNKNOWN = 0
 
A_CONST am_CustomMainSoundPropertyType_t am::MSP_GENIVI_TREBLE = 1
 
A_CONST am_CustomMainSoundPropertyType_t am::MSP_GENIVI_MID = 2
 
A_CONST am_CustomMainSoundPropertyType_t am::MSP_GENIVI_BASS = 3
 
A_CONST am_CustomNotificationType_t am::NT_UNKNOWN = 0
 
A_CONST am_CustomRampType_t am::RAMP_UNKNOWN = 0
 
A_CONST am_CustomRampType_t am::RAMP_GENIVI_DIRECT = 1
 sets directly the value without a ramp More...
 
A_CONST am_CustomRampType_t am::RAMP_GENIVI_NO_PLOP = 2
 Sets the volume as fast as possible. More...
 
A_CONST am_CustomRampType_t am::RAMP_GENIVI_EXP_INV = 3
 inverted exponential update, high gradient at the start - soft end More...
 
A_CONST am_CustomRampType_t am::RAMP_GENIVI_LINEAR = 4
 continues update of volume More...
 
A_CONST am_CustomRampType_t am::RAMP_GENIVI_EXP = 5
 exponential update, soft start - high gradient at the end More...
 
A_CONST am_CustomSoundPropertyType_t am::SP_UNKNOWN = 0
 
A_CONST am_CustomSoundPropertyType_t am::SP_GENIVI_TREBLE = 1
 
A_CONST am_CustomSoundPropertyType_t am::SP_GENIVI_MID = 2
 
A_CONST am_CustomSoundPropertyType_t am::SP_GENIVI_BASS = 3
 
A_CONST am_CustomSystemPropertyType_t am::SYP_UNKNOWN = 0
 

Detailed Description

Copyright (C) 2012 - 2014, BMW AG.

This file is part of GENIVI Project AudioManager.

Contributions are licensed to the GENIVI Alliance under one or more Contribution License Agreements.

Author
Christian Linke, chris.nosp@m.tian.nosp@m..link.nosp@m.e@bm.nosp@m.w.de BMW 2011 - 2014

For further information see http://projects.genivi.org/audio-manager

THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN.

Definition in file audiomanagertypes.h.

Macro Definition Documentation

#define A_CONST   static const

Definition at line 36 of file audiomanagertypes.h.