summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorchristian linke <christian.linke@bmw.de>2012-12-17 16:15:11 +0100
committerchristian linke <christian.linke@bmw.de>2012-12-17 16:15:11 +0100
commit54c5e965fe8f9a53a78834028fd65c792493da2b (patch)
tree560d7b1209e6a8d4798de9568e4b4a947c2ab42a /include
parent215e8a72dc81e8a86dd5b3a8ca40fd2c7c6a0b9c (diff)
downloadaudiomanager-54c5e965fe8f9a53a78834028fd65c792493da2b.tar.gz
* added new interfaces & nsm support + nsm tests + fixed some unit tests + fixed rundown
Signed-off-by: christian linke <christian.linke@bmw.de>
Diffstat (limited to 'include')
-rw-r--r--include/audiomanagertypes.h596
-rw-r--r--include/command/IAmCommandReceive.h128
-rw-r--r--include/command/IAmCommandSend.h106
-rw-r--r--include/control/IAmControlReceive.h527
-rw-r--r--include/control/IAmControlSend.h229
-rwxr-xr-x[-rw-r--r--]include/projecttypes.h79
-rw-r--r--include/routing/IAmRoutingReceive.h186
-rw-r--r--include/routing/IAmRoutingSend.h92
-rw-r--r--include/shared/CAmSerializer.h1
9 files changed, 1227 insertions, 717 deletions
diff --git a/include/audiomanagertypes.h b/include/audiomanagertypes.h
index 54760b4..8e4bf41 100644
--- a/include/audiomanagertypes.h
+++ b/include/audiomanagertypes.h
@@ -12,15 +12,15 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_F9B4F59D_FED5_44ac_85F2_F9F60549C133__INCLUDED_)
-#define EA_F9B4F59D_FED5_44ac_85F2_F9F60549C133__INCLUDED_
+#if !defined(EA_4739DD27_2A1B_4548_8F5F_7D50DB15209C__INCLUDED_)
+#define EA_4739DD27_2A1B_4548_8F5F_7D50DB15209C__INCLUDED_
#include <stdint.h>
#include "projecttypes.h"
@@ -29,112 +29,137 @@
#define AM_MUTE -3000
+#include "projecttypes.h"
+
namespace am {
/**
* a domain ID
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_domainID_t;
/**
* a source ID
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_sourceID_t;
/**
* a sink ID
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_sinkID_t;
/**
* a gateway ID
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_gatewayID_t;
/**
* a crossfader ID
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_crossfaderID_t;
/**
* a connection ID
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_connectionID_t;
/**
* a mainConnection ID
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_mainConnectionID_t;
/**
* speed
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_speed_t;
/**
- * The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE). The minimum and
- * maximum can be limited by actual project.
+ * 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 Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef int16_t am_volume_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.
+ * 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.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef int16_t am_mainVolume_t;
/**
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_sourceClass_t;
/**
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_sinkClass_t;
/**
* time in ms!
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef uint16_t am_time_t;
/**
* offset time that is introduced in milli seconds.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:13 PM
+ * @created 16-Dez-2012 15:58:12
*/
typedef int16_t am_timeSync_t;
/**
- * with the help of this enum, sinks and sources can report their availability
- * state
+ * describes the active sink of a crossfader.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
+ */
+ enum am_HotSink_e
+ {
+ /**
+ * 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
+ };
+
+ /**
+ * with the help of this enum, sinks and sources can report their availability state
+ * @author Christian Mueller
+ * @created 16-Dez-2012 15:58:12
*/
enum am_Availablility_e
{
@@ -156,7 +181,7 @@ namespace am {
/**
* represents the connection state
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_ConnectionState_e
{
@@ -174,8 +199,7 @@ namespace am {
*/
CS_DISCONNECTING = 3,
/**
- * only relevant for connectionStatechanged. Is send after the connection was
- * removed
+ * only relevant for connectionStatechanged. Is send after the connection was removed
*/
CS_DISCONNECTED = 4,
/**
@@ -187,7 +211,7 @@ namespace am {
/**
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_DomainState_e
{
@@ -213,7 +237,7 @@ namespace am {
/**
* This enum characterizes the data of the EarlyData_t
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_EarlyDataType_e
{
@@ -241,10 +265,9 @@ namespace am {
};
/**
- * the errors of the audiomanager. All possible errors are in here. This enum is
- * used widely as return parameter.
+ * the errors of the audiomanager. All possible errors are in here. This enum is used widely as return parameter.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_Error_e
{
@@ -289,9 +312,8 @@ namespace am {
*/
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
+ * 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
@@ -299,7 +321,7 @@ namespace am {
/**
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_MuteState_e
{
@@ -321,7 +343,7 @@ namespace am {
/**
* The source state reflects the state of the source
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_SourceState_e
{
@@ -335,18 +357,16 @@ namespace am {
*/
SS_OFF = 2,
/**
- * The source is paused. Meaning it cannot be heared but should be prepared to
- * play again soon.
+ * The source is paused. Meaning it cannot be heared but should be prepared to play again soon.
*/
SS_PAUSED = 3,
SS_MAX
};
/**
- * This enumeration is used to define the type of the action that is correlated to
- * a handle.
+ * This enumeration is used to define the type of the action that is correlated to a handle.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_Handle_e
{
@@ -361,12 +381,15 @@ namespace am {
H_SETSINKSOUNDPROPERTIES = 8,
H_SETSOURCESOUNDPROPERTIES = 9,
H_CROSSFADE = 10,
+ H_SETVOLUMES = 11,
+ H_SETSINKNOTIFICATION = 12,
+ H_SETSOURCENOTIFICATION = 13,
H_MAX
};
/**
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
enum am_InterruptState_e
{
@@ -386,36 +409,60 @@ namespace am {
};
/**
- * describes the active sink of a crossfader.
- * @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * This datatype determines if a sourceID or a sinkID is used in the union following
+ * @author q232968
+ * @version 1.0
+ * @created 16-Dez-2012 15:58:12
*/
- enum am_HotSink_e
+ enum am_VolumeType_e
{
+ VT_UNKNOWN = 0,
/**
- * default
+ * the following type is a sink
*/
- HS_UNKNOWN = 0,
+ VT_SINK = 1,
/**
- * sinkA is active
+ * the following type is a source
*/
- HS_SINKA = 1,
+ VT_SOURCE = 2,
+ VT_MAX
+ };
+
+ /**
+ * @author q232968
+ * @version 1.0
+ * @created 16-Dez-2012 15:58:12
+ */
+ enum am_NotificationStatus_e
+ {
+ NS_UNKNOWN = 0,
/**
- * sinkB is active
+ * No notification, the function is turned off
*/
- HS_SINKB = 2,
+ NS_OFF = 1,
/**
- * the crossfader is in the transition state
+ * Periodic notifications are sent out. The period in ms is given by am_NotificationParameter
*/
- HS_INTERMEDIATE = 3,
- HS_MAX
+ NS_PERIODIC = 2,
+ /**
+ * The notification is sent out when the minimum given by am_NotificationParameter is reached.
+ */
+ NS_MINIMUM = 3,
+ /**
+ * The notification is sent out when the maximum given by am_NotificationParameter is reached.
+ */
+ NS_MAXIMUM = 4,
+ /**
+ * The notification is sent out whena change happend. The Resolution of the change is defined by am_NotificationParameter.
+ */
+ NS_CHANGE = 5,
+ NS_MAX
};
/**
- * this describes the availability of a sink or a source together with the latest
- * change
+ * this describes the availability of a sink or a source together with the latest change
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
struct am_Availability_s
{
@@ -426,8 +473,7 @@ namespace am {
*/
am_Availablility_e availability;
/**
- * the reason for the last change. This can be used to trigger events that deal
- * with state changes.
+ * the reason for the last change. This can be used to trigger events that deal with state changes.
*/
am_AvailabilityReason_e availabilityReason;
@@ -436,7 +482,7 @@ namespace am {
/**
* describes class properties
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
struct am_ClassProperty_s
{
@@ -456,17 +502,16 @@ namespace am {
/**
* This struct describes the attribiutes of a crossfader.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
struct am_Crossfader_s
{
public:
/**
- * This is the ID of the crossfader, 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 AudioManager daemon), or it
- * is a fixed (the project has to ensure the uniqueness of the ID).
+ * This is the ID of the crossfader, 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 AudioManager daemon),
+ * or it is a fixed (the project has to ensure the uniqueness of the ID).
*/
am_crossfaderID_t crossfaderID;
/**
@@ -474,18 +519,15 @@ namespace am {
*/
std::string name;
/**
- * The sinkID of the SinkA. Sinks shall be registered before registering the
- * crossfader.
+ * The sinkID of the SinkA. Sinks shall be registered before registering the crossfader.
*/
am_sinkID_t sinkID_A;
/**
- * The sinkID of the SinkB. Sinks shall be registered before registering the
- * crossfader.
+ * The sinkID of the SinkB. Sinks shall be registered before registering the crossfader.
*/
am_sinkID_t sinkID_B;
/**
- * The sourceID of the crossfader source. The source shall be registered before
- * the crossfader.
+ * The sourceID of the crossfader source. The source shall be registered before the crossfader.
*/
am_sourceID_t sourceID;
/**
@@ -493,9 +535,8 @@ namespace am {
*
* HS_SINKA sinkA is the current hot one, sinkB is not audible
* HS_SINKB sinkB is the current hot one, sinkB is not audible
- * HS_INTERMEDIATE the fader is stuck in between a cross-fading action. This
- * could be due to an abort or an error. Before using the crossfader, it must be
- * set to either HS_SINKA or HS_SINKB.
+ * HS_INTERMEDIATE the fader is stuck in between a cross-fading action. This could be due to an abort or an error.
+ * Before using the crossfader, it must be set to either HS_SINKA or HS_SINKB.
*/
am_HotSink_e hotSink;
@@ -504,17 +545,16 @@ namespace am {
/**
* This struct describes the attributes of a gateway.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:12
*/
struct am_Gateway_s
{
public:
/**
- * This is the ID of the gateway, 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).
+ * This is the ID of the gateway, 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).
*/
am_gatewayID_t gatewayID;
/**
@@ -522,35 +562,29 @@ namespace am {
*/
std::string name;
/**
- * The sinkID of the gateway sink-end. The sink is a full blown sink with
- * connectionFormats, sinkClassIDs etc... It makes sense to register the sinks of
- * a gateway as non-visible. Care needs to be taken that the connectionsFormats
- * match with the ones in the conversionMatrix. If the sink is located in the
- * controllingDomain, the ID needs to be retrieved by registering the sink before
- * registering the gateway. In case the sink is in a different domain, the ID
- * needs to be retrieved via peeking.
+ * The sinkID of the gateway sink-end. The sink is a full blown sink with connectionFormats, sinkClassIDs etc... It makes
+ * sense to register the sinks of a gateway as non-visible. Care needs to be taken that the connectionsFormats match with
+ * the ones in the conversionMatrix. If the sink is located in the controllingDomain, the ID needs to be retrieved by
+ * registering the sink before registering the gateway. In case the sink is in a different domain, the ID needs to be
+ * retrieved via peeking.
*/
am_sinkID_t sinkID;
/**
- * The sourceID of the gateway sink-end. The sink is a full blown source with
- * connectionFormats, sinkClassIDs etc... It makes sense to register the sources
- * of a gateway as non-visible. Care needs to be taken that the connectionsFormats
- * match with the ones in the conversionMatrix. If the source is located in the
- * controllingDomain, the ID needs to be retrieved by registering the source
- * before registering the gateway. In case the source is in a different domain,
- * the ID needs to be retrieved via peeking.
+ * The sourceID of the gateway sink-end. The sink is a full blown source with connectionFormats, sinkClassIDs etc... It
+ * makes sense to register the sources of a gateway as non-visible. Care needs to be taken that the connectionsFormats
+ * match with the ones in the conversionMatrix. If the source is located in the controllingDomain, the ID needs to be
+ * retrieved by registering the source before registering the gateway. In case the source is in a different domain, the ID
+ * needs to be retrieved via peeking.
*/
am_sourceID_t sourceID;
/**
- * The ID of the sink. If the domain is the same like the controlling domain, the
- * ID is known due to registration. If the domain is different, the ID needs to be
- * retrieved via peeking.
+ * The ID of the sink. If the domain is the same like the controlling domain, the ID is known due to registration. If the
+ * domain is different, the ID needs to be retrieved via peeking.
*/
am_domainID_t domainSinkID;
/**
- * The ID of the source. If the domain is the same like the controlling domain,
- * the ID is known due to registration. If the domain is different, the ID needs
- * to be retrieved via peeking.
+ * The ID of the source. If the domain is the same like the controlling domain, the ID is known due to registration. If
+ * the domain is different, the ID needs to be retrieved via peeking.
*/
am_domainID_t domainSourceID;
/**
@@ -558,28 +592,23 @@ namespace am {
*/
am_domainID_t controlDomainID;
/**
- * This is the list of available formats on the source side of the gateway. It is
- * not defined during the gateway registration but copied from the source
- * registration.
+ * This is the list of available formats on the source side of the gateway. It is not defined during the gateway
+ * registration but copied from the source registration.
*/
std::vector<am_ConnectionFormat_e> listSourceFormats;
/**
- * This is the list of available formats on the sink side of the gateway. It is
- * not defined during the gateway registration but copied from the sink
- * registration.
+ * This is the list of available formats on the sink side of the gateway. It is not defined during the gateway
+ * registration but copied from the sink registration.
*/
std::vector<am_ConnectionFormat_e> listSinkFormats;
/**
- * This is matrix holding information about the conversion capability of the
- * gateway, it's length is defined by the length(listSinkFormats) x
- * length(listSourceFormats).
- * If a SinkFormat can be converted into a SourceFormat, the vector will hold a 1,
- * if no conversion is possible, a 0.
- * The data is stored row orientated, where the rows are related to the
- * sinksFormats and the columns to the sourceFormats. The first value will hold
- * the conversion information from the first sourceFormat to the first sinkFormat
- * for example and the seventh value the information about the 3rd sinkFormat to
- * the 1st sourceFormat in case we would have 3 sourceFormats.
+ * This is matrix holding information about the conversion capability of the gateway, it's length is defined by the
+ * length(listSinkFormats) x length(listSourceFormats).
+ * If a SinkFormat can be converted into a SourceFormat, the vector will hold a 1, if no conversion is possible, a 0.
+ * The data is stored row orientated, where the rows are related to the sinksFormats and the columns to the sourceFormats.
+ * The first value will hold the conversion information from the first sourceFormat to the first sinkFormat for example
+ * and the seventh value the information about the 3rd sinkFormat to the 1st sourceFormat in case we would have 3
+ * sourceFormats.
*
* This matrix
* 110 011 000 111 001
@@ -601,7 +630,7 @@ namespace am {
/**
* This represents one "hopp" in a route
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_RoutingElement_s
{
@@ -629,7 +658,7 @@ namespace am {
/**
* a list of routing elements that lead from source to sink
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:14 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_Route_s
{
@@ -653,7 +682,7 @@ namespace am {
/**
* struct describing the sound property
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_SoundProperty_s
{
@@ -673,7 +702,7 @@ namespace am {
/**
* struct describing system properties
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_SystemProperty_s
{
@@ -693,7 +722,7 @@ namespace am {
/**
* struct describing sinkclasses
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_SinkClass_s
{
@@ -708,8 +737,8 @@ namespace am {
*/
std::string name;
/**
- * the list of the class properties. These are pairs of a project specific enum
- * describing the type of the value and an integer holding the real value.
+ * the list of the class properties. These are pairs of a project specific enum describing the type of the value and an
+ * integer holding the real value.
*/
std::vector<am_ClassProperty_s> listClassProperties;
@@ -718,7 +747,7 @@ namespace am {
/**
* struct describing source classes
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_SourceClass_s
{
@@ -733,8 +762,8 @@ namespace am {
*/
std::string name;
/**
- * the list of the class properties. These are pairs of a project specific enum
- * describing the type of the value and an integer holding the real value.
+ * the list of the class properties. These are pairs of a project specific enum describing the type of the value and an
+ * integer holding the real value.
*/
std::vector<am_ClassProperty_s> listClassProperties;
@@ -743,17 +772,16 @@ namespace am {
/**
* this type holds all information of sources relevant to the HMI
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_SourceType_s
{
public:
/**
- * This is the ID of the source, 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).
+ * This is the ID of the source, 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).
*/
am_sourceID_t sourceID;
/**
@@ -765,9 +793,8 @@ namespace am {
*/
am_Availability_s availability;
/**
- * the sourceClassID, indicates the class the source is in. This information can
- * be used by the Controller to implement different behaviour for different
- * classes.
+ * the sourceClassID, indicates the class the source is in. This information can be used by the Controller to implement
+ * different behaviour for different classes.
*/
am_sourceClass_t sourceClassID;
@@ -776,17 +803,16 @@ namespace am {
/**
* this type holds all information of sinks relevant to the HMI
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_SinkType_s
{
public:
/**
- * 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).
+ * 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).
*/
am_sinkID_t sinkID;
/**
@@ -794,37 +820,33 @@ namespace am {
*/
std::string name;
/**
- * 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
+ * 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.
+ * 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.
*/
am_Availability_s availability;
/**
- * 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.
+ * 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.
*/
am_mainVolume_t volume;
am_MuteState_e muteState;
/**
- * The sinkClassID references to a sinkClass. With the help of classification,
- * rules can be setup to define the system behaviour.
+ * The sinkClassID references to a sinkClass. With the help of classification, rules can be setup to define the system
+ * behaviour.
*/
am_sinkClass_t sinkClassID;
};
/**
- * a handle is used for asynchronous operations and is uniquely assigned for each
- * of this operations
+ * a handle is used for asynchronous operations and is uniquely assigned for each of this operations
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_Handle_s
{
@@ -833,18 +855,18 @@ namespace am {
/**
* the handletype
*/
- am_Handle_e handleType:4;
+ am_Handle_e handleType:6;
/**
* the handle as value
*/
- uint16_t handle:12;
+ uint16_t handle:10;
};
/**
* struct describung mainsound property
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_MainSoundProperty_s
{
@@ -864,7 +886,7 @@ namespace am {
/**
* this type holds all information of connections relevant to the HMI
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:15 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_MainConnectionType_s
{
@@ -896,7 +918,7 @@ namespace am {
/**
* struct that holds attribiutes of a mainconnection
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:16 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_MainConnection_s
{
@@ -930,19 +952,69 @@ namespace am {
};
/**
+ * This struct holds the payload of a notification.
+ * @author q232968
+ * @version 1.0
+ * @created 16-Dez-2012 15:58:13
+ */
+ struct am_NotificationPayload_s
+ {
+
+ public:
+ /**
+ * This defines the notification type
+ */
+ am_NotificationType_e notificationType;
+ /**
+ * This is finally the value of the notification. It's meaning depends on the notificationType
+ */
+ int16_t notificationValue;
+
+ };
+
+ /**
+ * This struct holds information about the configuration for notifications
+ * @author q232968
+ * @version 1.0
+ * @created 16-Dez-2012 15:58:13
+ */
+ struct am_NotificationConfiguration_s
+ {
+
+ public:
+ /**
+ * The notification type of the notification
+ */
+ am_NotificationType_e notificationType;
+ /**
+ * The Notification status. This can be periodic, min/max value based or even off for example
+ */
+ am_NotificationStatus_e notificationStatus;
+ /**
+ * This gives additional information to the notification status.
+ * Relation between notification status and the value:
+ * NS_PERIODIC - the period in ms
+ * NS_MINIMUM - the minimum value that triggers the notification
+ * NS_MAXIMUM - the maximum value that triggers the notifcation
+ * NS_CHANGE - the resolution of the change value
+ */
+ int16_t notificationParameter;
+
+ };
+
+ /**
* This struct describes the attribiutes of a sink
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:16 PM
+ * @created 16-Dez-2012 15:58:13
*/
struct am_Sink_s
{
public:
/**
- * 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).
+ * 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).
*/
am_sinkID_t sinkID;
/**
@@ -950,13 +1022,12 @@ namespace am {
*/
std::string name;
/**
- * The domainID is the domain the sink belongs to. A sink can only be in one
- * domain.
+ * The domainID is the domain the sink belongs to. A sink can only be in one domain.
*/
am_domainID_t domainID;
/**
- * The sinkClassID references to a sinkClass. With the help of classification,
- * rules can be setup to define the system behaviour.
+ * The sinkClassID references to a sinkClass. With the help of classification, rules can be setup to define the system
+ * behaviour.
*/
am_sinkClass_t sinkClassID;
/**
@@ -964,77 +1035,74 @@ namespace am {
*/
am_volume_t volume;
/**
- * 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.
+ * 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.
*/
bool visible;
/**
- * 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
+ * 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.
+ * 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.
*/
am_Availability_s available;
/**
- * 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.
+ * 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.
*/
am_MuteState_e muteState;
/**
- * 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.
+ * 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.
*/
am_mainVolume_t mainVolume;
/**
- * 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.
+ * 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.
*/
std::vector<am_SoundProperty_s> listSoundProperties;
/**
- * This list holds information about the formats that the Source is capable of
- * supporting when delivering audio.
+ * This list holds information about the formats that the Source is capable of supporting when delivering audio.
*/
std::vector<am_ConnectionFormat_e> listConnectionFormats;
/**
- * This is the list of the available mainSoundProperties. The principle is the
- * same than with soundProperties, but they are only visible to the
- * CommandInterface.
+ * This is the list of the available mainSoundProperties. The principle is the same than with soundProperties, but they
+ * are only visible to the CommandInterface.
*/
std::vector<am_MainSoundProperty_s> listMainSoundProperties;
+ /**
+ * This is the list of the MainNotificationConfigurations. These notifications work on the level of command interface.
+ */
+ std::vector<am_NotificationConfiguration_s> listMainNotificationConfigurations;
+ /**
+ * This is the list of the NotificationConfigurations. These notifications work on the level of RoutingPlugins.
+ */
+ std::vector<am_NotificationConfiguration_s> listNotificationConfigurations;
};
/**
* This struct describes the attribiutes of a source
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:16 PM
+ * @created 16-Dez-2012 15:58:14
*/
struct am_Source_s
{
public:
/**
- * This is the ID of the source, 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).
+ * This is the ID of the source, 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).
*/
am_sourceID_t sourceID;
/**
- * The domainID is the domain the source belongs to. A source can only be in one
- * domain.
+ * The domainID is the domain the source belongs to. A source can only be in one domain.
*/
am_domainID_t domainID;
/**
@@ -1042,17 +1110,15 @@ namespace am {
*/
std::string name;
/**
- * the sourceClassID, indicates the class the source is in. This information can
- * be used by the Controller to implement different behaviour for different
- * classes.
+ * the sourceClassID, indicates the class the source is in. This information can be used by the Controller to implement
+ * different behaviour for different classes.
*/
am_sourceClass_t sourceClassID;
/**
- * The source state is an indication towards the source if it is actively heard or
- * not. The source can use this information to implement features like automatic
- * spin down of CD's in case the CD is not the active source or AF following of a
- * tuner that is not actively heard. The source state is set by the
- * AudioManagerController.There are 3 possible states:
+ * The source state is an indication towards the source if it is actively heard or not. The source can use this
+ * information to implement features like automatic spin down of CD's in case the CD is not the active source or AF
+ * following of a tuner that is not actively heard. The source state is set by the AudioManagerController.There are 3
+ * possible states:
*
* SS_ON: the source is active
* SS_OFF: the source is off
@@ -1060,38 +1126,31 @@ namespace am {
*/
am_SourceState_e sourceState;
/**
- * This is the volume of the source. It is set by the AudioManagerController. It
- * is used to adopt different audiolevels in a system and mixing of sources (e.g.
- * navigation hints & music).
+ * This is the volume of the source. It is set by the AudioManagerController. It is used to adopt different audiolevels in
+ * a system and mixing of sources (e.g. navigation hints & music).
*/
am_volume_t volume;
/**
- * This Boolean flag indicates whether a source 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 sources, for
- * example if the source is part of a crossfader or gateway. HMI relevant changes
- * in visible sources will be automatically reported by the daemon to the
- * commandInterface.
+ * This Boolean flag indicates whether a source 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 sources,
+ * for example if the source is part of a crossfader or gateway. HMI relevant changes in visible sources will be
+ * automatically reported by the daemon to the commandInterface.
*/
bool visible;
/**
- * This attribute reflects the availability of the source. There are several
- * reasons why a source could be not available for the moment. For example a CD
- * player which has no CD entered in the slot can be unavailable, or a USB player
- * with no or unreadable stick attached. Other scenarios involve the shutdown of a
- * source because of overtemperature or over- & undervoltage. The availability
- * consists of two informations:
+ * This attribute reflects the availability of the source. There are several reasons why a source could be not available
+ * for the moment. For example a CD player which has no CD entered in the slot can be unavailable, or a USB player with no
+ * or unreadable stick attached. Other scenarios involve the shutdown of a source because of overtemperature or over- &
+ * undervoltage. The availability consists of two informations:
*
- * 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.
+ * 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.
*/
am_Availability_s available;
/**
- * Some special sources can have special behaviors, the are so called "Low Level
- * Interrupts". Here the current status is documented. The information can be used
- * by the AudioManagerController to react to the changes by for example lowering
+ * Some special sources can have special behaviors, the are so called "Low Level Interrupts". Here the current status is
+ * documented. The information can be used by the AudioManagerController to react to the changes by for example lowering
* the volume of the mainSources. The two states are
*
* IS_OFF: the interrupt is not active at the moment
@@ -1099,29 +1158,34 @@ namespace am {
*/
am_InterruptState_e interruptState;
/**
- * This is the list of soundProperties, that the source is capable of. The
- * soundProperties itself are project specific. For sources, a possible
- * soundProperty could be navigation volume offset, for example.
+ * This is the list of soundProperties, that the source is capable of. The soundProperties itself are project specific.
+ * For sources, a possible soundProperty could be navigation volume offset, for example.
*/
std::vector<am_SoundProperty_s> listSoundProperties;
/**
- * This list holds information about the formats that the Source is capable of
- * supporting when delivering audio.
+ * This list holds information about the formats that the Source is capable of supporting when delivering audio.
*/
std::vector<am_ConnectionFormat_e> listConnectionFormats;
/**
- * This is the list of the available mainSoundProperties. The principle is the
- * same than with soundProperties, but they are only visible to the
- * CommandInterface.
+ * This is the list of the available mainSoundProperties. The principle is the same than with soundProperties, but they
+ * are only visible to the CommandInterface.
*/
std::vector<am_MainSoundProperty_s> listMainSoundProperties;
+ /**
+ * The list of MainNotificationConfigurations. These notifications work on the level of CommandInterface.
+ */
+ std::vector<am_NotificationConfiguration_s> listMainNotificationConfigurations;
+ /**
+ * The list of MainNotificationConfigurations. These notifications work on the level of RoutingInterface.
+ */
+ std::vector<am_NotificationConfiguration_s> listNotificationConfigurations;
};
/**
* This struct describes the attribiutes of a domain
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:16 PM
+ * @created 16-Dez-2012 15:58:14
*/
struct am_Domain_s
{
@@ -1136,8 +1200,7 @@ namespace am {
*/
std::string name;
/**
- * the busname. This is equal to a plugin name and is used to dispatch messages to
- * the elements of a plugin
+ * the busname. This is equal to a plugin name and is used to dispatch messages to the elements of a plugin
*/
std::string busname;
/**
@@ -1162,7 +1225,7 @@ namespace am {
/**
* a connection
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:16 PM
+ * @created 16-Dez-2012 15:58:14
*/
struct am_Connection_s
{
@@ -1196,7 +1259,7 @@ namespace am {
* volume_t in case of ED_SOURCE_VOLUME, ED_SINK_VOLUME
* soundProperty_t in case of ED_SOURCE_PROPERTY, ED_SINK_PROPERTY
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:16 PM
+ * @created 16-Dez-2012 15:58:14
*/
union am_EarlyData_u
{
@@ -1212,7 +1275,7 @@ namespace am {
* sourceID in case of ED_SOURCE_VOLUME, ED_SOURCE_PROPERTY
* sinkID in case of ED_SINK_VOLUME, ED_SINK_PROPERTY
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:16 PM
+ * @created 16-Dez-2012 15:58:14
*/
union am_DataType_u
{
@@ -1225,7 +1288,7 @@ namespace am {
/**
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
struct am_EarlyData_s
{
@@ -1236,5 +1299,38 @@ namespace am {
am_EarlyData_u data;
};
+
+ /**
+ * This types describe a mixed description for source and sinks volumes.
+ * @author q232968
+ * @version 1.0
+ * @created 16-Dez-2012 15:58:14
+ */
+ struct am_Volumes_s
+ {
+
+ public:
+ /**
+ * describes the type of the volume: source or sink.
+ */
+ am_VolumeType_e volumeType;
+ /**
+ * either sourceID or sinkID
+ */
+ am_DataType_u volumeID;
+ /**
+ * The volume
+ */
+ am_volume_t volume;
+ /**
+ * the ramp that shall be driven
+ */
+ am_RampType_e ramp;
+ /**
+ * the time for the ramp
+ */
+ am_time_t time;
+
+ };
}
-#endif // !defined(EA_F9B4F59D_FED5_44ac_85F2_F9F60549C133__INCLUDED_)
+#endif // !defined(EA_4739DD27_2A1B_4548_8F5F_7D50DB15209C__INCLUDED_)
diff --git a/include/command/IAmCommandReceive.h b/include/command/IAmCommandReceive.h
index 9239555..5a1a06c 100644
--- a/include/command/IAmCommandReceive.h
+++ b/include/command/IAmCommandReceive.h
@@ -12,15 +12,15 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_)
-#define EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_
+#if !defined(EA_3888D932_2C16_4c2a_BD7C_E1F819C9A7F0__INCLUDED_)
+#define EA_3888D932_2C16_4c2a_BD7C_E1F819C9A7F0__INCLUDED_
#include <vector>
#include <string>
@@ -31,25 +31,23 @@ class CAmSocketHandler;
}
-#define CommandReceiveVersion "1.0"
+#include "audiomanagertypes.h"
+
+#define CommandReceiveVersion "2.0"
namespace am {
/**
- * The interface towards the Controlling Instance (e.g HMI). It handles the
- * communication towards the HMI and other system components who need to interact
- * with the audiomanagement.
- * There are two rules that have to be kept in mind when implementing against this
- * interface:\n
+ * The interface towards the Controlling Instance (e.g HMI). It handles the communication towards the HMI and other system
+ * components who need to interact with the audiomanagement.
+ * There are two rules that have to be kept in mind when implementing against this interface:\n
* \warning
* 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
- * CALL THAT EXPECTS A RETURN VALUE.\n
+ * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
* \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can
- * implement thread safe by using the deferred-call pattern described on the wiki
- * which also helps to implement calls that are forbidden.\n
+ * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-
+ * call pattern described on the wiki which also helps to implement calls that are forbidden.\n
* For more information, please check CAmSerializer
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
class IAmCommandReceive
{
@@ -71,8 +69,7 @@ namespace am {
virtual void getInterfaceVersion(std::string& version) const =0;
/**
* connects a source to sink
- * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the
- * connection does already exists
+ * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists
*
* @param sourceID
* @param sinkID
@@ -81,16 +78,14 @@ namespace am {
virtual am_Error_e connect(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0;
/**
* disconnects a mainConnection
- * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist,
- * E_NOT_POSSIBLE on error.
+ * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist, E_NOT_POSSIBLE on error.
*
* @param mainConnectionID
*/
virtual am_Error_e disconnect(const am_mainConnectionID_t mainConnectionID) =0;
/**
* sets the volume for a sink
- * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is
- * out of range
+ * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is out of range
*
* @param sinkID the sink
* @param volume the volume
@@ -98,40 +93,34 @@ namespace am {
virtual am_Error_e setVolume(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
/**
* This function is used to increment or decrement the current volume for a sink.
- * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is
- * not in the given volume range.
+ * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is not in the given volume range.
*
* @param sinkID
- * @param volumeStep indicated the number of steps that should be incremented
- * or decremented. Positive values here inkrement, negative values decrement
+ * @param volumeStep indicated the number of steps that should be incremented or decremented. Positive values here
+ * inkrement, negative values decrement
*/
virtual am_Error_e volumeStep(const am_sinkID_t sinkID, const int16_t volumeStep) =0;
/**
* sets the mute state of a sink
- * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the
- * desired one, the Daemon will return E_OK.
+ * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the desired one, the Daemon will return E_OK.
*
* @param sinkID
* @param muteState
*/
virtual am_Error_e setSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
/**
- * This method is used to set sound properties, e.g. Equalizer Values. Since the
- * capabilities of the system can differ, the exact key value pairs can be
- * extended in each product
- * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
- * case of an error
+ * This method is used to set sound properties, e.g. Equalizer Values. Since the capabilities of the system can differ,
+ * the exact key value pairs can be extended in each product
+ * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
*
* @param soundProperty
* @param sinkID
*/
virtual am_Error_e setMainSinkSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;
/**
- * This method is used to set sound properties, e.g. Equalizer Values. Since the
- * capabilities of the system can differ, the exact key value pairs can be
- * extended in each product
- * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
- * case of an error
+ * This method is used to set sound properties, e.g. Equalizer Values. Since the capabilities of the system can differ,
+ * the exact key value pairs can be extended in each product
+ * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
*
* @param soundProperty
* @param sourceID
@@ -139,8 +128,7 @@ namespace am {
virtual am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
/**
* is used to set a specific system property.
- * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
- * case of an error
+ * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
*
* @param property the property that shall be set
*/
@@ -167,8 +155,8 @@ namespace am {
*/
virtual am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const =0;
/**
- * This is used to retrieve all source sound properties related to a source.
- * Returns a vector of the sound properties and values as pair
+ * This is used to retrieve all source sound properties related to a source. Returns a vector of the sound properties and
+ * values as pair
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param sinkID
@@ -206,8 +194,8 @@ namespace am {
virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
/**
* returns the delay in ms that the audiopath for the given mainConnection has
- * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet
- * retrieved, E_DATABASE_ERROR on read error on the database
+ * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet retrieved, E_DATABASE_ERROR on read error on
+ * the database
*
* @param mainConnectionID
* @param delay
@@ -215,20 +203,16 @@ namespace am {
virtual am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const =0;
/**
* this function is used to retrieve a pointer to the dBusConnectionWrapper
- * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without
- * DBus Support
+ * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support
*
- * @param dbusConnectionWrapper This is a wrapper class that is needed to keep
- * dbus inclusions away from the interface. The DBusWrapperClass will return the
- * pointer to the DbusConnection call (getDBusConnection)
+ * @param dbusConnectionWrapper This is a wrapper class that is needed to keep dbus inclusions away from the interface.
+ * The DBusWrapperClass will return the pointer to the DbusConnection call (getDBusConnection)
*/
virtual am_Error_e getDBusConnectionWrapper(CAmDbusWrapper*& dbusConnectionWrapper) const =0;
/**
- * This function returns the pointer to the socketHandler. This can be used to
- * integrate socket-based activites like communication with the mainloop of the
- * AudioManager.
- * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled
- * without socketHandler support,
+ * This function returns the pointer to the socketHandler. This can be used to integrate socket-based activites like
+ * communication with the mainloop of the AudioManager.
+ * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,
*
* @param socketHandler
*/
@@ -237,15 +221,47 @@ namespace am {
* asynchronous confirmation of setCommandReady.
*
* @param handle the handle that was handed over by setCommandReady
+ * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened.
*/
- virtual void confirmCommandReady(const uint16_t handle) =0;
+ virtual void confirmCommandReady(const uint16_t handle, const am_Error_e error) =0;
/**
* asynchronous confirmation of setCommandRundown
*
* @param handle the handle that was given via setCommandRundown
+ * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened.
+ */
+ virtual void confirmCommandRundown(const uint16_t handle, const am_Error_e error) =0;
+ /**
+ * Rtrieves the list of MainNotifications for a sink.
+ *
+ * @param sinkID The sinkID
+ * @param listMainNotificationConfigurations
+ */
+ virtual am_Error_e getListSinkMainNotificationConfigurations(const am_sinkID_t sinkID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) const =0;
+ /**
+ * Rtrieves the list of MainNotifications for a source.
+ *
+ * @param sourceID The sourceID
+ * @param listMainNotificationConfigurations
+ */
+ virtual am_Error_e getListSourceMainNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) const =0;
+ /**
+ * sets a MainNotificationConfiuration. This can be used to turn on an off notifications an to change the mode of the
+ * configuration.
+ *
+ * @param sinkID The sinkID of the MainNotification to be changed
+ * @param mainNotificationConfiguration The MainNotifiication that needs to be set
+ */
+ virtual am_Error_e setSinkMainNotificationConfiguration(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;
+ /**
+ * sets a MainNotificationConfiuration. This can be used to turn on an off notifications an to change the mode of the
+ * configuration.
+ *
+ * @param sourceID The sourceID of the MainNotification to be changed
+ * @param mainNotificationConfiguration The MainNotifiication that needs to be set
*/
- virtual void confirmCommandRundown(const uint16_t handle) =0;
+ virtual am_Error_e setSourceMainNotificationConfiguration(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;
};
}
-#endif // !defined(EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_)
+#endif // !defined(EA_3888D932_2C16_4c2a_BD7C_E1F819C9A7F0__INCLUDED_)
diff --git a/include/command/IAmCommandSend.h b/include/command/IAmCommandSend.h
index bf073f9..ce32131 100644
--- a/include/command/IAmCommandSend.h
+++ b/include/command/IAmCommandSend.h
@@ -12,15 +12,15 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_)
-#define EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_
+#if !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_)
+#define EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_
#include <vector>
#include <string>
@@ -31,29 +31,25 @@ class IAmCommandReceive;
}
#include "IAmCommandReceive.h"
+#include "audiomanagertypes.h"
-#define CommandSendVersion "1.0"
+#define CommandSendVersion "2.0"
namespace am {
/**
- * This interface handles all communication from the AudioManagerDaemon towards
- * the system. It is designed in such a way that only callbacks with no return
- * types are implemented. So when the CommandInterfacePlugins are designed in such
- * a way that they broadcast signals to any node who is interested in the
- * particular information (like signals on Dbus for example), more information can
- * be retrieved via the CommandReceiveInterface.
- * There are two rules that have to be kept in mind when implementing against this
- * interface:\n
+ * This interface handles all communication from the AudioManagerDaemon towards the system. It is designed in such a way
+ * that only callbacks with no return types are implemented. So when the CommandInterfacePlugins are designed in such a
+ * way that they broadcast signals to any node who is interested in the particular information (like signals on Dbus for
+ * example), more information can be retrieved via the CommandReceiveInterface.
+ * There are two rules that have to be kept in mind when implementing against this interface:\n
* \warning
* 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
- * CALL THAT EXPECTS A RETURN VALUE.\n
+ * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
* \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can
- * implement thread safe by using the deferred-call pattern described on the wiki
- * which also helps to implement calls that are forbidden.\n
+ * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-
+ * call pattern described on the wiki which also helps to implement calls that are forbidden.\n
* For more information, please check CAmSerializer
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
class IAmCommandSend
{
@@ -74,33 +70,29 @@ namespace am {
*/
virtual void getInterfaceVersion(std::string& version) const =0;
/**
- * This command starts the interface, the plugin itself. This is not meant to
- * start communication with the HMI itself. It is a good idea to implement here
- * everything that sets up the basic communication like DbusCommunication etc...
+ * This command starts the interface, the plugin itself. This is not meant to start communication with the HMI itself. It
+ * is a good idea to implement here everything that sets up the basic communication like DbusCommunication etc...
* Be aware of side effects with systemd and socketbased communication!
* @return E_OK on success, E_UNKNOWN on error
*
- * @param commandreceiveinterface pointer to the receive interface. Is used to
- * call the audiomanagerdaemon
+ * @param commandreceiveinterface pointer to the receive interface. Is used to call the audiomanagerdaemon
*/
virtual am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface) =0;
/**
- * This function will indirectly be called by the Controller and is used to start
- * the Communication. Before this command, all communication will be ignored by
- * the AudioManager.
- * After the Plugin is ready, it will asynchronously answer with
- * condfirmCommandReady, the handle that is handed over must be returned.
+ * This function will indirectly be called by the Controller and is used to start the Communication. Before this command,
+ * all communication will be ignored by the AudioManager.
+ * After the Plugin is ready, it will asynchronously answer with condfirmCommandReady, the handle that is handed over must
+ * be returned.
*
* @param handle the handle uniquely idenfies the request
*/
virtual void setCommandReady(const uint16_t handle) =0;
/**
- * This function will indirectly be called by the Controller and is used to stop
- * the Communication. After this command, all communication will be ignored by the
- * AudioManager. The plugin has to be prepared that either the power will be
+ * This function will indirectly be called by the Controller and is used to stop the Communication. After this command,
+ * all communication will be ignored by the AudioManager. The plugin has to be prepared that either the power will be
* switched off or the Interface is started again with setCommandReady
- * After the Plugin is ready to rundown, it will asynchronously answer with
- * condfirmCommandRundown, the handle that is handed over must be returned.
+ * After the Plugin is ready to rundown, it will asynchronously answer with condfirmCommandRundown, the handle that is
+ * handed over must be returned.
*
* @param handle This handle uniquly idenfies the request
*/
@@ -211,7 +203,53 @@ namespace am {
* @param time
*/
virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;
+ /**
+ * This callback is called when a sink is updated.
+ *
+ * @param sinkID The sinkID that is updated
+ * @param sinkClassID The sinkClassID of the updated sink. gives the current value even if not updated
+ * @param listMainSoundProperties The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if
+ * not changed
+ */
+ virtual void cbSinkUpdated(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
+ /**
+ * This callback is called when a source is updated.
+ *
+ * @param sourceID The sourceID that is updated
+ * @param sourceClassID The sourceClassID of the updated source. Gives the current value even if not updated
+ * @param listMainSoundProperties The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if
+ * not changed
+ */
+ virtual void cbSourceUpdated(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
+ /**
+ * This callback is called when a notifcated value of a sink changes.
+ *
+ * @param sinkID The sinkID
+ * @param notification The payload of the notification
+ */
+ virtual void cbSinkNotification(const am_sinkID_t sinkID, const am_NotificationPayload_s notification) =0;
+ /**
+ * This callback is called when a notifcated value of a source changes.
+ *
+ * @param sourceID The sourceID
+ * @param notification The payload of the notification
+ */
+ virtual void cbSourceNotification(const am_sourceID_t sourceID, const am_NotificationPayload_s notification) =0;
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ *
+ * @param sinkID
+ * @param mainNotificationConfiguration The MainNotificationConfiguration that changed
+ */
+ virtual void cbSinkMainNotificationConfigurationChanged(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ *
+ * @param sourceID
+ * @param mainNotificationConfiguration The MainNotificationConfiguration that changed
+ */
+ virtual void cbSourceMainNotificationConfigurationChanged(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;
};
}
-#endif // !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_)
+#endif // !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_)
diff --git a/include/control/IAmControlReceive.h b/include/control/IAmControlReceive.h
index 1cbf244..ccba927 100644
--- a/include/control/IAmControlReceive.h
+++ b/include/control/IAmControlReceive.h
@@ -12,15 +12,15 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_6E701C15_A8E8_4ad3_A50B_D91A5BD0973F__INCLUDED_)
-#define EA_6E701C15_A8E8_4ad3_A50B_D91A5BD0973F__INCLUDED_
+#if !defined(EA_AC2A0532_F989_4f95_A467_1055C94D9C1E__INCLUDED_)
+#define EA_AC2A0532_F989_4f95_A467_1055C94D9C1E__INCLUDED_
#include <vector>
#include <string>
@@ -30,24 +30,25 @@ class CAmSocketHandler;
}
-#define ControlReceiveVersion "1.0"
+#include "audiomanagertypes.h"
+#include "projecttypes.h"
+#include "NodeStateManager.h"
+
+#define ControlReceiveVersion "2.0"
namespace am {
/**
- * This interface gives access to all important functions of the audiomanager that
- * are used by the AudioManagerController to control the system.
- * There are two rules that have to be kept in mind when implementing against this
- * interface:\n
+ * This interface gives access to all important functions of the audiomanager that are used by the AudioManagerController
+ * to control the system.
+ * There are two rules that have to be kept in mind when implementing against this interface:\n
* \warning
* 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
- * CALL THAT EXPECTS A RETURN VALUE.\n
+ * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
* \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can
- * implement thread safe by using the deferred-call pattern described on the wiki
- * which also helps to implement calls that are forbidden.\n
+ * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-
+ * call pattern described on the wiki which also helps to implement calls that are forbidden.\n
* For more information, please check CAmSerializer
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:18 PM
+ * @created 16-Dez-2012 15:58:15
*/
class IAmControlReceive
{
@@ -71,20 +72,17 @@ namespace am {
* calculates a route from source to sink.
* @return E_OK on success, E_UNKNOWN on error
*
- * @param onlyfree if true return only routes which use gateways that are not
- * in use at the moment
+ * @param onlyfree if true return only routes which use gateways that are not in use at the moment
* @param sourceID
* @param sinkID
- * @param returnList this is a list of routes that are possible to take.
- * unsorted! The longest could be first.
+ * @param returnList this is a list of routes that are possible to take. unsorted! The longest could be first.
* In case not route can be found, the list will return empty.
*/
virtual am_Error_e getRoute(const bool onlyfree, const am_sourceID_t sourceID, const am_sinkID_t sinkID, std::vector<am_Route_s>& returnList) =0;
/**
* With this function, elementary connects can be triggered by the controller.
- * @return E_OK on success, E_UNKNOWN on error, E_WRONG_FORMAT of
- * connectionFormats do not match, E_NO_CHANGE if the desired connection is
- * already build up
+ * @return E_OK on success, E_UNKNOWN on error, E_WRONG_FORMAT of connectionFormats do not match, E_NO_CHANGE if the
+ * desired connection is already build up
*
* @param handle
* @param connectionID
@@ -95,8 +93,8 @@ namespace am {
virtual am_Error_e connect(am_Handle_s& handle, am_connectionID_t& connectionID, const am_ConnectionFormat_e format, const am_sourceID_t sourceID, const am_sinkID_t sinkID) =0;
/**
* is used to disconnect a connection
- * @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if connection was
- * not found, E_NO_CHANGE if no change is neccessary
+ * @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if connection was not found, E_NO_CHANGE if no change is
+ * neccessary
*
* @param handle
* @param connectionID
@@ -104,12 +102,10 @@ namespace am {
virtual am_Error_e disconnect(am_Handle_s& handle, const am_connectionID_t connectionID) =0;
/**
* triggers a cross fade.
- * @return E_OK on success, E_UNKNOWN on error E_NO_CHANGE if no change is
- * neccessary
+ * @return E_OK on success, E_UNKNOWN on error E_NO_CHANGE if no change is neccessary
*
* @param handle
- * @param hotSource this is the source that is going to be the active one after
- * the fading
+ * @param hotSource this is the source that is going to be the active one after the fading
* @param crossfaderID
* @param rampType
* @param rampTime rampTime 0 means default value
@@ -123,10 +119,9 @@ namespace am {
*/
virtual am_Error_e abortAction(const am_Handle_s handle) =0;
/**
- * this method sets a source state for a source. This function will trigger the
- * callback cbAckSetSourceState
- * @return E_OK on success, E_NO_CHANGE if the desired value is already correct,
- * E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary
+ * this method sets a source state for a source. This function will trigger the callback cbAckSetSourceState
+ * @return E_OK on success, E_NO_CHANGE if the desired value is already correct, E_UNKNOWN on error, E_NO_CHANGE if no
+ * change is neccessary
*
* @param handle
* @param sourceID
@@ -134,13 +129,12 @@ namespace am {
*/
virtual am_Error_e setSourceState(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SourceState_e state) =0;
/**
- * with this function, setting of sinks volumes is done. The behavior of the
- * volume set is depended on the given ramp and time information.
- * This function is not only used to ramp volume, but also to mute and direct set
- * the level. Exact behavior is depended on the selected mute ramps.
- * @return E_OK on success, E_NO_CHANGE if the volume is already on the desired
- * value, E_OUT_OF_RANGE is the volume is out of range, E_UNKNOWN on every other
- * error.
+ * with this function, setting of sinks volumes is done. The behavior of the volume set is depended on the given ramp and
+ * time information.
+ * This function is not only used to ramp volume, but also to mute and direct set the level. Exact behavior is depended on
+ * the selected mute ramps.
+ * @return E_OK on success, E_NO_CHANGE if the volume is already on the desired value, E_OUT_OF_RANGE is the volume is out
+ * of range, E_UNKNOWN on every other error.
*
* @param handle
* @param sinkID
@@ -150,13 +144,12 @@ namespace am {
*/
virtual am_Error_e setSinkVolume(am_Handle_s& handle, const am_sinkID_t sinkID, const am_volume_t volume, const am_RampType_e ramp, const am_time_t time) =0;
/**
- * with this function, setting of source volumes is done. The behavior of the
- * volume set is depended on the given ramp and time information.
- * This function is not only used to ramp volume, but also to mute and direct set
- * the level. Exact behavior is depended on the selected mute ramps.
- * @return E_OK on success, E_NO_CHANGE if the volume is already on the desired
- * value, E_OUT_OF_RANGE is the volume is out of range, E_UNKNOWN on every other
- * error.
+ * with this function, setting of source volumes is done. The behavior of the volume set is depended on the given ramp and
+ * time information.
+ * This function is not only used to ramp volume, but also to mute and direct set the level. Exact behavior is depended on
+ * the selected mute ramps.
+ * @return E_OK on success, E_NO_CHANGE if the volume is already on the desired value, E_OUT_OF_RANGE is the volume is out
+ * of range, E_UNKNOWN on every other error.
*
* @param handle
* @param sourceID
@@ -167,8 +160,8 @@ namespace am {
virtual am_Error_e setSourceVolume(am_Handle_s& handle, const am_sourceID_t sourceID, const am_volume_t volume, const am_RampType_e rampType, const am_time_t time) =0;
/**
* is used to set several sinkSoundProperties at a time
- * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out
- * of range, E_NO_CHANGE if no change is neccessary
+ * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range, E_NO_CHANGE if no change is
+ * neccessary
*
* @param handle
* @param sinkID
@@ -177,8 +170,8 @@ namespace am {
virtual am_Error_e setSinkSoundProperties(am_Handle_s& handle, const am_sinkID_t sinkID, const std::vector<am_SoundProperty_s>& soundProperty) =0;
/**
* is used to set sinkSoundProperties
- * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out
- * of range, E_NO_CHANGE if no change is neccessary
+ * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range, E_NO_CHANGE if no change is
+ * neccessary
*
* @param handle
* @param sinkID
@@ -187,8 +180,8 @@ namespace am {
virtual am_Error_e setSinkSoundProperty(am_Handle_s& handle, const am_sinkID_t sinkID, const am_SoundProperty_s& soundProperty) =0;
/**
* is used to set several SourceSoundProperties at a time
- * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out
- * of range. E_NO_CHANGE if no change is neccessary
+ * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range. E_NO_CHANGE if no change is
+ * neccessary
*
* @param handle
* @param sourceID
@@ -197,8 +190,8 @@ namespace am {
virtual am_Error_e setSourceSoundProperties(am_Handle_s& handle, const am_sourceID_t sourceID, const std::vector<am_SoundProperty_s>& soundProperty) =0;
/**
* is used to set sourceSoundProperties
- * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out
- * of range. E_NO_CHANGE if no change is neccessary
+ * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range. E_NO_CHANGE if no change is
+ * neccessary
*
* @param handle
* @param sourceID
@@ -207,8 +200,7 @@ namespace am {
virtual am_Error_e setSourceSoundProperty(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SoundProperty_s& soundProperty) =0;
/**
* sets the domain state of a domain
- * @return E_OK on success, E_UNKNOWN on error, E_NO_CHANGE if no change is
- * neccessary
+ * @return E_OK on success, E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary
*
* @param domainID
* @param domainState
@@ -216,8 +208,8 @@ namespace am {
virtual am_Error_e setDomainState(const am_domainID_t domainID, const am_DomainState_e domainState) =0;
/**
* enters a domain in the database, creates and ID
- * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the
- * database, E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the
+ * database had an error
*
* @param domainData domainID in am_Domain_s must be 0 here
* @param domainID
@@ -227,127 +219,109 @@ namespace am {
* enters a mainconnection in the database, creates and ID
* @return E_OK on success, E_DATABASE_ERROR if the database had an error
*
- * @param mainConnectionData the MainConnectionID is omitted since it is
- * created during the registration
+ * @param mainConnectionData the MainConnectionID is omitted since it is created during the registration
* @param connectionID
*/
virtual am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID) =0;
/**
* enters a sink in the database.
- * The sinkID in am_Sink_s shall be 0 in case of a dynamic added source A sinkID
- * greater than 100 will be assigned. If a specific sinkID with a value <100 is
- * given, the given value will be used. This is for a static setup where the ID's
- * are predefined.
- * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the
- * database, E_DATABASE_ERROR if the database had an error
- *
- * @param sinkData the sinkID will be omitted since it is created during the
- * registration
+ * The sinkID in am_Sink_s shall be 0 in case of a dynamic added source A sinkID greater than 100 will be assigned. If a
+ * specific sinkID with a value <100 is given, the given value will be used. This is for a static setup where the ID's are
+ * predefined.
+ * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the
+ * database had an error
+ *
+ * @param sinkData the sinkID will be omitted since it is created during the registration
* @param sinkID
*/
virtual am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
/**
* enters a crossfader in the database.
- * The crossfaderID in am_Crossfader_s shall be 0 in case of a dynamic added
- * source A crossfaderID greater than 100 will be assigned. If a specific
- * crossfaderID with a value <100 is given, the given value will be used. This is
- * for a static setup where the ID's are predefined.
- * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the
- * database, E_DATABASE_ERROR if the database had an error
- *
- * @param crossfaderData the ID in the data will be ignored since it is created
- * during the registration
+ * The crossfaderID in am_Crossfader_s shall be 0 in case of a dynamic added source A crossfaderID greater than 100 will
+ * be assigned. If a specific crossfaderID with a value <100 is given, the given value will be used. This is for a static
+ * setup where the ID's are predefined.
+ * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the
+ * database had an error
+ *
+ * @param crossfaderData the ID in the data will be ignored since it is created during the registration
* @param crossfaderID
*/
virtual am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
/**
* enters a gateway in the database.
- * The gatewayID in am_Gateway_s shall be 0 in case of a dynamic added source A
- * gatewayID greater than 100 will be assigned. If a specific gatewayID with a
- * value <100 is given, the given value will be used. This is for a static setup
+ * The gatewayID in am_Gateway_s shall be 0 in case of a dynamic added source A gatewayID greater than 100 will be
+ * assigned. If a specific gatewayID with a value <100 is given, the given value will be used. This is for a static setup
* where the ID's are predefined.
- * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the
- * database, E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the
+ * database had an error
*
- * @param gatewayData In a fixed setup, the gatewayID must be below 100. In a
- * dynamic setup, the gatewayID shall be 0! listSourceFormats and listSinkFormats
- * are empty at registration time. Values are taken over when sources and sinks
- * are registered.
+ * @param gatewayData In a fixed setup, the gatewayID must be below 100. In a dynamic setup, the gatewayID shall be 0!
+ * listSourceFormats and listSinkFormats are empty at registration time. Values are taken over when sources and sinks are
+ * registered.
* @param gatewayID
*/
virtual am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
/**
* enters a source in the database.
- * The sourceID in am_Source_s shall be 0 in case of a dynamic added source A
- * sourceID greater than 100 will be assigned. If a specific sourceID with a value
- * <100 is given, the given value will be used. This is for a static setup where
- * the ID's are predefined.
- * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the
- * database, E_DATABASE_ERROR if the database had an error
- *
- * @param sourceData sourceID is omitted here since it is created during
- * registration
+ * The sourceID in am_Source_s shall be 0 in case of a dynamic added source A sourceID greater than 100 will be assigned.
+ * If a specific sourceID with a value <100 is given, the given value will be used. This is for a static setup where the
+ * ID's are predefined.
+ * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the
+ * database had an error
+ *
+ * @param sourceData sourceID is omitted here since it is created during registration
* @param sourceID
*/
virtual am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
/**
* Enters a sourceClass into the database.
- * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the
- * database, E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the
+ * database had an error
*
- * @param sinkClass IDs given with the SinkCLassID are valid below 100 (static).
- * If given as 0, sinkClass will be enterd dynamic and ID above 100 will be
- * created.
+ * @param sinkClass IDs given with the SinkCLassID are valid below 100 (static). If given as 0, sinkClass will be
+ * enterd dynamic and ID above 100 will be created.
* @param sinkClassID
*/
virtual am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID) =0;
/**
* Enters a sourceClass into the database.
- * The sourceClassID in am_sourceClass_s shall be 0 in case of a dynamic added
- * source A sourceClassID greater than 100 will be assigned. If a specific
- * sourceClassID with a value <100 is given, the given value will be used. This is
- * for a static setup where the ID's are predefined.
- * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the
- * database, E_DATABASE_ERROR if the database had an error
+ * The sourceClassID in am_sourceClass_s shall be 0 in case of a dynamic added source A sourceClassID greater than 100
+ * will be assigned. If a specific sourceClassID with a value <100 is given, the given value will be used. This is for a
+ * static setup where the ID's are predefined.
+ * @return E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the
+ * database had an error
*
* @param sourceClassID
- * @param sourceClass IDs given with the SourceCLassID are valid below 100
- * (static). If given as 0, sourceClass will be enterd dynamic and ID above 100
- * will be created.
+ * @param sourceClass IDs given with the SourceCLassID are valid below 100 (static). If given as 0, sourceClass will be
+ * enterd dynamic and ID above 100 will be created.
*/
virtual am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass) =0;
/**
* changes class information of a sinkclass.
- * The properties will overwrite the values of the sinkClassID given in the
- * sinkClass.
- * It is the duty of the controller to check if the property is valid. If it does
- * not exist, the daemon will not return an error.
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
- * sinkClassID was not found.
+ * The properties will overwrite the values of the sinkClassID given in the sinkClass.
+ * It is the duty of the controller to check if the property is valid. If it does not exist, the daemon will not return an
+ * error.
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sinkClassID was not found.
*
- * @param sinkClass if a SourceClass ID other than 0 is given, the
- * classInformation replaces the existing one. In case of ClassID 0, a new classID
- * is created and returned
+ * @param sinkClass if a SourceClass ID other than 0 is given, the classInformation replaces the existing one. In case
+ * of ClassID 0, a new classID is created and returned
*/
virtual am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass) =0;
/**
* changes class information of a sourceClass.
- * The properties will overwrite the values of the sourceClassID given in the
- * sourceClass.
- * It is the duty of the controller to check if the property is valid. If it does
- * not exist, the daemon will not return an error.
- * @return E_OK on success, E_DATABASE_ERROR on error and E_NON_EXISTENT if the
- * ClassID does not exist.
+ * The properties will overwrite the values of the sourceClassID given in the sourceClass.
+ * It is the duty of the controller to check if the property is valid. If it does not exist, the daemon will not return an
+ * error.
+ * @return E_OK on success, E_DATABASE_ERROR on error and E_NON_EXISTENT if the ClassID does not exist.
*
- * @param sourceClass if a SourceClass ID other than 0 is given, the
- * classInformation replaces the existing one. In case of ClassID 0, a new classID
- * is created and returned
+ * @param sourceClass if a SourceClass ID other than 0 is given, the classInformation replaces the existing one. In
+ * case of ClassID 0, a new classID is created and returned
*/
virtual am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass) =0;
/**
* This function is used to enter the system Properties into the database.
- * All entries in the database will be erased before entering the new List. It
- * should only be called once at system startup.
+ * All entries in the database will be erased before entering the new List. It should only be called once at system
+ * startup.
* @return E_OK on success, E_DATABASE_ERROR if the database had an error
*
* @param listSystemProperties
@@ -355,8 +329,7 @@ namespace am {
virtual am_Error_e enterSystemPropertiesListDB(const std::vector<am_SystemProperty_s>& listSystemProperties) =0;
/**
* changes the mainConnectionState of MainConnection
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
- * mainconnection
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
*
* @param mainconnectionID
* @param listConnectionID
@@ -364,8 +337,7 @@ namespace am {
virtual am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const std::vector<am_connectionID_t>& listConnectionID) =0;
/**
* changes the mainConnectionState of MainConnection
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
- * mainconnection
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
*
* @param mainconnectionID
* @param connectionState
@@ -373,8 +345,7 @@ namespace am {
virtual am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState) =0;
/**
* changes the sink volume of a sink
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
- * not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
*
* @param mainVolume
* @param sinkID
@@ -382,8 +353,7 @@ namespace am {
virtual am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID) =0;
/**
* changes the availablility of a sink
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
- * not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
*
* @param availability
* @param sinkID
@@ -391,8 +361,7 @@ namespace am {
virtual am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID) =0;
/**
* changes the domainstate of a domain
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
*
* @param domainState
* @param domainID
@@ -400,8 +369,7 @@ namespace am {
virtual am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID) =0;
/**
* changes the mute state of a sink
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
- * not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
*
* @param muteState
* @param sinkID
@@ -409,8 +377,7 @@ namespace am {
virtual am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID) =0;
/**
* changes the mainsinksoundproperty of a sink
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
- * not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
*
* @param soundProperty
* @param sinkID
@@ -418,8 +385,7 @@ namespace am {
virtual am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;
/**
* changes the mainsourcesoundproperty of a sink
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
*
* @param soundProperty
* @param sourceID
@@ -427,8 +393,7 @@ namespace am {
virtual am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
/**
* changes the availablility of a source
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
*
* @param availability
* @param sourceID
@@ -436,80 +401,70 @@ namespace am {
virtual am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID) =0;
/**
* changes a systemProperty
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if property
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if property was not found
*
* @param property
*/
virtual am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property) =0;
/**
* removes a mainconnection from the DB
- * @return E_OK on success, E_NON_EXISTENT if main connection was not found,
- * E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if main connection was not found, E_DATABASE_ERROR if the database had an error
*
* @param mainConnectionID
*/
virtual am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) =0;
/**
* removes a sink from the DB
- * @return E_OK on success, E_NON_EXISTENT if sink was not found, E_DATABASE_ERROR
- * if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if sink was not found, E_DATABASE_ERROR if the database had an error
*
* @param sinkID
*/
virtual am_Error_e removeSinkDB(const am_sinkID_t sinkID) =0;
/**
* removes a source from the DB
- * @return E_OK on success, E_NON_EXISTENT if source was not found,
- * E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if source was not found, E_DATABASE_ERROR if the database had an error
*
* @param sourceID
*/
virtual am_Error_e removeSourceDB(const am_sourceID_t sourceID) =0;
/**
* removes a gateway from the DB
- * @return E_OK on success, E_NON_EXISTENT if gateway was not found,
- * E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if gateway was not found, E_DATABASE_ERROR if the database had an error
*
* @param gatewayID
*/
virtual am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID) =0;
/**
* removes a crossfader from the DB
- * @return E_OK on success, E_NON_EXISTENT if crossfader was not found,
- * E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if crossfader was not found, E_DATABASE_ERROR if the database had an error
*
* @param crossfaderID
*/
virtual am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID) =0;
/**
* removes a domain from the DB
- * @return E_OK on success, E_NON_EXISTENT if domain was not found,
- * E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
*
* @param domainID
*/
virtual am_Error_e removeDomainDB(const am_domainID_t domainID) =0;
/**
* removes a domain from the DB
- * @return E_OK on success, E_NON_EXISTENT if domain was not found,
- * E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
*
* @param sinkClassID
*/
virtual am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID) =0;
/**
* removes a domain from the DB
- * @return E_OK on success, E_NON_EXISTENT if domain was not found,
- * E_DATABASE_ERROR if the database had an error
+ * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
*
* @param sourceClassID
*/
virtual am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID) =0;
/**
* returns the ClassInformation of a source
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
*
* @param sourceID
* @param classInfo
@@ -517,8 +472,7 @@ namespace am {
virtual am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const =0;
/**
* returns the ClassInformation of a sink
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
- * not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
*
* @param sinkID
* @param sinkClass
@@ -526,8 +480,7 @@ namespace am {
virtual am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const =0;
/**
* returns the sinkData of a sink
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
- * not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
*
* @param sinkID
* @param sinkData
@@ -535,8 +488,7 @@ namespace am {
virtual am_Error_e getSinkInfoDB(const am_sinkID_t sinkID, am_Sink_s& sinkData) const =0;
/**
* returns the sourcekData of a source
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
- * not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
*
* @param sourceID
* @param sourceData
@@ -544,8 +496,7 @@ namespace am {
virtual am_Error_e getSourceInfoDB(const am_sourceID_t sourceID, am_Source_s& sourceData) const =0;
/**
* return source and sink of a gateway
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if gateway
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if gateway was not found
*
* @param gatewayID
* @param gatewayData
@@ -553,8 +504,7 @@ namespace am {
virtual am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const =0;
/**
* returns sources and the sink of a crossfader
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
- * crossfader was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found
*
* @param crossfaderID
* @param crossfaderData
@@ -562,8 +512,7 @@ namespace am {
virtual am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const =0;
/**
* returns sources and the sink of a crossfader
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
- * crossfader was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found
*
* @param mainConnectionID
* @param mainConnectionData
@@ -571,8 +520,7 @@ namespace am {
virtual am_Error_e getMainConnectionInfoDB(const am_mainConnectionID_t mainConnectionID, am_MainConnection_s& mainConnectionData) const =0;
/**
* returns all sinks of a domain
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
*
* @param domainID
* @param listSinkID
@@ -580,8 +528,7 @@ namespace am {
virtual am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const =0;
/**
* returns all source of a domain
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
*
* @param domainID
* @param listSourceID
@@ -589,8 +536,7 @@ namespace am {
virtual am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const =0;
/**
* returns all crossfaders of a domain
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
*
* @param domainID
* @param listCrossfadersID
@@ -598,8 +544,7 @@ namespace am {
virtual am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listCrossfadersID) const =0;
/**
* returns all gateways of a domain
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
- * was not found
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
*
* @param domainID
* @param listGatewaysID
@@ -682,45 +627,217 @@ namespace am {
*/
virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
/**
- * sets the command interface to ready. Will send setCommandReady to each of the
- * plugins. The corresponding answer is confirmCommandReady.
+ * sets the command interface to ready. Will send setCommandReady to each of the plugins. The corresponding answer is
+ * confirmCommandReady.
*/
virtual void setCommandReady() =0;
/**
- * sets the command interface into the rundown state. Will send setCommandRundown
- * to each of the plugins. The corresponding answer is confirmCommandRundown.
+ * sets the command interface into the rundown state. Will send setCommandRundown to each of the plugins. The
+ * corresponding answer is confirmCommandRundown.
*/
virtual void setCommandRundown() =0;
/**
- * sets the routinginterface to ready. Will send the command setRoutingReady to
- * each of the plugins. The related answer is confirmRoutingReady.
+ * sets the routinginterface to ready. Will send the command setRoutingReady to each of the plugins. The related answer
+ * is confirmRoutingReady.
*/
virtual void setRoutingReady() =0;
/**
- * sets the routinginterface to the rundown state. Will send the command
- * setRoutingRundown to each of the plugins. The related answer is
- * confirmRoutingRundown.
+ * sets the routinginterface to the rundown state. Will send the command setRoutingRundown to each of the plugins. The
+ * related answer is confirmRoutingRundown.
*/
virtual void setRoutingRundown() =0;
/**
* acknowledges the setControllerReady call.
+ *
+ * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened.
*/
- virtual void confirmControllerReady() =0;
+ virtual void confirmControllerReady(const am_Error_e error) =0;
/**
- * acknowledges the setControllerRundown call.
+ * Acknowledges the setControllerRundown call.
+ *
+ * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened.
+ * If an error !=E_OK is returned than the AudioManager will terminate with an exception.
+ * If E_OK is returned, the AudioManager will exit clean
*/
- virtual void confirmControllerRundown() =0;
+ virtual void confirmControllerRundown(const am_Error_e error) =0;
/**
- * This function returns the pointer to the socketHandler. This can be used to
- * integrate socket-based activites like communication with the mainloop of the
- * AudioManager.
- * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled
- * without socketHandler support,
+ * This function returns the pointer to the socketHandler. This can be used to integrate socket-based activites like
+ * communication with the mainloop of the AudioManager.
+ * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,
*
* @param socketHandler
*/
virtual am_Error_e getSocketHandler(CAmSocketHandler*& socketHandler) =0;
+ /**
+ * Change the data of the source.
+ *
+ * @param sourceID The sourceID of the source that needs to be changed.
+ * @param sourceClassID If this sourceClassID !=0, the sourceClassID of the source will be changed.
+ * @param listSoundProperties If the size of the list !=0, the list replaces the current one.
+ * @param listConnectionFormats If the size of the list !=0, the list replaces the current one.
+ * @param listMainSoundProperties If the size of the list !=0, the list replaces the current one.
+ */
+ virtual am_Error_e changeSourceDB(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_SoundProperty_s> listSoundProperties, const std::vector<am_ConnectionFormat_e> listConnectionFormats, const std::vector<am_MainSoundProperty_s> listMainSoundProperties) =0;
+ /**
+ * Change the data of the sink.
+ *
+ * @param sinkID the sinkID of the sink to be changed
+ * @param sinkClassID If !=0, the sinkClass will replace the current one.
+ * @param listSoundProperties The list of the sound properties. If The lenght of the list !=0, the current
+ * soundProperties will be changed.
+ * @param listConnectionFormats The list of the connectionformats to be changed. They will only be changed, if length
+ * of the list !=0
+ * @param listMainSoundProperties The list of the mainsoundproperties that need to be changed. Will be changed. if the
+ * length of the list !=0
+ */
+ virtual am_Error_e changeSinkDB(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_SoundProperty_s> listSoundProperties, const std::vector<am_ConnectionFormat_e> listConnectionFormats, const std::vector<am_MainSoundProperty_s> listMainSoundProperties) =0;
+ /**
+ * changes Gateway Data
+ *
+ * @param gatewayID the gatewayData to be changed
+ * @param listSourceConnectionFormats The list of the sourceConnectionFormats. Will be changed it the lenght of the
+ * list !=0.
+ * @param listSinkConnectionFormats The list of the sinkConnectionFormats. Will be changed it the lenght of the list
+ * !=0.
+ * @param convertionMatrix the convertionmatrix
+ */
+ virtual am_Error_e changeGatewayDB(const am_gatewayID_t gatewayID, const std::vector<am_ConnectionFormat_e> listSourceConnectionFormats, const std::vector<am_ConnectionFormat_e> listSinkConnectionFormats, const std::vector<bool> convertionMatrix) =0;
+ /**
+ * with this function, setting of multiple volumes at a time is done. The behavior of the volume set is depended on the
+ * given ramp and time information.
+ * This function is not only used to ramp volume, but also to mute and direct set the level. Exact behavior is depended on
+ * the selected mute ramps.
+ * @return E_OK on success, E_NO_CHANGE if the volume is already on the desired value, E_OUT_OF_RANGE is the volume is out
+ * of range, E_UNKNOWN on every other error.
+ *
+ * @param handle
+ * @param listVolumes
+ */
+ virtual am_Error_e setVolumes(am_Handle_s& handle, const std::vector<am_Volumes_s> listVolumes) =0;
+ /**
+ * set a sink notification configuration
+ *
+ * @param handle the handle that will be assigned for this operation
+ * @param sinkID the sinkID
+ * @param notificationConfiguration
+ */
+ virtual am_Error_e setSinkNotificationConfiguration(am_Handle_s& handle, const am_sinkID_t sinkID, const am_NotificationConfiguration_s notificationConfiguration) =0;
+ /**
+ * set a source notification configuration
+ *
+ * @param handle the handle that will be assigned for this operation
+ * @param sourceID the sinkID
+ * @param norificationConfiguration
+ */
+ virtual am_Error_e setSourceNotificationConfiguration(am_Handle_s& handle, const am_sourceID_t sourceID, const am_NotificationConfiguration_s norificationConfiguration) =0;
+ /**
+ * Sends out the main notificiation of a sink
+ * @return E_OK on success, E_UNKNOWN on error
+ *
+ * @param sinkID
+ * @param notificationPayload the payload
+ */
+ virtual void sendSinkMainNotificationPayload(const am_sinkID_t sinkID, const am_NotificationPayload_s notificationPayload) =0;
+ /**
+ * Sends out the main notificiation of a source
+ * @return E_OK on success, E_UNKNOWN on error
+ *
+ * @param sourceID
+ * @param notificationPayload the payload
+ */
+ virtual void sendSourceMainNotificationPayload(const am_sourceID_t sourceID, const am_NotificationPayload_s notificationPayload) =0;
+ /**
+ * change the mainNotificationConfiguration of a sink
+ * @return E_OK when successful, E_DATABASE on error
+ *
+ * @param sinkID the sinkID
+ * @param mainNotificationConfiguration the mainNotificationConfiguration
+ */
+ virtual am_Error_e changeMainSinkNotificationConfigurationDB(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;
+ /**
+ * change the mainNotificationConfiguration of a source
+ * @return E_OK when successful, E_DATABASE on error
+ *
+ * @param sourceID the sourceID
+ * @param mainNotificationConfiguration the mainNotificationConfiguration
+ */
+ virtual am_Error_e changeMainSourceNotificationConfigurationDB(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;
+ /**
+ * Retrieves the Restart Reason Property
+ * @return E_OK on success E_UNKNOWN if property could not be retrieved.
+ *
+ * @param restartReason the restart reason
+ */
+ virtual am_Error_e nsmGetRestartReasonProperty(NsmRestartReason_e& restartReason) =0;
+ /**
+ * Retrieves the shutdown reason property
+ * @return E_OK on success E_UNKNOWN if property could not be retrieved.
+ *
+ * @param ShutdownReason The shutdown reason
+ */
+ virtual am_Error_e nsmGetShutdownReasonProperty(NsmShutdownReason_e& ShutdownReason) =0;
+ /**
+ * Retrieves the running reason
+ * @return E_OK on success E_UNKNOWN if property could not be retrieved.
+ *
+ * @param nsmRunningReason the running reson
+ */
+ virtual am_Error_e nsmGetRunningReasonProperty(NsmRunningReason_e& nsmRunningReason) =0;
+ /**
+ * @return NsmErrorStatus_Ok in case of success
+ *
+ * @param nsmNodeState The current node state
+ */
+ virtual NsmErrorStatus_e nsmGetNodeState(NsmNodeState_e& nsmNodeState) =0;
+ /**
+ * Retrieves the current session state
+ * @return NsmErrorStatus_Ok on success E_UNKNOWN if property could not be retrieved.
+ *
+ * @param sessionName The current session state
+ * @param seatID
+ * @param sessionState The sessionState
+ */
+ virtual NsmErrorStatus_e nsmGetSessionState(const std::string& sessionName, const NsmSeat_e& seatID, NsmSessionState_e& sessionState) =0;
+ /**
+ * Retrieves the current applicationmode
+ * @return NsmErrorStatus_Ok on success E_UNKNOWN if property could not be retrieved.
+ *
+ * @param applicationMode The current application Mode
+ */
+ virtual NsmErrorStatus_e nsmGetApplicationMode(NsmApplicationMode_e& applicationMode) =0;
+ /**
+ * Registers the AudioManager as shutdown client
+ * @return NsmErrorStatus_Ok on success
+ * The interface for the client will be provided by the AudioManagerDeamon, therefore is no need to mention it here.
+ *
+ * @param shutdownMode The shutdown mode that the controller wants to register for. Can be
+ * @param timeoutMs Max. Timeout to wait for response from shutdown client in ms
+ */
+ virtual NsmErrorStatus_e nsmRegisterShutdownClient(const uint32_t shutdownMode, const uint32_t timeoutMs) =0;
+ /**
+ * unregisters the AudioManager as shutdown client
+ * @return NsmErrorStatus_Ok on success
+ *
+ * @param shutdownMode Shutdown mode for which client wants to unregister (NSM_SHUTDOWNTYPE_NORMAL,
+ * NSM_SHUTDOWNTYPE_FAST)
+ */
+ virtual NsmErrorStatus_e nsmUnRegisterShutdownClient(const uint32_t shutdownMode) =0;
+ /**
+ * @return E_OK on success, E_UNKOWN if interface could not be reached
+ *
+ * @param version
+ */
+ virtual am_Error_e nsmGetInterfaceVersion(uint32_t& version) =0;
+ /**
+ * Sends out the lifecyclerequest complete to the NSM
+ * @return NsmErrorStatus_Ok in case of success
+ *
+ * @param RequestId The request ID of the request.
+ * @param status The result of the call to "LifecycleRequest". NsmErrorStatus_Ok: Request successfully processed.
+ * NsmErrorStatus_Error: An error occured while processing the "LifecycleRequest".
+ */
+ virtual NsmErrorStatus_e nsmSendLifecycleRequestComplete(const uint32_t RequestId, const NsmErrorStatus_e status) =0;
};
}
-#endif // !defined(EA_6E701C15_A8E8_4ad3_A50B_D91A5BD0973F__INCLUDED_)
+#endif // !defined(EA_AC2A0532_F989_4f95_A467_1055C94D9C1E__INCLUDED_)
diff --git a/include/control/IAmControlSend.h b/include/control/IAmControlSend.h
index bac33b2..9b2d0b9 100644
--- a/include/control/IAmControlSend.h
+++ b/include/control/IAmControlSend.h
@@ -12,15 +12,15 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_)
-#define EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_
+#if !defined(EA_9CC33091_C4F5_4262_9C42_042DFB7606F2__INCLUDED_)
+#define EA_9CC33091_C4F5_4262_9C42_042DFB7606F2__INCLUDED_
#include <vector>
#include <string>
@@ -31,27 +31,25 @@ class IAmControlReceive;
}
#include "IAmControlReceive.h"
+#include "audiomanagertypes.h"
+#include "NodeStateManager.h"
-#define ControlSendVersion "1.0"
+#define ControlSendVersion "2.0"
namespace am {
/**
* This interface is presented by the AudioManager controller.
- * All the hooks represent system events that need to be handled. The callback
- * functions are used to handle for example answers to function calls on the
- * AudioManagerCoreInterface.
- * There are two rules that have to be kept in mind when implementing against this
- * interface:\n
+ * All the hooks represent system events that need to be handled. The callback functions are used to handle for example
+ * answers to function calls on the AudioManagerCoreInterface.
+ * There are two rules that have to be kept in mind when implementing against this interface:\n
* \warning
* 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
- * CALL THAT EXPECTS A RETURN VALUE.\n
+ * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
* \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can
- * implement thread safe by using the deferred-call pattern described on the wiki
- * which also helps to implement calls that are forbidden.\n
+ * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-
+ * call pattern described on the wiki which also helps to implement calls that are forbidden.\n
* For more information, please check CAmSerializer
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:18 PM
+ * @created 16-Dez-2012 15:58:15
*/
class IAmControlSend
{
@@ -75,25 +73,32 @@ namespace am {
/**
* Starts up the controller.
*
- * @param controlreceiveinterface This is a pointer to the
- * ControlReceiveInterface so that the controller knows to whom to communicate.
+ * @param controlreceiveinterface This is a pointer to the ControlReceiveInterface so that the controller knows to whom
+ * to communicate.
*/
virtual am_Error_e startupController(IAmControlReceive* controlreceiveinterface) =0;
/**
- * this message is used tell the controller that it should get ready. This message
- * must be acknowledged via confirmControllerReady.
+ * this message is used tell the controller that it should get ready. This message must be acknowledged via
+ * confirmControllerReady.
*/
virtual void setControllerReady() =0;
/**
- * this message tells the controller that he should prepare everything for the
- * power to be switched off. This message must be acknowledged via
- * confirmControllerRundown.
+ * This message tells the controller that he should prepare everything for the power to be switched off. This message must
+ * be acknowledged via confirmControllerRundown.
+ * The method will give the signal as integer that was responsible for calling the setControllerRundown.
+ * This function is called from the signal handler, either direct (when the program is killed) or from within the mainloop
+ * (if the program is terminated).
+ *
+ * @param signal The signal NO that was responsible for the rundown. Can be:
+ * SIGINT
+ * SIGQUIT
+ * SIGTERM
+ * SIGHUP
*/
- virtual void setControllerRundown() =0;
+ virtual void setControllerRundown(const int16_t signal) =0;
/**
* is called when a connection request comes in via the command interface
- * @return E_OK on success, E_NOT_POSSIBLE on error, E_ALREADY_EXISTENT if already
- * exists
+ * @return E_OK on success, E_NOT_POSSIBLE on error, E_ALREADY_EXISTENT if already exists
*
* @param sourceID
* @param sinkID
@@ -102,8 +107,7 @@ namespace am {
virtual am_Error_e hookUserConnectionRequest(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0;
/**
* is called when a disconnection request comes in via the command interface
- * @return E_OK on success, E_NOT_POSSIBLE on error, E_NON_EXISTENT if connection
- * does not exists
+ * @return E_OK on success, E_NOT_POSSIBLE on error, E_NON_EXISTENT if connection does not exists
*
* @param connectionID
*/
@@ -157,8 +161,7 @@ namespace am {
virtual am_Error_e hookUserSetSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
/**
* is called when a routing adaptor registers its domain
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already
- * exists
+ * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
*
* @param domainData ID is omitted here since it has not been created yet
* @param domainID
@@ -179,8 +182,7 @@ namespace am {
virtual void hookSystemDomainRegistrationComplete(const am_domainID_t domainID) =0;
/**
* is called when a routing adaptor registers a sink
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already
- * exists
+ * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
*
* @param sinkData Id is omitted here, since it has not been created yet
* @param sinkID
@@ -195,8 +197,7 @@ namespace am {
virtual am_Error_e hookSystemDeregisterSink(const am_sinkID_t sinkID) =0;
/**
* is called when a routing adaptor registers a source
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already
- * exists
+ * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
*
* @param sourceData ID is omitted here since it is not yet created
* @param sourceID
@@ -211,11 +212,9 @@ namespace am {
virtual am_Error_e hookSystemDeregisterSource(const am_sourceID_t sourceID) =0;
/**
* is called when a routing adaptor registers a gateway
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already
- * exists
+ * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
*
- * @param gatewayData gatewayID is not set here since it is not created at this
- * point of time
+ * @param gatewayData gatewayID is not set here since it is not created at this point of time
* @param gatewayID
*/
virtual am_Error_e hookSystemRegisterGateway(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
@@ -228,11 +227,9 @@ namespace am {
virtual am_Error_e hookSystemDeregisterGateway(const am_gatewayID_t gatewayID) =0;
/**
* is called when a routing adaptor registers a crossfader
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already
- * exists
+ * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
*
- * @param crossfaderData gatewayID is not set here since it is not created at
- * this point of time
+ * @param crossfaderData gatewayID is not set here since it is not created at this point of time
* @param crossfaderID
*/
virtual am_Error_e hookSystemRegisterCrossfader(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
@@ -295,15 +292,13 @@ namespace am {
virtual void hookSystemReceiveEarlyData(const std::vector<am_EarlyData_s>& data) =0;
/**
* this hook provides information about speed changes.
- * The quantization and sampling rate of the speed can be adjusted at compile time
- * of the AudioManagerDaemon.
+ * The quantization and sampling rate of the speed can be adjusted at compile time of the AudioManagerDaemon.
*
* @param speed
*/
virtual void hookSystemSpeedChange(const am_speed_t speed) =0;
/**
- * this hook is fired whenever the timing information of a mainconnection has
- * changed.
+ * this hook is fired whenever the timing information of a mainconnection has changed.
*
* @param mainConnectionID
* @param time
@@ -343,8 +338,8 @@ namespace am {
* ack for source volume changes
*
* @param handle the handle that is connected to the volume change
- * @param voulme the volume after the action ended (the desired volume if
- * everything went right, the actual one in case of abortion)
+ * @param voulme the volume after the action ended (the desired volume if everything went right, the actual one in case
+ * of abortion)
* @param error
*/
virtual void cbAckSetSourceVolumeChange(const am_Handle_s handle, const am_volume_t voulme, const am_Error_e error) =0;
@@ -384,36 +379,154 @@ namespace am {
*/
virtual void cbAckSetSinkSoundProperty(const am_Handle_s handle, const am_Error_e error) =0;
/**
- * This function is used by the routing algorithm to retrieve a priorized list of
- * connectionFormats from the Controller.
+ * This function is used by the routing algorithm to retrieve a priorized list of connectionFormats from the Controller.
* @return E_OK in case of successfull priorisation.
*
* @param sourceID sourceID of source that shall be connected
* @param sinkID sinkID of sink that shall be connected
- * @param listRoute This route is the one the priorized connectionFormats is
- * for.
+ * @param listRoute This route is the one the priorized connectionFormats is for.
* @param listPossibleConnectionFormats list of possible connectionformats
- * @param listPrioConnectionFormats the list return with prioos from the
- * controller. Best choice on first position.
+ * @param listPrioConnectionFormats the list return with prioos from the controller. Best choice on first position.
*/
virtual am_Error_e getConnectionFormatChoice(const am_sourceID_t sourceID, const am_sinkID_t sinkID, const am_Route_s listRoute, const std::vector<am_ConnectionFormat_e> listPossibleConnectionFormats, std::vector<am_ConnectionFormat_e>& listPrioConnectionFormats) =0;
/**
* confirms the setCommandReady call
+ *
+ * @param error E_OK if everything went right. If a plugin returns an error, it will be forwared here
*/
- virtual void confirmCommandReady() =0;
+ virtual void confirmCommandReady(const am_Error_e error) =0;
/**
* confirms the setRoutingReady call
+ *
+ * @param error E_OK if everything went right. If a plugin returns an error, it will be forwared here
*/
- virtual void confirmRoutingReady() =0;
+ virtual void confirmRoutingReady(const am_Error_e error) =0;
/**
* confirms the setCommandRundown call
+ *
+ * @param error E_OK if everything went right. If a plugin returns an error, it will be forwared here
*/
- virtual void confirmCommandRundown() =0;
+ virtual void confirmCommandRundown(const am_Error_e error) =0;
/**
* confirms the setRoutingRundown command
+ *
+ * @param error E_OK if everything went right. If a plugin returns an error, it will be forwared here
+ */
+ virtual void confirmRoutingRundown(const am_Error_e error) =0;
+ /**
+ * update form the SinkData
+ *
+ * @param sinkID the sinkID
+ * @param sinkClassID
+ * @param listSoundProperties
+ * @param listConnectionFormats
+ * @param listMainSoundProperties
+ */
+ virtual am_Error_e hookSystemUpdateSink(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_SoundProperty_s> listSoundProperties, const std::vector<am_ConnectionFormat_e> listConnectionFormats, std::vector<am_MainSoundProperty_s> listMainSoundProperties) =0;
+ /**
+ * update from the source Data
+ *
+ * @param sourceID the sourceID
+ * @param sourceClassID
+ * @param listSoundProperties
+ * @param listConnectionFormats
+ * @param listMainSoundProperties
+ */
+ virtual am_Error_e hookSystemUpdateSource(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_SoundProperty_s> listSoundProperties, const std::vector<am_ConnectionFormat_e> listConnectionFormats, std::vector<am_MainSoundProperty_s> listMainSoundProperties) =0;
+ /**
+ * updates the Gateway Data
+ *
+ * @param gatewayID the gatewayID
+ * @param listSourceConnectionFormats
+ * @param listSinkConnectionFormats
+ * @param convertionMatrix
+ */
+ virtual am_Error_e hookSystemUpdateGateway(const am_gatewayID_t gatewayID, const std::vector<am_ConnectionFormat_e> listSourceConnectionFormats, const std::vector<am_ConnectionFormat_e> listSinkConnectionFormats, const std::vector<bool> convertionMatrix) =0;
+ /**
+ * ack for mulitple volume changes
+ *
+ * @param handle
+ * @param listVolumes the list of volumes with the current status
+ * @param error
+ */
+ virtual void cbAckSetVolume(const am_Handle_s handle, const std::vector<am_Volumes_s> listVolumes, const am_Error_e error) =0;
+ /**
+ * The acknowledge of the sink notification configuration
+ *
+ * @param handle the handle
+ * @param error the error
+ */
+ virtual void cbAckSetSinkNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
+ /**
+ * The acknowledge of the sink notification configuration
+ *
+ * @param handle the handle
+ * @param error the error
+ */
+ virtual void cbAckSetSourceNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
+ /**
+ *
+ * @param sinkID the sinkID of the changed notification
+ * @param payload the payload
+ */
+ virtual void hookSinkNotificationDataChanged(const am_sinkID_t sinkID, const am_NotificationPayload_s payload) =0;
+ /**
+ *
+ * @param sourceID the sinkID of the changed notification
+ * @param payload the payload
+ */
+ virtual void hookSourceNotificationDataChanged(const am_sourceID_t sourceID, const am_NotificationPayload_s payload) =0;
+ /**
+ * sets a user MainSinkNotificationConfiguration
+ * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error
+ *
+ * @param sinkID
+ * @param notificationConfiguration
+ */
+ virtual am_Error_e hookUserSetMainSinkNotificationConfiguration(const am_sinkID_t sinkID, const am_NotificationConfiguration_s notificationConfiguration) =0;
+ /**
+ * sets a user MainSourceNotificationConfiguration
+ * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error
+ *
+ * @param sourceID
+ * @param notificationConfiguration
+ */
+ virtual am_Error_e hookUserSetMainSourceNotificationConfiguration(const am_sourceID_t sourceID, const am_NotificationConfiguration_s notificationConfiguration) =0;
+ /**
+ * This hook is connected to the NodeState signal of the NodeStateManager
+ *
+ * @param NodeStateId The new current state of the node
+ */
+ virtual void hookSystemNodeStateChanged(const NsmNodeState_e NodeStateId) =0;
+ /**
+ * This hook is connected to the NodeApplicationMode signal of the NodeStateManager
+ *
+ * @param ApplicationModeId The new ApplicationMode
+ */
+ virtual void hookSystemNodeApplicationModeChanged(const NsmApplicationMode_e ApplicationModeId) =0;
+ /**
+ * the sessionstate change was send by the NSM
+ *
+ * @param sessionName
+ * @param seatID
+ * @param sessionStateID
+ */
+ virtual void hookSystemSessionStateChanged(const std::string sessionName, const int32_t seatID, const NsmSessionState_e sessionStateID) =0;
+ /**
+ * A lifecycle request comes in from the NSM and must be processed.
+ * @return NsmErrorStatus_Ok if successful
+ * The controller has to respond to this message with LifecycleRequestComplete.
+ *
+ * @param Request the shutdown request from the NSM. One of the types
+ *
+ * NSM_SHUTDOWNTYPE_RUNUP, NSM_SHUTDOWNTYPE_NORMAL
+ * NSM_SHUTDOWNTYPE_FAST
+ *
+ * In order to receive this request, the controller needs to register for this request first via RegisterShutdownClient
+ * @param RequestId the requestID
*/
- virtual void confirmRoutingRundown() =0;
+ virtual NsmErrorStatus_e hookSystemLifecycleRequest(const uint32_t Request, const uint32_t RequestId) =0;
};
}
-#endif // !defined(EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_)
+#endif // !defined(EA_9CC33091_C4F5_4262_9C42_042DFB7606F2__INCLUDED_)
diff --git a/include/projecttypes.h b/include/projecttypes.h
index 0b1faa2..00919a0 100644..100755
--- a/include/projecttypes.h
+++ b/include/projecttypes.h
@@ -1,32 +1,33 @@
/**
- * Copyright (C) 2012, BMW AG
+ * Copyright (C) 2012, BMW AG
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * This file is part of GENIVI Project AudioManager.
*
- * \copyright
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
- * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
*
- * \file
- * For further information see http://www.genivi.org/.
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ *
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
+ *
+ * \file
+ * For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_E2993ED0_906E_49c8_A444_958D08CA0905__INCLUDED_)
-#define EA_E2993ED0_906E_49c8_A444_958D08CA0905__INCLUDED_
+#if !defined(EA_793BA955_1445_4da2_9C22_4EFA92A026C5__INCLUDED_)
+#define EA_793BA955_1445_4da2_9C22_4EFA92A026C5__INCLUDED_
namespace am {
/**
- * This enum classifies the format in which data is exchanged within a connection.
- * The enum itself is project specific although there are some Genivi standard
- * formats defined.
+ * This enum classifies the format in which data is exchanged within a connection. The enum itself is project specific
+ * although there are some Genivi standard formats defined.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
enum am_ConnectionFormat_e
{
@@ -56,7 +57,7 @@ namespace am {
/**
* This enum gives the information about reason for reason for Source/Sink change
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
enum am_AvailabilityReason_e
{
@@ -94,7 +95,7 @@ namespace am {
/**
* product specific identifier of property
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
enum am_ClassProperty_e
{
@@ -103,8 +104,8 @@ namespace am {
*/
CP_UNKNOWN = 0,
/**
- * defines the source type of a source. Project specific, could be for example
- * differentiation between interrupt source and main source.
+ * defines the source type of a source. Project specific, could be for example differentiation between interrupt source
+ * and main source.
*/
CP_GENIVI_SOURCE_TYPE = 1,
/**
@@ -115,12 +116,10 @@ namespace am {
};
/**
- * The given ramp types here are just a possiblity. 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.
+ * The given ramp types here are just a possiblity. 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.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
enum am_RampType_e
{
@@ -140,10 +139,9 @@ namespace am {
};
/**
- * sound properties. Within genivi only the standard properties are defined, for
- * products these need to be extended.
+ * sound properties. Within genivi only the standard properties are defined, for products these need to be extended.
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
enum am_SoundPropertyType_e
{
@@ -167,10 +165,9 @@ namespace am {
};
/**
- * Here are all SoundProperties that can be set via the CommandInterface. Product
- * specific
+ * Here are all SoundProperties that can be set via the CommandInterface. Product specific
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
enum am_MainSoundPropertyType_e
{
@@ -196,7 +193,7 @@ namespace am {
/**
* describes the different system properties. Project specific
* @author Christian Mueller
- * @created 07-Mar-2012 6:06:17 PM
+ * @created 16-Dez-2012 15:58:14
*/
enum am_SystemPropertyType_e
{
@@ -206,5 +203,17 @@ namespace am {
SYP_UNKNOWN = 0,
SYP_MAX
};
+
+ /**
+ * gives the type of the Notification.
+ * @author q232968
+ * @version 1.0
+ * @created 16-Dez-2012 15:58:14
+ */
+ enum am_NotificationType_e
+ {
+ NT_UNKNOWN = 0,
+ NT_MAX
+ };
}
-#endif // !defined(EA_E2993ED0_906E_49c8_A444_958D08CA0905__INCLUDED_)
+#endif // !defined(EA_793BA955_1445_4da2_9C22_4EFA92A026C5__INCLUDED_)
diff --git a/include/routing/IAmRoutingReceive.h b/include/routing/IAmRoutingReceive.h
index 45097ab..fd88178 100644
--- a/include/routing/IAmRoutingReceive.h
+++ b/include/routing/IAmRoutingReceive.h
@@ -12,15 +12,15 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_F3B2C6E5_FEAE_42a2_AEB2_59B2AE54EE05__INCLUDED_)
-#define EA_F3B2C6E5_FEAE_42a2_AEB2_59B2AE54EE05__INCLUDED_
+#if !defined(EA_36ADD7D1_5B51_4364_9C3B_4839230FAAC2__INCLUDED_)
+#define EA_36ADD7D1_5B51_4364_9C3B_4839230FAAC2__INCLUDED_
#include <vector>
#include <string>
@@ -32,19 +32,22 @@ class CAmSocketHandler;
}
-#define RoutingReceiveVersion "1.0"
+#include "audiomanagertypes.h"
+
+#define RoutingReceiveVersion "2.0"
namespace am {
/**
- * Routing Receive sendInterface description. This class implements everything from RoutingAdapter -> Audiomanager
- * There are two rules that have to be kept in mind when implementing against this interface:\n
- * \warning
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
- * \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-call pattern described on the wiki which also helps to implement calls that are forbidden.\n
+ * Routing Receive sendInterface description. This class implements everything from RoutingAdapter -> Audiomanager
+ * There are two rules that have to be kept in mind when implementing against this interface:\n
+ * \warning
+ * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
+ * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
+ * \details
+ * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-
+ * call pattern described on the wiki which also helps to implement calls that are forbidden.\n
* For more information, please check CAmSerializer
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:08 PM
+ * @created 16-Dez-2012 15:58:16
*/
class IAmRoutingReceive
{
@@ -59,6 +62,12 @@ namespace am {
}
/**
+ * This function returns the version of the interface
+ *
+ * @param version retrieves the verison of the interface
+ */
+ virtual void getInterfaceVersion(std::string& version) const =0;
+ /**
* acknowledges a asyncConnect
*
* @param handle
@@ -75,17 +84,17 @@ namespace am {
*/
virtual void ackDisconnect(const am_Handle_s handle, const am_connectionID_t connectionID, const am_Error_e error) =0;
/**
- * acknowledges a asyncsetSinkVolume
+ * acknowledges a asyncsetSinkVolume
*
* @param handle
- * @param volume The current actual value that is set
+ * @param volume The current actual value that is set
* @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
*/
virtual void ackSetSinkVolumeChange(const am_Handle_s handle, const am_volume_t volume, const am_Error_e error) =0;
/**
* acknowledges a asyncsetSourceVolume
*
- * @param handle handle that belongs to the change
+ * @param handle handle that belongs to the change
* @param volume the current volume
* @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
*/
@@ -150,7 +159,9 @@ namespace am {
*/
virtual void ackSinkVolumeTick(const am_Handle_s handle, const am_sinkID_t sinkID, const am_volume_t volume) =0;
/**
- * This function returns the ID to the given domainName. If already a domain is registered with this name, it will return the corresponding ID, if not it will reserve an ID but not register the domain. The other parameters of the domain will be overwritten when the domain is registered.
+ * This function returns the ID to the given domainName. If already a domain is registered with this name, it will return
+ * the corresponding ID, if not it will reserve an ID but not register the domain. The other parameters of the domain will
+ * be overwritten when the domain is registered.
* @return E_OK on success, E_UNKNOWN on error
*
* @param name
@@ -158,7 +169,7 @@ namespace am {
*/
virtual am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID) =0;
/**
- * registers a domain
+ * registers a domain
* @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
*
* @param domainData domainID in am_Domain_s must be 0!
@@ -166,7 +177,7 @@ namespace am {
*/
virtual am_Error_e registerDomain(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
/**
- * deregisters a domain. All sources, sinks, gateways and crossfaders from that domain will be removed as well.
+ * deregisters a domain. All sources, sinks, gateways and crossfaders from that domain will be removed as well.
* @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
*
* @param domainID < the nonde of the bus
@@ -175,21 +186,25 @@ namespace am {
/**
* registers a gateway. @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
*
- * @param gatewayData In a fixed setup, the gatewayID must be below 100. In a dynamic setup, the gatewayID shall be 0. listSourceFormats and listSinkFormats are empty at registration time. Values are taken over when sources and sinks are registered.
- *
+ * @param gatewayData In a fixed setup, the gatewayID must be below 100. In a dynamic setup, the gatewayID shall be 0.
+ * listSourceFormats and listSinkFormats are empty at registration time. Values are taken over when sources and sinks are
+ * registered.
+ *
*
* @param gatewayID
*/
virtual am_Error_e registerGateway(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
/**
- * deregisters a gateway. Also removes all sinks and sources of the controlling domain.
+ * deregisters a gateway. Also removes all sinks and sources of the controlling domain.
* @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
*
* @param gatewayID domainID of the control domain
*/
virtual am_Error_e deregisterGateway(const am_gatewayID_t gatewayID) =0;
/**
- * This function returns the ID to the given sinkName. If already a sink is registered with this name, it will return the corresponding ID, if not it will reserve an ID but not register the sink. The other parameters of the sink will be overwritten when the sink is registered.
+ * This function returns the ID to the given sinkName. If already a sink is registered with this name, it will return the
+ * corresponding ID, if not it will reserve an ID but not register the sink. The other parameters of the sink will be
+ * overwritten when the sink is registered.
* @return E_OK on success, E_UNKNOWN on error
*
* @param name ID is not valid since not created yet
@@ -197,22 +212,25 @@ namespace am {
*/
virtual am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID) =0;
/**
- * Registers a sink. If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation
+ * Registers a sink. If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation
* @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
*
- * @param sinkData In a fixed setup, the sinkID within am_Sink_s must be below 100. In a dynamic setup the sinkID must be 0 in am_Sink_s.
+ * @param sinkData In a fixed setup, the sinkID within am_Sink_s must be below 100. In a dynamic setup the sinkID must
+ * be 0 in am_Sink_s.
* @param sinkID
*/
virtual am_Error_e registerSink(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
/**
- * deregisters a sink.
+ * deregisters a sink.
* @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
*
* @param sinkID
*/
virtual am_Error_e deregisterSink(const am_sinkID_t sinkID) =0;
/**
- * This function returns the ID to the given sourceName. If already a source is registered with this name, it will return the corresponding ID, if not it will reserve an ID but not register the source. The other parameters of the source will be overwritten when the source is registered.
+ * This function returns the ID to the given sourceName. If already a source is registered with this name, it will return
+ * the corresponding ID, if not it will reserve an ID but not register the source. The other parameters of the source will
+ * be overwritten when the source is registered.
* @return E_OK on success, E_UNKNOWN on error
*
* @param name
@@ -220,37 +238,39 @@ namespace am {
*/
virtual am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID) =0;
/**
- * registers a source. If the source is part of a gateway, the listconnectionFormats is copied to the gatewayInformation
+ * registers a source. If the source is part of a gateway, the listconnectionFormats is copied to the gatewayInformation
* @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID already exists
*
- * @param sourceData In a fixed setup, the sourceID within am_Source_s must be below 100. In a dynamic setup the sourceID must be 0 in am_Source_s
+ * @param sourceData In a fixed setup, the sourceID within am_Source_s must be below 100. In a dynamic setup the
+ * sourceID must be 0 in am_Source_s
* @param sourceID
*/
virtual am_Error_e registerSource(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
/**
- * deregisters a source
+ * deregisters a source
* @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
*
* @param sourceID
*/
virtual am_Error_e deregisterSource(const am_sourceID_t sourceID) =0;
/**
- * this function registers a crossfader.
+ * this function registers a crossfader.
* @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
*
- * @param crossfaderData in a fixed setup, the crossfaderID must be below 100. In a dynamic setup the crossfasderID shall be 0
+ * @param crossfaderData in a fixed setup, the crossfaderID must be below 100. In a dynamic setup the crossfasderID
+ * shall be 0
* @param crossfaderID
*/
virtual am_Error_e registerCrossfader(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
/**
- * this function deregisters a crossfader. removes all sources and sinks assiated as well.
+ * this function deregisters a crossfader. removes all sources and sinks assiated as well.
* @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
*
* @param crossfaderID
*/
virtual am_Error_e deregisterCrossfader(const am_crossfaderID_t crossfaderID) =0;
/**
- * this function peeks a sourceclassID. It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.
+ * this function peeks a sourceclassID. It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.
* @return E_OK on succes, E_DATABASE_ERROR on error
*
* @param name
@@ -258,7 +278,7 @@ namespace am {
*/
virtual am_Error_e peekSourceClassID(const std::string& name, am_sourceClass_t& sourceClassID) =0;
/**
- * this function peeks a sourceclassID. It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.
+ * this function peeks a sourceclassID. It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.
* @return E_OK on succes, E_DATABASE_ERROR on error
*
* @param name
@@ -273,7 +293,7 @@ namespace am {
*/
virtual void hookInterruptStatusChange(const am_sourceID_t sourceID, const am_InterruptState_e interruptState) =0;
/**
- * This hook is called when all elements from a domain are registered.
+ * This hook is called when all elements from a domain are registered.
* Is used by the Controller to know when all expected domains are finally registered
*
* @param domainID
@@ -308,45 +328,115 @@ namespace am {
*/
virtual void hookTimingInformationChanged(const am_connectionID_t connectionID, const am_timeSync_t delay) =0;
/**
- * this function is used to send out all data that has been changed in an early state.
+ * this function is used to send out all data that has been changed in an early state.
* @return E_OK on success, E_UNKNOWN on error
*
* @param earlyData
*/
virtual void sendChangedData(const std::vector<am_EarlyData_s>& earlyData) =0;
/**
- * this function is used to retrieve a pointer to the dBusConnectionWrapper
+ * this function is used to retrieve a pointer to the dBusConnectionWrapper
* @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support
*
- * @param dbusConnectionWrapper This is a wrapper class that is needed to keep dbus inclusions away from the interface. The DBusWrapperClass will return the pointer to the DbusConnection call (getDBusConnection)
+ * @param dbusConnectionWrapper This is a wrapper class that is needed to keep dbus inclusions away from the interface.
+ * The DBusWrapperClass will return the pointer to the DbusConnection call (getDBusConnection)
*/
virtual am_Error_e getDBusConnectionWrapper(CAmDbusWrapper*& dbusConnectionWrapper) const =0;
/**
- * This function returns the pointer to the socketHandler. This can be used to integrate socket-based activites like communication with the mainloop of the AudioManager.
+ * This function returns the pointer to the socketHandler. This can be used to integrate socket-based activites like
+ * communication with the mainloop of the AudioManager.
* returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,
*
* @param socketHandler
*/
virtual am_Error_e getSocketHandler(CAmSocketHandler*& socketHandler) const =0;
/**
- * This function returns the version of the interface
- *
- * @param version retrieves the verison of the interface
- */
- virtual void getInterfaceVersion(std::string& version) const =0;
- /**
* confirms the setRoutingReady Command
*
* @param handle the handle that was given via setRoutingReady
+ * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened.
*/
- virtual void confirmRoutingReady(const uint16_t handle) =0;
+ virtual void confirmRoutingReady(const uint16_t handle, const am_Error_e error) =0;
/**
* confirms the setRoutingRundown Command
*
* @param handle handle that was given via setRoutingRundown
+ * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened.
+ */
+ virtual void confirmRoutingRundown(const uint16_t handle, const am_Error_e error) =0;
+ /**
+ * updates data of an gateway. @return E_OK on success, E_NON_EXISTENT if the gatewayID is not valid.
+ *
+ * @param gatewayID This is the new gateway data that has been updated. Please note that changing source and sink IDs,
+ *
+ * @param listSourceFormats
+ * @param listSinkFormats
+ * @param convertionMatrix
+ */
+ virtual am_Error_e updateGateway(const am_gatewayID_t gatewayID, std::vector<am_ConnectionFormat_e> listSourceFormats, const std::vector<am_ConnectionFormat_e> listSinkFormats, std::vector<bool> convertionMatrix) =0;
+ /**
+ * updates data of an gateway. @return E_OK on success, E_NON_EXISTENT if the sinkID is not valid.
+ *
+ * @param sinkID The sinkID of the sink
+ * @param sinkClassID
+ * @param listSoundProperties
+ * @param listConnectionFormats
+ * @param listMainSoundProperties
+ */
+ virtual am_Error_e updateSink(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_SoundProperty_s> listSoundProperties, const std::vector<am_ConnectionFormat_e> listConnectionFormats, std::vector<am_MainSoundProperty_s> listMainSoundProperties) =0;
+ /**
+ * updates data of an source. @return E_OK on success, E_NON_EXISTENT if the sourceID in the struct is not valid.
+ * Please note that only the following data out of am_Source_s have effect when they are changed:
+ * sourceClassID,
+ * listSoundProperties,
+ * listConnectionFormats,
+ * listMainSoundProperties
+ *
+ * @param sourceID the sourceID of the source
+ * @param sourceClassID
+ * @param listSoundProperties
+ * @param listConnectionFormats
+ * @param listMainSoundProperties
+ */
+ virtual am_Error_e updateSource(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, std::vector<am_SoundProperty_s> listSoundProperties, std::vector<am_ConnectionFormat_e> listConnectionFormats, const std::vector<am_MainSoundProperty_s> listMainSoundProperties) =0;
+ /**
+ * acknowledges a asyncsetSinkVolume
+ *
+ * @param handle
+ * @param listvolumes The list of volumes that have been set. ramp and time values have no meaning when the struct is
+ * used here.
+ * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
+ */
+ virtual void ackSetVolumes(const am_Handle_s handle, const std::vector<am_Volumes_s> listvolumes, const am_Error_e error) =0;
+ /**
+ * The acknowledge of the SinkNotificationConfiguration
+ *
+ * @param handle
+ * @param error
+ */
+ virtual void ackSinkNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
+ /**
+ * The acknowledge of the SourceNotificationConfiguration
+ *
+ * @param handle
+ * @param error
+ */
+ virtual void ackSourceNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
+ /**
+ * is called whenever a notified value needs to be send
+ *
+ * @param sinkID The sinkID of the sink where the data changed
+ * @param payload The payload
+ */
+ virtual void hookSinkNotificationDataChange(const am_sinkID_t sinkID, const am_NotificationPayload_s payload) =0;
+ /**
+ * is called whenever a notified value needs to be send
+ *
+ * @param sourceID The sinkID of the sink where the data changed
+ * @param payload The payload
*/
- virtual void confirmRoutingRundown(const uint16_t handle) =0;
+ virtual void hookSourceNotificationDataChange(const am_sourceID_t sourceID, const am_NotificationPayload_s payload) =0;
};
}
-#endif // !defined(EA_F3B2C6E5_FEAE_42a2_AEB2_59B2AE54EE05__INCLUDED_)
+#endif // !defined(EA_36ADD7D1_5B51_4364_9C3B_4839230FAAC2__INCLUDED_)
diff --git a/include/routing/IAmRoutingSend.h b/include/routing/IAmRoutingSend.h
index 4280931..d077c73 100644
--- a/include/routing/IAmRoutingSend.h
+++ b/include/routing/IAmRoutingSend.h
@@ -12,15 +12,15 @@
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_39D31D03_9B43_4dfe_B134_B2A969767ECB__INCLUDED_)
-#define EA_39D31D03_9B43_4dfe_B134_B2A969767ECB__INCLUDED_
+#if !defined(EA_3921A27D_CF17_4db4_BE29_6A5BD7C5FE53__INCLUDED_)
+#define EA_3921A27D_CF17_4db4_BE29_6A5BD7C5FE53__INCLUDED_
#include <vector>
#include <string>
@@ -30,21 +30,24 @@ namespace am {
class IAmRoutingReceive;
}
+#include "audiomanagertypes.h"
#include "IAmRoutingReceive.h"
+#include "projecttypes.h"
-#define RoutingSendVersion "1.0"
+#define RoutingSendVersion "2.0"
namespace am {
/**
- * This class implements everything from Audiomanager -> RoutingAdapter
- * There are two rules that have to be kept in mind when implementing against this interface:\n
- * \warning
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
- * \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-call pattern described on the wiki which also helps to implement calls that are forbidden.\n
+ * This class implements everything from Audiomanager -> RoutingAdapter
+ * There are two rules that have to be kept in mind when implementing against this interface:\n
+ * \warning
+ * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
+ * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
+ * \details
+ * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-
+ * call pattern described on the wiki which also helps to implement calls that are forbidden.\n
* For more information, please check CAmSerializer
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:09 PM
+ * @created 16-Dez-2012 15:58:16
*/
class IAmRoutingSend
{
@@ -59,6 +62,12 @@ namespace am {
}
/**
+ * This function returns the version of the interface
+ *
+ * @param version
+ */
+ virtual void getInterfaceVersion(std::string& version) const =0;
+ /**
* starts up the interface. In the implementations, here is the best place for init routines.
*
* @param routingreceiveinterface pointer to the receive interface
@@ -77,14 +86,14 @@ namespace am {
*/
virtual void setRoutingRundown(const uint16_t handle) =0;
/**
- * aborts an asynchronous action.
+ * aborts an asynchronous action.
* @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if handle was not found
*
* @param handle
*/
virtual am_Error_e asyncAbort(const am_Handle_s handle) =0;
/**
- * connects a source to a sink
+ * connects a source to a sink
* @return E_OK on success, E_UNKNOWN on error, E_WRONG_FORMAT in case am_ConnectionFormat_e does not match
*
* @param handle
@@ -95,7 +104,7 @@ namespace am {
*/
virtual am_Error_e asyncConnect(const am_Handle_s handle, const am_connectionID_t connectionID, const am_sourceID_t sourceID, const am_sinkID_t sinkID, const am_ConnectionFormat_e connectionFormat) =0;
/**
- * disconnect a connection with given connectionID
+ * disconnect a connection with given connectionID
* @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if connection was not found
*
* @param handle
@@ -103,7 +112,8 @@ namespace am {
*/
virtual am_Error_e asyncDisconnect(const am_Handle_s handle, const am_connectionID_t connectionID) =0;
/**
- * this method is used to set the volume of a sink. This function is used to drive ramps, to mute or unmute or directly set the value. The difference is made through the ramptype.
+ * this method is used to set the volume of a sink. This function is used to drive ramps, to mute or unmute or directly
+ * set the value. The difference is made through the ramptype.
* @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if new volume is out of range
*
* @param handle
@@ -114,8 +124,9 @@ namespace am {
*/
virtual am_Error_e asyncSetSinkVolume(const am_Handle_s handle, const am_sinkID_t sinkID, const am_volume_t volume, const am_RampType_e ramp, const am_time_t time) =0;
/**
- * sets the volume of a source. This method is used to set the volume of a sink. This function is used to drive ramps, to mute or unmute or directly set the value. The difference is made through the ramptype.
- * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of range.
+ * sets the volume of a source. This method is used to set the volume of a sink. This function is used to drive ramps, to
+ * mute or unmute or directly set the value. The difference is made through the ramptype.
+ * @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of range.
* triggers the acknowledge ackSourceVolumeChange
*
* @param handle
@@ -126,7 +137,7 @@ namespace am {
*/
virtual am_Error_e asyncSetSourceVolume(const am_Handle_s handle, const am_sourceID_t sourceID, const am_volume_t volume, const am_RampType_e ramp, const am_time_t time) =0;
/**
- * This function is used to set the source state of a particular source.
+ * This function is used to set the source state of a particular source.
* @return E_OK on success, E_UNKNOWN on error
*
* @param handle
@@ -135,7 +146,7 @@ namespace am {
*/
virtual am_Error_e asyncSetSourceState(const am_Handle_s handle, const am_sourceID_t sourceID, const am_SourceState_e state) =0;
/**
- * this function sets the sinksoundproperty.
+ * this function sets the sinksoundproperty.
* @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range
*
* @param handle
@@ -144,7 +155,7 @@ namespace am {
*/
virtual am_Error_e asyncSetSinkSoundProperties(const am_Handle_s handle, const am_sinkID_t sinkID, const std::vector<am_SoundProperty_s>& listSoundProperties) =0;
/**
- * this function sets the sinksoundproperty.
+ * this function sets the sinksoundproperty.
* @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range
*
* @param handle
@@ -153,7 +164,7 @@ namespace am {
*/
virtual am_Error_e asyncSetSinkSoundProperty(const am_Handle_s handle, const am_sinkID_t sinkID, const am_SoundProperty_s& soundProperty) =0;
/**
- * this function sets the sourcesoundproperty.
+ * this function sets the sourcesoundproperty.
* @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range
*
* @param handle
@@ -162,7 +173,7 @@ namespace am {
*/
virtual am_Error_e asyncSetSourceSoundProperties(const am_Handle_s handle, const am_sourceID_t sourceID, const std::vector<am_SoundProperty_s>& listSoundProperties) =0;
/**
- * this function sets the sourcesoundproperty.
+ * this function sets the sourcesoundproperty.
* @return E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range
*
* @param handle
@@ -171,7 +182,7 @@ namespace am {
*/
virtual am_Error_e asyncSetSourceSoundProperty(const am_Handle_s handle, const am_sourceID_t sourceID, const am_SoundProperty_s& soundProperty) =0;
/**
- * this function triggers crossfading.
+ * this function triggers crossfading.
* @return E_OK on success, E_UNKNOWN on error
*
* @param handle
@@ -182,7 +193,7 @@ namespace am {
*/
virtual am_Error_e asyncCrossFade(const am_Handle_s handle, const am_crossfaderID_t crossfaderID, const am_HotSink_e hotSink, const am_RampType_e rampType, const am_time_t time) =0;
/**
- * this function is used for early and late audio functions to set the domain state
+ * this function is used for early and late audio functions to set the domain state
* @return E_OK on success, E_UNKNOWN on error
*
* @param domainID
@@ -190,19 +201,40 @@ namespace am {
*/
virtual am_Error_e setDomainState(const am_domainID_t domainID, const am_DomainState_e domainState) =0;
/**
- * this method is used to retrieve the busname during startup of the plugin. Needs to be implemented
+ * this method is used to retrieve the busname during startup of the plugin. Needs to be implemented
* @return E_OK on success, E_UNKNOWN on error
*
* @param BusName
*/
virtual am_Error_e returnBusName(std::string& BusName) const =0;
/**
- * This function returns the version of the interface
+ * This command sets multiple source or and sink volumes within a domain at a time. It can be used to synchronize volume
+ * setting events.
+ * @return E_OK on success, E_UNKNOWN on error.
*
- * @param version
+ * @param handle the handle
+ * @param listVolumes a list of volumes that shall be set a the same time
*/
- virtual void getInterfaceVersion(std::string& version) const =0;
+ virtual am_Error_e asyncSetVolumes(const am_Handle_s handle, const std::vector<am_Volumes_s>& listVolumes) =0;
+ /**
+ * sets the notification configuration of a source.
+ * @return E_OK on success, E_UNKNOWN on error.
+ *
+ * @param handle The handle for this operation.
+ * @param sinkID the sourceID of the source the notification should be set
+ * @param notificationConfiguration The notification configuration
+ */
+ virtual am_Error_e asyncSetSinkNotificationConfiguration(const am_Handle_s handle, const am_sinkID_t sinkID, const am_NotificationConfiguration_s& notificationConfiguration) =0;
+ /**
+ * sets the notification configuration of a source.
+ * @return E_OK on success, E_UNKNOWN on error.
+ *
+ * @param handle The handle for this operation.
+ * @param sourceID the sourceID of the source the notification should be set
+ * @param notificationConfiguration The notification configuration
+ */
+ virtual am_Error_e asyncSetSourceNotificationConfiguration(const am_Handle_s handle, const am_sourceID_t sourceID, const am_NotificationConfiguration_s& notificationConfiguration) =0;
};
}
-#endif // !defined(EA_39D31D03_9B43_4dfe_B134_B2A969767ECB__INCLUDED_)
+#endif // !defined(EA_3921A27D_CF17_4db4_BE29_6A5BD7C5FE53__INCLUDED_)
diff --git a/include/shared/CAmSerializer.h b/include/shared/CAmSerializer.h
index 98257d0..d840f34 100644
--- a/include/shared/CAmSerializer.h
+++ b/include/shared/CAmSerializer.h
@@ -1005,7 +1005,6 @@ public:
template<class TClass1, class Targ, class Targ1>
void asyncCall(TClass1* instance, void (TClass1::*function)(Targ argument, Targ1& argument1), Targ argument, Targ1& argument1)
{
- logInfo("took ref");
CAmDelegagePtr p(new CAmTwoArgDelegateSecondRef<TClass1, Targ, Targ1>(instance, function, argument, argument1));
send(p);
}