libAlgAudio  v1.99-440-g08538e5-dirty
The development library for AlgAudio framework.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AlgAudio::Config Class Reference

#include <Config.hpp>

Public Member Functions

 Config (const Config &other)=default
 

Static Public Member Functions

static Config Default ()
 
static const ConfigGlobal ()
 
static ConfigGlobalWriteable ()
 

Public Attributes

int block_size
 
bool debug
 
bool debug_osc
 
int input_channels
 
int output_channels
 
std::string path_to_sclang
 
int sample_rate
 
std::string scsynth_audio_driver_name
 
bool supernova
 
bool use_sc
 

Detailed Description

This class provides configuration settings for AlgAudio. This includes supercollider's audio settings. The static member Global() returns a reference to an instance of this class which shall be used when accessing configuration.

Constructor & Destructor Documentation

AlgAudio::Config::Config ( const Config other)
default

Member Function Documentation

static Config AlgAudio::Config::Default ( )
static
static const Config& AlgAudio::Config::Global ( )
static

Reuturns a reference to the global Config instance. Usually, you will access configuration properties this way:

static Config& AlgAudio::Config::GlobalWriteable ( )
static

Member Data Documentation

int AlgAudio::Config::block_size
bool AlgAudio::Config::debug

False by default. If set to true, various debuggin features will be enabled, including sc console window.

bool AlgAudio::Config::debug_osc

False by default. If set to true, will enable OSCFunc.trace in sclang.

int AlgAudio::Config::input_channels
int AlgAudio::Config::output_channels
std::string AlgAudio::Config::path_to_sclang

The path to sclang binary executable file.

int AlgAudio::Config::sample_rate
std::string AlgAudio::Config::scsynth_audio_driver_name

The name of driver device to be used by scsynth for audio I/O. If set to an empty string, scsynth will use the default device.

bool AlgAudio::Config::supernova

If set to true, supernova will be launched instead of scsynth. This setting has no effect on Windows, which does not support supernova.

bool AlgAudio::Config::use_sc

This flag marks whether we use supercollider or not. Usually supercollider is in use, but the user can manually specify not to use it. In such case, no audio processing will happen. This may be, however, useful, when, for example, testing UI.


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