VISR  0.11.7
Versatile Interactive Scene Renderer
visr::audiointerfaces::JackInterface Class Reference

#include <jack_interface.hpp>

Inheritance diagram for visr::audiointerfaces::JackInterface:
visr::audiointerfaces::AudioInterface

Classes

struct  Config
 
class  Impl
 

Public Types

using Base = AudioInterface
 
- Public Types inherited from visr::audiointerfaces::AudioInterface
using SampleRateType = std::size_t
 
using AudioCallback = void(*)(void *, ExternalSampleType const *const *, ExternalSampleType *const *, bool &)
 
using ExternalSampleType = float
 Preliminary definition of sample types. More...
 
using InternalSampleType = float
 note: the internal sample type should be of no concern to the abstract interface. More...
 

Public Member Functions

 JackInterface (Configuration const &baseConfig, std::string const &config)
 
virtual ~JackInterface () override
 
void start () override
 
void stop () override
 
bool registerCallback (AudioCallback callback, void *userData) override
 
bool unregisterCallback (AudioCallback audioCallback) override
 
std::size_t numberOfCaptureChannels () const override
 
std::size_t numberOfPlaybackChannels () const override
 
std::size_t period () const override
 
std::size_t samplingFrequency () const override
 
- Public Member Functions inherited from visr::audiointerfaces::AudioInterface
virtual ~AudioInterface ()
 

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ JackInterface()

visr::audiointerfaces::JackInterface::JackInterface ( Configuration const &  baseConfig,
std::string const &  config 
)
explicit

◆ ~JackInterface()

visr::audiointerfaces::JackInterface::~JackInterface ( )
overridevirtual

Member Function Documentation

◆ numberOfCaptureChannels()

std::size_t visr::audiointerfaces::JackInterface::numberOfCaptureChannels ( ) const
overridevirtual

Return the number of input channels to the interface.

Implements visr::audiointerfaces::AudioInterface.

◆ numberOfPlaybackChannels()

std::size_t visr::audiointerfaces::JackInterface::numberOfPlaybackChannels ( ) const
overridevirtual

Return the number of output channels to the interface.

Implements visr::audiointerfaces::AudioInterface.

◆ period()

std::size_t visr::audiointerfaces::JackInterface::period ( ) const
overridevirtual

Return the configured period (block size).

Implements visr::audiointerfaces::AudioInterface.

◆ registerCallback()

bool visr::audiointerfaces::JackInterface::registerCallback ( AudioCallback  callback,
void *  userData 
)
overridevirtual

◆ samplingFrequency()

std::size_t visr::audiointerfaces::JackInterface::samplingFrequency ( ) const
overridevirtual

Return the configured sampling frequency (in Hz)

Implements visr::audiointerfaces::AudioInterface.

◆ start()

void visr::audiointerfaces::JackInterface::start ( )
overridevirtual

Start the audio interface, i.e., reacting to callbacks and passing them to the registered callback handlers. Pure virtual method, must be implemented in all concrete derived classes.

Implements visr::audiointerfaces::AudioInterface.

◆ stop()

void visr::audiointerfaces::JackInterface::stop ( )
overridevirtual

Stop the audio interface, i.e., calling the registered callback functions anymore. Pure virtual method, must be implemented in all concrete derived classes.

Implements visr::audiointerfaces::AudioInterface.

◆ unregisterCallback()

bool visr::audiointerfaces::JackInterface::unregisterCallback ( AudioCallback  audioCallback)
overridevirtual

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