SlimDXc_Jun2010(VC++2008)/source/directsound/ParametricEqualizer.h

   1 /*\r
   2 * Copyright (c) 2007-2010 SlimDX Group\r
   3 * \r
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy\r
   5 * of this software and associated documentation files (the "Software"), to deal\r
   6 * in the Software without restriction, including without limitation the rights\r
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
   8 * copies of the Software, and to permit persons to whom the Software is\r
   9 * furnished to do so, subject to the following conditions:\r
  10 * \r
  11 * The above copyright notice and this permission notice shall be included in\r
  12 * all copies or substantial portions of the Software.\r
  13 * \r
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  20 * THE SOFTWARE.\r
  21 */\r
  22 #pragma once\r
  23 \r
  24 namespace SlimDX\r
  25 {\r
  26         namespace DirectSound\r
  27         {\r
  28                 /// <summary>\r
  29                 /// The SoundEffectParametricEqualizer object is used to set and retrieve effect parameters on a buffer that supports parametric equalizer effects.\r
  30                 /// </summary>\r
  31                 /// <unmanaged>IDirectSoundFXParamEq</unmanaged>\r
  32                 public ref class ParametricEqualizer : public ComObject\r
  33                 {\r
  34                         COMOBJECT(IDirectSoundFXParamEq, ParametricEqualizer);\r
  35 \r
  36                 public:\r
  37                         /// <summary>\r
  38                         /// Center frequency, in hertz. This value cannot exceed one-third of the frequency of the buffer. The default value is 8000.\r
  39                         /// </summary>\r
  40                         property float Center\r
  41                         {\r
  42                                 float get();\r
  43                                 void set( float value );\r
  44                         }\r
  45 \r
  46                         /// <summary>\r
  47                         /// Bandwidth, in semitones. The default value is 12.\r
  48                         /// </summary>\r
  49                         property float Bandwidth\r
  50                         {\r
  51                                 float get();\r
  52                                 void set( float value );\r
  53                         }\r
  54 \r
  55                         /// <summary>\r
  56                         /// Gain, The default value is 0.\r
  57                         /// </summary>\r
  58                         property float Gain\r
  59                         {\r
  60                                 float get();\r
  61                                 void set( float value );\r
  62                         }\r
  63 \r
  64                         /// <summary>\r
  65                         /// Default center frequency, in hertz.\r
  66                         /// </summary>\r
  67                         literal float CenterDefault = 8000.0f;\r
  68 \r
  69                         /// <summary>\r
  70                         /// Maximum center frequency, in hertz.\r
  71                         /// </summary>\r
  72                         literal float CenterMax = DSFXPARAMEQ_CENTER_MAX;\r
  73 \r
  74                         /// <summary>\r
  75                         /// Minimum center frequency, in hertz.\r
  76                         /// </summary>\r
  77                         literal float CenterMin = DSFXPARAMEQ_CENTER_MIN;\r
  78 \r
  79                         /// <summary>\r
  80                         /// Default bandwidth, in semitones.\r
  81                         /// </summary>\r
  82                         literal float BandwidthDefault = 12.0f;\r
  83 \r
  84                         /// <summary>\r
  85                         /// Maximum bandwidth, in semitones.\r
  86                         /// </summary>\r
  87                         literal float BandwidthMax = DSFXPARAMEQ_BANDWIDTH_MAX;\r
  88 \r
  89                         /// <summary>\r
  90                         /// Minimum bandwidth, in semitones.\r
  91                         /// </summary>\r
  92                         literal float BandwidthMin = DSFXPARAMEQ_BANDWIDTH_MIN;\r
  93 \r
  94                         /// <summary>\r
  95                         /// Default gain.\r
  96                         /// </summary>\r
  97                         literal float GainDefault = 0.0f;\r
  98 \r
  99                         /// <summary>\r
 100                         /// Maximum gain.\r
 101                         /// </summary>\r
 102                         literal float GainMax = DSFXPARAMEQ_GAIN_MAX;\r
 103 \r
 104                         /// <summary>\r
 105                         /// Minimum gain.\r
 106                         /// </summary>\r
 107                         literal float GainMin = DSFXPARAMEQ_GAIN_MIN;\r
 108                 };\r
 109         }\r
 110 }