includes/command/CommandReceiveInterface.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_434BDFE9_DDA7_4273_AF1E_77AE60CB055D__INCLUDED_)\r
  26 #define EA_434BDFE9_DDA7_4273_AF1E_77AE60CB055D__INCLUDED_\r
  27 \r
  28 #include <vector>\r
  29 #include <string>\r
  30 #include "../audiomanagertypes.h"\r
  31 namespace am {\r
  32 class DBusWrapper;\r
  33 class SocketHandler;\r
  34 }\r
  35
  36
  37 #define CommandReceiveVersion 1
  38 namespace am {
  39         /**
  40          * 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.
  41          * @author christian
  42          * @version 1.0
  43          * @created 19-Jan-2012 4:32:00 PM
  44          */
  45         class CommandReceiveInterface
  46         {
  47
  48         public:
  49                 /**
  50                  * connects a source to sink\r
  51                  * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists
  52                  *
  53                  * @param sourceID
  54                  * @param sinkID
  55                  * @param mainConnectionID
  56                  */
  57                 virtual am_Error_e connect(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0;
  58                 /**
  59                  * disconnects a mainConnection\r
  60                  * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist, E_NOT_POSSIBLE on error.
  61                  *
  62                  * @param mainConnectionID
  63                  */
  64                 virtual am_Error_e disconnect(const am_mainConnectionID_t mainConnectionID) =0;
  65                 /**
  66                  * sets the volume for a sink\r
  67                  * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is out of range
  68                  *
  69                  * @param sinkID    the sink
  70                  * @param volume    the volume
  71                  */
  72                 virtual am_Error_e setVolume(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
  73                 /**
  74                  * This function is used to increment or decrement the current volume for a sink.\r
  75                  * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is not in the given volume range.
  76                  *
  77                  * @param sinkID
  78                  * @param volumeStep    indicated the number of steps that should be incremented or decremented. Positive values here inkrement, negative values decrement
  79                  */
  80                 virtual am_Error_e volumeStep(const am_sinkID_t sinkID, const int16_t volumeStep) =0;
  81                 /**
  82                  * sets the mute state of a sink\r
  83                  * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the desired one, the Daemon will return E_OK.
  84                  *
  85                  * @param sinkID
  86                  * @param muteState
  87                  */
  88                 virtual am_Error_e setSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
  89                 /**
  90                  * 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
  91                  * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
  92                  *
  93                  * @param soundProperty
  94                  * @param sinkID
  95                  */
  96                 virtual am_Error_e setMainSinkSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;
  97                 /**
  98                  * 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
  99                  * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
 100                  *
 101                  * @param soundProperty
 102                  * @param sourceID
 103                  */
 104                 virtual am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
 105                 /**
 106                  * is used to set a specific system property.\r
 107                  * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
 108                  *
 109                  * @param property    the property that shall be set
 110                  */
 111                 virtual am_Error_e setSystemProperty(const am_SystemProperty_s& property) =0;
 112                 /**
 113                  * returns the actual list of MainConnections\r
 114                  * @return E_OK on success, E_DATABASE_ERROR on error
 115                  *
 116                  * @param listConnections    returns a list of all connections
 117                  */
 118                 virtual am_Error_e getListMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const =0;
 119                 /**
 120                  * returns the actual list of Sinks\r
 121                  * @return E_OK on success, E_DATABASE_ERROR on error
 122                  *
 123                  * @param listMainSinks    the list of the sinks
 124                  */
 125                 virtual am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const =0;
 126                 /**
 127                  * returns the actual list of Sources\r
 128                  * @return E_OK on success, E_DATABASE_ERROR on error
 129                  *
 130                  * @param listMainSources    the list of sources
 131                  */
 132                 virtual am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const =0;
 133                 /**
 134                  * 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
 135                  * @return E_OK on success, E_DATABASE_ERROR on error
 136                  *
 137                  * @param sinkID
 138                  * @param listSoundProperties
 139                  */
 140                 virtual am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const =0;
 141                 /**
 142                  * This is used to retrieve all source sound properties related to a source.\r
 143                  * @return E_OK on success, E_DATABASE_ERROR on error
 144                  *
 145                  * @param sourceID
 146                  * @param listSourceProperties
 147                  */
 148                 virtual am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const =0;
 149                 /**
 150                  * This is used to retrieve SourceClass Information of all source classes \r
 151                  * @return E_OK on success, E_DATABASE_ERROR on error
 152                  *
 153                  * @param listSourceClasses
 154                  */
 155                 virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const =0;
 156                 /**
 157                  * This is used to retrieve SinkClass Information of all sink classes \r
 158                  * @return E_OK on success, E_DATABASE_ERROR on error
 159                  *
 160                  * @param listSinkClasses
 161                  */
 162                 virtual am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const =0;
 163                 /**
 164                  * Retrieves a complete list of all systemProperties.\r
 165                  * @return E_OK on success, E_DATABASE_ERROR on error
 166                  *
 167                  * @param listSystemProperties
 168                  */
 169                 virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
 170                 /**
 171                  * returns the delay in ms that the audiopath for the given mainConnection has\r
 172                  * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet retrieved, E_DATABASE_ERROR on read error on the database
 173                  *
 174                  * @param mainConnectionID
 175                  * @param delay
 176                  */
 177                 virtual am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const =0;
 178                 /**
 179                  * this function is used to retrieve a pointer to the dBusConnectionWrapper\r
 180                  * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support
 181                  *
 182                  * @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)
 183                  */
 184                 virtual am_Error_e getDBusConnectionWrapper(DBusWrapper*& dbusConnectionWrapper) const =0;
 185                 /**
 186                  * 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
 187                  * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,
 188                  *
 189                  * @param socketHandler
 190                  */
 191                 virtual am_Error_e getSocketHandler(SocketHandler*& socketHandler) const =0;
 192                 /**
 193                  * This function returns the version of the interface.
 194                  */
 195                 virtual uint16_t getInterfaceVersion() const =0;
 196
 197         };
 198 }
 199 #endif // !defined(EA_434BDFE9_DDA7_4273_AF1E_77AE60CB055D__INCLUDED_)