Allolib  1.0
C++ Components For Interactive Multimedia
al::AudioDevice Class Reference

#include <C:/Users/Andres/source/repos/casm_viewer/external/tinc/external/allolib/include/al/io/al_AudioIO.hpp>

Inheritance diagram for al::AudioDevice:
al::AudioDeviceInfo

Public Types

enum  StreamMode { INPUT = 1 , OUTPUT = 2 }
 Stream mode. More...
 

Public Member Functions

 AudioDevice (int deviceNum=-1)
 
 AudioDevice (const std::string &nameKeyword, StreamMode stream=StreamMode(INPUT|OUTPUT))
 
virtual bool valid () const
 Returns whether device is valid.
 
virtual bool hasInput () const
 Returns whether device has input.
 
virtual bool hasOutput () const
 Returns whether device has output.
 
virtual void print () const
 Prints info about specific i/o device to stdout.
 
virtual int id () const
 Get device unique ID.
 
virtual const char * name () const
 Get device name.
 
virtual int channelsInMax () const
 Get maximum number of input channels supported.
 
virtual int channelsOutMax () const
 Get maximum number of output channels supported.
 
virtual double defaultSampleRate () const
 Get default sample rate.
 
virtual void setID (int iD)
 Sets unique ID.
 
virtual void setName (char *name)
 Sets device name.
 
virtual void setChannelsInMax (int num)
 Sets maximum number of Input channels supported.
 
virtual void setChannelsOutMax (int num)
 Sets maximum number of Output channels supported.
 
virtual void setDefaultSampleRate (double rate)
 Sets default sample rate.
 

Static Public Member Functions

static AudioDevice defaultInput ()
 Get system's default input device.
 
static AudioDevice defaultOutput ()
 Get system's default output device.
 
static int numDevices ()
 Returns number of audio i/o devices available.
 
static void printAll ()
 Prints info about all available i/o devices to stdout.
 

Protected Member Functions

void setImpl (int deviceNum)
 

Static Protected Member Functions

static void initDevices ()
 

Protected Attributes

int mID {-1}
 
char mName [128]
 
int mChannelsInMax {0}
 
int mChannelsOutMax {0}
 
double mDefaultSampleRate {0}
 
bool mValid {false}
 

Detailed Description

Audio device

Definition at line 118 of file al_AudioIO.hpp.

Member Enumeration Documentation

◆ StreamMode

Stream mode.

Enumerator
INPUT 

Input stream

OUTPUT 

Output stream

Definition at line 121 of file al_AudioIO.hpp.

Constructor & Destructor Documentation

◆ AudioDevice() [1/2]

al::AudioDevice::AudioDevice ( int  deviceNum = -1)
Parameters
[in]deviceNumDevice enumeration number

◆ AudioDevice() [2/2]

al::AudioDevice::AudioDevice ( const std::string &  nameKeyword,
StreamMode  stream = StreamMode(INPUT|OUTPUT) 
)
Parameters
[in]nameKeywordKeyword to search for in device name
[in]streamWhether to search for input and/or output devices

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