CLAM::JACKNetworkPlayer Class Reference

#include <JACKNetworkPlayer.hxx>

Inheritance diagram for CLAM::JACKNetworkPlayer:

List of all members.

---

Detailed Description

Definition at line 12 of file JACKNetworkPlayer.hxx.

Public Member Functions
	JACKNetworkPlayer (const std::string &name="CLAM network player")
virtual	~JACKNetworkPlayer ()
void	InitClient ()
bool	IsWorking () const
	Should return true when the backend is able to run the network.
std::string	NonWorkingReason () const
	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	CopyJackBuffersToGenerators (const jack_nframes_t nframes)
void	CopySinksToJackBuffers (const jack_nframes_t nframes)
virtual void	Start ()
virtual void	Stop ()
virtual void	Init ()
virtual unsigned	BackendBufferSize ()
virtual unsigned	BackendSampleRate ()
void	Do (const jack_nframes_t nframes)
void	StoreConnections ()
void	RestoreConnections ()
void	AutoConnectPorts ()
Classes
struct	JackConnection
struct	SinkJackBinding
struct	SourceJackBinding

---

Constructor & Destructor Documentation

CLAM::JACKNetworkPlayer::JACKNetworkPlayer

(

const std::string &

name = "CLAM network player"

)

Definition at line 24 of file JACKNetworkPlayer.cxx.

References InitClient().

CLAM::JACKNetworkPlayer::~JACKNetworkPlayer

(

)

[virtual]

Definition at line 32 of file JACKNetworkPlayer.cxx.

References Stop().

---

Member Function Documentation

void CLAM::JACKNetworkPlayer::InitClient

(

)

Definition at line 56 of file JACKNetworkPlayer.cxx.

References CLAM_ASSERT, CLAM::JackProcessingCallback(), and CLAM::JackShutdownCallback().

Referenced by Init(), JACKNetworkPlayer(), and Start().

bool CLAM::JACKNetworkPlayer::IsWorking

(

)

const [virtual]

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

Implements CLAM::NetworkPlayer.

Definition at line 45 of file JACKNetworkPlayer.cxx.

std::string CLAM::JACKNetworkPlayer::NonWorkingReason

(

)

const [virtual]

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

Implements CLAM::NetworkPlayer.

Definition at line 50 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::RegisterPorts

(

)

Definition at line 80 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::GetNetwork(), RegisterInputPorts(), and RegisterOutputPorts().

Referenced by Start().

void CLAM::JACKNetworkPlayer::RegisterInputPorts

(

const Network &

net

)

Definition at line 86 of file JACKNetworkPlayer.cxx.

References CLAM::FlattenedNetwork::BeginProcessings(), CLAM_ASSERT, and CLAM::FlattenedNetwork::EndProcessings().

Referenced by RegisterPorts().

void CLAM::JACKNetworkPlayer::RegisterOutputPorts

(

const Network &

net

)

Definition at line 113 of file JACKNetworkPlayer.cxx.

References CLAM::FlattenedNetwork::BeginProcessings(), CLAM_ASSERT, and CLAM::FlattenedNetwork::EndProcessings().

Referenced by RegisterPorts().

void CLAM::JACKNetworkPlayer::UnRegisterPorts

(

)

Definition at line 140 of file JACKNetworkPlayer.cxx.

Referenced by Start().

void CLAM::JACKNetworkPlayer::OnShutdown

(

)

Definition at line 216 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::GetNetwork(), CLAM::NetworkPlayer::SetStopped(), and CLAM::FlattenedNetwork::Stop().

Referenced by CLAM::JackShutdownCallback().

void CLAM::JACKNetworkPlayer::CopyJackBuffersToGenerators

(

const jack_nframes_t

nframes

)

Definition at line 163 of file JACKNetworkPlayer.cxx.

Referenced by Do().

void CLAM::JACKNetworkPlayer::CopySinksToJackBuffers

(

const jack_nframes_t

nframes

)

Definition at line 177 of file JACKNetworkPlayer.cxx.

Referenced by Do().

void CLAM::JACKNetworkPlayer::Start

(

)

[virtual]

Implements CLAM::NetworkPlayer.

Definition at line 189 of file JACKNetworkPlayer.cxx.

References AutoConnectPorts(), InitClient(), CLAM::NetworkPlayer::IsStopped(), RegisterPorts(), RestoreConnections(), CLAM::NetworkPlayer::SetStopped(), and UnRegisterPorts().

void CLAM::JACKNetworkPlayer::Stop

(

)

[virtual]

Implements CLAM::NetworkPlayer.

Definition at line 226 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::IsStopped(), CLAM::NetworkPlayer::SetStopped(), and StoreConnections().

Referenced by ~JACKNetworkPlayer().

void CLAM::JACKNetworkPlayer::Init

(

)

[virtual]

Reimplemented from CLAM::NetworkPlayer.

Definition at line 212 of file JACKNetworkPlayer.cxx.

References InitClient().

virtual unsigned CLAM::JACKNetworkPlayer::BackendBufferSize

(

)

[inline, virtual]

Reimplemented from CLAM::NetworkPlayer.

Definition at line 83 of file JACKNetworkPlayer.hxx.

virtual unsigned CLAM::JACKNetworkPlayer::BackendSampleRate

(

)

[inline, virtual]

Reimplemented from CLAM::NetworkPlayer.

Definition at line 88 of file JACKNetworkPlayer.hxx.

void CLAM::JACKNetworkPlayer::Do

(

const jack_nframes_t

nframes

)

Definition at line 240 of file JACKNetworkPlayer.cxx.

References CopyJackBuffersToGenerators(), CopySinksToJackBuffers(), CLAM::FlattenedNetwork::Do(), CLAM::NetworkPlayer::GetNetwork(), and CLAM::NetworkPlayer::IsStopped().

Referenced by CLAM::JackProcessingCallback().

void CLAM::JACKNetworkPlayer::StoreConnections

(

)

Definition at line 250 of file JACKNetworkPlayer.cxx.

Referenced by Stop().

void CLAM::JACKNetworkPlayer::RestoreConnections

(

)

Definition at line 270 of file JACKNetworkPlayer.cxx.

Referenced by Start().

void CLAM::JACKNetworkPlayer::AutoConnectPorts

(

)

Definition at line 301 of file JACKNetworkPlayer.cxx.

References NULL.

Referenced by Start().

---

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

• JACKNetworkPlayer.hxx
• JACKNetworkPlayer.cxx