includes/control/ControlReceiveInterface.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_E6AC61AD_E107_4b3d_8E11_9A434157C19F__INCLUDED_)\r
  26 #define EA_E6AC61AD_E107_4b3d_8E11_9A434157C19F__INCLUDED_\r
  27 \r
  28 #include <vector>\r
  29 #include <string>\r
  30 #include "../audiomanagertypes.h"\r
  31 namespace am {\r
  32 class SocketHandler;\r
  33 }\r
  34
  35
  36 #define ControlReceiveVersion 1
  37 namespace am {
  38         /**
  39          * This interface gives access to all important functions of the audiomanager that are used by the AudioManagerController to control the system.
  40          * @author christian
  41          * @version 1.0
  42          * @created 19-Jan-2012 4:32:00 PM
  43          */
  44         class ControlReceiveInterface
  45         {
  46
  47         public:
  48                 /**
  49                  * calculates a route from source to sink.\r
  50                  * @return E_OK on success, E_UNKNOWN on error
  51                  *
  52                  * @param onlyfree    if true return only routes which use gateways that are not in use at the moment
  53                  * @param sourceID
  54                  * @param sinkID
  55                  * @param returnList    this is a list of routes that are possible to take. unsorted! The longest could be first.\r
  56                  * In case not route can be found, the list will return empty.
  57                  */
  58                 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;
  59                 /**
  60                  * With this function, elementary connects can be triggered by the controller.\r
  61                  * @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
  62                  *
  63                  * @param handle
  64                  * @param connectionID
  65                  * @param format
  66                  * @param sourceID
  67                  * @param sinkID
  68                  */
  69                 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;
  70                 /**
  71                  * is used to disconnect a connection\r
  72                  * @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
  73                  *
  74                  * @param handle
  75                  * @param connectionID
  76                  */
  77                 virtual am_Error_e disconnect(am_Handle_s& handle, const am_connectionID_t connectionID) =0;
  78                 /**
  79                  * triggers a cross fade.\r
  80                  * @return E_OK on success, E_UNKNOWN on error E_NO_CHANGE if no change is neccessary
  81                  *
  82                  * @param handle
  83                  * @param hotSource    this is the source that is going to be the active one after the fading
  84                  * @param crossfaderID
  85                  * @param rampType
  86                  * @param rampTime    rampTime 0 means default value
  87                  */
  88                 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;
  89                 /**
  90                  * with this method, all actions that have a handle assigned can be stopped.\r
  91                  * @return E_OK on success, E_UNKNOWN on error
  92                  *
  93                  * @param handle    the handle of the action to be stopped
  94                  */
  95                 virtual am_Error_e abortAction(const am_Handle_s handle) =0;
  96                 /**
  97                  * this method sets a source state for a source. This function will trigger the callback cbAckSetSourceState\r
  98                  * @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
  99                  *
 100                  * @param handle
 101                  * @param sourceID
 102                  * @param state
 103                  */
 104                 virtual am_Error_e setSourceState(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SourceState_e state) =0;
 105                 /**
 106                  * 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
 107                  * 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
 108                  * @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.
 109                  *
 110                  * @param handle
 111                  * @param sinkID
 112                  * @param volume
 113                  * @param ramp
 114                  * @param time
 115                  */
 116                 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;
 117                 /**
 118                  * 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
 119                  * 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
 120                  * @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.
 121                  *
 122                  * @param handle
 123                  * @param sourceID
 124                  * @param volume
 125                  * @param rampType
 126                  * @param time
 127                  */
 128                 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;
 129                 /**
 130                  * is used to set several sinkSoundProperties at a time\r
 131                  * @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
 132                  *
 133                  * @param handle
 134                  * @param sinkID
 135                  * @param soundProperty
 136                  */
 137                 virtual am_Error_e setSinkSoundProperties(am_Handle_s& handle, const am_sinkID_t sinkID, const std::vector<am_SoundProperty_s>& soundProperty) =0;
 138                 /**
 139                  * is used to set sinkSoundProperties\r
 140                  * @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
 141                  *
 142                  * @param handle
 143                  * @param sinkID
 144                  * @param soundProperty
 145                  */
 146                 virtual am_Error_e setSinkSoundProperty(am_Handle_s& handle, const am_sinkID_t sinkID, const am_SoundProperty_s& soundProperty) =0;
 147                 /**
 148                  * is used to set several SourceSoundProperties at a time\r
 149                  * @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
 150                  *
 151                  * @param handle
 152                  * @param sourceID
 153                  * @param soundProperty
 154                  */
 155                 virtual am_Error_e setSourceSoundProperties(am_Handle_s& handle, const am_sourceID_t sourceID, const std::vector<am_SoundProperty_s>& soundProperty) =0;
 156                 /**
 157                  * is used to set sourceSoundProperties\r
 158                  * @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
 159                  *
 160                  * @param handle
 161                  * @param sourceID
 162                  * @param soundProperty
 163                  */
 164                 virtual am_Error_e setSourceSoundProperty(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SoundProperty_s& soundProperty) =0;
 165                 /**
 166                  * sets the domain state of a domain\r
 167                  * @return E_OK on success, E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary
 168                  *
 169                  * @param domainID
 170                  * @param domainState
 171                  */
 172                 virtual am_Error_e setDomainState(const am_domainID_t domainID, const am_DomainState_e domainState) =0;
 173                 /**
 174                  * enters a domain in the database, creates and ID\r
 175                  * @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
 176                  *
 177                  * @param domainData    domainID in am_Domain_s must be 0 here
 178                  * @param domainID
 179                  */
 180                 virtual am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
 181                 /**
 182                  * enters a mainconnection in the database, creates and ID\r
 183                  * @return E_OK on success, E_DATABASE_ERROR if the database had an error
 184                  *
 185                  * @param mainConnectionData    the MainConnectionID is omitted since it is created during the registration
 186                  * @param connectionID
 187                  */
 188                 virtual am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID) =0;
 189                 /**
 190                  * enters a sink in the database.\r
 191                  * 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
 192                  * @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
 193                  *
 194                  * @param sinkData    the sinkID will be omitted since it is created during the registration
 195                  * @param sinkID
 196                  */
 197                 virtual am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
 198                 /**
 199                  * enters a crossfader in the database.\r
 200                  * 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
 201                  * @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
 202                  *
 203                  * @param crossfaderData    the ID in the data will be ignored since it is created during the registration
 204                  * @param crossfaderID
 205                  */
 206                 virtual am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
 207                 /**
 208                  * enters a gateway in the database.\r
 209                  * 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
 210                  * @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
 211                  *
 212                  * @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.
 213                  * @param gatewayID
 214                  */
 215                 virtual am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
 216                 /**
 217                  * enters a source in the database.\r
 218                  * 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
 219                  * @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
 220                  *
 221                  * @param sourceData    sourceID is omitted here since it is created during registration
 222                  * @param sourceID
 223                  */
 224                 virtual am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
 225                 /**
 226                  * Enters a sourceClass into the database.\r
 227                  * @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
 228                  *
 229                  * @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.
 230                  * @param sinkClassID
 231                  */
 232                 virtual am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID) =0;
 233                 /**
 234                  * Enters a sourceClass into the database.\r
 235                  * 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
 236                  * @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
 237                  *
 238                  * @param sourceClassID
 239                  * @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.
 240                  */
 241                 virtual am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass) =0;
 242                 /**
 243                  * changes class information of a sinkclass.\r
 244                  * The properties will overwrite the values of the sinkClassID given in the sinkClass.\r
 245                  * 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
 246                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sinkClassID was not found.
 247                  *
 248                  * @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
 249                  */
 250                 virtual am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass) =0;
 251                 /**
 252                  * changes class information of a sourceClass. \r
 253                  * The properties will overwrite the values of the sourceClassID given in the sourceClass.\r
 254                  * 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
 255                  * @return E_OK on success, E_DATABASE_ERROR on error and E_NON_EXISTENT if the ClassID does not exist.
 256                  *
 257                  * @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
 258                  */
 259                 virtual am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass) =0;
 260                 /**
 261                  * This function is used to enter the system Properties into the database.\r
 262                  * All entries in the database will be erased before entering the new List. It should only be called once at system startup.\r
 263                  * @return E_OK on success,  E_DATABASE_ERROR if the database had an error
 264                  *
 265                  * @param listSystemProperties
 266                  */
 267                 virtual am_Error_e enterSystemPropertiesListDB(const std::vector<am_SystemProperty_s>& listSystemProperties) =0;
 268                 /**
 269                  * changes the mainConnectionState of MainConnection\r
 270                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
 271                  *
 272                  * @param mainconnectionID
 273                  * @param route
 274                  */
 275                 virtual am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const am_Route_s& route) =0;
 276                 /**
 277                  * changes the mainConnectionState of MainConnection\r
 278                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
 279                  *
 280                  * @param mainconnectionID
 281                  * @param connectionState
 282                  */
 283                 virtual am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState) =0;
 284                 /**
 285                  * changes the sink volume of a sink\r
 286                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 287                  *
 288                  * @param mainVolume
 289                  * @param sinkID
 290                  */
 291                 virtual am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID) =0;
 292                 /**
 293                  * changes the availablility of a sink\r
 294                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 295                  *
 296                  * @param availability
 297                  * @param sinkID
 298                  */
 299                 virtual am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID) =0;
 300                 /**
 301                  * changes the domainstate of a domain \r
 302                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 303                  *
 304                  * @param domainState
 305                  * @param domainID
 306                  */
 307                 virtual am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID) =0;
 308                 /**
 309                  * changes the mute state of a sink\r
 310                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 311                  *
 312                  * @param muteState
 313                  * @param sinkID
 314                  */
 315                 virtual am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID) =0;
 316                 /**
 317                  * changes the mainsinksoundproperty of a sink\r
 318                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 319                  *
 320                  * @param soundProperty
 321                  * @param sinkID
 322                  */
 323                 virtual am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;
 324                 /**
 325                  * changes the mainsourcesoundproperty of a sink\r
 326                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
 327                  *
 328                  * @param soundProperty
 329                  * @param sourceID
 330                  */
 331                 virtual am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
 332                 /**
 333                  * changes the availablility of a source\r
 334                  * @return E_OK on success, E_DATABASE_ERROR  on error, E_NON_EXISTENT if source was not found
 335                  *
 336                  * @param availability
 337                  * @param sourceID
 338                  */
 339                 virtual am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID) =0;
 340                 /**
 341                  * changes a systemProperty\r
 342                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if property was not found
 343                  *
 344                  * @param property
 345                  */
 346                 virtual am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property) =0;
 347                 /**
 348                  * removes a mainconnection from the DB\r
 349                  * @return E_OK on success, E_NON_EXISTENT if main connection was not found, E_DATABASE_ERROR if the database had an error
 350                  *
 351                  * @param mainConnectionID
 352                  */
 353                 virtual am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) =0;
 354                 /**
 355                  * removes a sink from the DB\r
 356                  * @return E_OK on success, E_NON_EXISTENT if sink was not found, E_DATABASE_ERROR if the database had an error
 357                  *
 358                  * @param sinkID
 359                  */
 360                 virtual am_Error_e removeSinkDB(const am_sinkID_t sinkID) =0;
 361                 /**
 362                  * removes a source from the DB\r
 363                  * @return E_OK on success, E_NON_EXISTENT if source was not found, E_DATABASE_ERROR if the database had an error
 364                  *
 365                  * @param sourceID
 366                  */
 367                 virtual am_Error_e removeSourceDB(const am_sourceID_t sourceID) =0;
 368                 /**
 369                  * removes a gateway from the DB\r
 370                  * @return E_OK on success, E_NON_EXISTENT if gateway was not found, E_DATABASE_ERROR if the database had an error
 371                  *
 372                  * @param gatewayID
 373                  */
 374                 virtual am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID) =0;
 375                 /**
 376                  * removes a crossfader from the DB\r
 377                  * @return E_OK on success, E_NON_EXISTENT if crossfader was not found, E_DATABASE_ERROR if the database had an error
 378                  *
 379                  * @param crossfaderID
 380                  */
 381                 virtual am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID) =0;
 382                 /**
 383                  * removes a domain from the DB\r
 384                  * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
 385                  *
 386                  * @param domainID
 387                  */
 388                 virtual am_Error_e removeDomainDB(const am_domainID_t domainID) =0;
 389                 /**
 390                  * removes a domain from the DB\r
 391                  * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
 392                  *
 393                  * @param sinkClassID
 394                  */
 395                 virtual am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID) =0;
 396                 /**
 397                  * removes a domain from the DB\r
 398                  * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
 399                  *
 400                  * @param sourceClassID
 401                  */
 402                 virtual am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID) =0;
 403                 /**
 404                  * returns the ClassInformation of a source\r
 405                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
 406                  *
 407                  * @param sourceID
 408                  * @param classInfo
 409                  */
 410                 virtual am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const =0;
 411                 /**
 412                  * returns the ClassInformation of a sink\r
 413                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 414                  *
 415                  * @param sinkID
 416                  * @param sinkClass
 417                  */
 418                 virtual am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const =0;
 419                 /**
 420                  * return source and sink of a gateway\r
 421                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if gateway was not found
 422                  *
 423                  * @param gatewayID
 424                  * @param gatewayData
 425                  */
 426                 virtual am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const =0;
 427                 /**
 428                  * returns sources and the sink of a crossfader\r
 429                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found
 430                  *
 431                  * @param crossfaderID
 432                  * @param crossfaderData
 433                  */
 434                 virtual am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const =0;
 435                 /**
 436                  * returns all sinks of a domain\r
 437                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 438                  *
 439                  * @param domainID
 440                  * @param listSinkID
 441                  */
 442                 virtual am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const =0;
 443                 /**
 444                  * returns all source of a domain\r
 445                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 446                  *
 447                  * @param domainID
 448                  * @param listSourceID
 449                  */
 450                 virtual am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const =0;
 451                 /**
 452                  * returns all crossfaders of a domain\r
 453                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 454                  *
 455                  * @param domainID
 456                  * @param listCrossfadersID
 457                  */
 458                 virtual am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listCrossfadersID) const =0;
 459                 /**
 460                  * returns all gateways of a domain\r
 461                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 462                  *
 463                  * @param domainID
 464                  * @param listGatewaysID
 465                  */
 466                 virtual am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const =0;
 467                 /**
 468                  * returns a complete list of all MainConnections\r
 469                  * @return E_OK on success, E_DATABASE_ERROR on error
 470                  *
 471                  * @param listMainConnections
 472                  */
 473                 virtual am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const =0;
 474                 /**
 475                  * returns a complete list of all domains\r
 476                  * @return E_OK on success, E_DATABASE_ERROR on error
 477                  *
 478                  * @param listDomains
 479                  */
 480                 virtual am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const =0;
 481                 /**
 482                  * returns a complete list of all Connections\r
 483                  * @return E_OK on success, E_DATABASE_ERROR on error
 484                  *
 485                  * @param listConnections
 486                  */
 487                 virtual am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const =0;
 488                 /**
 489                  * returns a list of all sinks\r
 490                  * @return E_OK on success, E_DATABASE_ERROR on error
 491                  *
 492                  * @param listSinks
 493                  */
 494                 virtual am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const =0;
 495                 /**
 496                  * returns a list of all sources\r
 497                  * @return E_OK on success, E_DATABASE_ERROR on error
 498                  *
 499                  * @param listSources
 500                  */
 501                 virtual am_Error_e getListSources(std::vector<am_Source_s>& listSources) const =0;
 502                 /**
 503                  * returns a list of all source classes\r
 504                  * @return E_OK on success, E_DATABASE_ERROR on error
 505                  *
 506                  * @param listSourceClasses
 507                  */
 508                 virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const =0;
 509                 /**
 510                  * returns a list of all handles\r
 511                  * @return E_OK on success, E_DATABASE_ERROR on error
 512                  *
 513                  * @param listHandles
 514                  */
 515                 virtual am_Error_e getListHandles(std::vector<am_Handle_s>& listHandles) const =0;
 516                 /**
 517                  * returns a list of all crossfaders\r
 518                  * @return E_OK on success, E_DATABASE_ERROR on error
 519                  *
 520                  * @param listCrossfaders
 521                  */
 522                 virtual am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const =0;
 523                 /**
 524                  * returns a list of  gateways\r
 525                  * @return E_OK on success, E_DATABASE_ERROR on error
 526                  *
 527                  * @param listGateways
 528                  */
 529                 virtual am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const =0;
 530                 /**
 531                  * returns a list of all sink classes\r
 532                  * @return E_OK on success, E_DATABASE_ERROR on error
 533                  *
 534                  * @param listSinkClasses
 535                  */
 536                 virtual am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const =0;
 537                 /**
 538                  * returns the list of SystemProperties
 539                  *
 540                  * @param listSystemProperties
 541                  */
 542                 virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
 543                 /**
 544                  * sets the command interface to ready
 545                  */
 546                 virtual void setCommandReady() =0;
 547                 /**
 548                  * sets the routinginterface to  ready.
 549                  */
 550                 virtual void setRoutingReady() =0;
 551                 /**
 552                  * 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
 553                  * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,
 554                  *
 555                  * @param socketHandler
 556                  */
 557                 virtual am_Error_e getSocketHandler(SocketHandler*& socketHandler) =0;
 558                 /**
 559                  * This function returns the version of the interface
 560                  */
 561                 virtual uint16_t getInterfaceVersion() const =0;
 562
 563         };
 564 }
 565 #endif // !defined(EA_E6AC61AD_E107_4b3d_8E11_9A434157C19F__INCLUDED_)