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

Namespaces
	V1

	V2

Classes
struct	am_Availability_s
	this describes the availability of a sink or a source together with the latest change More...

struct	am_ClassProperty_s
	describes class properties More...

struct	am_Connection_s
	a connection More...

struct	am_Converter_s
	This struct describes the attributes of a converter. More...

struct	am_Crossfader_s
	This struct describes the attribiutes of a crossfader. More...

union	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_Domain_s
	This struct describes the attribiutes of a domain. More...

struct	am_EarlyData_s

union	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...

struct	am_Gateway_s
	This struct describes the attributes of a gateway. More...

struct	am_Handle_s
	a handle is used for asynchronous operations and is uniquely assigned for each of this operations More...

struct	am_MainConnection_s
	struct that holds attribiutes of a mainconnection More...

struct	am_MainConnectionType_s
	this type holds all information of connections relevant to the HMI More...

struct	am_MainSoundProperty_s
	struct describung mainsound property More...

struct	am_NotificationConfiguration_s
	This struct holds information about the configuration for notifications. More...

struct	am_NotificationPayload_s
	This struct holds the payload of a notification. More...

struct	am_Route_s
	a list of routing elements that lead from source to sink More...

struct	am_RoutingElement_s
	This represents one "hopp" in a route. More...

struct	am_RoutingNodeData_s
	A structure used as user data in the graph nodes. More...

struct	am_Sink_s
	This struct describes the attribiutes of a sink. More...

struct	am_SinkClass_s
	struct describing sinkclasses More...

struct	am_SinkType_s
	this type holds all information of sinks relevant to the HMI More...

struct	am_SoundProperty_s
	struct describing the sound property More...

struct	am_Source_s
	This struct describes the attribiutes of a source. More...

struct	am_SourceClass_s
	struct describing source classes More...

struct	am_SourceType_s
	this type holds all information of sources relevant to the HMI More...

struct	am_SystemProperty_s
	struct describing system properties More...

struct	am_Volumes_s
	This types describe a mixed description for source and sinks volumes. More...

class	CAmCommandLineSingleton

class	CAmCommandReceiver
	This class realizes the command Interface. More...

class	CAmCommandSender
	This class is used to send data to the CommandInterface. More...

class	CAmCommonAPIWrapper

class	CAmControlReceiver
	This class is used to receive all commands from the control interface. More...

class	CAmControlSender
	sends data to the commandInterface, takes the file of the library that needs to be loaded More...

class	CAmDatabaseHandlerMap
	This class handles and abstracts the database. More...

class	CAmDbusWrapper
	This wraps dbus and provides everything needed to anyone who wants to use dbus (including plugins). More...

class	CAmDltWrapper
	Wraps around the dlt. More...

class	CAmGraph
	Class representing a directed or undirected graph. More...

class	CAmGraphElement
	This class is base class for nodes and vertices. More...

class	CAmNode

class	CAmRouter
	Implements autorouting algorithm for connecting sinks and sources via different audio domains. More...

class	CAmRoutingReceiver
	Implements the Receiving side of the RoutingPlugins. More...

class	CAmRoutingSender
	Implements the RoutingSendInterface. More...

class	CAmSocketHandler
	The am::CAmSocketHandler implements a mainloop for the AudioManager. More...

class	CAmVertex

class	CAmWatchdog
	Implements the watchdog of the AudioManager with the help of systemd. More...

class	IAmCommandReceive
	The interface towards the Controlling Instance (e.g HMI). More...

class	IAmCommandSend
	This interface handles all communication from the AudioManagerDaemon towards the system. More...

class	IAmControlReceive
	This interface gives access to all important functions of the audiomanager that are used by the AudioManagerController to control the system. More...

class	IAmControlSend
	This interface is presented by the AudioManager controller. More...

class	IAmDatabaseHandler
	This class handles and abstracts the database. More...

class	IAmRoutingReceive
	Routing Receive sendInterface description. More...

class	IAmRoutingSend
	This class implements everything from Audiomanager -> RoutingAdapter There are two rules that have to be kept in mind when implementing against this interface: . More...

class	IAmShPollCheck
	prototype for poll check callback More...

class	IAmShPollDispatch
	prototype for dispatch callback More...

class	IAmShPollFired
	prototype for poll fired callback More...

class	IAmShPollPrepare
	prototype for poll prepared callback More...

class	IAmShTimerCallBack
	prototype for the timer callback More...

class	TAmShPollCheck
	template for a callback More...

class	TAmShPollDispatch
	template for a callback More...

class	TAmShPollFired
	make private, not public template for a callback More...

class	TAmShPollPrepare
	template for a callback More...

class	TAmShTimerCallBack
	template to create the functor for a class More...

Typedefs
typedef GES_VISITED	am_GraphElementStatus_e

typedef GRAPH_PATH_END	am_GraphPathPosition_e

typedef am_RoutingNodeData_s::am_NodeDataType_e	CAmNodeDataType

typedef CAmNode< am_RoutingNodeData_s >	CAmRoutingNode

typedef CAmGraph< am_RoutingNodeData_s, uint16_t >	CAmRoutingGraph

typedef CAmVertex< am_RoutingNodeData_s, uint16_t >	CAmRoutingVertex

typedef std::list< CAmRoutingVertex >	CAmRoutingListVertices

typedef std::vector< CAmRoutingListVertices * >	CAmRoutingVertexReferenceList

typedef std::map< am_gatewayID_t, std::vector< bool > >	ListConnectionFormat
	type for list of connection formats More...

typedef V1::CAmSerializer CAmSerializer	DEPRECATED("You should use V2::CAmSerializer instead!")

typedef uint16_t	sh_pollHandle_t
	this is a handle for a filedescriptor to be used with the SocketHandler More...

typedef sh_pollHandle_t	sh_timerHandle_t
	this is a handle for a timer to be used with the SocketHandler More...

typedef uint16_t	am_domainID_t
	a domain ID More...

typedef uint16_t	am_crossfaderID_t
	a crossfader ID More...

typedef uint16_t	am_connectionID_t
	a connection ID More...

typedef uint16_t	am_sourceID_t
	a source ID More...

typedef uint16_t	am_sinkID_t
	a sink ID More...

typedef uint16_t	am_converterID_t
	a converter ID More...

typedef uint16_t	am_gatewayID_t
	a gateway ID More...

typedef uint16_t	am_mainConnectionID_t
	a mainConnection ID More...

typedef uint16_t	am_speed_t
	speed More...

typedef int16_t	am_volume_t
	The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE). More...

typedef int16_t	am_mainVolume_t
	This is the volume presented on the command interface. More...

typedef uint16_t	am_sourceClass_t

typedef uint16_t	am_sinkClass_t

typedef uint16_t	am_time_t
	time in ms! More...

typedef int16_t	am_timeSync_t
	offset time that is introduced in milli seconds. More...

typedef uint16_t	am_CustomAvailabilityReason_t
	This type gives the information about reason for reason for Source/Sink change. More...

typedef uint16_t	am_CustomClassProperty_t
	This is a custom specific identifier of property. More...

typedef uint16_t	am_CustomConnectionFormat_t
	This type classifies the format in which data is exchanged within a connection. More...

typedef uint16_t	am_CustomMainSoundPropertyType_t
	Here are all SoundProperties that can be set via the CommandInterface. More...

typedef uint16_t	am_CustomNotificationType_t
	The notification types are project specific. More...

typedef uint16_t	am_CustomRampType_t
	The given ramp types here are just examples. More...

typedef uint16_t	am_CustomSoundPropertyType_t
	Within genivi only the some example properties are defined. More...

typedef uint16_t	am_CustomSystemPropertyType_t
	Describes the different system properties which are project specific. More...

Enumerations
enum	am_HotSink_e { HS_UNKNOWN = 0, HS_SINKA = 1, HS_SINKB = 2, HS_INTERMEDIATE = 3, HS_MAX }
	describes the active sink of a crossfader. More...

enum	am_Availability_e { A_UNKNOWN = 0, A_AVAILABLE = 1, A_UNAVAILABLE = 2, A_MAX }
	with the help of this enum, sinks and sources can report their availability state More...

enum	am_ConnectionState_e { CS_UNKNOWN = 0, CS_CONNECTING = 1, CS_CONNECTED = 2, CS_DISCONNECTING = 3, CS_DISCONNECTED = 4, CS_SUSPENDED = 5, CS_MAX }
	represents the connection state More...

enum	am_DomainState_e { DS_UNKNOWN = 0, DS_CONTROLLED = 1, DS_INDEPENDENT_STARTUP = 2, DS_INDEPENDENT_RUNDOWN = 3, DS_MAX }

enum	am_EarlyDataType_e { ES_UNKNOWN = 0, ED_SOURCE_VOLUME = 1, ED_SINK_VOLUME = 2, ED_SOURCE_PROPERTY = 3, ED_SINK_PROPERTY = 4, ED_INTERRUPT_STATE = 5, ED_MAX }
	This enum characterizes the data of the EarlyData_t. More...

enum	am_Error_e { E_OK = 0, E_UNKNOWN = 1, E_OUT_OF_RANGE = 2, E_NOT_USED = 3, E_DATABASE_ERROR = 4, E_ALREADY_EXISTS = 5, E_NO_CHANGE = 6, E_NOT_POSSIBLE = 7, E_NON_EXISTENT = 8, E_ABORTED = 9, E_WRONG_FORMAT = 10, E_COMMUNICATION = 11, E_MAX }
	the errors of the audiomanager. More...

enum	am_MuteState_e { MS_UNKNOWN = 0, MS_MUTED = 1, MS_UNMUTED = 2, MS_MAX }

enum	am_SourceState_e { SS_UNKNNOWN = 0, SS_ON = 1, SS_OFF = 2, SS_PAUSED = 3, SS_MAX }
	The source state reflects the state of the source. More...

enum	am_Handle_e { 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_SETVOLUMES = 11, H_SETSINKNOTIFICATION = 12, H_SETSOURCENOTIFICATION = 13, H_MAX }
	This enumeration is used to define the type of the action that is correlated to a handle. More...

enum	am_InterruptState_e { IS_UNKNOWN = 0, IS_OFF = 1, IS_INTERRUPTED = 2, IS_MAX }

enum	am_VolumeType_e { VT_UNKNOWN = 0, VT_SINK = 1, VT_SOURCE = 2, VT_MAX }
	This datatype determines if a sourceID or a sinkID is used in the union following. More...

enum	am_NotificationStatus_e { NS_UNKNOWN = 0, NS_OFF = 1, NS_PERIODIC = 2, NS_MINIMUM = 3, NS_MAXIMUM = 4, NS_CHANGE = 5, NS_MAX }

Functions
template<typename T >
bool	isDataEqual (const T &left, const T &right)

template<typename T , typename L = std::vector<T>>
bool	isDataEqual (const L &left, const L &right)

template<typename TMapKeyType , class TMapObjectType >
TMapObjectType const *	objectForKeyIfExistsInMap (const TMapKeyType &key, const std::unordered_map< TMapKeyType, TMapObjectType > &map)

template<typename TMapKeyType , class TMapObjectType >
bool	existsObjectWithKeyInMap (const TMapKeyType &key, const std::unordered_map< TMapKeyType, TMapObjectType > &map)

template<class TReturn , typename TIdentifier >
const TReturn *	objectMatchingPredicate (const std::unordered_map< TIdentifier, TReturn > &map, std::function< bool(const TReturn &refObject)> comparator)
	Returns an object matching predicate. More...

bool	changeMainNotificationConfiguration (std::vector< am_NotificationConfiguration_s > &listMainNotificationConfigurations, const am_NotificationConfiguration_s &mainNotificationConfiguration)

bool	changeNotificationConfiguration (std::vector< am_NotificationConfiguration_s > &listNotificationConfigurations, const am_NotificationConfiguration_s &notificationConfiguration)

template<class X >
void	getMergeConnectionFormats (const X *element, const am_CustomConnectionFormat_t connectionFormat, const std::vector< am_CustomConnectionFormat_t > &listConnectionFormats, std::vector< am_CustomConnectionFormat_t > &outListMergeConnectionFormats)

template<typename T , typename... TArgs>
void	log (DltContext *const context, DltLogLevelType loglevel, T value, TArgs...args)
	logs given values with a given context (register first!) and given loglevel More...

template<typename T , typename... TArgs>
void	logDebug (T value, TArgs...args)
	logs given values with debuglevel with the default context More...

template<typename T , typename... TArgs>
void	logInfo (T value, TArgs...args)
	logs given values with infolevel with the default context More...

template<typename T , typename... TArgs>
void	logError (T value, TArgs...args)
	logs given values with errorlevel with the default context More...

template<typename T , typename... TArgs>
void	logWarning (T value, TArgs...args)
	logs given values with warninglevel with the default context More...

template<typename T , typename... TArgs>
void	logVerbose (T value, TArgs...args)
	logs given values with verbose with the default context More...

template<class T >
T *	getCreateFunction (const std::string &libname, void *&libraryHandle)

template<class T >
T *	getDestroyFunction (const std::string &libname, void *libraryHandle)

Variables
typedef	enum
	Graph element status. More...

typedef	GES_IN_PROGRESS

typedef	GRAPH_PATH_MIDDLE

CAmCommonAPIWrapper (	getCAPI )() = CAmCommonAPIWrapper::getInstance

A_CONST am_volume_t	AM_MUTE = -3000

A_CONST am_CustomAvailabilityReason_t	AR_UNKNOWN = 0

A_CONST am_CustomAvailabilityReason_t	AR_GENIVI_NEWMEDIA = 1
	new media was entered More...

A_CONST am_CustomAvailabilityReason_t	AR_GENIVI_SAMEMEDIA = 2
	same media was entered More...

A_CONST am_CustomAvailabilityReason_t	AR_GENIVI_NOMEDIA = 3
	there is no media or media is removed More...

A_CONST am_CustomAvailabilityReason_t	AR_GENIVI_TEMPERATURE = 4
	there was a temperature event More...

A_CONST am_CustomAvailabilityReason_t	AR_GENIVI_VOLTAGE = 5
	there was a voltage event More...

A_CONST am_CustomAvailabilityReason_t	AR_GENIVI_ERRORMEDIA = 6
	fatal errors on reading or accessing media More...

A_CONST am_CustomClassProperty_t	CP_UNKNOWN = 0

A_CONST am_CustomClassProperty_t	CP_GENIVI_SOURCE_TYPE = 1

A_CONST am_CustomClassProperty_t	CP_GENIVI_SINK_TYPE = 2

A_CONST am_CustomConnectionFormat_t	CF_UNKNOWN = 0

A_CONST am_CustomConnectionFormat_t	CF_GENIVI_MONO = 1

A_CONST am_CustomConnectionFormat_t	CF_GENIVI_STEREO = 2

A_CONST am_CustomConnectionFormat_t	CF_GENIVI_ANALOG = 3

A_CONST am_CustomConnectionFormat_t	CF_GENIVI_AUTO = 4

A_CONST am_CustomMainSoundPropertyType_t	MSP_UNKNOWN = 0

A_CONST am_CustomMainSoundPropertyType_t	MSP_GENIVI_TREBLE = 1

A_CONST am_CustomMainSoundPropertyType_t	MSP_GENIVI_MID = 2

A_CONST am_CustomMainSoundPropertyType_t	MSP_GENIVI_BASS = 3

A_CONST am_CustomNotificationType_t	NT_UNKNOWN = 0

A_CONST am_CustomRampType_t	RAMP_UNKNOWN = 0

A_CONST am_CustomRampType_t	RAMP_GENIVI_DIRECT = 1
	sets directly the value without a ramp More...

A_CONST am_CustomRampType_t	RAMP_GENIVI_NO_PLOP = 2
	Sets the volume as fast as possible. More...

A_CONST am_CustomRampType_t	RAMP_GENIVI_EXP_INV = 3
	inverted exponential update, high gradient at the start - soft end More...

A_CONST am_CustomRampType_t	RAMP_GENIVI_LINEAR = 4
	continues update of volume More...

A_CONST am_CustomRampType_t	RAMP_GENIVI_EXP = 5
	exponential update, soft start - high gradient at the end More...

A_CONST am_CustomSoundPropertyType_t	SP_UNKNOWN = 0

A_CONST am_CustomSoundPropertyType_t	SP_GENIVI_TREBLE = 1

A_CONST am_CustomSoundPropertyType_t	SP_GENIVI_MID = 2

A_CONST am_CustomSoundPropertyType_t	SP_GENIVI_BASS = 3

A_CONST am_CustomSystemPropertyType_t	SYP_UNKNOWN = 0

Detailed Description

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

todo add removeCallback ...

It is implemented as singleton and usually instantiated at the beginning with CAmSocketHandler as parameter. Example: CAmCommonAPIWrapper *pCAPIWrapper = CAmCommonAPIWrapper::instantiateOnce( aSocketHandlerPointer );

Typedef Documentation

typedef uint16_t am::am_connectionID_t

a connection ID

Definition at line 55 of file audiomanagertypes.h.

typedef uint16_t am::am_converterID_t

a converter ID

Definition at line 70 of file audiomanagertypes.h.

typedef uint16_t am::am_crossfaderID_t

a crossfader ID

Definition at line 50 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomAvailabilityReason_t

This type gives the information about reason for reason for Source/Sink change.

Definition at line 119 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomClassProperty_t

This is a custom specific identifier of property.

It can be used to differentiate between interrupt source/sink, main source/sink, etc.

Definition at line 138 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomConnectionFormat_t

This type classifies the format in which data is exchanged within a connection.

The type itself is project specific although there are some standard formats defined.

Definition at line 148 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomMainSoundPropertyType_t

Here are all SoundProperties that can be set via the CommandInterface.

This type is product specific and can be changed or extended.

Definition at line 159 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomNotificationType_t

The notification types are project specific.

Definition at line 168 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomRampType_t

The given ramp types here are just examples.

For products, different ramp types can be defined here. It is in the responsibility of the product to make sure that the routing plugins are aware of the ramp types used.

Definition at line 176 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomSoundPropertyType_t

Within genivi only the some example properties are defined.

For products these should be changed or extended.

Definition at line 193 of file audiomanagertypes.h.

typedef uint16_t am::am_CustomSystemPropertyType_t

Describes the different system properties which are project specific.

Definition at line 202 of file audiomanagertypes.h.

typedef uint16_t am::am_domainID_t

a domain ID

Definition at line 45 of file audiomanagertypes.h.

typedef uint16_t am::am_gatewayID_t

a gateway ID

Definition at line 75 of file audiomanagertypes.h.

typedef GES_VISITED am::am_GraphElementStatus_e

Definition at line 48 of file CAmGraph.h.

typedef GRAPH_PATH_END am::am_GraphPathPosition_e

Definition at line 58 of file CAmGraph.h.

typedef uint16_t am::am_mainConnectionID_t

a mainConnection ID

Definition at line 80 of file audiomanagertypes.h.

typedef int16_t am::am_mainVolume_t

This is the volume presented on the command interface.

It is in the duty of the Controller to change the volumes given here into meaningful values on the routing interface. The range of this type is customer specific.

Definition at line 100 of file audiomanagertypes.h.

typedef uint16_t am::am_sinkClass_t

Definition at line 104 of file audiomanagertypes.h.

typedef uint16_t am::am_sinkID_t

a sink ID

Definition at line 65 of file audiomanagertypes.h.

typedef uint16_t am::am_sourceClass_t

Definition at line 102 of file audiomanagertypes.h.

typedef uint16_t am::am_sourceID_t

a source ID

Definition at line 60 of file audiomanagertypes.h.

typedef uint16_t am::am_speed_t

speed

Definition at line 85 of file audiomanagertypes.h.

typedef uint16_t am::am_time_t

time in ms!

Definition at line 109 of file audiomanagertypes.h.

typedef int16_t am::am_timeSync_t

offset time that is introduced in milli seconds.

Definition at line 114 of file audiomanagertypes.h.

typedef int16_t am::am_volume_t

The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE).

The minimum and maximum can be limited by actual project.

Definition at line 91 of file audiomanagertypes.h.

typedef am_RoutingNodeData_s::am_NodeDataType_e am::CAmNodeDataType

Definition at line 147 of file CAmRouter.h.

typedef CAmGraph<am_RoutingNodeData_s, uint16_t> am::CAmRoutingGraph

Definition at line 149 of file CAmRouter.h.

typedef std::list<CAmRoutingVertex> am::CAmRoutingListVertices

Definition at line 151 of file CAmRouter.h.

typedef CAmNode<am_RoutingNodeData_s> am::CAmRoutingNode

Definition at line 148 of file CAmRouter.h.

typedef CAmVertex<am_RoutingNodeData_s, uint16_t> am::CAmRoutingVertex

Definition at line 150 of file CAmRouter.h.

typedef std::vector<CAmRoutingListVertices*> am::CAmRoutingVertexReferenceList

Definition at line 152 of file CAmRouter.h.

typedef V1::CAmSerializer CAmSerializer am::DEPRECATED("You should use V2::CAmSerializer instead!")

Definition at line 1214 of file CAmSerializer.h.

typedef std::map<am_gatewayID_t, std::vector<bool> > am::ListConnectionFormat

type for list of connection formats

Definition at line 49 of file IAmDatabaseHandler.h.

typedef uint16_t am::sh_pollHandle_t

this is a handle for a filedescriptor to be used with the SocketHandler

Definition at line 51 of file CAmSocketHandler.h.

typedef sh_pollHandle_t am::sh_timerHandle_t

this is a handle for a timer to be used with the SocketHandler

Definition at line 52 of file CAmSocketHandler.h.

Enumeration Type Documentation

enum am::am_Availability_e

with the help of this enum, sinks and sources can report their availability state

Enumerator
A_UNKNOWN	default
A_AVAILABLE	The source / sink is available.
A_UNAVAILABLE	the source / sink is not available
A_MAX

Definition at line 233 of file audiomanagertypes.h.

enum am::am_ConnectionState_e

represents the connection state

Enumerator
CS_UNKNOWN
CS_CONNECTING	This means the connection is just building up.
CS_CONNECTED	the connection is ready to be used
CS_DISCONNECTING	the connection is in the course to be knocked down
CS_DISCONNECTED	only relevant for connectionStatechanged. Is send after the connection was removed
CS_SUSPENDED	this means the connection is still build up but unused at the moment
CS_MAX

Definition at line 253 of file audiomanagertypes.h.

enum am::am_DomainState_e

Enumerator
DS_UNKNOWN	default
DS_CONTROLLED	the domain is controlled by the daemon
DS_INDEPENDENT_STARTUP	the domain is independent starting up
DS_INDEPENDENT_RUNDOWN	the domain is independent running down
DS_MAX

Definition at line 280 of file audiomanagertypes.h.

enum am::am_EarlyDataType_e

This enum characterizes the data of the EarlyData_t.

Enumerator
ES_UNKNOWN	default
ED_SOURCE_VOLUME	the source volume
ED_SINK_VOLUME	the sink volume
ED_SOURCE_PROPERTY	a source property
ED_SINK_PROPERTY	a sink property
ED_INTERRUPT_STATE	The interrupt state.
ED_MAX

Definition at line 304 of file audiomanagertypes.h.

enum am::am_Error_e

the errors of the audiomanager.

All possible errors are in here. This enum is used widely as return parameter.

Enumerator
E_OK	no error - positive reply
E_UNKNOWN	default
E_OUT_OF_RANGE	value out of range
E_NOT_USED	not used
E_DATABASE_ERROR	a database error occurred
E_ALREADY_EXISTS	the desired object already exists
E_NO_CHANGE	there is no change
E_NOT_POSSIBLE	the desired action is not possible
E_NON_EXISTENT	the desired object is non existent
E_ABORTED	the asynchronous action was aborted
E_WRONG_FORMAT	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_COMMUNICATION	A communication error happened.
E_MAX

Definition at line 337 of file audiomanagertypes.h.

enum am::am_Handle_e

This enumeration is used to define the type of the action that is correlated to a handle.

Enumerator
H_UNKNOWN
H_CONNECT
H_DISCONNECT
H_SETSOURCESTATE
H_SETSINKVOLUME
H_SETSOURCEVOLUME
H_SETSINKSOUNDPROPERTY
H_SETSOURCESOUNDPROPERTY
H_SETSINKSOUNDPROPERTIES
H_SETSOURCESOUNDPROPERTIES
H_CROSSFADE
H_SETVOLUMES
H_SETSINKNOTIFICATION
H_SETSOURCENOTIFICATION
H_MAX

Definition at line 435 of file audiomanagertypes.h.

enum am::am_HotSink_e

describes the active sink of a crossfader.

Enumerator
HS_UNKNOWN	default
HS_SINKA	sinkA is active
HS_SINKB	sinkB is active
HS_INTERMEDIATE	the crossfader is in the transition state
HS_MAX

Definition at line 208 of file audiomanagertypes.h.

enum am::am_InterruptState_e

Enumerator
IS_UNKNOWN	default
IS_OFF	the interrupt state is off - no interrupt
IS_INTERRUPTED	the interrupt state is interrupted - the interrupt is active
IS_MAX

Definition at line 454 of file audiomanagertypes.h.

enum am::am_MuteState_e

Enumerator
MS_UNKNOWN	default
MS_MUTED	the source / sink is muted
MS_UNMUTED	the source / sink is unmuted
MS_MAX

Definition at line 392 of file audiomanagertypes.h.

enum am::am_NotificationStatus_e

Enumerator
NS_UNKNOWN
NS_OFF	No notification, the function is turned off.
NS_PERIODIC	Periodic notifications are sent out. The period in ms is given by am_NotificationParameter
NS_MINIMUM	The notification is sent out when the minimum given by am_NotificationParameter is reached.
NS_MAXIMUM	The notification is sent out when the maximum given by am_NotificationParameter is reached.
NS_CHANGE	The notification is sent out when a change happened. The Resolution of the change is defined by am_NotificationParameter.
NS_MAX

Definition at line 489 of file audiomanagertypes.h.

enum am::am_SourceState_e

The source state reflects the state of the source.

Enumerator
SS_UNKNNOWN
SS_ON	The source can be activly heared.
SS_OFF	The source cannot be heared.
SS_PAUSED	The source is paused. Meaning it cannot be heared but should be prepared to play again soon.
SS_MAX

Definition at line 412 of file audiomanagertypes.h.

enum am::am_VolumeType_e

This datatype determines if a sourceID or a sinkID is used in the union following.

Enumerator
VT_UNKNOWN
VT_SINK	the following type is a sink
VT_SOURCE	the following type is a source
VT_MAX

Definition at line 475 of file audiomanagertypes.h.

Function Documentation

bool am::changeMainNotificationConfiguration	(	std::vector< am_NotificationConfiguration_s > &	listMainNotificationConfigurations,
		const am_NotificationConfiguration_s &	mainNotificationConfiguration
	)

Definition at line 3183 of file CAmDatabaseHandlerMap.cpp.

bool am::changeNotificationConfiguration	(	std::vector< am_NotificationConfiguration_s > &	listNotificationConfigurations,
		const am_NotificationConfiguration_s &	notificationConfiguration
	)

Definition at line 3301 of file CAmDatabaseHandlerMap.cpp.

template<typename TMapKeyType , class TMapObjectType >

bool am::existsObjectWithKeyInMap	(	const TMapKeyType &	key,
		const std::unordered_map< TMapKeyType, TMapObjectType > &	map
	)

Definition at line 115 of file CAmDatabaseHandlerMap.cpp.

template<class T >

T* am::getCreateFunction	(	const std::string &	libname,
		void *&	libraryHandle
	)

This template tries to load a library and cast to a class
Parameters

libname the full path to the library to be loaded

libraryHandle the handle to the library that gets returned

Returns
returns the pointer to the class to be loaded

Definition at line 40 of file TAmPluginTemplate.h.

template<class T >

T* am::getDestroyFunction	(	const std::string &	libname,
		void *	libraryHandle
	)

This template tries to destroy
Parameters

libname the full path to the library to be loaded

Definition at line 94 of file TAmPluginTemplate.h.

template<class X >

void am::getMergeConnectionFormats	(	const X *	element,
		const am_CustomConnectionFormat_t	connectionFormat,
		const std::vector< am_CustomConnectionFormat_t > &	listConnectionFormats,
		std::vector< am_CustomConnectionFormat_t > &	outListMergeConnectionFormats
	)

Definition at line 37 of file CAmRouter.cpp.

template<typename T >

bool am::isDataEqual	(	const T &	left,
		const T &	right
	)

Definition at line 90 of file CAmDatabaseHandlerMap.cpp.

template<typename T , typename L = std::vector<T>>

bool am::isDataEqual	(	const L &	left,
		const L &	right
	)

Definition at line 95 of file CAmDatabaseHandlerMap.cpp.