GNU Radio 3.3.0 C++ API
audio_jack_sink Class Reference

audio sink using JACK More...

#include <audio_jack_sink.h>

Inheritance diagram for audio_jack_sink:

List of all members.

Public Member Functions

 ~audio_jack_sink ()
bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 just like gr_block::general_work, only this arranges to call consume_each for you

Protected Member Functions

 audio_jack_sink (int sampling_rate, const std::string device_name, bool ok_to_block)

Friends

audio_jack_sink_sptr audio_jack_make_sink (int sampling_rate, const std::string device_name, bool ok_to_block)
 make an JACK audio sink.
int jack_sink_process (jack_nframes_t nframes, void *arg)

Detailed Description

audio sink using JACK

The sink has one input stream of floats.

Input samples must be in the range [-1,1].


Constructor & Destructor Documentation

audio_jack_sink::audio_jack_sink ( int  sampling_rate,
const std::string  device_name,
bool  ok_to_block 
) [protected]
audio_jack_sink::~audio_jack_sink ( )

Member Function Documentation

bool audio_jack_sink::check_topology ( int  ninputs,
int  noutputs 
) [virtual]

Confirm that ninputs and noutputs is an acceptable combination.

Parameters:
ninputsnumber of input streams connected
noutputsnumber of output streams connected
Returns:
true if this is a valid configuration for this block.

This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures.

Reimplemented from gr_basic_block.

int audio_jack_sink::work ( int  noutput_items,
gr_vector_const_void_star input_items,
gr_vector_void_star output_items 
) [virtual]

just like gr_block::general_work, only this arranges to call consume_each for you

The user must override work to define the signal processing code

Implements gr_sync_block.


Friends And Related Function Documentation

audio_jack_sink_sptr audio_jack_make_sink ( int  sampling_rate,
const std::string  device_name,
bool  ok_to_block 
) [friend]

make an JACK audio sink.

Parameters:
sampling_ratesampling rate in Hz
device_nameJACK device name, e.g., "gr_sink"
ok_to_block
int jack_sink_process ( jack_nframes_t  nframes,
void *  arg 
) [friend]

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