diff options
author | christian linke <christian.linke@bmw.de> | 2012-12-17 16:15:11 +0100 |
---|---|---|
committer | christian linke <christian.linke@bmw.de> | 2012-12-17 16:15:11 +0100 |
commit | 54c5e965fe8f9a53a78834028fd65c792493da2b (patch) | |
tree | 560d7b1209e6a8d4798de9568e4b4a947c2ab42a /include/command | |
parent | 215e8a72dc81e8a86dd5b3a8ca40fd2c7c6a0b9c (diff) | |
download | audiomanager-54c5e965fe8f9a53a78834028fd65c792493da2b.tar.gz |
* added new interfaces & nsm support + nsm tests + fixed some unit tests + fixed rundown
Signed-off-by: christian linke <christian.linke@bmw.de>
Diffstat (limited to 'include/command')
-rw-r--r-- | include/command/IAmCommandReceive.h | 128 | ||||
-rw-r--r-- | include/command/IAmCommandSend.h | 106 |
2 files changed, 144 insertions, 90 deletions
diff --git a/include/command/IAmCommandReceive.h b/include/command/IAmCommandReceive.h index 9239555..5a1a06c 100644 --- a/include/command/IAmCommandReceive.h +++ b/include/command/IAmCommandReceive.h @@ -12,15 +12,15 @@ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_)
-#define EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_
+#if !defined(EA_3888D932_2C16_4c2a_BD7C_E1F819C9A7F0__INCLUDED_)
+#define EA_3888D932_2C16_4c2a_BD7C_E1F819C9A7F0__INCLUDED_
#include <vector>
#include <string>
@@ -31,25 +31,23 @@ class CAmSocketHandler; }
-#define CommandReceiveVersion "1.0" +#include "audiomanagertypes.h" + +#define CommandReceiveVersion "2.0" namespace am { /** - * The interface towards the Controlling Instance (e.g HMI). It handles the - * communication towards the HMI and other system components who need to interact - * with the audiomanagement. - * There are two rules that have to be kept in mind when implementing against this - * interface:\n + * The interface towards the Controlling Instance (e.g HMI). It handles the communication towards the HMI and other system + * components who need to interact with the audiomanagement. + * There are two rules that have to be kept in mind when implementing against this interface:\n * \warning * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n - * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS - * CALL THAT EXPECTS A RETURN VALUE.\n + * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n * \details - * Violation these rules may lead to unexpected behavior! Nevertheless you can - * implement thread safe by using the deferred-call pattern described on the wiki - * which also helps to implement calls that are forbidden.\n + * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred- + * call pattern described on the wiki which also helps to implement calls that are forbidden.\n * For more information, please check CAmSerializer * @author Christian Mueller - * @created 07-Mar-2012 6:06:17 PM + * @created 16-Dez-2012 15:58:14 */ class IAmCommandReceive { @@ -71,8 +69,7 @@ namespace am { virtual void getInterfaceVersion(std::string& version) const =0; /** * connects a source to sink - * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the - * connection does already exists + * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists * * @param sourceID * @param sinkID @@ -81,16 +78,14 @@ namespace am { virtual am_Error_e connect(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0; /** * disconnects a mainConnection - * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist, - * E_NOT_POSSIBLE on error. + * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist, E_NOT_POSSIBLE on error. * * @param mainConnectionID */ virtual am_Error_e disconnect(const am_mainConnectionID_t mainConnectionID) =0; /** * sets the volume for a sink - * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is - * out of range + * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is out of range * * @param sinkID the sink * @param volume the volume @@ -98,40 +93,34 @@ namespace am { virtual am_Error_e setVolume(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0; /** * This function is used to increment or decrement the current volume for a sink. - * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is - * not in the given volume range. + * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is not in the given volume range. * * @param sinkID - * @param volumeStep indicated the number of steps that should be incremented - * or decremented. Positive values here inkrement, negative values decrement + * @param volumeStep indicated the number of steps that should be incremented or decremented. Positive values here + * inkrement, negative values decrement */ virtual am_Error_e volumeStep(const am_sinkID_t sinkID, const int16_t volumeStep) =0; /** * sets the mute state of a sink - * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the - * desired one, the Daemon will return E_OK. + * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the desired one, the Daemon will return E_OK. * * @param sinkID * @param muteState */ virtual am_Error_e setSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0; /** - * This method is used to set sound properties, e.g. Equalizer Values. Since the - * capabilities of the system can differ, the exact key value pairs can be - * extended in each product - * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in - * case of an error + * This method is used to set sound properties, e.g. Equalizer Values. Since the capabilities of the system can differ, + * the exact key value pairs can be extended in each product + * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error * * @param soundProperty * @param sinkID */ virtual am_Error_e setMainSinkSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0; /** - * This method is used to set sound properties, e.g. Equalizer Values. Since the - * capabilities of the system can differ, the exact key value pairs can be - * extended in each product - * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in - * case of an error + * This method is used to set sound properties, e.g. Equalizer Values. Since the capabilities of the system can differ, + * the exact key value pairs can be extended in each product + * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error * * @param soundProperty * @param sourceID @@ -139,8 +128,7 @@ namespace am { virtual am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0; /** * is used to set a specific system property. - * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in - * case of an error + * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error * * @param property the property that shall be set */ @@ -167,8 +155,8 @@ namespace am { */ virtual am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const =0; /** - * This is used to retrieve all source sound properties related to a source. - * Returns a vector of the sound properties and values as pair + * This is used to retrieve all source sound properties related to a source. Returns a vector of the sound properties and + * values as pair * @return E_OK on success, E_DATABASE_ERROR on error * * @param sinkID @@ -206,8 +194,8 @@ namespace am { virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0; /** * returns the delay in ms that the audiopath for the given mainConnection has - * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet - * retrieved, E_DATABASE_ERROR on read error on the database + * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet retrieved, E_DATABASE_ERROR on read error on + * the database * * @param mainConnectionID * @param delay @@ -215,20 +203,16 @@ namespace am { virtual am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const =0; /** * this function is used to retrieve a pointer to the dBusConnectionWrapper - * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without - * DBus Support + * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support * - * @param dbusConnectionWrapper This is a wrapper class that is needed to keep - * dbus inclusions away from the interface. The DBusWrapperClass will return the - * pointer to the DbusConnection call (getDBusConnection) + * @param dbusConnectionWrapper This is a wrapper class that is needed to keep dbus inclusions away from the interface. + * The DBusWrapperClass will return the pointer to the DbusConnection call (getDBusConnection) */ virtual am_Error_e getDBusConnectionWrapper(CAmDbusWrapper*& dbusConnectionWrapper) const =0; /** - * This function returns the pointer to the socketHandler. This can be used to - * integrate socket-based activites like communication with the mainloop of the - * AudioManager. - * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled - * without socketHandler support, + * This function returns the pointer to the socketHandler. This can be used to integrate socket-based activites like + * communication with the mainloop of the AudioManager. + * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support, * * @param socketHandler */ @@ -237,15 +221,47 @@ namespace am { * asynchronous confirmation of setCommandReady. * * @param handle the handle that was handed over by setCommandReady + * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened. */ - virtual void confirmCommandReady(const uint16_t handle) =0; + virtual void confirmCommandReady(const uint16_t handle, const am_Error_e error) =0; /** * asynchronous confirmation of setCommandRundown * * @param handle the handle that was given via setCommandRundown + * @param error E_OK if the ready command succeeded. E_UNKNOWN if an error happened. + */ + virtual void confirmCommandRundown(const uint16_t handle, const am_Error_e error) =0; + /** + * Rtrieves the list of MainNotifications for a sink. + * + * @param sinkID The sinkID + * @param listMainNotificationConfigurations + */ + virtual am_Error_e getListSinkMainNotificationConfigurations(const am_sinkID_t sinkID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) const =0; + /** + * Rtrieves the list of MainNotifications for a source. + * + * @param sourceID The sourceID + * @param listMainNotificationConfigurations + */ + virtual am_Error_e getListSourceMainNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) const =0; + /** + * sets a MainNotificationConfiuration. This can be used to turn on an off notifications an to change the mode of the + * configuration. + * + * @param sinkID The sinkID of the MainNotification to be changed + * @param mainNotificationConfiguration The MainNotifiication that needs to be set + */ + virtual am_Error_e setSinkMainNotificationConfiguration(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0; + /** + * sets a MainNotificationConfiuration. This can be used to turn on an off notifications an to change the mode of the + * configuration. + * + * @param sourceID The sourceID of the MainNotification to be changed + * @param mainNotificationConfiguration The MainNotifiication that needs to be set */ - virtual void confirmCommandRundown(const uint16_t handle) =0; + virtual am_Error_e setSourceMainNotificationConfiguration(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0; }; } -#endif // !defined(EA_B1A684DC_5ED5_4848_82ED_4D3376454A3B__INCLUDED_) +#endif // !defined(EA_3888D932_2C16_4c2a_BD7C_E1F819C9A7F0__INCLUDED_) diff --git a/include/command/IAmCommandSend.h b/include/command/IAmCommandSend.h index bf073f9..ce32131 100644 --- a/include/command/IAmCommandSend.h +++ b/include/command/IAmCommandSend.h @@ -12,15 +12,15 @@ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
*
- * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Christian Mueller, christian.linke@bmw.de BMW 2011,2012
*
* \file
* For further information see http://www.genivi.org/.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
-#if !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_)
-#define EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_
+#if !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_)
+#define EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_
#include <vector>
#include <string>
@@ -31,29 +31,25 @@ class IAmCommandReceive; } #include "IAmCommandReceive.h" +#include "audiomanagertypes.h" -#define CommandSendVersion "1.0" +#define CommandSendVersion "2.0" namespace am { /** - * This interface handles all communication from the AudioManagerDaemon towards - * the system. It is designed in such a way that only callbacks with no return - * types are implemented. So when the CommandInterfacePlugins are designed in such - * a way that they broadcast signals to any node who is interested in the - * particular information (like signals on Dbus for example), more information can - * be retrieved via the CommandReceiveInterface. - * There are two rules that have to be kept in mind when implementing against this - * interface:\n + * This interface handles all communication from the AudioManagerDaemon towards the system. It is designed in such a way + * that only callbacks with no return types are implemented. So when the CommandInterfacePlugins are designed in such a + * way that they broadcast signals to any node who is interested in the particular information (like signals on Dbus for + * example), more information can be retrieved via the CommandReceiveInterface. + * There are two rules that have to be kept in mind when implementing against this interface:\n * \warning * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n - * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS - * CALL THAT EXPECTS A RETURN VALUE.\n + * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n * \details - * Violation these rules may lead to unexpected behavior! Nevertheless you can - * implement thread safe by using the deferred-call pattern described on the wiki - * which also helps to implement calls that are forbidden.\n + * Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred- + * call pattern described on the wiki which also helps to implement calls that are forbidden.\n * For more information, please check CAmSerializer * @author Christian Mueller - * @created 07-Mar-2012 6:06:17 PM + * @created 16-Dez-2012 15:58:14 */ class IAmCommandSend { @@ -74,33 +70,29 @@ namespace am { */ virtual void getInterfaceVersion(std::string& version) const =0; /** - * This command starts the interface, the plugin itself. This is not meant to - * start communication with the HMI itself. It is a good idea to implement here - * everything that sets up the basic communication like DbusCommunication etc... + * This command starts the interface, the plugin itself. This is not meant to start communication with the HMI itself. It + * is a good idea to implement here everything that sets up the basic communication like DbusCommunication etc... * Be aware of side effects with systemd and socketbased communication! * @return E_OK on success, E_UNKNOWN on error * - * @param commandreceiveinterface pointer to the receive interface. Is used to - * call the audiomanagerdaemon + * @param commandreceiveinterface pointer to the receive interface. Is used to call the audiomanagerdaemon */ virtual am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface) =0; /** - * This function will indirectly be called by the Controller and is used to start - * the Communication. Before this command, all communication will be ignored by - * the AudioManager. - * After the Plugin is ready, it will asynchronously answer with - * condfirmCommandReady, the handle that is handed over must be returned. + * This function will indirectly be called by the Controller and is used to start the Communication. Before this command, + * all communication will be ignored by the AudioManager. + * After the Plugin is ready, it will asynchronously answer with condfirmCommandReady, the handle that is handed over must + * be returned. * * @param handle the handle uniquely idenfies the request */ virtual void setCommandReady(const uint16_t handle) =0; /** - * This function will indirectly be called by the Controller and is used to stop - * the Communication. After this command, all communication will be ignored by the - * AudioManager. The plugin has to be prepared that either the power will be + * This function will indirectly be called by the Controller and is used to stop the Communication. After this command, + * all communication will be ignored by the AudioManager. The plugin has to be prepared that either the power will be * switched off or the Interface is started again with setCommandReady - * After the Plugin is ready to rundown, it will asynchronously answer with - * condfirmCommandRundown, the handle that is handed over must be returned. + * After the Plugin is ready to rundown, it will asynchronously answer with condfirmCommandRundown, the handle that is + * handed over must be returned. * * @param handle This handle uniquly idenfies the request */ @@ -211,7 +203,53 @@ namespace am { * @param time */ virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0; + /** + * This callback is called when a sink is updated. + * + * @param sinkID The sinkID that is updated + * @param sinkClassID The sinkClassID of the updated sink. gives the current value even if not updated + * @param listMainSoundProperties The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if + * not changed + */ + virtual void cbSinkUpdated(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0; + /** + * This callback is called when a source is updated. + * + * @param sourceID The sourceID that is updated + * @param sourceClassID The sourceClassID of the updated source. Gives the current value even if not updated + * @param listMainSoundProperties The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if + * not changed + */ + virtual void cbSourceUpdated(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0; + /** + * This callback is called when a notifcated value of a sink changes. + * + * @param sinkID The sinkID + * @param notification The payload of the notification + */ + virtual void cbSinkNotification(const am_sinkID_t sinkID, const am_NotificationPayload_s notification) =0; + /** + * This callback is called when a notifcated value of a source changes. + * + * @param sourceID The sourceID + * @param notification The payload of the notification + */ + virtual void cbSourceNotification(const am_sourceID_t sourceID, const am_NotificationPayload_s notification) =0; + /** + * This callback is triggered when a mainNotificationConfiguration is changed. + * + * @param sinkID + * @param mainNotificationConfiguration The MainNotificationConfiguration that changed + */ + virtual void cbSinkMainNotificationConfigurationChanged(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0; + /** + * This callback is triggered when a mainNotificationConfiguration is changed. + * + * @param sourceID + * @param mainNotificationConfiguration The MainNotificationConfiguration that changed + */ + virtual void cbSourceMainNotificationConfigurationChanged(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0; }; } -#endif // !defined(EA_EA24D1A2_FDA1_4285_8606_7E77A080B4E9__INCLUDED_) +#endif // !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_) |