Noatun API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

Visualization Class Reference

Base class for all sorts of visualizations. More...

#include <plugin.h>

Inheritance diagram for Visualization:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Visualization (int interval=125, int pid=0)
virtual void start ()
virtual void stop ()
int interval () const
virtual void setInterval (int msecs)
virtual void timeout ()=0
Noatun::StereoEffectStack visualizationStack ()
Arts::SoundServerV2 * server ()
bool connected ()

Static Public Member Functions

int noatunPid ()
void initDispatcher ()

Detailed Description

Base class for all sorts of visualizations.

all Noatun Visualizations can be in separate processes! You must fork, and then exec() to be able to use this. Its perfectly safe to create a visualization in a binary executed by KProcess.

Definition at line 82 of file plugin.h.

Constructor & Destructor Documentation

Visualization::Visualization (  int  interval = 125,
int  pid = 0
) 
 

interval is how frequently the rescope will occur 0 means disabled

Pid, if not zero, can force the visualizaton to use another noatun's process's visualization stack, if it is zero, it'l try to guess what to use

Member Function Documentation

bool Visualization::connected (   ) 
 

test if the server is still there

void Visualization::initDispatcher (   )  [static]
 

create a dispatcher object , does nothing if this already has been called

int Visualization::interval (   )  const
 

how long between each rescoping in milliseconds

int Visualization::noatunPid (   )  [static]
 

return noatun's pid, useful if you're doing remote-visualization

It returns the pid to use, or -1, if there was an error, or there isn't a noatun running. If there isn't a noatun running, the computer will crash, the trains will take the wrong tracks, time will start moving in the wrong direction, and the whole universe will melt down.

virtual void Visualization::setInterval (  int  msecs  )  [virtual]
 

set how long to wait the change takes effect immediately, unless it hadn't been start()ed beforehand

virtual void Visualization::start (   )  [virtual]
 

start the timer, if it's 0, then this will do nothing.

virtual void Visualization::stop (   )  [virtual]
 

stop the timer

virtual void Visualization::timeout (   )  [pure virtual]
 

cause a rescoping to take effect immediately

Implemented in StereoFFTScope, MonoFFTScope, MonoScope, and StereoScope.

The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for Noatun 2.6.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 23:49:50 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003