AudioMeter Class Reference

AudioMeter widget. More...

Inheritance diagram for AudioMeter:

Public Member Functions
	AudioMeter (string name, Element element, bool isVertical, int busId, bool useOutput)
	creates an AudioMeter widget on the user inteface. More...
void	setStripImage (string imagePath, int numImages)

Public Attributes
number	alpha
	transparency value between 0.0 and 1.0
string	backgroundColour
	background colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
table	bounds
	widget bounding rect {x,y,width,height}
function	changed
	callback function used by child widgets to be notified of changes
bool	displayAsMono
	should we display only one meter (sum) for multichannel bus
string	displayName
	widget display name
bool	displayScale
	should we display the dB scale
bool	enabled
	boolean flag to enable / disable the widget
string	foregroundColour
	foregroun colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
int	height
	widget height in pixels
bool	interceptsMouseClicks
	boolean flag to toggle mouse handling on widget
string	name
	widget name
string	overColour
	overflow (> 0dB) colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
bool	persistent
	flag to tell if the widget values should be serialized when saving. True by default. Persistent widgets will call their changed function on reload
table	position
	widget position {x,y}
bool	showLabel
	show widgets label if any
table	size
	widget size {width, height}
string	textColour
	text colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
string	tooltip
	widget tooltip, default is name
bool	visible
	boolean flag to toggle widget visibility
int	width
	widget width in pixels
int	x
	x position in pixels
int	y
	y position in pixels
string	⠀0dBColour
	use ["0dBColour"] notation as the script does not like properties that start with a number. [-3, -10] dB colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
string	⠀10dBColour
	use ["10dBColour"] notation as the script does not like properties that start with a number. [-inf, -10] dB colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
string	⠀3dBColour
	use ["3dBColour"] notation as the script does not like properties that start with a number. [-6, -3] dB colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
string	⠀6dBColour
	use ["6dBColour"] notation as the script does not like properties that start with a number . [-10, -6] dB colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format

Detailed Description

AudioMeter widget.

Creates an AudioMeter widget on the user inteface.

meter = AudioMeter("out", Program, true, 0, true)
meter.bounds = {250, 0, 40, 100}
meter["0dBColour"] = "red" -- we cannot use meter.0dBColour: this is a valid property, but not a valid lua identifier
meter["10dBColour"] = "blue"

Constructor & Destructor Documentation

AudioMeter::AudioMeter	(	string	name,
		Element	element,
		bool	isVertical,
		int	busId,
		bool	useOutput
	)

creates an AudioMeter widget on the user inteface.

–

Parameters

name	the name to give to the widget –
element	the element bus to listen to (ex Program, Program.layers[1]) –
isVertical	vertical or horizontal audio meter –
busId	0 by default –
useOutput	use either input or output of the bus

Member Function Documentation

void AudioMeter::setStripImage	(	string	imagePath,
		int	numImages
	)

Parameters

imagePath	path to audio meter strip image
numImages	number of images in strip