diff options
Diffstat (limited to 'include/control/IAmControlSend.h')
| -rw-r--r-- | include/control/IAmControlSend.h | 137 |
1 files changed, 81 insertions, 56 deletions
diff --git a/include/control/IAmControlSend.h b/include/control/IAmControlSend.h index 7f1cddc..bac33b2 100644 --- a/include/control/IAmControlSend.h +++ b/include/control/IAmControlSend.h @@ -19,8 +19,8 @@ *
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_FB5AF069_7968_42a2_AB14_7C86BD1888E0__INCLUDED_)
-#define EA_FB5AF069_7968_42a2_AB14_7C86BD1888E0__INCLUDED_
+#if !defined(EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_)
+#define EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_
#include <vector>
#include <string>
@@ -35,17 +35,23 @@ class IAmControlReceive; #define ControlSendVersion "1.0" namespace am { /** - * This interface is presented by the AudioManager controller.
- * All the hooks represent system events that need to be handled. The callback functions are used to handle for example answers to function calls on the AudioManagerCoreInterface.
- * There are two rules that have to be kept in mind when implementing against this interface:\n
- * \warning
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n
- * \details
- * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-call pattern described on the wiki which also helps to implement calls that are forbidden.\n
+ * This 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 { @@ -60,22 +66,34 @@ namespace am { } /** + * 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
- * @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 @@ -83,14 +101,15 @@ namespace am { */ virtual am_Error_e hookUserConnectionRequest(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0; /** - * is called when a disconnection request comes in via the command interface
- * @return E_OK on success, E_NOT_POSSIBLE on error, E_NON_EXISTENT if connection does not exists + * 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
+ * sets a user MainSinkSoundProperty * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error * * @param sinkID @@ -98,7 +117,7 @@ namespace am { */ virtual am_Error_e hookUserSetMainSinkSoundProperty(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) =0; /** - * sets a user MainSourceSoundProperty
+ * sets a user MainSourceSoundProperty * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error * * @param sourceID @@ -106,14 +125,14 @@ namespace am { */ virtual am_Error_e hookUserSetMainSourceSoundProperty(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0; /** - * sets a user SystemProperty
+ * 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
+ * sets a user volume * @return E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error * * @param SinkID @@ -121,7 +140,7 @@ namespace am { */ virtual am_Error_e hookUserVolumeChange(const am_sinkID_t SinkID, const am_mainVolume_t newVolume) =0; /** - * sets a user volume as increment
+ * 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 @@ -129,7 +148,7 @@ namespace am { */ virtual am_Error_e hookUserVolumeStep(const am_sinkID_t SinkID, const int16_t increment) =0; /** - * sets the mute state of a sink
+ * sets the mute state of a sink * @return E_OK on success, E_UNKNOWN on error * * @param sinkID @@ -137,15 +156,16 @@ namespace am { */ virtual am_Error_e hookUserSetSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0; /** - * is called when a routing adaptor registers its domain
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists + * 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
+ * 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 @@ -158,60 +178,66 @@ namespace am { */ virtual void hookSystemDomainRegistrationComplete(const am_domainID_t domainID) =0; /** - * is called when a routing adaptor registers a sink
- * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists + * 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
+ * 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
- * @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
+ * 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
- * @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
+ * 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
- * @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
+ * 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 @@ -268,14 +294,16 @@ namespace am { */ virtual void hookSystemReceiveEarlyData(const std::vector<am_EarlyData_s>& data) =0; /** - * this hook provides information about speed changes.
- * The quantization and sampling rate of the speed can be adjusted at compile time of the AudioManagerDaemon. + * 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 @@ -315,7 +343,8 @@ namespace am { * ack for source volume changes * * @param handle the handle that is connected to the volume change - * @param voulme the volume after the action ended (the desired volume if everything went right, the actual one in case of abortion) + * @param voulme the volume after the action ended (the desired volume if + * everything went right, the actual one in case of abortion) * @param error */ virtual void cbAckSetSourceVolumeChange(const am_Handle_s handle, const am_volume_t voulme, const am_Error_e error) =0; @@ -355,24 +384,20 @@ namespace am { */ virtual void cbAckSetSinkSoundProperty(const am_Handle_s handle, const am_Error_e error) =0; /** - * This function is used by the routing algorithm to retrieve a priorized list of connectionFormats from the Controller.
+ * This function is used by the routing algorithm to retrieve a priorized list of + * connectionFormats from the Controller. * @return E_OK in case of successfull priorisation. * * @param sourceID sourceID of source that shall be connected * @param sinkID sinkID of sink that shall be connected - * @param listRoute This route is the one the priorized connectionFormats is for. + * @param listRoute This route is the one the priorized connectionFormats is + * for. * @param listPossibleConnectionFormats list of possible connectionformats - * @param listPrioConnectionFormats the list return with prioos from the controller. Best choice on first position. + * @param listPrioConnectionFormats the list return with prioos from the + * controller. Best choice on first position. */ virtual am_Error_e getConnectionFormatChoice(const am_sourceID_t sourceID, const am_sinkID_t sinkID, const am_Route_s listRoute, const std::vector<am_ConnectionFormat_e> listPossibleConnectionFormats, std::vector<am_ConnectionFormat_e>& listPrioConnectionFormats) =0; /** - * 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; - /** * confirms the setCommandReady call */ virtual void confirmCommandReady() =0; @@ -391,4 +416,4 @@ namespace am { }; } -#endif // !defined(EA_FB5AF069_7968_42a2_AB14_7C86BD1888E0__INCLUDED_) +#endif // !defined(EA_B9BE9751_825D_44b9_86F1_C2F02E5FA3ED__INCLUDED_) |