rtaudiom Namespace Reference

Regroups elements defined by the RtAudio module. More...

Classes
class	CReceive
	Receive audio from input interface Implements a push mechanism: process function and filters are not used. More...
class	CInputInterface
	Audio input interface node. More...
class	COpenInputStream
	Open input stream cell (access cell for CInputInterface). More...
class	CCloseInputStream
	Close input stream cell (access cell for CInputInterface. More...
class	CSend
	Send audio to output interface. More...
class	COutputInterface
	Audio output interface. More...
class	COpenOutputStream
	Open output stream cell (access cell for COutputInterface). More...
class	CCloseOutputStream
	Close output stream cell (access cell for COutputInterface). More...
Functions
int	max (int a, int b)
int	min (int a, int b)
void	registerFactories ()
	Function to call to load the node and cell factories in the system.
Utility functions
bool	openInputStream (fsf::CRepository *pRepository, std::string &strInterfaceName, int nInputDevice, int nInputChannels, unsigned int nFormat, unsigned int nSampleRate, unsigned int nBufferFrames=0)
	Opens the input stream of the specified input interface (identified by name and repository) with the specified parameters.
bool	closeInputStream (fsf::CRepository *pRepository, std::string &strInterfaceName)
	Closes the input stream of the specified input interface (identified by name and repository).
bool	openOutputStream (fsf::CRepository *pRepository, std::string &strInterfaceName, int nOutputDevice, int nOutputChannels, unsigned int nFormat, unsigned int nSampleRate, unsigned int nBufferFrames=0)
	Opens the input stream of the specified input interface (identified by name and repository) with the specified parameters.
bool	closeOutputStream (fsf::CRepository *pRepository, std::string &strInterfaceName)
	Closes the output stream of the specified output interface (identified by name and repository).
int	selectInputDevice ()
	Lists available input devices and prompts for selection (cout and cin).
int	selectOutputDevice ()
	Lists available output devices and prompts for selection (cout and cin).
Variables
const unsigned int	RTAUDIO_FORMAT [6] = { 0x20, 0x10, 0x8, 0x4, 0x2, 0x1 }
Handle IDs
const long	STREAM_OUTPUT_DEVICE = 0
const long	STREAM_OUTPUT_CHANNELS = 1
const long	STREAM_INPUT_DEVICE = 2
const long	STREAM_INPUT_CHANNELS = 3
const long	STREAM_AUDIO_FORMAT = 4
const long	STREAM_SAMPLE_RATE = 5
const long	STREAM_BUFFER_FRAMES = 6

---

Detailed Description

Regroups elements defined by the RtAudio module.

---

Function Documentation

bool rtaudiom::closeInputStream	(	fsf::CRepository *	pRepository,
		std::string &	strInterfaceName
	)

Closes the input stream of the specified input interface (identified by name and repository).

bool rtaudiom::closeOutputStream	(	fsf::CRepository *	pRepository,
		std::string &	strInterfaceName
	)

Closes the output stream of the specified output interface (identified by name and repository).

int rtaudiom::max	(	int	a,
		int	b
	)			[inline]

int rtaudiom::min	(	int	a,
		int	b
	)			[inline]

bool rtaudiom::openInputStream	(	fsf::CRepository *	pRepository,
		std::string &	strInterfaceName,
		int	nInputDevice,
		int	nInputChannels,
		unsigned int	nFormat,
		unsigned int	nSampleRate,
		unsigned int	nBufferFrames = 0
	)

Opens the input stream of the specified input interface (identified by name and repository) with the specified parameters.

bool rtaudiom::openOutputStream	(	fsf::CRepository *	pRepository,
		std::string &	strInterfaceName,
		int	nOutputDevice,
		int	nOutputChannels,
		unsigned int	nFormat,
		unsigned int	nSampleRate,
		unsigned int	nBufferFrames = 0
	)

Opens the input stream of the specified input interface (identified by name and repository) with the specified parameters.

int rtaudiom::selectInputDevice

(

)

Lists available input devices and prompts for selection (cout and cin).

int rtaudiom::selectOutputDevice

(

)

Lists available output devices and prompts for selection (cout and cin).

---

Variable Documentation

const unsigned int rtaudiom::RTAUDIO_FORMAT[6] = { 0x20, 0x10, 0x8, 0x4, 0x2, 0x1 }

const long rtaudiom::STREAM_AUDIO_FORMAT = 4

const long rtaudiom::STREAM_BUFFER_FRAMES = 6

const long rtaudiom::STREAM_INPUT_CHANNELS = 3

const long rtaudiom::STREAM_INPUT_DEVICE = 2

const long rtaudiom::STREAM_OUTPUT_CHANNELS = 1

const long rtaudiom::STREAM_OUTPUT_DEVICE = 0

const long rtaudiom::STREAM_SAMPLE_RATE = 5