---

syn::AudioFormat Class Reference

Audio format descriptor this class describes the format of an audio data stream and will be used practically everywhere you pass audio data around. More...

#include <AudioFormat.h>

List of all members.

Public Types
enum	Packing { INTERLACED }
enum	SampleType {   UNSIGNED8, SIGNED8, UNSIGNED16, SIGNED16,   FLOAT32 }
Public Methods
	AudioFormat (SampleType dt=FLOAT32, int chan=1, int sampRate=44100)
	default constructor. More...
void	copy (const AudioFormat &af)
	copy one descriptor to another result: sets this descriptor to af. More...
	AudioFormat (const AudioFormat &af)
	copy constructor. More...
const AudioFormat&	operator= (const AudioFormat &af)
	equal operator. More...
bool	operator== (const AudioFormat &af) const
	equal operator. More...
bool	operator!= (const AudioFormat &af) const
	not equal operator. More...
int	sampsize () const
	sample size in bytes. More...
Public Attributes
int	samplingRateHz
	sampling rate in herz (usually a value like 44100, 22050, 11025, etc.). More...
int	channels
	number of channels in the audio data until there is an interlaced flag, the data will always be interlaced when channels > 1. More...
SampleType	datatype
	the datatype of each sample see the enum values listed this AudioFormat class for available types. More...

---

Detailed Description

Audio format descriptor this class describes the format of an audio data stream and will be used practically everywhere you pass audio data around.

Definition at line 227 of file AudioFormat.h.

---

Member Enumeration Documentation

enum syn::AudioFormat::Packing

Enumeration values: INTERLACED   Definition at line 230 of file AudioFormat.h.

enum syn::AudioFormat::SampleType

Enumeration values: UNSIGNED8   SIGNED8   UNSIGNED16   SIGNED16   FLOAT32   Definition at line 235 of file AudioFormat.h.

---

Constructor & Destructor Documentation

syn::AudioFormat::AudioFormat ( SampleType dt = FLOAT32, int chan = 1, int sampRate = 44100 ) [inline]

default constructor. Definition at line 243 of file AudioFormat.h.

syn::AudioFormat::AudioFormat ( const AudioFormat & af ) [inline]

copy constructor. Definition at line 260 of file AudioFormat.h.

---

Member Function Documentation

void syn::AudioFormat::copy ( const AudioFormat & af ) [inline]

copy one descriptor to another result: sets this descriptor to af. Definition at line 252 of file AudioFormat.h. Referenced by AudioFormat(), and operator=().

const AudioFormat & syn::AudioFormat::operator= ( const AudioFormat & af ) [inline]

equal operator. Definition at line 266 of file AudioFormat.h.

bool syn::AudioFormat::operator== ( const AudioFormat & af ) const [inline]

equal operator. Definition at line 273 of file AudioFormat.h. Referenced by operator!=().

bool syn::AudioFormat::operator!= ( const AudioFormat & af ) const [inline]

not equal operator. Definition at line 285 of file AudioFormat.h.

int syn::AudioFormat::sampsize ( ) const [inline]

sample size in bytes. Definition at line 291 of file AudioFormat.h. Referenced by syn::WavAudioIStream::numsamps(), syn::WavAudioIStream::read(), syn::WavAudioIStream::seek(), and syn::RawAudioOStream::write().

---

Member Data Documentation

int syn::AudioFormat::samplingRateHz

sampling rate in herz (usually a value like 44100, 22050, 11025, etc.). Definition at line 310 of file AudioFormat.h.

int syn::AudioFormat::channels

number of channels in the audio data until there is an interlaced flag, the data will always be interlaced when channels > 1. Definition at line 316 of file AudioFormat.h.

SampleType syn::AudioFormat::datatype

the datatype of each sample see the enum values listed this AudioFormat class for available types. Definition at line 321 of file AudioFormat.h.

---

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

• /root/src/subsynth/syn/Util/AudioFormat.h

---