includes/projecttypes.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_D441AD1F_B077_485c_AE04_AF1567A1359F__INCLUDED_)\r
  26 #define EA_D441AD1F_B077_485c_AE04_AF1567A1359F__INCLUDED_\r
  27 \r
  28 namespace am {\r
  29         /**\r
  30          * This enum classifies the format in which data is exchanged within a connection. The enum itself is project specific although there are some Genivi standard formats defined.\r
  31          * @author christian\r
  32          * @version 1.0\r
  33          * @created 19-Jan-2012 4:31:59 PM\r
  34          */\r
  35         enum am_ConnectionFormat_e\r
  36         {\r
  37                 CF_STEREO = 0,\r
  38                 CF_MONO = 1,\r
  39                 CF_ANALOG = 2,\r
  40                 CF_MAX = 3,\r
  41                 CF_MIN = CF_STEREO\r
  42         };\r
  43 \r
  44         /**\r
  45          * This enum gives the information about reason for reason for Source/Sink change\r
  46          * @author christian\r
  47          * @version 1.0\r
  48          * @created 19-Jan-2012 4:31:59 PM\r
  49          */\r
  50         enum am_AvailabilityReason_e\r
  51         {\r
  52                 AR_NEWMEDIA = 0,\r
  53                 AR_SAMEMEDIA = 1,\r
  54                 AR_NOMEDIA = 2,\r
  55                 AR_UNKNOWN = 3,\r
  56                 AR_TEMPERATURE = 4,\r
  57                 AR_VOLTAGE = 5,\r
  58                 AR_MAX = 6,\r
  59                 AR_MIN = AR_NEWMEDIA\r
  60         };\r
  61 \r
  62         /**\r
  63          * product specific identifier of property\r
  64          * @author christian\r
  65          * @version 1.0\r
  66          * @created 19-Jan-2012 4:31:59 PM\r
  67          */\r
  68         enum am_ClassProperty_e\r
  69         {\r
  70                 /**\r
  71                  * defines the source type of a source. Project specific, could be for example differentiation between interrupt source and main source.\r
  72                  */\r
  73                 CP_SOURCE_TYPE = 0,\r
  74                 /**\r
  75                  * defines the SINK_TYPE. Project specific\r
  76                  */\r
  77                 CP_SINK_TYPE = 1,\r
  78                 CP_MAX = 2,\r
  79                 CP_MIN = CP_SOURCE_TYPE\r
  80         };\r
  81 \r
  82         /**\r
  83          * The given ramp types here are just a possiblity. for products, different ramp types can be defined here.\r
  84          * It is in the responsibility of the product to make sure that the routing plugins are aware of the ramp types used.
  85          * @author christian
  86          * @version 1.0
  87          * @created 19-Jan-2012 4:31:59 PM
  88          */
  89         enum am_RampType_e
  90         {
  91                 /**
  92                  * this ramp type triggers a direct setting of the value without a ramp
  93                  */
  94                 RAMP_DIRECT = 0,
  95                 /**
  96                  * This ramp type will set the volume as fast as possible.
  97                  */
  98                 RAMP_NO_BLOB = 1,
  99                 RAMP_LOG = 2,
 100                 RAMP_STRAIGHT = 3,
 101                 RAMP_MAX = 4,
 102                 RAMP_MIN = RAMP_DIRECT
 103         };
 104
 105         /**
 106          * sound properties. Within genivi only the standard properties are defined, for products these need to be extended.
 107          * @author christian
 108          * @version 1.0
 109          * @created 19-Jan-2012 4:31:59 PM
 110          */
 111         enum am_SoundPropertyType_e
 112         {
 113                 SP_TREBLE = 0,
 114                 SP_MID = 1,
 115                 SP_BASS = 2,
 116                 SP_MAX = 3,
 117                 SP_MIN = SP_TREBLE
 118         };
 119
 120         /**
 121          * Here are all SoundProperties that can be set via the CommandInterface. Product specific
 122          * @author christian
 123          * @version 1.0
 124          * @created 19-Jan-2012 4:31:59 PM
 125          */
 126         enum am_MainSoundPropertyType_e
 127         {
 128                 /**
 129                  * gives the navigation offset in percent
 130                  */
 131                 MSP_NAVIGATION_OFFSET = 0,
 132                 MSP_TEST = 1,
 133                 MSP_MAX = 2,
 134                 MSP_MIN = MSP_NAVIGATION_OFFSET
 135         };
 136
 137         /**
 138          * describes the different system properties. Project specific
 139          * @author christian
 140          * @version 1.0
 141          * @created 19-Jan-2012 4:31:59 PM
 142          */
 143         enum am_SystemPropertyType_e
 144         {
 145                 SYP_TEST = 0,
 146                 SYP_MAX = 1,
 147                 SYP_MIN = SYP_TEST
 148         };
 149 }
 150 #endif // !defined(EA_D441AD1F_B077_485c_AE04_AF1567A1359F__INCLUDED_)