uk.org.toot.audio.meter
Class MeterControls

java.lang.Object
  extended by java.util.Observable
      extended by uk.org.toot.control.Control
          extended by uk.org.toot.control.CompoundControl
              extended by uk.org.toot.audio.core.AudioControls
                  extended by uk.org.toot.audio.meter.MeterControls

public class MeterControls
extends AudioControls

MeterControls provides composite controls for MeterProcess.


Nested Class Summary
static class MeterControls.ChannelState
          A ChannelState represents the states of a particular meter channel.
static class MeterControls.MeterIndicator
          A MeterIndicator is the primary meter 'movement', the main reason for these controls.
static class MeterControls.MindBControl
          A MindBControl concretizes EnumControl with various minimum dB values for the meter (display), from -12dB to -100dB, suitable for both normal operation and calibration.
static class MeterControls.OverIndicator
          Somewhat unusually, OverIndicator extends Control directly, to use its Observer pattern support to indicate state changes.
 class MeterControls.ResetControl
          A ResetControl is a momentary acting BooleanControl that resets the 'overs' and 'maxima' states.
static class MeterControls.TypeControl
          A TypeControl concretizes EnumControl with the different K-System meter types, K-20/RMS, K-14/RMS and K-12/RMS.
 
Nested classes/interfaces inherited from class uk.org.toot.control.CompoundControl
CompoundControl.BypassControl
 
Field Summary
static int METER
           
static int METER_INDICATOR
           
static int METER_MIN_DB
           
static int METER_OVERS
           
static int METER_RESET
           
static int METER_TYPE
           
 
Fields inherited from class uk.org.toot.control.CompoundControl
USE_PARENT_PROVIDER_ID
 
Constructor Summary
MeterControls(ChannelFormat format, java.lang.String name)
           
 
Method Summary
 void addOvers(int chan, int overs)
           
 ChannelFormat getChannelFormat()
           
 float getMaxdB()
           
 MeterControls.MeterIndicator getMeterIndicator()
           
 float getMindB()
           
 MeterControls.ChannelState getState(int chan)
           
 boolean isAlwaysVertical()
           
 void resetMaxima()
           
 void resetOvers()
           
 void setAverage(int chan, float average)
           
 void setPeak(int chan, float peak)
           
 void setUpdateTime(float ms)
           
 
Methods inherited from class uk.org.toot.audio.core.AudioControls
canBeMinimized, canBypass, getBypassControl, getPersistenceDomain, hasOrderedFrequencies, isBypassed, setBypassed
 
Methods inherited from class uk.org.toot.control.CompoundControl
canBeDeleted, canBeInsertedBefore, canBeMoved, canBeMovedBefore, deepFind, find, find, find, getAlignmentY, getAlternate, getClientProperty, getControls, getInstanceIndex, getMemberControls, getNativeSupport, getPersistence, getProviderId, hasCustomUI, hasPresets, isAlwaysHorizontal, isNeverBordered, isPluginParent, putClientProperty, setEnabled, setPersistence, setProviderId, toString
 
Methods inherited from class uk.org.toot.control.Control
getAnnotation, getControlPath, getControlPath, getId, getIntValue, getName, getParent, getValueString, isAdjusting, isEnabled, isHidden, isIndicator, setAdjusting, setAnnotation, setHidden, setIntValue, setName
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

METER

public static final int METER
See Also:
Constant Field Values

METER_TYPE

public static final int METER_TYPE
See Also:
Constant Field Values

METER_RESET

public static final int METER_RESET
See Also:
Constant Field Values

METER_OVERS

public static final int METER_OVERS
See Also:
Constant Field Values

METER_INDICATOR

public static final int METER_INDICATOR
See Also:
Constant Field Values

METER_MIN_DB

public static final int METER_MIN_DB
See Also:
Constant Field Values
Constructor Detail

MeterControls

public MeterControls(ChannelFormat format,
                     java.lang.String name)
Method Detail

isAlwaysVertical

public boolean isAlwaysVertical()
Overrides:
isAlwaysVertical in class CompoundControl

getMeterIndicator

public MeterControls.MeterIndicator getMeterIndicator()

getMaxdB

public float getMaxdB()

getMindB

public float getMindB()

getChannelFormat

public ChannelFormat getChannelFormat()

getState

public MeterControls.ChannelState getState(int chan)

resetOvers

public void resetOvers()

resetMaxima

public void resetMaxima()

addOvers

public void addOvers(int chan,
                     int overs)

setPeak

public void setPeak(int chan,
                    float peak)

setAverage

public void setAverage(int chan,
                       float average)

setUpdateTime

public void setUpdateTime(float ms)


Copyright © 2004, 2005, 2006, 2007 Steve Taylor. All Rights Reserved.