interface_policy using JACK. More...

#include <apf/jack_policy.h>

Inheritance diagram for apf::jack_policy:

Public Types
using	sample_type = sample_t

Public Types inherited from apf::JackClient
enum	callback_usage_t { dont_use_jack_process_callback = 0 , use_jack_process_callback }
	Select if JACK's audio callback function shall be called. More...

typedef jack_default_audio_sample_t	sample_t

typedef jack_nframes_t	nframes_t

typedef jack_port_t	port_t

Public Member Functions
nframes_t	block_size () const

bool	activate () const
	Activate JACK client. More...

bool	deactivate () const
	Deactivate JACK client. More...

nframes_t	sample_rate () const

Public Member Functions inherited from apf::JackClient
	JackClient (const std::string &name="JackClient", callback_usage_t callback_usage=dont_use_jack_process_callback)
	Constructor. More...

bool	activate () const
	Activate JACK client. More...

bool	deactivate () const
	Deactivate JACK client. More...

port_t *	register_in_port (const std::string &name) const
	Register JACK input port. More...

port_t *	register_out_port (const std::string &name) const
	Register JACK output port. More...

port_t *	register_port (const std::string &name, unsigned long flags) const
	Register JACK port (input or output). More...

bool	unregister_port (port_t *port) const
	Unregister JACK port. More...

bool	connect_ports (const std::string &source, const std::string &destination) const
	Connect two JACK ports. More...

bool	disconnect_ports (const std::string &source, const std::string &destination) const
	Disconnect two JACK ports. More...

bool	connect_pending_connections () const
	Make connections which are still pending from a previous call to connect_ports(). More...

void	transport_start () const
	Start JACK transport. More...

void	transport_stop () const
	Stop JACK transport. More...

bool	transport_locate (nframes_t frame) const
	Set JACK transport location. More...

std::pair< bool, nframes_t >	get_transport_state () const
	Get JACK transport state. More...

bool	set_freewheel (int onoff) const
	Set JACK freewheeling mode. More...

std::string	client_name () const

nframes_t	sample_rate () const

nframes_t	buffer_size () const

bool	is_realtime () const
	Start JACK transport. More...

int	get_real_time_priority () const
	Start JACK transport. More...

float	get_cpu_load () const
	Start JACK transport. More...

jack_native_thread_t	client_thread_id () const
	Start JACK transport. More...

Protected Member Functions
	jack_policy (const parameter_map &p=parameter_map())
	Constructor. More...

Protected Member Functions inherited from apf::JackClient
virtual int	jack_sync_callback (jack_transport_state_t state, jack_position_t *pos)
	JACK sync callback function. More...

virtual void	jack_shutdown_callback ()
	JACK shutdown callback. More...

virtual int	jack_sample_rate_callback (nframes_t sr)
	JACK sample rate callback. More...

virtual int	jack_buffer_size_callback (nframes_t bs)
	JACK buffer size callback. More...

virtual int	jack_xrun_callback ()
	JACK xrun callback. More...

Detailed Description

interface_policy using JACK.

Some of the functions are directly taken from JackClient.

See also: MimoProcessor

Definition at line 55 of file jack_policy.h.

Member Typedef Documentation

◆ sample_type

using apf::jack_policy::sample_type = sample_t

Definition at line 58 of file jack_policy.h.

Constructor & Destructor Documentation

◆ jack_policy()

apf::jack_policy::jack_policy ( const parameter_map & p = parameter_map() )

inlineexplicitprotected

Constructor.

Parameters

p	Parameters, only the parameter `"name"` (for the name of the JACK client) is supported.

Definition at line 72 of file jack_policy.h.

Member Function Documentation

◆ block_size()

nframes_t apf::jack_policy::block_size ( ) const

inline

Definition at line 66 of file jack_policy.h.

◆ activate()

bool apf::JackClient::activate ( ) const

inline

Activate JACK client.

Returns: true on success

See also: jack_activate()

Definition at line 126 of file jackclient.h.

◆ deactivate()

bool apf::JackClient::deactivate ( ) const

inline

Deactivate JACK client.

Returns: true on success

See also: jack_deactivate()

Definition at line 141 of file jackclient.h.

◆ sample_rate()

nframes_t apf::JackClient::sample_rate ( ) const

inline

Returns: JACK sample rate

Definition at line 296 of file jackclient.h.

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

apf/jack_policy.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ sample_type

Constructor & Destructor Documentation

◆ jack_policy()

Member Function Documentation

◆ block_size()

◆ activate()

◆ deactivate()

◆ sample_rate()