InstantIO::Sample Class Reference

Sample class More...

#include <InstantIO/Sample.h>

List of all members.

Public Member Functions
	Sample ()
	Creates a new Sample object.
	~Sample ()
	Destroys the Sample object.
void	setParameters (unsigned int samplerate, unsigned char bits, unsigned char channels, unsigned long numFrames)
	Sets the parameters of the sample.
unsigned int	getSamplerate () const
	Returns the samplerate.
unsigned char	getBits () const
	Returns the number of bits.
unsigned char	getChannels () const
	Returns the number of channels.
unsigned long	getNumFrames () const
	Returns the number of frames.
unsigned int	getBytesPerFrame () const
	Returns the number of bytes per frame.
const char *	getBuffer () const
	Returns a pointer to the buffer that holds the sample data.
char *	getBuffer ()
	Returns a pointer to the buffer that holds the sample data.
unsigned long	getBufferSize () const
	Returns the size of the buffer that holds the sample data in bytes.

---

Detailed Description

Sample class

---

Member Function Documentation

void InstantIO::Sample::setParameters	(	unsigned int	samplerate,
		unsigned char	bits,
		unsigned char	channels,
		unsigned long	numFrames
	)

Sets the parameters of the sample.

Parameters:

	samplerate	The samplerate
	bits	The number of bits
	channels	The number of channels
	numFrames	The number of frames

unsigned int InstantIO::Sample::getSamplerate

(

)

const [inline]

Returns the samplerate.

Returns:

The samplerate

unsigned char InstantIO::Sample::getBits

(

)

const [inline]

Returns the number of bits.

Returns:

The number of bits

unsigned char InstantIO::Sample::getChannels

(

)

const [inline]

Returns the number of channels.

Returns:

The number of channels

unsigned long InstantIO::Sample::getNumFrames

(

)

const [inline]

Returns the number of frames.

Returns:

The number of frames.

unsigned int InstantIO::Sample::getBytesPerFrame

(

)

const [inline]

Returns the number of bytes per frame.

Returns:

The number of bytes per frame.

const char* InstantIO::Sample::getBuffer

(

)

const [inline]

Returns a pointer to the buffer that holds the sample data.

Returns:

The buffer

char* InstantIO::Sample::getBuffer

(

)

[inline]

Returns a pointer to the buffer that holds the sample data.

Returns:

The buffer

unsigned long InstantIO::Sample::getBufferSize

(

)

const [inline]

Returns the size of the buffer that holds the sample data in bytes.

Returns:

The size

---

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

• Sample.h