urbi::USound Class Reference

Class encapsulating sound information. More...

#include <usound.hh>

Collaboration diagram for urbi::USound:

List of all members.

Public Member Functions
void	init ()
	Initialize.
const char *	format_string () const
	Return a legible definition of imageFormat.
bool	operator== (const USound &b) const
std::ostream &	dump (std::ostream &o) const
Static Public Member Functions
static USound	make ()
	Return an empty instance.
Public Attributes
char *	data
	Pointer to sound data.
size_t	size
	Total size in byte.
size_t	channels
	Number of audio channels.
size_t	rate
	Rate in Hertz.
size_t	sampleSize
	Sample size in bit.
USoundFormat	soundFormat
	Format of the sound data.
USoundSampleFormat	sampleFormat
	Sample format.
Private Member Functions
std::string	headers_ () const
Friends
class	UBinary

---

Detailed Description

Class encapsulating sound information.

This class does not handle its memory: the data field must be freed manualy.

Definition at line 62 of file usound.hh.

---

Member Function Documentation

std::ostream & urbi::USound::dump

(

std::ostream &

o

)

const

Definition at line 135 of file usound.cc.

References channels, format_string(), rate, sampleFormat, sampleSize, and size.

Referenced by urbi::operator<<().

const char * urbi::USound::format_string

(

)

const

Return a legible definition of imageFormat.

Definition at line 120 of file usound.cc.

References soundFormat.

Referenced by dump(), and headers_().

std::string urbi::USound::headers_

(

)

const [private]

Definition at line 126 of file usound.cc.

References channels, format_string(), rate, sampleFormat, and sampleSize.

Referenced by urbi::UBinary::getMessage().

void urbi::USound::init

(

)

Initialize.

Not a constructor so that we can still put it in a union.

Definition at line 97 of file usound.cc.

References channels, data, rate, urbi::SAMPLE_UNSIGNED, sampleFormat, sampleSize, size, urbi::SOUND_UNKNOWN, and soundFormat.

Referenced by make().

USound urbi::USound::make

(

)

[static]

Return an empty instance.

Not a constructor so that we can still put it in a union.

Definition at line 106 of file usound.cc.

References init().

Referenced by urbi::UValue::operator USound().

bool urbi::USound::operator==

(

const USound &

b

)

const

Definition at line 114 of file usound.cc.

---

Friends And Related Function Documentation

friend class UBinary [friend]

Definition at line 99 of file usound.hh.

---

Member Data Documentation

size_t urbi::USound::channels

Number of audio channels.

Definition at line 86 of file usound.hh.

Referenced by urbi::convert(), dump(), headers_(), init(), urbi::UBinary::parse(), and urbi::UAbstractClient::sendSound().

char* urbi::USound::data

Pointer to sound data.

Definition at line 82 of file usound.hh.

Referenced by urbi::convert(), init(), urbi::UAbstractClient::sendSound(), and urbi::UBinary::UBinary().

size_t urbi::USound::rate

Rate in Hertz.

Definition at line 88 of file usound.hh.

Referenced by urbi::convert(), dump(), headers_(), init(), urbi::UBinary::parse(), and urbi::UAbstractClient::sendSound().

USoundSampleFormat urbi::USound::sampleFormat

Sample format.

Definition at line 96 of file usound.hh.

Referenced by urbi::convert(), dump(), headers_(), init(), urbi::UBinary::parse(), and urbi::UAbstractClient::sendSound().

size_t urbi::USound::sampleSize

Sample size in bit.

Definition at line 90 of file usound.hh.

Referenced by urbi::convert(), dump(), headers_(), init(), urbi::UBinary::parse(), and urbi::UAbstractClient::sendSound().

size_t urbi::USound::size

Total size in byte.

Definition at line 84 of file usound.hh.

Referenced by urbi::convert(), dump(), init(), urbi::UBinary::parse(), urbi::UAbstractClient::sendSound(), and urbi::UBinary::UBinary().

USoundFormat urbi::USound::soundFormat

Format of the sound data.

Definition at line 93 of file usound.hh.

Referenced by urbi::convert(), format_string(), init(), urbi::UValue::operator std::string(), urbi::UBinary::parse(), and urbi::UAbstractClient::sendSound().

---

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

• usound.hh
• usound.cc