CLAM::JACKNetworkPlayer Class Reference

#include <JACKNetworkPlayer.hxx>

List of all members.

Classes

struct  JackConnection
 Memento to restore jack connection status.

Public Member Functions

 JACKNetworkPlayer (const std::string &name="CLAM network player")
virtual ~JACKNetworkPlayer ()
void InitClient ()
bool IsWorking ()
 Should return true when the backend is able to run the network.
virtual bool IsRealTime () const
std::string NonWorkingReason ()
 Whenever the backend is not working, this method returns the reason.
void RegisterPorts ()
void RegisterInputPorts (const Network &net)
void RegisterOutputPorts (const Network &net)
void UnRegisterPorts ()
void OnShutdown ()
void CopyJackBuffersToSources (const jack_nframes_t nframes)
void CopySinksToJackBuffers (const jack_nframes_t nframes)
void BlankJackBuffers (const jack_nframes_t nframes)
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.
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 unsigned BackendBufferSize ()
virtual unsigned BackendSampleRate ()
void Do (const jack_nframes_t nframes)
void StoreConnections ()
void RestoreConnections ()
void AutoConnectPorts ()

Detailed Description

Definition at line 14 of file JACKNetworkPlayer.hxx.


Constructor & Destructor Documentation

CLAM::JACKNetworkPlayer::JACKNetworkPlayer ( const std::string &  name = "CLAM network player"  ) 

Definition at line 19 of file JACKNetworkPlayer.cxx.

References OnShutdown().

CLAM::JACKNetworkPlayer::~JACKNetworkPlayer (  )  [virtual]

Definition at line 28 of file JACKNetworkPlayer.cxx.


Member Function Documentation

void CLAM::JACKNetworkPlayer::AutoConnectPorts (  ) 

Definition at line 296 of file JACKNetworkPlayer.cxx.

virtual unsigned CLAM::JACKNetworkPlayer::BackendBufferSize (  )  [inline, virtual]

Reimplemented from CLAM::NetworkPlayer.

Definition at line 75 of file JACKNetworkPlayer.hxx.

virtual unsigned CLAM::JACKNetworkPlayer::BackendSampleRate (  )  [inline, virtual]

Reimplemented from CLAM::NetworkPlayer.

Definition at line 80 of file JACKNetworkPlayer.hxx.

void CLAM::JACKNetworkPlayer::BlankJackBuffers ( const jack_nframes_t  nframes  ) 

Definition at line 164 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::SetSinkBuffer().

void CLAM::JACKNetworkPlayer::CopyJackBuffersToSources ( const jack_nframes_t  nframes  ) 

Definition at line 144 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::CopySinksToJackBuffers ( const jack_nframes_t  nframes  ) 

Definition at line 154 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::SetSourceBuffer().

void CLAM::JACKNetworkPlayer::Do ( const jack_nframes_t  nframes  ) 

Definition at line 230 of file JACKNetworkPlayer.cxx.

Referenced by CLAM::JackShutdownCallback().

void CLAM::JACKNetworkPlayer::Init (  )  [virtual]

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.

Reimplemented from CLAM::NetworkPlayer.

Definition at line 203 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::InitClient (  ) 

Definition at line 52 of file JACKNetworkPlayer.cxx.

virtual bool CLAM::JACKNetworkPlayer::IsRealTime (  )  const [inline, virtual]

Implements CLAM::NetworkPlayer.

Definition at line 55 of file JACKNetworkPlayer.hxx.

bool CLAM::JACKNetworkPlayer::IsWorking (  )  [virtual]

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

Implements CLAM::NetworkPlayer.

Definition at line 41 of file JACKNetworkPlayer.cxx.

std::string CLAM::JACKNetworkPlayer::NonWorkingReason (  )  [virtual]

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

Implements CLAM::NetworkPlayer.

Definition at line 46 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::OnShutdown (  ) 

Definition at line 207 of file JACKNetworkPlayer.cxx.

Referenced by JACKNetworkPlayer().

void CLAM::JACKNetworkPlayer::RegisterInputPorts ( const Network net  ) 
void CLAM::JACKNetworkPlayer::RegisterOutputPorts ( const Network net  ) 

Definition at line 106 of file JACKNetworkPlayer.cxx.

Referenced by RegisterInputPorts().

void CLAM::JACKNetworkPlayer::RegisterPorts (  ) 

Definition at line 85 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::RestoreConnections (  ) 

Definition at line 265 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::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 174 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::Stop (  )  [virtual]

Redefine it to deactivate the backend.

Implements CLAM::NetworkPlayer.

Definition at line 217 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::StoreConnections (  ) 

Definition at line 245 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::UnRegisterPorts (  ) 

Definition at line 121 of file JACKNetworkPlayer.cxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3