includes/command/CommandSendInterface.h

   1 /**\r
   2 * Copyright (C) 2011, BMW AG\r
   3 *\r
   4 * GeniviAudioMananger\r
   5 *\r
   6 * \file  \r
   7 *\r
   8 * \date 20-Oct-2011 3:42:04 PM\r
   9 * \author Christian Mueller (christian.ei.mueller@bmw.de)\r
  10 *\r
  11 * \section License\r
  12 * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)\r
  13 * Copyright (C) 2011, BMW AG Christian M?ller  Christian.ei.mueller@bmw.de\r
  14 *\r
  15 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.\r
  16 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.\r
  17 * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.\r
  18 * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.\r
  19 * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.\r
  20 * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.\r
  21 * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.\r
  22 *\r
  23 * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
  24 */\r
  25 #if !defined(EA_B654AC7A_A617_46d0_836D_36974F99E750__INCLUDED_)\r
  26 #define EA_B654AC7A_A617_46d0_836D_36974F99E750__INCLUDED_\r
  27 \r
  28 #include <vector>\r
  29 #include <string>\r
  30 #include "../audiomanagertypes.h"\r
  31 \r
  32 namespace am {\r
  33 class CommandReceiveInterface;\r
  34 }
  35
  36 #define CommandSendVersion 1
  37 namespace am {
  38         /**
  39          * 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.
  40          * @author christian
  41          * @version 1.0
  42          * @created 11-Jan-2012 9:19:58 PM
  43          */
  44         class CommandSendInterface
  45         {
  46
  47         public:
  48                 /**
  49                  * 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
  50                  * @return E_OK on success, E_UNKNOWN on error
  51                  *
  52                  * @param commandreceiveinterface    pointer to the receive interface. Is used to call the audiomanagerdaemon
  53                  */
  54                 virtual am_Error_e startupInterface(CommandReceiveInterface* commandreceiveinterface) =0;
  55                 /**
  56                  * This command stops the interface before the plugin is unloaded.\r
  57                  * @return E_OK on success, E_UNKNOWN on error
  58                  */
  59                 virtual am_Error_e stopInterface() =0;
  60                 /**
  61                  * This callback is fired when the Interface is ready to be used. Before this command, all communication will be ignored by the Audiomanager
  62                  */
  63                 virtual am_Error_e cbCommunicationReady() =0;
  64                 /**
  65                  * This callback is fired when the AudioManager is about to rundown. After this command no more action will be carried out by the AudioManager.
  66                  */
  67                 virtual am_Error_e cbCommunicationRundown() =0;
  68                 /**
  69                  * Callback that is called when the number of connections change
  70                  */
  71                 virtual void cbNumberOfMainConnectionsChanged() =0;
  72                 /**
  73                  * Callback that is called when the number of sinks change
  74                  */
  75                 virtual void cbNumberOfSinksChanged() =0;
  76                 /**
  77                  * Callback that is called when the number of sources change
  78                  */
  79                 virtual void cbNumberOfSourcesChanged() =0;
  80                 /**
  81                  * this callback is fired if the number of sink classes changed
  82                  */
  83                 virtual void cbNumberOfSinkClassesChanged() =0;
  84                 /**
  85                  * this callback is fired if the number of source classes changed
  86                  */
  87                 virtual void cbNumberOfSourceClassesChanged() =0;
  88                 /**
  89                  * This callback is called when the ConnectionState of a connection changed.
  90                  *
  91                  * @param connectionID
  92                  * @param connectionState
  93                  */
  94                 virtual void cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState) =0;
  95                 /**
  96                  * this callback indicates that a sinkSoundProperty has changed.
  97                  *
  98                  * @param sinkID
  99                  * @param soundProperty
 100                  */
 101                 virtual void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s soundProperty) =0;
 102                 /**
 103                  * this callback indicates that a sourceSoundProperty has changed.
 104                  *
 105                  * @param sourceID
 106                  * @param soundProperty
 107                  */
 108                 virtual void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0;
 109                 /**
 110                  * this callback is called when the availability of a sink has changed
 111                  *
 112                  * @param sinkID
 113                  * @param availability
 114                  */
 115                 virtual void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;
 116                 /**
 117                  * this callback is called when the availability of source has changed.
 118                  *
 119                  * @param sourceID
 120                  * @param availability
 121                  */
 122                 virtual void cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s& availability) =0;
 123                 /**
 124                  * this callback indicates a volume change on the indicated sink
 125                  *
 126                  * @param sinkID
 127                  * @param volume
 128                  */
 129                 virtual void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
 130                 /**
 131                  * this callback indicates a mute state change on a sink.
 132                  *
 133                  * @param sinkID
 134                  * @param muteState
 135                  */
 136                 virtual void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
 137                 /**
 138                  * is fired if a systemProperty changed
 139                  *
 140                  * @param systemProperty
 141                  */
 142                 virtual void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty) =0;
 143                 /**
 144                  * CommandReceiveVer_0.0.9.
 145                  *
 146                  * @param time
 147                  * @param mainConnectionID
 148                  */
 149                 virtual void cbTimingInformationChanged(const am_timeSync_t time, const am_mainConnectionID_t mainConnectionID) =0;
 150                 /**
 151                  * This function returns the version of the interface\r
 152                  * returns E_OK, E_UNKOWN if version is unknown.
 153                  */
 154                 virtual uint16_t getInterfaceVersion() const =0;
 155
 156         };
 157 }
 158 #endif // !defined(EA_B654AC7A_A617_46d0_836D_36974F99E750__INCLUDED_)