pav::lib::Visualization Interface Reference

List of all members.

Public Member Functions
void	addVisualizer (Visualizer visualizer, String name) throws PAVException
void	addVisualizer (Visualizer visualizer, int level) throws PAVException
void	addVisualizer (Visualizer visualizer, int level, String name) throws PAVException
void	removeVisualizer (Visualizer visualizer)
void	removeVisualizer (String name)
void	removeVisualizerAt (int level)
Visualizer	getVisualizer (int level)
Visualizer	getVisualizer (String name)
Map< Integer, Visualizer >	getVisualizers ()
int	numVisualizers ()
void	setSampleRate (float rate)
void	process (float[] frame) throws PAVException
Package Functions
void	addVisualizer (Visualizer visualizer) throws PAVException

---

Detailed Description

A visualization, comprised of a number of visualizers.

Author:

christopher

---

Member Function Documentation

void pav::lib::Visualization::addVisualizer

(

Visualizer

visualizer

)

throws PAVException [package]

Adds a new visualizer. The new visualizer will be drawn last.

Parameters:

visualizer

The visualizer to add. Must not be null

Exceptions:

PAVException

If an error occured while adding the visualizer

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::addVisualizer	(	Visualizer	visualizer,
		String	name
	)			throws PAVException

Adds a new visualizer. The new visualizer will be drawn last.

Parameters:

	visualizer	The visualizer to add. Must not be null
	name	The name of the visualizer. Must be unique

Exceptions:

PAVException

If an error occured while adding the visualizer

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::addVisualizer	(	Visualizer	visualizer,
		int	level,
		String	name
	)			throws PAVException

Adds a new visualizer with a given level. The level specifies then the visualizer will be told to draw itself relative to the other visualizers. Visualizers with lower levels will be drawn first. If a visualizer with the given level already exists, it will be replaced.

Parameters:

	visualizer	The visualizer to add. Must not be null
	level	The level
	name	The name of the visualizer. Must be unique

Exceptions:

PAVException

If an error occured while adding the visualizer

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::addVisualizer	(	Visualizer	visualizer,
		int	level
	)			throws PAVException

Adds a new visualizer with a given level. The level specifies then the visualizer will be told to draw itself relative to the other visualizers. Visualizers with lower levels will be drawn first. If a visualizer with the given level already exists, it will be replaced.

Parameters:

	visualizer	The visualizer to add. Must not be null
	level	The level

Exceptions:

PAVException

If an error occured while adding the visualizer

Implemented in pav::lib::VisualizationImpl.

Visualizer pav::lib::Visualization::getVisualizer

(

int

level

)

Returns the visualizer that is located at the specified level. Returns null if no visualizer exists at that level.

Parameters:

level

The level

Returns:

The visualizer or null

Implemented in pav::lib::VisualizationImpl.

Visualizer pav::lib::Visualization::getVisualizer

(

String

name

)

Returns the visualizer with the given name or null if no such visualizer exists.

Parameters:

level

The visualizer name

Returns:

The visualizer or null

Implemented in pav::lib::VisualizationImpl.

Map<Integer, Visualizer> pav::lib::Visualization::getVisualizers

(

)

Gets all visualizers that are currently part of this visualization along with their associated level. The Map is be sorted, the visualizer with the lowest level is the first item in the list. The returned map must not be modified.

Returns:

A map containing all visualizers

Implemented in pav::lib::VisualizationImpl.

int pav::lib::Visualization::numVisualizers

(

)

Returns the number of visualizers this visualization contains.

Returns:

Number of visualizers

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::process

(

float[]

frame

)

throws PAVException

Tells the visualization to process.

Parameters:

frame

The next frame of the audio signal. Must not be null

Exceptions:

PAVException

On any errors

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::removeVisualizer

(

String

name

)

Removes the visualizer with the given name. Does nothing if the visualizer does not exist.

Parameters:

name

The name of the visualizer. Must not be null

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::removeVisualizer

(

Visualizer

visualizer

)

Removes a visualizer. Does nothing if the visualizer does not exist.

Parameters:

visualizer

The visualizer. Must not be null

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::removeVisualizerAt

(

int

level

)

Removes the visualizer at the specified level if it exists, otherwise does nothing.

Parameters:

level

The level

Implemented in pav::lib::VisualizationImpl.

void pav::lib::Visualization::setSampleRate

(

float

rate

)

Sets the audio sample rate.

Parameters:

rate

The sample rate. Must be > 0

Implemented in pav::lib::VisualizationImpl.

---

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

• src/pav/lib/Visualization.java