reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

ofSoundDevice Class Reference

Represents information about a sound device on the system. More...

#include <ofSoundBaseTypes.h>

Public Types

enum  Api {
  UNSPECIFIED , DEFAULT , ALSA , PULSE ,
  OSS , JACK , OSX_CORE , MS_WASAPI ,
  MS_ASIO , MS_DS , NUM_APIS
}
 

Public Attributes

enum ofSoundDevice::Api api = UNSPECIFIED
 
std::string name {"Unknown"}
 Descriptive name for the device This is the same string that ofSoundStream::getMatchingDevices() will be looking for.
 
int deviceID = -1
 The device's unique ID (to be used in ofSoundStream::setDeviceID() )
 
unsigned int inputChannels = 0
 Number of input channels the device supports.
 
unsigned int outputChannels = 0
 Number of output channels the device supports.
 
bool isDefaultInput = false
 If true, this device will be used by ofSoundStream unless changed with setDeviceID()
 
bool isDefaultOutput = false
 If true, this device will be used by ofSoundStream unless changed with setDeviceID()
 
std::vector< unsigned int > sampleRates
 List of sample rates the device claims to support.
 

Friends

std::ostream & operator<< (std::ostream &os, const ofSoundDevice &dev)
 
std::ostream & operator<< (std::ostream &os, const std::vector< ofSoundDevice > &devs)
 

Detailed Description

Represents information about a sound device on the system.

Member Enumeration Documentation

◆ Api

Enumerator
UNSPECIFIED 
DEFAULT 
ALSA 

The Advanced Linux Sound Architecture API.

PULSE 

The Linux PulseAudio API.

OSS 

The Linux Open Sound System API.

JACK 

The Jack Low-Latency Audio Server API.

OSX_CORE 

Macintosh OS-X Core Audio API.

MS_WASAPI 

The Microsoft WASAPI API.

MS_ASIO 

The Steinberg Audio Stream I/O API.

MS_DS 

The Microsoft Direct Sound API.

NUM_APIS 

Friends And Related Symbol Documentation

◆ operator<< [1/2]

std::ostream & operator<< ( std::ostream &  os,
const ofSoundDevice dev 
)
friend

◆ operator<< [2/2]

std::ostream & operator<< ( std::ostream &  os,
const std::vector< ofSoundDevice > &  devs 
)
friend

Member Data Documentation

◆ api

enum ofSoundDevice::Api ofSoundDevice::api = UNSPECIFIED

◆ deviceID

int ofSoundDevice::deviceID = -1

The device's unique ID (to be used in ofSoundStream::setDeviceID() )

◆ inputChannels

unsigned int ofSoundDevice::inputChannels = 0

Number of input channels the device supports.

◆ isDefaultInput

bool ofSoundDevice::isDefaultInput = false

If true, this device will be used by ofSoundStream unless changed with setDeviceID()

◆ isDefaultOutput

bool ofSoundDevice::isDefaultOutput = false

If true, this device will be used by ofSoundStream unless changed with setDeviceID()

◆ name

std::string ofSoundDevice::name {"Unknown"}

Descriptive name for the device This is the same string that ofSoundStream::getMatchingDevices() will be looking for.

◆ outputChannels

unsigned int ofSoundDevice::outputChannels = 0

Number of output channels the device supports.

◆ sampleRates

std::vector<unsigned int> ofSoundDevice::sampleRates

List of sample rates the device claims to support.


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