csl::SoundCue Class Reference

#include <SoundFile.h>

Inheritance diagram for csl::SoundCue:

List of all members.

Public Member Functions
	SoundCue ()
	SoundCue (string name, Abst_SoundFile *file=0, int start=1, int stop=-1)
	Constructor.
	~SoundCue ()
void	readFrom (FILE *input)
	for loading file lists
void	dump (void)
void	nextBuffer (Buffer &outputBuffer) throw (CException)
	UGen operations.
bool	isActive ()
	query whether I'm currently active (Envelopes can go inactive)
unsigned	channels () const
void	setToEnd (void)
void	trigger (void)
float	duration () const
	duration in frames
Public Attributes
string	mName
	my name
Abst_SoundFile *	mFile
	the file I point into
int	mStart
int	mStop
int	mCurrent
	the start/stop samples I represent
UnitGenerator *	mReadRate
	my playback rate
Protected Attributes
float	mFloatCurrent
	current pointer as a float

---

Detailed Description

SoundCue -- a pointer to a segment of a sound file

---

Constructor & Destructor Documentation

SoundCue::SoundCue

(

)

References mCurrent, and mFile.

SoundCue::SoundCue	(	string	name,
		Abst_SoundFile *	file = 0,
		int	start = 1,
		int	stop = -1
	)

Constructor.

References mCurrent, mReadRate, and mStart.

SoundCue::~SoundCue

(

)

---

Member Function Documentation

void SoundCue::readFrom

(

FILE *

input

)

for loading file lists

References mCurrent, mName, mStart, and mStop.

void SoundCue::dump

(

void

)

[virtual]

pretty-print me

Reimplemented from csl::UnitGenerator.

References csl::Abst_SoundFile::channels(), csl::UnitGenerator::frameRate(), csl::logMsg(), mFile, mName, mStart, and mStop.

void SoundCue::nextBuffer

(

Buffer &

outputBuffer

)

throw (CException) [virtual]

UGen operations.

copy next buffer from cache

Reimplemented from csl::UnitGenerator.

References h.

bool SoundCue::isActive

(

)

[virtual]

query whether I'm currently active (Envelopes can go inactive)

Reimplemented from csl::UnitGenerator.

References mCurrent, mFile, and mStop.

unsigned csl::SoundCue::channels

(

)

const [inline]

References csl::Abst_SoundFile::channels(), and mFile.

void SoundCue::setToEnd

(

void

)

References mCurrent, and mStop.

void SoundCue::trigger

(

void

)

References mCurrent, mFloatCurrent, and mStart.

Referenced by phonemes(), play_crackle(), play_nfile(), play_sns(), and play_wood().

float csl::SoundCue::duration

(

)

const [inline]

duration in frames

References mStart, and mStop.

Referenced by play_crackle(), play_nfile(), play_sns(), and play_wood().

---

Member Data Documentation

string csl::SoundCue::mName

my name

Referenced by dump(), and readFrom().

Abst_SoundFile* csl::SoundCue::mFile

the file I point into

Referenced by channels(), dump(), isActive(), and SoundCue().

int csl::SoundCue::mStart

Referenced by dump(), duration(), readFrom(), SoundCue(), and trigger().

int csl::SoundCue::mStop

Referenced by dump(), duration(), isActive(), readFrom(), and setToEnd().

int csl::SoundCue::mCurrent

the start/stop samples I represent

Referenced by isActive(), readFrom(), setToEnd(), SoundCue(), and trigger().

UnitGenerator* csl::SoundCue::mReadRate

my playback rate

Referenced by SoundCue().

float csl::SoundCue::mFloatCurrent [protected]

current pointer as a float

Referenced by trigger().

---

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

• CSL/IO/SoundFile.h
• CSL/IO/SoundFile.cpp