sbIMediacoreEqualizerBand Interface Reference

import"sbIMediacoreMultibandEqualizer.idl";

Inheritance diagram for sbIMediacoreEqualizerBand:
[legend]
Collaboration diagram for sbIMediacoreEqualizerBand:
[legend]

Public Member Functions

void init (in unsigned long aIndex, in unsigned long aFrequency, in double aGain)
 Initialize the equalizer band object. More...
 
void getValues (out unsigned long aIndex, out unsigned long aFrequency, out double aGain)
 Get all the values in the equalizer band object. More...
 
void setValues (in unsigned long aIndex, in unsigned long aFrequency, in double aGain)
 Set all the values in the equalizer band object. More...
 

Public Attributes

attribute unsigned long index
 The index of the band in the EQ (eg. band 0). More...
 
attribute unsigned long frequency
 Frequency in Hz. More...
 
attribute double gain
 Gain in dB. Valid range is from -1 to 1. More...
 

Detailed Description

Definition at line 32 of file sbIMediacoreMultibandEqualizer.idl.

Member Function Documentation

void sbIMediacoreEqualizerBand::getValues ( out unsigned long  aIndex,
out unsigned long  aFrequency,
out double  aGain 
)

Get all the values in the equalizer band object.

void sbIMediacoreEqualizerBand::init ( in unsigned long  aIndex,
in unsigned long  aFrequency,
in double  aGain 
)

Initialize the equalizer band object.

Parameters
aIndex- The index of the band (eg. band 1).
aFrequency- The frequency band, in Hz.
aGain- The gain value from -1 to 1.
void sbIMediacoreEqualizerBand::setValues ( in unsigned long  aIndex,
in unsigned long  aFrequency,
in double  aGain 
)

Set all the values in the equalizer band object.

Member Data Documentation

attribute unsigned long sbIMediacoreEqualizerBand::frequency

Frequency in Hz.

Definition at line 41 of file sbIMediacoreMultibandEqualizer.idl.

attribute double sbIMediacoreEqualizerBand::gain

Gain in dB. Valid range is from -1 to 1.

Definition at line 45 of file sbIMediacoreMultibandEqualizer.idl.

attribute unsigned long sbIMediacoreEqualizerBand::index

The index of the band in the EQ (eg. band 0).

Definition at line 37 of file sbIMediacoreMultibandEqualizer.idl.


The documentation for this interface was generated from the following file: