sbIMediacoreMultibandEqualizer.idl
Go to the documentation of this file.
1 /*
2  //
3 // BEGIN SONGBIRD GPL
4 //
5 // This file is part of the Songbird web player.
6 //
7 // Copyright(c) 2005-2009 POTI, Inc.
8 // http://songbirdnest.com
9 //
10 // This file may be licensed under the terms of of the
11 // GNU General Public License Version 2 (the "GPL").
12 //
13 // Software distributed under the License is distributed
14 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
15 // express or implied. See the GPL for the specific language
16 // governing rights and limitations.
17 //
18 // You should have received a copy of the GPL along with this
19 // program. If not, go to http://www.gnu.org/licenses/gpl.html
20 // or write to the Free Software Foundation, Inc.,
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 //
23 // END SONGBIRD GPL
24 //
25  */
26 
27 #include "nsISupports.idl"
28 
29 interface nsISimpleEnumerator;
30 
31 [scriptable, uuid(e88ad08d-eeea-4550-afa5-0f847fdc4dbd)]
33 {
37  attribute unsigned long index;
41  attribute unsigned long frequency;
45  attribute double gain;
46 
53  void init(in unsigned long aIndex, in unsigned long aFrequency, in double aGain);
54 
58  void getValues(out unsigned long aIndex, out unsigned long aFrequency, out double aGain);
59 
63  void setValues(in unsigned long aIndex, in unsigned long aFrequency, in double aGain);
64 };
65 
66 [scriptable, uuid(4bb5b39b-6ae2-45e8-a7e8-b46daf22d9fb)]
68 {
72  attribute boolean eqEnabled;
81  readonly attribute unsigned long bandCount;
88  attribute AString currentPresetName;
92  sbIMediacoreEqualizerBand getBand(in unsigned long aBandIndex);
96  void setBand(in sbIMediacoreEqualizerBand aBand);
97 };
98 
99 %{C++
100 
101 #define SB_MEDIACORE_EQUALIZER_BAND_DESCRIPTION \
102  "Songbird Mediacore Equalizer Band"
103 #define SB_MEDIACORE_EQUALIZER_BAND_CONTRACTID \
104  "@songbirdnest.com/Songbird/Mediacore/equalizerband;1"
105 #define SB_MEDIACORE_EQUALIZER_BAND_CLASSNAME \
106  "sbMediacoreEqualizerBand"
107 #define SB_MEDIACORE_EQUALIZER_BAND_CID \
108  {0x2133a879, 0x337b, 0x4f64, {0x92, 0x4a, 0x2a, 0xd8, 0x51, 0x30, 0xae, 0x6c}}
109 
110 %};
void getValues(out unsigned long aIndex, out unsigned long aFrequency, out double aGain)
Get all the values in the equalizer band object.
readonly attribute unsigned long bandCount
The number of bands available.
attribute unsigned long index
The index of the band in the EQ (eg. band 0).
void setBand(in sbIMediacoreEqualizerBand aBand)
Set a band.
sbIMediacoreEqualizerBand getBand(in unsigned long aBandIndex)
Get a band.
attribute AString currentPresetName
The name of the current equalizer preset.
var uuid
void init(in unsigned long aIndex, in unsigned long aFrequency, in double aGain)
Initialize the equalizer band object.
function C(H)
attribute boolean eqEnabled
Whether the EQ is enabled or not.
attribute unsigned long frequency
Frequency in Hz.
attribute nsISimpleEnumerator bands
Enumerator containing all available bands.
attribute double gain
Gain in dB. Valid range is from -1 to 1.
void setValues(in unsigned long aIndex, in unsigned long aFrequency, in double aGain)
Set all the values in the equalizer band object.