VISR  0.12.0
Versatile Interactive Scene Renderer
visr::audiointerfaces::PortaudioInterface::Config Struct Reference

#include <portaudio_interface.hpp>

Classes

class  SampleFormat
 

Public Types

using TranslateSampleFormatMapTypeString = std::map< std::string, SampleFormat::Type >
 
using SamplingRateType = std::size_t
 

Public Member Functions

SampleFormat::Type translateToSampleFormat (std::string format)
 
 Config (std::string sampleFormat, bool interleaved, std::string mHostApi)
 

Public Attributes

SampleFormat::Type mSampleFormat
 
TranslateSampleFormatMapTypeString const cTranslateSampleFormatMapString
 
std::size_t mNumberOfCaptureChannels
 
std::size_t mNumberOfPlaybackChannels
 
std::size_t mPeriodSize
 
SamplingRateType mSampleRate
 
bool mInterleaved
 
std::string mHostApi
 

Detailed Description

Structure to hold all configuration arguments for a PortAudioInterface instance.

Member Typedef Documentation

◆ SamplingRateType

Todo: Consider moving this definition to a more general place.

◆ TranslateSampleFormatMapTypeString

Constructor & Destructor Documentation

◆ Config()

visr::audiointerfaces::PortaudioInterface::Config::Config ( std::string  sampleFormat,
bool  interleaved,
std::string  mHostApi 
)

Member Function Documentation

◆ translateToSampleFormat()

SampleFormat::Type visr::audiointerfaces::PortaudioInterface::Config::translateToSampleFormat ( std::string  format)
inline

Member Data Documentation

◆ cTranslateSampleFormatMapString

TranslateSampleFormatMapTypeString const visr::audiointerfaces::PortaudioInterface::Config::cTranslateSampleFormatMapString
Initial value:
= {
{"signedInt8Bit", SampleFormat::signedInt8Bit },
{"unsignedInt8Bit", SampleFormat::unsignedInt8Bit },
{"signedInt16Bit", SampleFormat::signedInt16Bit },
{"unsignedInt16Bit", SampleFormat::unsignedInt16Bit },
{"signedInt24Bit", SampleFormat::signedInt24Bit },
{"unsignedInt24Bit", SampleFormat::unsignedInt24Bit },
{"signedInt32Bit", SampleFormat::signedInt32Bit },
{"unsignedInt32Bit", SampleFormat::unsignedInt32Bit },
{"float32Bit", SampleFormat::float32Bit }
}

◆ mHostApi

std::string visr::audiointerfaces::PortaudioInterface::Config::mHostApi

A string determining the host API to be used for portaudio. At the moment, admissible values are 'default' on all platforms 'DirectSound', 'MME', 'ASIO' 'SoundManager', 'CoreAudio', 'OSS', ALSA', AL', 'WDMKS', 'JACK''WASAPI'

◆ mInterleaved

bool visr::audiointerfaces::PortaudioInterface::Config::mInterleaved

Enumeration for a type-independent sample format specification TODO: Move to a more general location (for use by all audio interfaces)

◆ mNumberOfCaptureChannels

std::size_t visr::audiointerfaces::PortaudioInterface::Config::mNumberOfCaptureChannels

◆ mNumberOfPlaybackChannels

std::size_t visr::audiointerfaces::PortaudioInterface::Config::mNumberOfPlaybackChannels

◆ mPeriodSize

std::size_t visr::audiointerfaces::PortaudioInterface::Config::mPeriodSize

◆ mSampleFormat

SampleFormat::Type visr::audiointerfaces::PortaudioInterface::Config::mSampleFormat

◆ mSampleRate

SamplingRateType visr::audiointerfaces::PortaudioInterface::Config::mSampleRate

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