CLAM::NetworkPlayer Class Reference
#include <NetworkPlayer.hxx>
Detailed Description
A NetworkPlayer is an object that controls the playback of a Network providing a high level transport like interface.This class is an abstract class. Subclasses contextualizes the network inside a given execution context dealing with threading, callback calling and device mapping on concrete architectures such as Alsa, PortAudio, Jack, VST, Ladspa...
Definition at line 39 of file NetworkPlayer.hxx.
Public Member Functions | |
| NetworkPlayer () | |
| virtual | ~NetworkPlayer () |
| virtual bool | IsWorking () const =0 |
| Should return true when the backend is able to run the network. | |
| virtual std::string | NonWorkingReason () const =0 |
| Whenever the backend is not working, this method returns the reason. | |
| virtual void | Start ()=0 |
| virtual void | Stop ()=0 |
| virtual void | Init () |
| void | SetNetworkBackLink (Network &net) |
| bool | IsStopped () |
| virtual unsigned | BackendBufferSize () |
| virtual unsigned | BackendSampleRate () |
| std::string | SourcesAndSinksToString () |
Protected Types | |
| typedef std::vector < AudioSource * > | AudioSources |
| typedef std::vector< AudioSink * > | AudioSinks |
Protected Member Functions | |
| Network & | GetNetwork () |
| void | SetStopped (const bool val) |
| void | CollectSourcesAndSinks () |
| const AudioSources & | GetAudioSources () const |
| const AudioSinks & | GetAudioSinks () const |
| AudioSources & | GetAudioSources () |
| AudioSinks & | GetAudioSinks () |
Protected Attributes | |
| AudioSources | _sources |
| AudioSinks | _sinks |
Member Typedef Documentation
typedef std::vector<AudioSource*> CLAM::NetworkPlayer::AudioSources [protected] |
Definition at line 42 of file NetworkPlayer.hxx.
typedef std::vector<AudioSink*> CLAM::NetworkPlayer::AudioSinks [protected] |
Definition at line 43 of file NetworkPlayer.hxx.
Constructor & Destructor Documentation
| CLAM::NetworkPlayer::NetworkPlayer | ( | ) | [inline] |
| virtual CLAM::NetworkPlayer::~NetworkPlayer | ( | ) | [inline, virtual] |
Definition at line 51 of file NetworkPlayer.hxx.
Member Function Documentation
| virtual bool CLAM::NetworkPlayer::IsWorking | ( | ) | const [pure virtual] |
Should return true when the backend is able to run the network.
Implemented in CLAM::FreewheelingNetworkPlayer, CLAM::JACKNetworkPlayer, and CLAM::PANetworkPlayer.
| virtual std::string CLAM::NetworkPlayer::NonWorkingReason | ( | ) | const [pure virtual] |
Whenever the backend is not working, this method returns the reason.
Implemented in CLAM::FreewheelingNetworkPlayer, CLAM::JACKNetworkPlayer, and CLAM::PANetworkPlayer.
| virtual void CLAM::NetworkPlayer::Start | ( | ) | [pure virtual] |
Implemented in CLAM::FreewheelingNetworkPlayer, CLAM::JACKNetworkPlayer, and CLAM::PANetworkPlayer.
Referenced by CLAM::FlattenedNetwork::Start().
| virtual void CLAM::NetworkPlayer::Stop | ( | ) | [pure virtual] |
Implemented in CLAM::FreewheelingNetworkPlayer, CLAM::JACKNetworkPlayer, and CLAM::PANetworkPlayer.
Referenced by CLAM::FlattenedNetwork::Stop().
| virtual void CLAM::NetworkPlayer::Init | ( | ) | [inline, virtual] |
Reimplemented in CLAM::JACKNetworkPlayer.
Definition at line 61 of file NetworkPlayer.hxx.
Referenced by CLAM::FlattenedNetwork::SetPlayer().
| void CLAM::NetworkPlayer::SetNetworkBackLink | ( | Network & | net | ) | [inline] |
| bool CLAM::NetworkPlayer::IsStopped | ( | ) | [inline] |
Definition at line 69 of file NetworkPlayer.hxx.
Referenced by CLAM::JACKNetworkPlayer::Do(), CLAM::FlattenedNetwork::IsStopped(), CLAM::PANetworkPlayer::Start(), CLAM::JACKNetworkPlayer::Start(), CLAM::FreewheelingNetworkPlayer::Start(), CLAM::PANetworkPlayer::Stop(), CLAM::JACKNetworkPlayer::Stop(), and CLAM::FreewheelingNetworkPlayer::Stop().
| virtual unsigned CLAM::NetworkPlayer::BackendBufferSize | ( | ) | [inline, virtual] |
Reimplemented in CLAM::JACKNetworkPlayer.
Definition at line 73 of file NetworkPlayer.hxx.
Referenced by CLAM::FlattenedNetwork::BackendBufferSize().
| virtual unsigned CLAM::NetworkPlayer::BackendSampleRate | ( | ) | [inline, virtual] |
Reimplemented in CLAM::JACKNetworkPlayer.
Definition at line 78 of file NetworkPlayer.hxx.
Referenced by CLAM::FlattenedNetwork::BackendSampleRate().
| std::string CLAM::NetworkPlayer::SourcesAndSinksToString | ( | ) |
Definition at line 41 of file NetworkPlayer.cxx.
References CLAM::FlattenedNetwork::BeginProcessings(), CLAM::FlattenedNetwork::EndProcessings(), and GetNetwork().
| Network& CLAM::NetworkPlayer::GetNetwork | ( | ) | [inline, protected] |
Definition at line 85 of file NetworkPlayer.hxx.
References CLAM_ASSERT, and NULL.
Referenced by CollectSourcesAndSinks(), CLAM::JACKNetworkPlayer::Do(), CLAM::JACKNetworkPlayer::OnShutdown(), CLAM::FreewheelingNetworkPlayer::ProcessInputFile(), CLAM::JACKNetworkPlayer::RegisterPorts(), SourcesAndSinksToString(), and CLAM::FreewheelingNetworkPlayer::Start().
| void CLAM::NetworkPlayer::SetStopped | ( | const bool | val | ) | [inline, protected] |
Definition at line 90 of file NetworkPlayer.hxx.
Referenced by NetworkPlayer(), CLAM::JACKNetworkPlayer::OnShutdown(), CLAM::PANetworkPlayer::Start(), CLAM::JACKNetworkPlayer::Start(), CLAM::FreewheelingNetworkPlayer::Start(), CLAM::PANetworkPlayer::Stop(), CLAM::JACKNetworkPlayer::Stop(), and CLAM::FreewheelingNetworkPlayer::Stop().
| void CLAM::NetworkPlayer::CollectSourcesAndSinks | ( | ) | [protected] |
Definition at line 27 of file NetworkPlayer.cxx.
References _sinks, _sources, CLAM::FlattenedNetwork::BeginProcessings(), CLAM::FlattenedNetwork::EndProcessings(), and GetNetwork().
Referenced by CLAM::PANetworkPlayer::Start(), and CLAM::FreewheelingNetworkPlayer::Start().
| const AudioSources& CLAM::NetworkPlayer::GetAudioSources | ( | ) | const [inline, protected] |
Definition at line 92 of file NetworkPlayer.hxx.
References _sources.
Referenced by CLAM::FreewheelingNetworkPlayer::IsWorking(), CLAM::FreewheelingNetworkPlayer::NonWorkingReason(), and CLAM::FreewheelingNetworkPlayer::Start().
| const AudioSinks& CLAM::NetworkPlayer::GetAudioSinks | ( | ) | const [inline, protected] |
Definition at line 93 of file NetworkPlayer.hxx.
References _sinks.
Referenced by CLAM::FreewheelingNetworkPlayer::IsWorking(), CLAM::FreewheelingNetworkPlayer::NonWorkingReason(), and CLAM::FreewheelingNetworkPlayer::Start().
| AudioSources& CLAM::NetworkPlayer::GetAudioSources | ( | ) | [inline, protected] |
| AudioSinks& CLAM::NetworkPlayer::GetAudioSinks | ( | ) | [inline, protected] |
Member Data Documentation
AudioSources CLAM::NetworkPlayer::_sources [protected] |
Definition at line 97 of file NetworkPlayer.hxx.
Referenced by CollectSourcesAndSinks(), GetAudioSources(), and CLAM::PANetworkPlayer::Start().
AudioSinks CLAM::NetworkPlayer::_sinks [protected] |
Definition at line 98 of file NetworkPlayer.hxx.
Referenced by CollectSourcesAndSinks(), GetAudioSinks(), and CLAM::PANetworkPlayer::Start().
The documentation for this class was generated from the following files:
