MOCK_METHOD1(setCommandRundown,
void(const uint16_t handle));
MOCK_METHOD1(cbNewMainConnection,
- void(const am_MainConnectionType_s mainConnection));
+ void(const am_MainConnectionType_s& mainConnection));
MOCK_METHOD1(cbRemovedMainConnection,
void(const am_mainConnectionID_t mainConnection));
MOCK_METHOD1(cbNewSink,
am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface);
void setCommandReady(const uint16_t handle);
void setCommandRundown(const uint16_t handle);
- void cbNewMainConnection(const am_MainConnectionType_s mainConnection);
+ void cbNewMainConnection(const am_MainConnectionType_s& mainConnection);
void cbRemovedMainConnection(const am_mainConnectionID_t mainConnection);
void cbNewSink(const am_SinkType_s& sink);
void cbRemovedSink(const am_sinkID_t sinkID);
*/
}
-void CAmCommandSenderDbus::cbNewMainConnection(const am_MainConnectionType_s mainConnection)
+void CAmCommandSenderDbus::cbNewMainConnection(const am_MainConnectionType_s& mainConnection)
{
(void)mainConnection;
//todo: change xml and interface to differetiate between new connection and removed one
*\r
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
*/\r
-#if !defined(EA_FACD3063_1102_4d56_A616_6F63FAC9A011__INCLUDED_)\r
-#define EA_FACD3063_1102_4d56_A616_6F63FAC9A011__INCLUDED_\r
+#if !defined(EA_F9B4F59D_FED5_44ac_85F2_F9F60549C133__INCLUDED_)\r
+#define EA_F9B4F59D_FED5_44ac_85F2_F9F60549C133__INCLUDED_\r
\r
#include <stdint.h>\r
#include "projecttypes.h"\r
/**
* a domain ID
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_domainID_t;
/**
* a source ID
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_sourceID_t;
/**
- * a sink ID
+ * a sink ID
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_sinkID_t;
/**
* a gateway ID
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_gatewayID_t;
/**
* a crossfader ID
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_crossfaderID_t;
/**
- * a connection ID
+ * a connection ID
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_connectionID_t;
/**
* a mainConnection ID
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_mainConnectionID_t;
/**
* speed
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
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 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
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.\r
+ * 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 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef int16_t am_mainVolume_t;
/**
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_sourceClass_t;
/**
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_sinkClass_t;
/**
* time in ms!
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef uint16_t am_time_t;
/**
* offset time that is introduced in milli seconds.
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:13 PM
*/
typedef int16_t am_timeSync_t;
/**
- * with the help of this enum, sinks and sources can report their availability state
+ * with the help of this enum, sinks and sources can report their availability
+ * state
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_Availablility_e
{
/**
* represents the connection state
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_ConnectionState_e
{
*/
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,
/**
/**
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_DomainState_e
{
/**
* This enum characterizes the data of the EarlyData_t
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_EarlyDataType_e
{
};
/**
- * 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 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_Error_e
{
/**
- * default
+ * no error - positive reply
*/
- E_UNKNOWN = 0,
+ E_OK = 0,
/**
- * no error - positive reply
+ * default
*/
- E_OK = 1,
+ E_UNKNOWN = 1,
/**
* value out of range
*/
*/
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
/**
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_MuteState_e
{
/**
* The source state reflects the state of the source
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_SourceState_e
{
*/
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 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_Handle_e
{
/**
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_InterruptState_e
{
/**
* describes the active sink of a crossfader.
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
enum am_HotSink_e
{
};
/**
- * 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 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
struct am_Availability_s
{
*/
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;
/**
* describes class properties
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:03 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
struct am_ClassProperty_s
{
/**
* This struct describes the attribiutes of a crossfader.
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
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;
/**
*/
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;
/**
- * This enum can have 3 states:\r
- * \r
- * HS_SINKA sinkA is the current hot one, sinkB is not audible\r
- * HS_SINKB sinkB is the current hot one, sinkB is not audible\r
- * 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.
+ * This enum can have 3 states:
+ *
+ * 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.
*/
am_HotSink_e hotSink;
/**
* This struct describes the attributes of a gateway.
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
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;
/**
*/
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;
/**
*/
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).\r
- * If a SinkFormat can be converted into a SourceFormat, the vector will hold a 1, if no conversion is possible, a 0.\r
- * 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.\r
- * \r
- * This matrix \r
- * 110 011 000 111 001\r
- * \r
- * reads as this:\r
- * Source\r
- * ** 1 2 3 \r
- * *********************\r
- * S 1* 1 1 0 \r
- * i 2* 0 1 1\r
- * n 3* 0 0 0\r
- * k 4* 1 1 1\r
+ * 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
+ *
+ * reads as this:
+ * Source
+ * ** 1 2 3
+ * *********************
+ * S 1* 1 1 0
+ * i 2* 0 1 1
+ * n 3* 0 0 0
+ * k 4* 1 1 1
* 5* 0 0 1
*/
std::vector<bool> convertionMatrix;
/**
* This represents one "hopp" in a route
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
struct am_RoutingElement_s
{
/**
* a list of routing elements that lead from source to sink
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:14 PM
*/
struct am_Route_s
{
/**
* struct describing the sound property
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
struct am_SoundProperty_s
{
/**
* struct describing system properties
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
struct am_SystemProperty_s
{
/**
* struct describing sinkclasses
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
struct am_SinkClass_s
{
*/
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;
/**
* struct describing source classes
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:04 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
struct am_SourceClass_s
{
*/
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;
/**
* this type holds all information of sources relevant to the HMI
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:05 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
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;
/**
*/
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;
/**
* this type holds all information of sinks relevant to the HMI
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:05 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
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;
/**
*/
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 consists of two pieces of information:\r
- * \r
- * Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN\r
- * AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
+ * 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.
*/
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 06-Mar-2012 8:01:05 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
struct am_Handle_s
{
/**
* struct describung mainsound property
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:05 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
struct am_MainSoundProperty_s
{
/**
* this type holds all information of connections relevant to the HMI
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:05 PM
+ * @created 07-Mar-2012 6:06:15 PM
*/
struct am_MainConnectionType_s
{
/**
* struct that holds attribiutes of a mainconnection
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:05 PM
+ * @created 07-Mar-2012 6:06:16 PM
*/
struct am_MainConnection_s
{
/**
* This struct describes the attribiutes of a sink
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:05 PM
+ * @created 07-Mar-2012 6:06:16 PM
*/
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;
/**
*/
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;
/**
*/
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 consists of two pieces of information:\r
- * \r
- * Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN\r
- * AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
+ * 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.
*/
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 struct describes the attribiutes of a source
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:06 PM
+ * @created 07-Mar-2012 6:06:16 PM
*/
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;
/**
*/
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:\r
- * \r
- * SS_ON: the source is active\r
- * SS_OFF: the source is off\r
- * SS_PAUSED: the source is paused and not active.
+ * 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
+ * SS_PAUSED: the source is paused and not active.
*/
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:\r
- * \r
- * Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN\r
- * AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
+ * 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.
*/
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 the volume of the mainSources. The two states are\r
- * \r
- * IS_OFF: the interrupt is not active at the moment\r
- * IS_INTERRUPTED: the interrupt is playing at the moment.
+ * 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
+ * IS_INTERRUPTED: the interrupt is playing at the moment.
*/
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;
/**
* This struct describes the attribiutes of a domain
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:06 PM
+ * @created 07-Mar-2012 6:06:16 PM
*/
struct am_Domain_s
{
*/
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;
/**
/**
* a connection
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:06 PM
+ * @created 07-Mar-2012 6:06:16 PM
*/
struct am_Connection_s
{
};
/**
- * data type depends of am_EarlyDataType_e:\r
- * volume_t in case of ED_SOURCE_VOLUME, ED_SINK_VOLUME \r
- * soundProperty_t in case of ED_SOURCE_PROPERTY, ED_SINK_PROPERTY
+ * data type depends of am_EarlyDataType_e:
+ * volume_t in case of ED_SOURCE_VOLUME, ED_SINK_VOLUME
+ * soundProperty_t in case of ED_SOURCE_PROPERTY, ED_SINK_PROPERTY
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:06 PM
+ * @created 07-Mar-2012 6:06:16 PM
*/
union am_EarlyData_u
{
};
/**
- * data type depends of am_EarlyDataType_e:\r
- * sourceID in case of ED_SOURCE_VOLUME, ED_SOURCE_PROPERTY\r
- * sinkID in case of ED_SINK_VOLUME, ED_SINK_PROPERTY
+ * data type depends of am_EarlyDataType_e:
+ * sourceID in case of ED_SOURCE_VOLUME, ED_SOURCE_PROPERTY
+ * sinkID in case of ED_SINK_VOLUME, ED_SINK_PROPERTY
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:06 PM
+ * @created 07-Mar-2012 6:06:16 PM
*/
union am_DataType_u
{
/**
* @author Christian Mueller
- * @created 06-Mar-2012 8:01:06 PM
+ * @created 07-Mar-2012 6:06:17 PM
*/
struct am_EarlyData_s
{
};
}
-#endif // !defined(EA_FACD3063_1102_4d56_A616_6F63FAC9A011__INCLUDED_)
+#endif // !defined(EA_F9B4F59D_FED5_44ac_85F2_F9F60549C133__INCLUDED_)
*\r
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
*/\r
-#if !defined(EA_DA0CD257_9FA2_49b6_AE6D_548273E438E1__INCLUDED_)\r
-#define EA_DA0CD257_9FA2_49b6_AE6D_548273E438E1__INCLUDED_\r
+#if !defined(EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_)\r
+#define EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_\r
\r
#include <vector>\r
#include <string>\r
#define CommandReceiveVersion "1.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.\r
- * There are two rules that have to be kept in mind when implementing against this interface:\n\r
- * \warning\r
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n\r
- * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n\r
- * \details\r
- * 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\r
+ * 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
+ * \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:07 PM
+ * @created 07-Mar-2012 6:06:17 PM
*/
class IAmCommandReceive
{
}
/**
- * connects a source to sink\r
- * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists
+ * This function returns the version of the interface.
+ *
+ * @param version
+ */
+ 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
*
* @param sourceID
* @param sinkID
*/
virtual am_Error_e connect(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0;
/**
- * disconnects a mainConnection\r
- * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist, E_NOT_POSSIBLE on error.
+ * disconnects a mainConnection
+ * @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\r
- * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is out of range
+ * 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
*
* @param sinkID the sink
* @param volume the volume
*/
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.\r
- * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is not in the given volume range.
+ * 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.
*
* @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\r
- * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the desired one, the Daemon will return E_OK.
+ * 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.
*
* @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\r
- * @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\r
- * @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
*/
virtual am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
/**
- * is used to set a specific system property.\r
- * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
+ * 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
*
* @param property the property that shall be set
*/
virtual am_Error_e setSystemProperty(const am_SystemProperty_s& property) =0;
/**
- * returns the actual list of MainConnections\r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * returns the actual list of MainConnections
+ * @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listConnections returns a list of all connections
*/
virtual am_Error_e getListMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const =0;
/**
- * returns the actual list of Sinks\r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * returns the actual list of Sinks
+ * @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listMainSinks the list of the sinks
*/
virtual am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const =0;
/**
- * returns the actual list of Sources\r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * returns the actual list of Sources
+ * @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listMainSources the list of sources
*/
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\r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * 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
* @param listSoundProperties
*/
virtual am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const =0;
/**
- * This is used to retrieve all source sound properties related to a source.\r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * This is used to retrieve all source sound properties related to a source.
+ * @return E_OK on success, E_DATABASE_ERROR on error
*
* @param sourceID
* @param listSourceProperties
*/
virtual am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const =0;
/**
- * This is used to retrieve SourceClass Information of all source classes \r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * This is used to retrieve SourceClass Information of all source classes
+ * @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listSourceClasses
*/
virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const =0;
/**
- * This is used to retrieve SinkClass Information of all sink classes \r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * This is used to retrieve SinkClass Information of all sink classes
+ * @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listSinkClasses
*/
virtual am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const =0;
/**
- * Retrieves a complete list of all systemProperties.\r
- * @return E_OK on success, E_DATABASE_ERROR on error
+ * Retrieves a complete list of all systemProperties.
+ * @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listSystemProperties
*/
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\r
- * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet retrieved, E_DATABASE_ERROR on read error on the database
+ * 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
*
* @param mainConnectionID
* @param delay
*/
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\r
- * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support
+ * 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.\r
- * 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) const =0;
/**
- * This function returns the version of the interface.
- *
- * @param version
- */
- virtual void getInterfaceVersion(std::string& version) const =0;
- /**
* asynchronous confirmation of setCommandReady.
*
* @param handle the handle that was handed over by setCommandReady
};
}
-#endif // !defined(EA_DA0CD257_9FA2_49b6_AE6D_548273E438E1__INCLUDED_)
+#endif // !defined(EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_)
*\r
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
*/\r
-#if !defined(EA_7D83FF38_8EFF_42da_9D53_B196FE091604__INCLUDED_)\r
-#define EA_7D83FF38_8EFF_42da_9D53_B196FE091604__INCLUDED_\r
+#if !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_)\r
+#define EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_\r
\r
#include <vector>\r
#include <string>\r
#define CommandSendVersion "1.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.\r
- * There are two rules that have to be kept in mind when implementing against this interface:\n\r
- * \warning\r
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n\r
- * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n\r
- * \details\r
- * 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\r
+ * 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
+ * \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:07 PM
+ * @created 07-Mar-2012 6:06:17 PM
*/
class IAmCommandSend
{
}
/**
- * 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...\r
- * Be aware of side effects with systemd and socketbased communication!\r
+ * returns the interface version as string.
+ *
+ * @param version
+ */
+ 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...
+ * 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.\r
- * 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 switched off or the Interface is started again with setCommandReady\r
- * After the Plugin is ready to rundown, it will asynchronously answer with condfirmCommandRundown, the handle that is handed over must be returned.
+ * 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.
*
* @param handle This handle uniquly idenfies the request
*/
*
* @param mainConnection
*/
- virtual void cbNewMainConnection(const am_MainConnectionType_s mainConnection) =0;
+ virtual void cbNewMainConnection(const am_MainConnectionType_s& mainConnection) =0;
/**
* Callback that is called when the number of connections change
*
* @param time
*/
virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;
- /**
- * returns the interface version as string.
- *
- * @param version
- */
- virtual void getInterfaceVersion(std::string& version) const =0;
};
}
-#endif // !defined(EA_7D83FF38_8EFF_42da_9D53_B196FE091604__INCLUDED_)
+#endif // !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_)
*\r
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
*/\r
-#if !defined(EA_FC4DEA6F_95C3_409f_83CE_63BF9A997339__INCLUDED_)\r
-#define EA_FC4DEA6F_95C3_409f_83CE_63BF9A997339__INCLUDED_\r
+#if !defined(EA_6E701C15_A8E8_4ad3_A50B_D91A5BD0973F__INCLUDED_)\r
+#define EA_6E701C15_A8E8_4ad3_A50B_D91A5BD0973F__INCLUDED_\r
\r
#include <vector>\r
#include <string>\r
#define ControlReceiveVersion "1.0"
namespace am {
/**
- * This interface gives access to all important functions of the audiomanager that are used by the AudioManagerController to control the system.\r
- * There are two rules that have to be kept in mind when implementing against this interface:\n\r
- * \warning\r
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n\r
- * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n\r
- * \details\r
- * 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\r
+ * 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
+ * \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:07 PM
+ * @created 07-Mar-2012 6:06:18 PM
*/
class IAmControlReceive
{
}
/**
- * calculates a route from source to sink.\r
+ * This function returns the version of the interface
+ *
+ * @param version
+ */
+ virtual void getInterfaceVersion(std::string& version) const =0;
+ /**
+ * 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.\r
+ * @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.\r
- * @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
+ * 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
*
* @param handle
* @param connectionID
*/
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\r
- * @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
+ * 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
*
* @param handle
* @param connectionID
*/
virtual am_Error_e disconnect(am_Handle_s& handle, const am_connectionID_t connectionID) =0;
/**
- * triggers a cross fade.\r
- * @return E_OK on success, E_UNKNOWN on error E_NO_CHANGE if no change is neccessary
+ * triggers a cross fade.
+ * @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
*/
virtual am_Error_e crossfade(am_Handle_s& handle, const am_HotSink_e hotSource, const am_crossfaderID_t crossfaderID, const am_RampType_e rampType, const am_time_t rampTime) =0;
/**
- * with this method, all actions that have a handle assigned can be stopped.\r
+ * with this method, all actions that have a handle assigned can be stopped.
* @return E_OK on success, E_UNKNOWN on error
*
* @param handle the handle of the action to be stopped
*/
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\r
- * @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
*/
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.\r
- * 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.\r
- * @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
*/
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.\r
- * 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.\r
- * @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
*/
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\r
- * @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
+ * 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
*
* @param handle
* @param sinkID
*/
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\r
- * @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
+ * 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
*
* @param handle
* @param sinkID
*/
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\r
- * @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
+ * 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
*
* @param handle
* @param sourceID
*/
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\r
- * @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
+ * 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
*
* @param handle
* @param sourceID
*/
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\r
- * @return E_OK on success, E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary
+ * sets the domain state of a domain
+ * @return E_OK on success, E_UNKNOWN on error, E_NO_CHANGE if no change is
+ * neccessary
*
* @param domainID
* @param domainState
*/
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\r
- * @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
+ * 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
*
* @param domainData domainID in am_Domain_s must be 0 here
* @param domainID
*/
virtual am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
/**
- * enters a mainconnection in the database, creates and ID\r
+ * 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.\r
- * 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.\r
- * @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
+ * 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
+ * @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.\r
- * 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.\r
- * @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
+ * 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
+ * @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.\r
- * 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.\r
- * @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.
+ * 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
+ * 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 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.\r
- * 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.\r
- * @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
+ * 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
+ * @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.\r
- * @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
+ * 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
*
- * @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.\r
- * 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.\r
- * @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
+ * 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
*
* @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.\r
- * The properties will overwrite the values of the sinkClassID given in the sinkClass.\r
- * 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.\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sinkClassID was not found.
+ * 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.
*
- * @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. \r
- * The properties will overwrite the values of the sourceClassID given in the sourceClass.\r
- * 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.\r
- * @return E_OK on success, E_DATABASE_ERROR on error and E_NON_EXISTENT if the ClassID does not exist.
+ * 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.
*
- * @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.\r
- * All entries in the database will be erased before entering the new List. It should only be called once at system startup.\r
+ * 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.
* @return E_OK on success, E_DATABASE_ERROR if the database had an error
*
* @param listSystemProperties
*/
virtual am_Error_e enterSystemPropertiesListDB(const std::vector<am_SystemProperty_s>& listSystemProperties) =0;
/**
- * changes the mainConnectionState of MainConnection\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
+ * changes the mainConnectionState of MainConnection
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
+ * mainconnection
*
* @param mainconnectionID
* @param listConnectionID
*/
virtual am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const std::vector<am_connectionID_t>& listConnectionID) =0;
/**
- * changes the mainConnectionState of MainConnection\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
+ * changes the mainConnectionState of MainConnection
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
+ * mainconnection
*
* @param mainconnectionID
* @param connectionState
*/
virtual am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState) =0;
/**
- * changes the sink volume of a sink\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
+ * 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
*
* @param mainVolume
* @param sinkID
*/
virtual am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID) =0;
/**
- * changes the availablility of a sink\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
+ * changes the availablility of a sink
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
+ * not found
*
* @param availability
* @param sinkID
*/
virtual am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID) =0;
/**
- * changes the domainstate of a domain \r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
+ * changes the domainstate of a domain
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
+ * was not found
*
* @param domainState
* @param domainID
*/
virtual am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID) =0;
/**
- * changes the mute state of a sink\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
+ * 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
*
* @param muteState
* @param sinkID
*/
virtual am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID) =0;
/**
- * changes the mainsinksoundproperty of a sink\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
+ * changes the mainsinksoundproperty of a sink
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
+ * not found
*
* @param soundProperty
* @param sinkID
*/
virtual am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;
/**
- * changes the mainsourcesoundproperty of a sink\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
+ * changes the mainsourcesoundproperty of a sink
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source
+ * was not found
*
* @param soundProperty
* @param sourceID
*/
virtual am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
/**
- * changes the availablility of a source\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
+ * changes the availablility of a source
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source
+ * was not found
*
* @param availability
* @param sourceID
*/
virtual am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID) =0;
/**
- * changes a systemProperty\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if property was not found
+ * changes a systemProperty
+ * @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\r
- * @return E_OK on success, E_NON_EXISTENT if main connection was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param mainConnectionID
*/
virtual am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) =0;
/**
- * removes a sink from the DB\r
- * @return E_OK on success, E_NON_EXISTENT if sink was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param sinkID
*/
virtual am_Error_e removeSinkDB(const am_sinkID_t sinkID) =0;
/**
- * removes a source from the DB\r
- * @return E_OK on success, E_NON_EXISTENT if source was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param sourceID
*/
virtual am_Error_e removeSourceDB(const am_sourceID_t sourceID) =0;
/**
- * removes a gateway from the DB\r
- * @return E_OK on success, E_NON_EXISTENT if gateway was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param gatewayID
*/
virtual am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID) =0;
/**
- * removes a crossfader from the DB\r
- * @return E_OK on success, E_NON_EXISTENT if crossfader was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param crossfaderID
*/
virtual am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID) =0;
/**
- * removes a domain from the DB\r
- * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param domainID
*/
virtual am_Error_e removeDomainDB(const am_domainID_t domainID) =0;
/**
- * removes a domain from the DB\r
- * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param sinkClassID
*/
virtual am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID) =0;
/**
- * removes a domain from the DB\r
- * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
+ * 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
*
* @param sourceClassID
*/
virtual am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID) =0;
/**
- * returns the ClassInformation of a source\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
+ * returns the ClassInformation of a source
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source
+ * was not found
*
* @param sourceID
* @param classInfo
*/
virtual am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const =0;
/**
- * returns the ClassInformation of a sink\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
+ * returns the ClassInformation of a sink
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
+ * not found
*
* @param sinkID
* @param sinkClass
*/
virtual am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const =0;
/**
- * returns the sinkData of a sink\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
+ * returns the sinkData of a sink
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
+ * not found
*
* @param sinkID
* @param sinkData
*/
virtual am_Error_e getSinkInfoDB(const am_sinkID_t sinkID, am_Sink_s& sinkData) const =0;
/**
- * returns the sourcekData of a source\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
+ * returns the sourcekData of a source
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
+ * not found
*
* @param sourceID
* @param sourceData
*/
virtual am_Error_e getSourceInfoDB(const am_sourceID_t sourceID, am_Source_s& sourceData) const =0;
/**
- * return source and sink of a gateway\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if gateway was not found
+ * 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
*
* @param gatewayID
* @param gatewayData
*/
virtual am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const =0;
/**
- * returns sources and the sink of a crossfader\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found
+ * 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
*
* @param crossfaderID
* @param crossfaderData
*/
virtual am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const =0;
/**
- * returns sources and the sink of a crossfader\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found
+ * 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
*
* @param mainConnectionID
* @param mainConnectionData
*/
virtual am_Error_e getMainConnectionInfoDB(const am_mainConnectionID_t mainConnectionID, am_MainConnection_s& mainConnectionData) const =0;
/**
- * returns all sinks of a domain\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
+ * returns all sinks of a domain
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
+ * was not found
*
* @param domainID
* @param listSinkID
*/
virtual am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const =0;
/**
- * returns all source of a domain\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
+ * returns all source of a domain
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
+ * was not found
*
* @param domainID
* @param listSourceID
*/
virtual am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const =0;
/**
- * returns all crossfaders of a domain\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
+ * returns all crossfaders of a domain
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
+ * was not found
*
* @param domainID
* @param listCrossfadersID
*/
virtual am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listCrossfadersID) const =0;
/**
- * returns all gateways of a domain\r
- * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
+ * returns all gateways of a domain
+ * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain
+ * was not found
*
* @param domainID
* @param listGatewaysID
*/
virtual am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const =0;
/**
- * returns a complete list of all MainConnections\r
+ * returns a complete list of all MainConnections
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listMainConnections
*/
virtual am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const =0;
/**
- * returns a complete list of all domains\r
+ * returns a complete list of all domains
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listDomains
*/
virtual am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const =0;
/**
- * returns a complete list of all Connections\r
+ * returns a complete list of all Connections
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listConnections
*/
virtual am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const =0;
/**
- * returns a list of all sinks\r
+ * returns a list of all sinks
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listSinks
*/
virtual am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const =0;
/**
- * returns a list of all sources\r
+ * returns a list of all sources
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listSources
*/
virtual am_Error_e getListSources(std::vector<am_Source_s>& listSources) const =0;
/**
- * returns a list of all source classes\r
+ * returns a list of all source classes
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listSourceClasses
*/
virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const =0;
/**
- * returns a list of all handles\r
+ * returns a list of all handles
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listHandles
*/
virtual am_Error_e getListHandles(std::vector<am_Handle_s>& listHandles) const =0;
/**
- * returns a list of all crossfaders\r
+ * returns a list of all crossfaders
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listCrossfaders
*/
virtual am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const =0;
/**
- * returns a list of gateways\r
+ * returns a list of gateways
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listGateways
*/
virtual am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const =0;
/**
- * returns a list of all sink classes\r
+ * returns a list of all sink classes
* @return E_OK on success, E_DATABASE_ERROR on error
*
* @param listSinkClasses
*/
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;
/**
*/
virtual void confirmControllerRundown() =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.\r
- * 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;
- /**
- * This function returns the version of the interface
- *
- * @param version
- */
- virtual void getInterfaceVersion(std::string& version) const =0;
};
}
-#endif // !defined(EA_FC4DEA6F_95C3_409f_83CE_63BF9A997339__INCLUDED_)
+#endif // !defined(EA_6E701C15_A8E8_4ad3_A50B_D91A5BD0973F__INCLUDED_)
*\r
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
*/\r
-#if !defined(EA_FB5AF069_7968_42a2_AB14_7C86BD1888E0__INCLUDED_)\r
-#define EA_FB5AF069_7968_42a2_AB14_7C86BD1888E0__INCLUDED_\r
+#if !defined(EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_)\r
+#define EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_\r
\r
#include <vector>\r
#include <string>\r
#define ControlSendVersion "1.0"
namespace am {
/**
- * This interface is presented by the AudioManager controller.\r
- * 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.\r
- * There are two rules that have to be kept in mind when implementing against this interface:\n\r
- * \warning\r
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n\r
- * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n\r
- * \details\r
- * 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\r
+ * 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
+ * \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 07-Mar-2012 6:06:18 PM
*/
class IAmControlSend
{
}
/**
+ * This function returns the version of the interface
+ * returns E_OK, E_UNKOWN if version is unknown.
+ *
+ * @param version
+ */
+ virtual void getInterfaceVersion(std::string& version) const =0;
+ /**
* 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.
*/
virtual void setControllerRundown() =0;
/**
- * is called when a connection request comes in via the command interface\r
- * @return E_OK on success, E_NOT_POSSIBLE on error, E_ALREADY_EXISTENT if already exists
+ * 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
*
* @param sourceID
* @param sinkID
*/
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\r
- * @return E_OK on success, E_NOT_POSSIBLE on error, E_NON_EXISTENT if connection does not exists
+ * 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
*
* @param connectionID
*/
virtual am_Error_e hookUserDisconnectionRequest(const am_mainConnectionID_t connectionID) =0;
/**
- * sets a user MainSinkSoundProperty\r
+ * sets a user MainSinkSoundProperty
* @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error
*
* @param sinkID
*/
virtual am_Error_e hookUserSetMainSinkSoundProperty(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) =0;
/**
- * sets a user MainSourceSoundProperty\r
+ * sets a user MainSourceSoundProperty
* @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error
*
* @param sourceID
*/
virtual am_Error_e hookUserSetMainSourceSoundProperty(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0;
/**
- * sets a user SystemProperty\r
+ * sets a user SystemProperty
* @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error
*
* @param property
*/
virtual am_Error_e hookUserSetSystemProperty(const am_SystemProperty_s& property) =0;
/**
- * sets a user volume\r
+ * sets a user volume
* @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error
*
* @param SinkID
*/
virtual am_Error_e hookUserVolumeChange(const am_sinkID_t SinkID, const am_mainVolume_t newVolume) =0;
/**
- * sets a user volume as increment \r
+ * sets a user volume as increment
* @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error
*
* @param SinkID
*/
virtual am_Error_e hookUserVolumeStep(const am_sinkID_t SinkID, const int16_t increment) =0;
/**
- * sets the mute state of a sink\r
+ * sets the mute state of a sink
* @return E_OK on success, E_UNKNOWN on error
*
* @param sinkID
*/
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\r
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
+ * is called when a routing adaptor registers its domain
+ * @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
*/
virtual am_Error_e hookSystemRegisterDomain(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
/**
- * is called when a routing adaptor wants to derigister a domain\r
+ * is called when a routing adaptor wants to derigister a domain
* @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found
*
* @param domainID
*/
virtual void hookSystemDomainRegistrationComplete(const am_domainID_t domainID) =0;
/**
- * is called when a routing adaptor registers a sink\r
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
+ * is called when a routing adaptor registers a sink
+ * @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
*/
virtual am_Error_e hookSystemRegisterSink(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
/**
- * is called when a routing adaptor deregisters a sink\r
+ * is called when a routing adaptor deregisters a sink
* @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found
*
* @param sinkID
*/
virtual am_Error_e hookSystemDeregisterSink(const am_sinkID_t sinkID) =0;
/**
- * is called when a routing adaptor registers a source\r
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
+ * is called when a routing adaptor registers a source
+ * @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
*/
virtual am_Error_e hookSystemRegisterSource(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
/**
- * is called when a routing adaptor deregisters a source\r
+ * is called when a routing adaptor deregisters a source
* @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found
*
* @param sourceID
*/
virtual am_Error_e hookSystemDeregisterSource(const am_sourceID_t sourceID) =0;
/**
- * is called when a routing adaptor registers a gateway\r
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
+ * is called when a routing adaptor registers a gateway
+ * @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;
/**
- * is called when a routing adaptor deregisters a gateway\r
+ * is called when a routing adaptor deregisters a gateway
* @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found
*
* @param gatewayID
*/
virtual am_Error_e hookSystemDeregisterGateway(const am_gatewayID_t gatewayID) =0;
/**
- * is called when a routing adaptor registers a crossfader\r
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists
+ * is called when a routing adaptor registers a crossfader
+ * @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;
/**
- * is called when a routing adaptor deregisters a crossfader\r
+ * is called when a routing adaptor deregisters a crossfader
* @return E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found
*
* @param crossfaderID
*/
virtual void hookSystemReceiveEarlyData(const std::vector<am_EarlyData_s>& data) =0;
/**
- * this hook provides information about speed changes.\r
- * The quantization and sampling rate of the speed can be adjusted at compile time of the AudioManagerDaemon.
+ * this hook provides information about speed changes.
+ * 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
* 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;
*/
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.\r
+ * 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;
/**
- * This function returns the version of the interface\r
- * returns E_OK, E_UNKOWN if version is unknown.
- *
- * @param version
- */
- virtual void getInterfaceVersion(std::string& version) const =0;
- /**
* confirms the setCommandReady call
*/
virtual void confirmCommandReady() =0;
};
}
-#endif // !defined(EA_FB5AF069_7968_42a2_AB14_7C86BD1888E0__INCLUDED_)
+#endif // !defined(EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_)
--- /dev/null
+use strict;
+use warnings;
+
+foreach (@ARGV)
+{
+
+ open FILE, $_ or die "Couldn't open file: $!";
+ my $string = join("", <FILE>);
+ close FILE;
+
+ $string=~ s|/[*].*?[*]/||sg;
+ $string=~ s/virtual//sg;
+ $string=~ s/=0;/;/sg;
+ $string=~ s/(^|\n)[\n\s]*/$1/g;
+
+ open F, ">$_" or die "Couldn't open file: $!";
+ print F $string;
+ close F;
+}
+
+
+
+
+
/**\r
- * Copyright (c) 2012 BMW\r
+ * Copyright (C) 2012, BMW AG\r
*\r
* \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012\r
*\r
* 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.\r
* 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\r
* THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- \r
+ *\r
+ * \file \r
* For further information see http://www.genivi.org/.\r
*\r
- * \r
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
*/\r
-#if !defined(EA_E3FA794F_2DEB_48eb_BF6A_69D59A10533C__INCLUDED_)\r
-#define EA_E3FA794F_2DEB_48eb_BF6A_69D59A10533C__INCLUDED_\r
+#if !defined(EA_E2993ED0_906E_49c8_A444_958D08CA0905__INCLUDED_)\r
+#define EA_E2993ED0_906E_49c8_A444_958D08CA0905__INCLUDED_\r
\r
namespace am {\r
/**\r
- * 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.\r
+ * This enum classifies the format in which data is exchanged within a connection.\r
+ * The enum itself is project specific although there are some Genivi standard\r
+ * formats defined.\r
* @author Christian Mueller\r
- * @created 05-Mar-2012 9:02:07 PM\r
+ * @created 07-Mar-2012 6:06:17 PM\r
*/\r
enum am_ConnectionFormat_e\r
{\r
/**\r
* This enum gives the information about reason for reason for Source/Sink change\r
* @author Christian Mueller\r
- * @created 05-Mar-2012 9:02:07 PM\r
+ * @created 07-Mar-2012 6:06:17 PM\r
*/\r
enum am_AvailabilityReason_e\r
{\r
/**\r
* product specific identifier of property\r
* @author Christian Mueller\r
- * @created 05-Mar-2012 9:02:07 PM\r
+ * @created 07-Mar-2012 6:06:17 PM\r
*/\r
enum am_ClassProperty_e\r
{\r
*/\r
CP_UNKNOWN = 0,\r
/**\r
- * defines the source type of a source. Project specific, could be for example differentiation between interrupt source and main source.\r
+ * defines the source type of a source. Project specific, could be for example\r
+ * differentiation between interrupt source and main source.\r
*/\r
CP_GENIVI_SOURCE_TYPE = 1,\r
/**\r
};\r
\r
/**\r
- * The given ramp types here are just a possiblity. for products, different ramp types can be defined here.\r
- * 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 05-Mar-2012 9:02:07 PM
- */
- enum am_RampType_e
- {
- RAMP_UNKNOWN = 0,
- /**
- * this ramp type triggers a direct setting of the value without a ramp
- */
- RAMP_GENIVI_DIRECT = 1,
- /**
- * This ramp type will set the volume as fast as possible.
- */
- RAMP_GENIVI_NO_PLOB = 2,
- RAMP_GENIVI_EXP_INV = 3,
- RAMP_GENIVI_LINEAR = 4,
- RAMP_GENIVI_EXP = 5,
- RAMP_MAX
- };
-
- /**
- * sound properties. Within genivi only the standard properties are defined, for products these need to be extended.
- * @author Christian Mueller
- * @created 05-Mar-2012 9:02:07 PM
- */
- enum am_SoundPropertyType_e
- {
- /**
- * default
- */
- SP_UNKNOWN = 0,
- /**
- * example treble value min =-10 max =10
- */
- SP_EXAMPLE_TREBLE = 1,
- /**
- * example mid value min =-10 max =10
- */
- SP_EXAMPLE_MID = 2,
- /**
- * example bass value min =-10 max =10
- */
- SP_EXAMPLE_BASS = 3,
- SP_MAX
- };
-
- /**
- * Here are all SoundProperties that can be set via the CommandInterface. Product specific
- * @author Christian Mueller
- * @created 05-Mar-2012 9:02:07 PM
- */
- enum am_MainSoundPropertyType_e
- {
- /**
- * default
- */
- MSP_UNKNOWN = 0,
- /**
- * example value between -10 and +10
- */
- MSP_EXAMPLE_TREBLE = 1,
- /**
- * example value between -10 and +10
- */
- MSP_EXAMPLE_MID = 2,
- /**
- * example value between -10 and +10
- */
- MSP_EXAMPLE_BASS = 3,
- MSP_MAX
- };
-
- /**
- * describes the different system properties. Project specific
- * @author Christian Mueller
- * @created 05-Mar-2012 9:02:07 PM
- */
- enum am_SystemPropertyType_e
- {
- /**
- * default
- */
- SYP_UNKNOWN = 0,
- SYP_MAX
- };
-}
-#endif // !defined(EA_E3FA794F_2DEB_48eb_BF6A_69D59A10533C__INCLUDED_)
+ * The given ramp types here are just a possiblity. for products, different ramp\r
+ * types can be defined here.\r
+ * It is in the responsibility of the product to make sure that the routing\r
+ * plugins are aware of the ramp types used.\r
+ * @author Christian Mueller\r
+ * @created 07-Mar-2012 6:06:17 PM\r
+ */\r
+ enum am_RampType_e\r
+ {\r
+ RAMP_UNKNOWN = 0,\r
+ /**\r
+ * this ramp type triggers a direct setting of the value without a ramp\r
+ */\r
+ RAMP_GENIVI_DIRECT = 1,\r
+ /**\r
+ * This ramp type will set the volume as fast as possible. \r
+ */\r
+ RAMP_GENIVI_NO_PLOP = 2,\r
+ RAMP_GENIVI_EXP_INV = 3,\r
+ RAMP_GENIVI_LINEAR = 4,\r
+ RAMP_GENIVI_EXP = 5,\r
+ RAMP_MAX\r
+ };\r
+\r
+ /**\r
+ * sound properties. Within genivi only the standard properties are defined, for\r
+ * products these need to be extended.\r
+ * @author Christian Mueller\r
+ * @created 07-Mar-2012 6:06:17 PM\r
+ */\r
+ enum am_SoundPropertyType_e\r
+ {\r
+ /**\r
+ * default\r
+ */\r
+ SP_UNKNOWN = 0,\r
+ /**\r
+ * example treble value min =-10 max =10\r
+ */\r
+ SP_EXAMPLE_TREBLE = 1,\r
+ /**\r
+ * example mid value min =-10 max =10\r
+ */\r
+ SP_EXAMPLE_MID = 2,\r
+ /**\r
+ * example bass value min =-10 max =10\r
+ */\r
+ SP_EXAMPLE_BASS = 3,\r
+ SP_MAX\r
+ };\r
+\r
+ /**\r
+ * Here are all SoundProperties that can be set via the CommandInterface. Product\r
+ * specific\r
+ * @author Christian Mueller\r
+ * @created 07-Mar-2012 6:06:17 PM\r
+ */\r
+ enum am_MainSoundPropertyType_e\r
+ {\r
+ /**\r
+ * default\r
+ */\r
+ MSP_UNKNOWN = 0,\r
+ /**\r
+ * example value between -10 and +10 \r
+ */\r
+ MSP_EXAMPLE_TREBLE = 1,\r
+ /**\r
+ * example value between -10 and +10 \r
+ */\r
+ MSP_EXAMPLE_MID = 2,\r
+ /**\r
+ * example value between -10 and +10 \r
+ */\r
+ MSP_EXAMPLE_BASS = 3,\r
+ MSP_MAX\r
+ };\r
+\r
+ /**\r
+ * describes the different system properties. Project specific\r
+ * @author Christian Mueller\r
+ * @created 07-Mar-2012 6:06:17 PM\r
+ */\r
+ enum am_SystemPropertyType_e\r
+ {\r
+ /**\r
+ * default\r
+ */\r
+ SYP_UNKNOWN = 0,\r
+ SYP_MAX\r
+ };\r
+}\r
+#endif // !defined(EA_E2993ED0_906E_49c8_A444_958D08CA0905__INCLUDED_)\r