gva::AudioFunctions Class Reference

The Audio Functions class. More...

#include <audio.h>

Collaboration diagram for gva::AudioFunctions:

Data Structures
struct	CallbackData
	The callback data. More...

Public Member Functions
	AudioFunctions ()
	Construct a new Audio Functions object.
	~AudioFunctions ()
	Destroy the Audio Functions object.
AudioFunctions &	operator= (const AudioFunctions &)=delete
	AudioFunctions (const AudioFunctions &)=delete
	Construct a new Audio Functions object.
int	Play (AudioSampleBase *sample)
	Play a given file.
void	PlayThreat ()
	Play threat tone.
void	PlayCaution ()
	Play Caution tone.
void	PlayWarning ()
	Play Warning.

Static Public Member Functions
static int	Callback (const void *input, void *output, unsigned long frameCount, const PaStreamCallbackTimeInfo *timeInfo, PaStreamCallbackFlags statusFlags, void *userData)
	Portaudio callback for simple audio.

Data Fields
const uint32_t	kFramesPerBuffer = 512
	Number of frames per buffer.

Detailed Description

The Audio Functions class.

---

Data Structure Documentation

gva::AudioFunctions::CallbackData

struct gva::AudioFunctions::CallbackData

The callback data.

Collaboration diagram for gva::AudioFunctions::CallbackData:

Data Fields
SNDFILE *	file	The audio sample file.
SF_INFO	info	The audio sample info.

Member Function Documentation

Callback()

int gva::AudioFunctions::Callback ( const void *  input, void *  output, unsigned long  frameCount, const PaStreamCallbackTimeInfo *  timeInfo, PaStreamCallbackFlags  statusFlags, void *  userData  )

static

Portaudio callback for simple audio.

Parameters

input
output
frameCount
timeInfo
statusFlags
userData

Returns

int

Play()

int gva::AudioFunctions::Play

(

AudioSampleBase *

sample

)

Play a given file.

Parameters

sample

The audio sample

Returns

int

---

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

• src/hmicore/hardware/audio.h
• src/hmicore/hardware/audio.cc