include/control/IAmControlReceive.h

   1 /** Copyright (c) 2012 GENIVI Alliance\r
   2  *  Copyright (c) 2012 BMW\r
   3  *\r
   4  *  \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012\r
   5  *\r
   6  *  \copyright\r
   7  *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction,\r
   8  *  including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,\r
   9  *  subject to the following conditions:\r
  10  *  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r
  11  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\r
  12  *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR\r
  13  *  THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  14  \r
  15  *  For further information see http://www.genivi.org/.\r
  16  *\r
  17  * \r
  18  * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN\r
  19  */\r
  20 #if !defined(EA_9408C8ED_AF20_4839_B557_1316C8F36E07__INCLUDED_)\r
  21 #define EA_9408C8ED_AF20_4839_B557_1316C8F36E07__INCLUDED_\r
  22 \r
  23 #include <vector>\r
  24 #include <string>\r
  25 #include "audiomanagertypes.h"\r
  26 namespace am {\r
  27 class CAmSocketHandler;\r
  28 }\r
  29
  30
  31 #define ControlReceiveVersion "1.0"
  32 namespace am {
  33         /**
  34          * This interface gives access to all important functions of the audiomanager that are used by the AudioManagerController to control the system.\r
  35          * There are two rules that have to be kept in mind when implementing against this interface:\n\r
  36          * \warning\r
  37          * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n\r
  38          * 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.\n\r
  39          * \details\r
  40          * 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\r
  41          * For more information, please check CAmSerializer
  42          * @author Christian Mueller
  43          * @created 05-Mar-2012 9:02:08 PM
  44          */
  45         class IAmControlReceive
  46         {
  47
  48         public:
  49                 IAmControlReceive() {
  50
  51                 }
  52
  53                 virtual ~IAmControlReceive() {
  54
  55                 }
  56
  57                 /**
  58                  * calculates a route from source to sink.\r
  59                  * @return E_OK on success, E_UNKNOWN on error
  60                  *
  61                  * @param onlyfree    if true return only routes which use gateways that are not in use at the moment
  62                  * @param sourceID
  63                  * @param sinkID
  64                  * @param returnList    this is a list of routes that are possible to take. unsorted! The longest could be first.\r
  65                  * In case not route can be found, the list will return empty.
  66                  */
  67                 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;
  68                 /**
  69                  * With this function, elementary connects can be triggered by the controller.\r
  70                  * @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
  71                  *
  72                  * @param handle
  73                  * @param connectionID
  74                  * @param format
  75                  * @param sourceID
  76                  * @param sinkID
  77                  */
  78                 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;
  79                 /**
  80                  * is used to disconnect a connection\r
  81                  * @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
  82                  *
  83                  * @param handle
  84                  * @param connectionID
  85                  */
  86                 virtual am_Error_e disconnect(am_Handle_s& handle, const am_connectionID_t connectionID) =0;
  87                 /**
  88                  * triggers a cross fade.\r
  89                  * @return E_OK on success, E_UNKNOWN on error E_NO_CHANGE if no change is neccessary
  90                  *
  91                  * @param handle
  92                  * @param hotSource    this is the source that is going to be the active one after the fading
  93                  * @param crossfaderID
  94                  * @param rampType
  95                  * @param rampTime    rampTime 0 means default value
  96                  */
  97                 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;
  98                 /**
  99                  * with this method, all actions that have a handle assigned can be stopped.\r
 100                  * @return E_OK on success, E_UNKNOWN on error
 101                  *
 102                  * @param handle    the handle of the action to be stopped
 103                  */
 104                 virtual am_Error_e abortAction(const am_Handle_s handle) =0;
 105                 /**
 106                  * this method sets a source state for a source. This function will trigger the callback cbAckSetSourceState\r
 107                  * @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
 108                  *
 109                  * @param handle
 110                  * @param sourceID
 111                  * @param state
 112                  */
 113                 virtual am_Error_e setSourceState(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SourceState_e state) =0;
 114                 /**
 115                  * 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
 116                  * 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
 117                  * @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.
 118                  *
 119                  * @param handle
 120                  * @param sinkID
 121                  * @param volume
 122                  * @param ramp
 123                  * @param time
 124                  */
 125                 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;
 126                 /**
 127                  * 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
 128                  * 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
 129                  * @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.
 130                  *
 131                  * @param handle
 132                  * @param sourceID
 133                  * @param volume
 134                  * @param rampType
 135                  * @param time
 136                  */
 137                 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;
 138                 /**
 139                  * is used to set several sinkSoundProperties at a time\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 setSinkSoundProperties(am_Handle_s& handle, const am_sinkID_t sinkID, const std::vector<am_SoundProperty_s>& soundProperty) =0;
 147                 /**
 148                  * is used to set sinkSoundProperties\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 sinkID
 153                  * @param soundProperty
 154                  */
 155                 virtual am_Error_e setSinkSoundProperty(am_Handle_s& handle, const am_sinkID_t sinkID, const am_SoundProperty_s& soundProperty) =0;
 156                 /**
 157                  * is used to set several SourceSoundProperties at a time\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 setSourceSoundProperties(am_Handle_s& handle, const am_sourceID_t sourceID, const std::vector<am_SoundProperty_s>& soundProperty) =0;
 165                 /**
 166                  * is used to set sourceSoundProperties\r
 167                  * @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
 168                  *
 169                  * @param handle
 170                  * @param sourceID
 171                  * @param soundProperty
 172                  */
 173                 virtual am_Error_e setSourceSoundProperty(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SoundProperty_s& soundProperty) =0;
 174                 /**
 175                  * sets the domain state of a domain\r
 176                  * @return E_OK on success, E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary
 177                  *
 178                  * @param domainID
 179                  * @param domainState
 180                  */
 181                 virtual am_Error_e setDomainState(const am_domainID_t domainID, const am_DomainState_e domainState) =0;
 182                 /**
 183                  * enters a domain in the database, creates and ID\r
 184                  * @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
 185                  *
 186                  * @param domainData    domainID in am_Domain_s must be 0 here
 187                  * @param domainID
 188                  */
 189                 virtual am_Error_e enterDomainDB(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
 190                 /**
 191                  * enters a mainconnection in the database, creates and ID\r
 192                  * @return E_OK on success, E_DATABASE_ERROR if the database had an error
 193                  *
 194                  * @param mainConnectionData    the MainConnectionID is omitted since it is created during the registration
 195                  * @param connectionID
 196                  */
 197                 virtual am_Error_e enterMainConnectionDB(const am_MainConnection_s& mainConnectionData, am_mainConnectionID_t& connectionID) =0;
 198                 /**
 199                  * enters a sink in the database.\r
 200                  * 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
 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 sinkData    the sinkID will be omitted since it is created during the registration
 204                  * @param sinkID
 205                  */
 206                 virtual am_Error_e enterSinkDB(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
 207                 /**
 208                  * enters a crossfader in the database.\r
 209                  * 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
 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 crossfaderData    the ID in the data will be ignored since it is created during the registration
 213                  * @param crossfaderID
 214                  */
 215                 virtual am_Error_e enterCrossfaderDB(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
 216                 /**
 217                  * enters a gateway in the database.\r
 218                  * 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
 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 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.
 222                  * @param gatewayID
 223                  */
 224                 virtual am_Error_e enterGatewayDB(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
 225                 /**
 226                  * enters a source in the database.\r
 227                  * 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
 228                  * @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
 229                  *
 230                  * @param sourceData    sourceID is omitted here since it is created during registration
 231                  * @param sourceID
 232                  */
 233                 virtual am_Error_e enterSourceDB(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
 234                 /**
 235                  * Enters a sourceClass into the database.\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 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.
 239                  * @param sinkClassID
 240                  */
 241                 virtual am_Error_e enterSinkClassDB(const am_SinkClass_s& sinkClass, am_sinkClass_t& sinkClassID) =0;
 242                 /**
 243                  * Enters a sourceClass into the database.\r
 244                  * 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
 245                  * @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
 246                  *
 247                  * @param sourceClassID
 248                  * @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.
 249                  */
 250                 virtual am_Error_e enterSourceClassDB(am_sourceClass_t& sourceClassID, const am_SourceClass_s& sourceClass) =0;
 251                 /**
 252                  * changes class information of a sinkclass.\r
 253                  * The properties will overwrite the values of the sinkClassID given in the sinkClass.\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, E_NON_EXISTENT if sinkClassID was not found.
 256                  *
 257                  * @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
 258                  */
 259                 virtual am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass) =0;
 260                 /**
 261                  * changes class information of a sourceClass. \r
 262                  * The properties will overwrite the values of the sourceClassID given in the sourceClass.\r
 263                  * 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
 264                  * @return E_OK on success, E_DATABASE_ERROR on error and E_NON_EXISTENT if the ClassID does not exist.
 265                  *
 266                  * @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
 267                  */
 268                 virtual am_Error_e changeSourceClassInfoDB(const am_SourceClass_s& sourceClass) =0;
 269                 /**
 270                  * This function is used to enter the system Properties into the database.\r
 271                  * All entries in the database will be erased before entering the new List. It should only be called once at system startup.\r
 272                  * @return E_OK on success,  E_DATABASE_ERROR if the database had an error
 273                  *
 274                  * @param listSystemProperties
 275                  */
 276                 virtual am_Error_e enterSystemPropertiesListDB(const std::vector<am_SystemProperty_s>& listSystemProperties) =0;
 277                 /**
 278                  * changes the mainConnectionState of MainConnection\r
 279                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
 280                  *
 281                  * @param mainconnectionID
 282                  * @param listConnectionID
 283                  */
 284                 virtual am_Error_e changeMainConnectionRouteDB(const am_mainConnectionID_t mainconnectionID, const std::vector<am_connectionID_t>& listConnectionID) =0;
 285                 /**
 286                  * changes the mainConnectionState of MainConnection\r
 287                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection
 288                  *
 289                  * @param mainconnectionID
 290                  * @param connectionState
 291                  */
 292                 virtual am_Error_e changeMainConnectionStateDB(const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState) =0;
 293                 /**
 294                  * changes the sink volume of a sink\r
 295                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 296                  *
 297                  * @param mainVolume
 298                  * @param sinkID
 299                  */
 300                 virtual am_Error_e changeSinkMainVolumeDB(const am_mainVolume_t mainVolume, const am_sinkID_t sinkID) =0;
 301                 /**
 302                  * changes the availablility of a sink\r
 303                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 304                  *
 305                  * @param availability
 306                  * @param sinkID
 307                  */
 308                 virtual am_Error_e changeSinkAvailabilityDB(const am_Availability_s& availability, const am_sinkID_t sinkID) =0;
 309                 /**
 310                  * changes the domainstate of a domain \r
 311                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 312                  *
 313                  * @param domainState
 314                  * @param domainID
 315                  */
 316                 virtual am_Error_e changDomainStateDB(const am_DomainState_e domainState, const am_domainID_t domainID) =0;
 317                 /**
 318                  * changes the mute state of a sink\r
 319                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 320                  *
 321                  * @param muteState
 322                  * @param sinkID
 323                  */
 324                 virtual am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID) =0;
 325                 /**
 326                  * changes the mainsinksoundproperty of a sink\r
 327                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 328                  *
 329                  * @param soundProperty
 330                  * @param sinkID
 331                  */
 332                 virtual am_Error_e changeMainSinkSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;
 333                 /**
 334                  * changes the mainsourcesoundproperty of a sink\r
 335                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
 336                  *
 337                  * @param soundProperty
 338                  * @param sourceID
 339                  */
 340                 virtual am_Error_e changeMainSourceSoundPropertyDB(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
 341                 /**
 342                  * changes the availablility of a source\r
 343                  * @return E_OK on success, E_DATABASE_ERROR  on error, E_NON_EXISTENT if source was not found
 344                  *
 345                  * @param availability
 346                  * @param sourceID
 347                  */
 348                 virtual am_Error_e changeSourceAvailabilityDB(const am_Availability_s& availability, const am_sourceID_t sourceID) =0;
 349                 /**
 350                  * changes a systemProperty\r
 351                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if property was not found
 352                  *
 353                  * @param property
 354                  */
 355                 virtual am_Error_e changeSystemPropertyDB(const am_SystemProperty_s& property) =0;
 356                 /**
 357                  * removes a mainconnection from the DB\r
 358                  * @return E_OK on success, E_NON_EXISTENT if main connection was not found, E_DATABASE_ERROR if the database had an error
 359                  *
 360                  * @param mainConnectionID
 361                  */
 362                 virtual am_Error_e removeMainConnectionDB(const am_mainConnectionID_t mainConnectionID) =0;
 363                 /**
 364                  * removes a sink from the DB\r
 365                  * @return E_OK on success, E_NON_EXISTENT if sink was not found, E_DATABASE_ERROR if the database had an error
 366                  *
 367                  * @param sinkID
 368                  */
 369                 virtual am_Error_e removeSinkDB(const am_sinkID_t sinkID) =0;
 370                 /**
 371                  * removes a source from the DB\r
 372                  * @return E_OK on success, E_NON_EXISTENT if source was not found, E_DATABASE_ERROR if the database had an error
 373                  *
 374                  * @param sourceID
 375                  */
 376                 virtual am_Error_e removeSourceDB(const am_sourceID_t sourceID) =0;
 377                 /**
 378                  * removes a gateway from the DB\r
 379                  * @return E_OK on success, E_NON_EXISTENT if gateway was not found, E_DATABASE_ERROR if the database had an error
 380                  *
 381                  * @param gatewayID
 382                  */
 383                 virtual am_Error_e removeGatewayDB(const am_gatewayID_t gatewayID) =0;
 384                 /**
 385                  * removes a crossfader from the DB\r
 386                  * @return E_OK on success, E_NON_EXISTENT if crossfader was not found, E_DATABASE_ERROR if the database had an error
 387                  *
 388                  * @param crossfaderID
 389                  */
 390                 virtual am_Error_e removeCrossfaderDB(const am_crossfaderID_t crossfaderID) =0;
 391                 /**
 392                  * removes a domain from the DB\r
 393                  * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
 394                  *
 395                  * @param domainID
 396                  */
 397                 virtual am_Error_e removeDomainDB(const am_domainID_t domainID) =0;
 398                 /**
 399                  * removes a domain from the DB\r
 400                  * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
 401                  *
 402                  * @param sinkClassID
 403                  */
 404                 virtual am_Error_e removeSinkClassDB(const am_sinkClass_t sinkClassID) =0;
 405                 /**
 406                  * removes a domain from the DB\r
 407                  * @return E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error
 408                  *
 409                  * @param sourceClassID
 410                  */
 411                 virtual am_Error_e removeSourceClassDB(const am_sourceClass_t sourceClassID) =0;
 412                 /**
 413                  * returns the ClassInformation of a source\r
 414                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found
 415                  *
 416                  * @param sourceID
 417                  * @param classInfo
 418                  */
 419                 virtual am_Error_e getSourceClassInfoDB(const am_sourceID_t sourceID, am_SourceClass_s& classInfo) const =0;
 420                 /**
 421                  * returns the ClassInformation of a sink\r
 422                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 423                  *
 424                  * @param sinkID
 425                  * @param sinkClass
 426                  */
 427                 virtual am_Error_e getSinkClassInfoDB(const am_sinkID_t sinkID, am_SinkClass_s& sinkClass) const =0;
 428                 /**
 429                  * returns the sinkData of a sink\r
 430                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 431                  *
 432                  * @param sinkID
 433                  * @param sinkData
 434                  */
 435                 virtual am_Error_e getSinkInfoDB(const am_sinkID_t sinkID, am_Sink_s& sinkData) const =0;
 436                 /**
 437                  * returns the sourcekData of a source\r
 438                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found
 439                  *
 440                  * @param sourceID
 441                  * @param sourceData
 442                  */
 443                 virtual am_Error_e getSourceInfoDB(const am_sourceID_t sourceID, am_Source_s& sourceData) const =0;
 444                 /**
 445                  * return source and sink of a gateway\r
 446                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if gateway was not found
 447                  *
 448                  * @param gatewayID
 449                  * @param gatewayData
 450                  */
 451                 virtual am_Error_e getGatewayInfoDB(const am_gatewayID_t gatewayID, am_Gateway_s& gatewayData) const =0;
 452                 /**
 453                  * returns sources and the sink of a crossfader\r
 454                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found
 455                  *
 456                  * @param crossfaderID
 457                  * @param crossfaderData
 458                  */
 459                 virtual am_Error_e getCrossfaderInfoDB(const am_crossfaderID_t crossfaderID, am_Crossfader_s& crossfaderData) const =0;
 460                 /**
 461                  * returns sources and the sink of a crossfader\r
 462                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found
 463                  *
 464                  * @param mainConnectionID
 465                  * @param mainConnectionData
 466                  */
 467                 virtual am_Error_e getMainConnectionInfoDB(const am_mainConnectionID_t mainConnectionID, am_MainConnection_s& mainConnectionData) const =0;
 468                 /**
 469                  * returns all sinks of a domain\r
 470                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 471                  *
 472                  * @param domainID
 473                  * @param listSinkID
 474                  */
 475                 virtual am_Error_e getListSinksOfDomain(const am_domainID_t domainID, std::vector<am_sinkID_t>& listSinkID) const =0;
 476                 /**
 477                  * returns all source of a domain\r
 478                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 479                  *
 480                  * @param domainID
 481                  * @param listSourceID
 482                  */
 483                 virtual am_Error_e getListSourcesOfDomain(const am_domainID_t domainID, std::vector<am_sourceID_t>& listSourceID) const =0;
 484                 /**
 485                  * returns all crossfaders of a domain\r
 486                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 487                  *
 488                  * @param domainID
 489                  * @param listCrossfadersID
 490                  */
 491                 virtual am_Error_e getListCrossfadersOfDomain(const am_domainID_t domainID, std::vector<am_crossfaderID_t>& listCrossfadersID) const =0;
 492                 /**
 493                  * returns all gateways of a domain\r
 494                  * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found
 495                  *
 496                  * @param domainID
 497                  * @param listGatewaysID
 498                  */
 499                 virtual am_Error_e getListGatewaysOfDomain(const am_domainID_t domainID, std::vector<am_gatewayID_t>& listGatewaysID) const =0;
 500                 /**
 501                  * returns a complete list of all MainConnections\r
 502                  * @return E_OK on success, E_DATABASE_ERROR on error
 503                  *
 504                  * @param listMainConnections
 505                  */
 506                 virtual am_Error_e getListMainConnections(std::vector<am_MainConnection_s>& listMainConnections) const =0;
 507                 /**
 508                  * returns a complete list of all domains\r
 509                  * @return E_OK on success, E_DATABASE_ERROR on error
 510                  *
 511                  * @param listDomains
 512                  */
 513                 virtual am_Error_e getListDomains(std::vector<am_Domain_s>& listDomains) const =0;
 514                 /**
 515                  * returns a complete list of all Connections\r
 516                  * @return E_OK on success, E_DATABASE_ERROR on error
 517                  *
 518                  * @param listConnections
 519                  */
 520                 virtual am_Error_e getListConnections(std::vector<am_Connection_s>& listConnections) const =0;
 521                 /**
 522                  * returns a list of all sinks\r
 523                  * @return E_OK on success, E_DATABASE_ERROR on error
 524                  *
 525                  * @param listSinks
 526                  */
 527                 virtual am_Error_e getListSinks(std::vector<am_Sink_s>& listSinks) const =0;
 528                 /**
 529                  * returns a list of all sources\r
 530                  * @return E_OK on success, E_DATABASE_ERROR on error
 531                  *
 532                  * @param listSources
 533                  */
 534                 virtual am_Error_e getListSources(std::vector<am_Source_s>& listSources) const =0;
 535                 /**
 536                  * returns a list of all source classes\r
 537                  * @return E_OK on success, E_DATABASE_ERROR on error
 538                  *
 539                  * @param listSourceClasses
 540                  */
 541                 virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const =0;
 542                 /**
 543                  * returns a list of all handles\r
 544                  * @return E_OK on success, E_DATABASE_ERROR on error
 545                  *
 546                  * @param listHandles
 547                  */
 548                 virtual am_Error_e getListHandles(std::vector<am_Handle_s>& listHandles) const =0;
 549                 /**
 550                  * returns a list of all crossfaders\r
 551                  * @return E_OK on success, E_DATABASE_ERROR on error
 552                  *
 553                  * @param listCrossfaders
 554                  */
 555                 virtual am_Error_e getListCrossfaders(std::vector<am_Crossfader_s>& listCrossfaders) const =0;
 556                 /**
 557                  * returns a list of  gateways\r
 558                  * @return E_OK on success, E_DATABASE_ERROR on error
 559                  *
 560                  * @param listGateways
 561                  */
 562                 virtual am_Error_e getListGateways(std::vector<am_Gateway_s>& listGateways) const =0;
 563                 /**
 564                  * returns a list of all sink classes\r
 565                  * @return E_OK on success, E_DATABASE_ERROR on error
 566                  *
 567                  * @param listSinkClasses
 568                  */
 569                 virtual am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const =0;
 570                 /**
 571                  * returns the list of SystemProperties
 572                  *
 573                  * @param listSystemProperties
 574                  */
 575                 virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
 576                 /**
 577                  * sets the command interface to ready. Will send setCommandReady to each of the plugins. The corresponding answer is confirmCommandReady.
 578                  */
 579                 virtual void setCommandReady() =0;
 580                 /**
 581                  * sets the command interface into the rundown state. Will send setCommandRundown to each of the plugins. The corresponding answer is confirmCommandRundown.
 582                  */
 583                 virtual void setCommandRundown() =0;
 584                 /**
 585                  * sets the routinginterface to  ready. Will send the command  setRoutingReady to each of the plugins. The related answer is confirmRoutingReady.
 586                  */
 587                 virtual void setRoutingReady() =0;
 588                 /**
 589                  * sets the routinginterface to the rundown state. Will send the command  setRoutingRundown to each of the plugins. The related answer is confirmRoutingRundown.
 590                  */
 591                 virtual void setRoutingRundown() =0;
 592                 /**
 593                  * acknowledges the setControllerReady call.
 594                  */
 595                 virtual void confirmControllerReady() =0;
 596                 /**
 597                  * acknowledges the setControllerRundown call.
 598                  */
 599                 virtual void confirmControllerRundown() =0;
 600                 /**
 601                  * 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
 602                  * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,
 603                  *
 604                  * @param socketHandler
 605                  */
 606                 virtual am_Error_e getSocketHandler(CAmSocketHandler*& socketHandler) =0;
 607                 /**
 608                  * This function returns the version of the interface
 609                  *
 610                  * @param version
 611                  */
 612                 virtual void getInterfaceVersion(std::string& version) const =0;
 613
 614         };
 615 }
 616 #endif // !defined(EA_9408C8ED_AF20_4839_B557_1316C8F36E07__INCLUDED_)