hula::HulaAudioSettings Class Reference

Class containing all settings pertinent to the audio module. More...

#include <HulaAudioSettings.h>

Inheritance diagram for hula::HulaAudioSettings:

Public Member Functions
bool	getShowRecordDevices ()
	Getters. More...
int	getNumberOfChannels ()
	Get the number of channels for the current global device configuration. More...
int	getSampleRate ()
	Get the number of channels for the current global device configuration. More...
int	getSampleSize ()
	Get the sample size for the current global device configuration. More...
void	setShowRecordDevices (bool)
	Setters. More...
void	setNumberOfChannels (int)
	Set the number of channels for the current global device configuration. More...
void	setSampleRate (int)
	Set the number of channels for the current global device configuration. More...
void	setSampleSize (int)
	Set the sample size for the current global device configuration. More...
	~HulaAudioSettings ()
	Destructor for HulaAudioSettings.

Static Public Member Functions
static HulaAudioSettings *	getInstance ()
	Retreive the singular instance of HulaSettings or construct a new one if none exists. More...

Protected Member Functions
	HulaAudioSettings ()
	Private constructor to enforce the singleton pattern. More...

Detailed Description

Class containing all settings pertinent to the audio module.

Constructor & Destructor Documentation

HulaAudioSettings::HulaAudioSettings ( )

protected

Private constructor to enforce the singleton pattern.

Initializes all settings to default values.

Member Function Documentation

HulaAudioSettings * HulaAudioSettings::getInstance ( )

static

Retreive the singular instance of HulaSettings or construct a new one if none exists.

Returns

Pointer to the HulaAudioSettings instance.

int HulaAudioSettings::getNumberOfChannels

(

)

Get the number of channels for the current global device configuration.

This is the configuration that buffers and output files have been setup for. Changing it mid-anything may break stuff.

Returns

Number of channels that the application is currently configured for

int HulaAudioSettings::getSampleRate

(

)

Get the number of channels for the current global device configuration.

This is the configuration that buffers and output files have been setup for. Changing it mid-anything may break stuff.

Returns

Sample rate that the application is currentlyy configured for

int HulaAudioSettings::getSampleSize

(

)

Get the sample size for the current global device configuration.

This is the configuration that buffers and output files have been setup for. Changing it mid-anything may break stuff.

Returns

Sample size that the application is currently configured for

bool HulaAudioSettings::getShowRecordDevices

(

)

Getters.

Determine whether or not true record devices (i.e.

microphones) should be displayed in device lists.

Returns

Value of showRecordDevices

void HulaAudioSettings::setNumberOfChannels

(

int

val

)

Set the number of channels for the current global device configuration.

This is the configuration that buffers and output files have been setup for. Changing it mid-anything may break stuff.

Parameters

val	Number of channels that the application is currently configured for

void HulaAudioSettings::setSampleRate

(

int

val

)

Set the number of channels for the current global device configuration.

This is the configuration that buffers and output files have been setup for. Changing it mid-anything may break stuff.

Parameters

val	Sample rate that the application is currentlyy configured for

void HulaAudioSettings::setSampleSize

(

int

val

)

Set the sample size for the current global device configuration.

This is the configuration that buffers and output files have been setup for. Changing it mid-anything may break stuff.

Parameters

val	Sample size that the application is currently configured for

void HulaAudioSettings::setShowRecordDevices

(

bool

val

)

Setters.

Set whether or not true record devices (i.e.

microphones) should be displayed in the device lists.

Parameters

val	Value of option.

---

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

• HulaAudioSettings.h
• HulaAudioSettings.cpp