CLAM-Development  1.4.0
Public Member Functions
CLAM::PANetworkPlayer Class Reference

#include <PANetworkPlayer.hxx>

List of all members.

Public Member Functions

 PANetworkPlayer (const std::string &networkFile)
 PANetworkPlayer ()
virtual ~PANetworkPlayer ()
bool IsWorking ()
 Should return true when the backend is able to run the network.
std::string NonWorkingReason ()
 Whenever the backend is not working, this method returns the reason.
virtual bool IsRealTime () const
virtual void Start ()
 Redefine to make the backend ready to process and start the network. If IsPlaying() should do nothing. If it IsPaused() you should consider just call BePlaying() without starting the processings.
virtual void Stop ()
 Redefine it to deactivate the backend.
- Public Member Functions inherited from CLAM::NetworkPlayer
 NetworkPlayer ()
virtual ~NetworkPlayer ()
virtual void Init ()
 Redefine to add any initialization after being attached to a network TODO: Consider removing it as just Jack backend uses it but it is redundant.
virtual void Pause ()
void SetNetworkBackLink (Network &net)
void BePaused ()
void BeStopped ()
void BePlaying ()
bool IsPaused () const
bool IsStopped () const
bool IsPlaying () const
virtual unsigned BackendBufferSize ()
virtual unsigned BackendSampleRate ()
std::string SourcesAndSinksToString ()

Additional Inherited Members

- Protected Types inherited from CLAM::NetworkPlayer
enum  Status { Playing = 0, Stopped = 1, Paused = 2 }
- Protected Member Functions inherited from CLAM::NetworkPlayer
NetworkGetNetwork ()
unsigned GetNSinks () const
unsigned GetNSources () const
void CacheSourcesAndSinks ()
const std::string & SourceName (unsigned source) const
const std::string & SinkName (unsigned sink) const
void SetSourceBuffer (unsigned source, const float *data, unsigned nframes)
void SetSinkBuffer (unsigned sink, float *data, unsigned nframes)
void SetSinkFrameSize (unsigned sink, unsigned frameSize)
void SetSourceFrameSize (unsigned source, unsigned frameSize)

Detailed Description

Definition at line 34 of file PANetworkPlayer.hxx.


Constructor & Destructor Documentation

CLAM::PANetworkPlayer::PANetworkPlayer ( const std::string &  networkFile)
CLAM::PANetworkPlayer::PANetworkPlayer ( )

Definition at line 79 of file PANetworkPlayer.cxx.

CLAM::PANetworkPlayer::~PANetworkPlayer ( )
virtual

Definition at line 87 of file PANetworkPlayer.cxx.

References Stop().


Member Function Documentation

virtual bool CLAM::PANetworkPlayer::IsRealTime ( ) const
inlinevirtual

Implements CLAM::NetworkPlayer.

Definition at line 54 of file PANetworkPlayer.hxx.

bool CLAM::PANetworkPlayer::IsWorking ( )
virtual

Should return true when the backend is able to run the network.

Implements CLAM::NetworkPlayer.

Definition at line 232 of file PANetworkPlayer.cxx.

std::string CLAM::PANetworkPlayer::NonWorkingReason ( )
virtual

Whenever the backend is not working, this method returns the reason.

Implements CLAM::NetworkPlayer.

Definition at line 237 of file PANetworkPlayer.cxx.

void CLAM::PANetworkPlayer::Start ( )
virtual

Redefine to make the backend ready to process and start the network. If IsPlaying() should do nothing. If it IsPaused() you should consider just call BePlaying() without starting the processings.

Implements CLAM::NetworkPlayer.

Definition at line 92 of file PANetworkPlayer.cxx.

References CLAM::NetworkPlayer::BePlaying(), CLAM::NetworkPlayer::CacheSourcesAndSinks(), CLAM_ASSERT, CLAM::NetworkPlayer::GetNSinks(), CLAM::NetworkPlayer::GetNSources(), CLAM::NetworkPlayer::IsPaused(), CLAM::NetworkPlayer::IsPlaying(), and NULL.

void CLAM::PANetworkPlayer::Stop ( )
virtual

Redefine it to deactivate the backend.

Implements CLAM::NetworkPlayer.

Definition at line 219 of file PANetworkPlayer.cxx.

References CLAM::NetworkPlayer::BeStopped(), and CLAM::NetworkPlayer::IsStopped().

Referenced by ~PANetworkPlayer().


The documentation for this class was generated from the following files: