VuMeter Class Reference

A level meter that for showing peak values. More...

Inherits Component, and SettableTooltipClient.

Public Types
enum	ColourId { outlineColour = 0, ledColour, backgroundColour }
	The ColourIds that can be changed with setColour. More...
enum	Type { MonoHorizontal = 0, MonoVertical, StereoHorizontal, StereoVertical }
	The Style of the vu meter. More...

Public Member Functions
void	setColour (ColourId id, Colour newColour)
	Change the colour of the VuMeter. More...
void	setPeak (float left, float right=0.0f)
	sets a new peak level. More...
void	setType (Type newType)
	Change the Type of the VuMeter. More...
	VuMeter (float leftPeak=0.0f, float rightPeak=0.0f, Type t=MonoHorizontal)
	Creates a new VuMeter. More...

Detailed Description

A level meter that for showing peak values.

The best practice for using one of those is a Timer that regularly calls setPeak() in its timerCallback().

Member Enumeration Documentation

enum ColourId

The ColourIds that can be changed with setColour.

Enumerator
outlineColour	the outline colour
ledColour	the colour of the segmented leds or the mono-bar
backgroundColour	the background colour

enum Type

The Style of the vu meter.

Enumerator
MonoHorizontal	a non segmented mono meter with linear range (0.0 - 1.0)
MonoVertical	a vertical version of the MonoHorizontal Style (not yet implemented)
StereoHorizontal	a segmented stereo meter with logarithmic range (-100dB - 0dB)
StereoVertical	a vertical version of StereoHorizontal

Constructor & Destructor Documentation

VuMeter	(	float	leftPeak = 0.0f,
		float	rightPeak = 0.0f,
		Type	t = MonoHorizontal
	)

Creates a new VuMeter.

Member Function Documentation

void setColour ( ColourId  id, Colour  newColour  )

inline

Change the colour of the VuMeter.

void setPeak	(	float	left,
		float	right = 0.0f
	)

sets a new peak level.

For stereo meters there is a peak logic with decibel conversion and decreasing level, and for monophonic VuMeters it simply displays the 'left' value.

void setType

(

Type

newType

)

Change the Type of the VuMeter.