FIFE::SoundClip Class Reference

#include <soundclip.h>

Inheritance diagram for FIFE::SoundClip:

Collaboration diagram for FIFE::SoundClip:

List of all members.

Public Member Functions
bool	isStream () const
unsigned int	countBuffers () const
ALuint *	getBuffers (unsigned int streamid=0) const
unsigned int	beginStreaming ()
void	acquireStream (unsigned int streamid)
bool	setStreamPos (unsigned int streamid, SoundPositionType type, float value)
float	getStreamPos (unsigned int streamid, SoundPositionType type) const
bool	getStream (unsigned int streamid, ALuint buffer)
void	quitStreaming (unsigned int streamid)
SoundDecoder *	getDecoder () const
Public Member Functions inherited from FIFE::ResourceClass
const ResourceLocation &	getResourceLocation ()
virtual void	setResourceLocation (const ResourceLocation &location)
int	getPoolId ()
Public Member Functions inherited from FIFE::FifeClass
fifeid_t	getFifeId ()
virtual void	addRef ()
virtual void	decRef ()
virtual unsigned int	getRefCount ()
Public Member Functions inherited from FIFE::IReferenceCounted
virtual void	addRef ()=0
virtual void	decRef ()=0
virtual unsigned int	getRefCount ()=0

---

Detailed Description

Class to handle the buffers of an audio file

Definition at line 58 of file soundclip.h.

---

Member Function Documentation

void FIFE::SoundClip::acquireStream

(

unsigned int

streamid

)

Fills the streaming-buffers with initial data

Parameters:

streamid

The stream ID

Definition at line 124 of file soundclip.cpp.

References getStream().

Referenced by FIFE::SoundEmitter::setCursor().

Here is the caller graph for this function:

unsigned int FIFE::SoundClip::beginStreaming

(

)

Starts streaming the soundclip

Returns:

Returns the streamid

Definition at line 73 of file soundclip.cpp.

unsigned int FIFE::SoundClip::countBuffers ( ) const

inline

Returns the number of buffers used by the SoundClip (only for non-streaming sound clips)

Returns:

Returns the number of buffers.

Definition at line 78 of file soundclip.h.

ALuint* FIFE::SoundClip::getBuffers ( unsigned int  streamid = 0 ) const

inline

Returns the array of buffers for queuing

Definition at line 85 of file soundclip.h.

Referenced by FIFE::SoundEmitter::setCursor().

Here is the caller graph for this function:

SoundDecoder* FIFE::SoundClip::getDecoder ( ) const

inline

Returns the attached decoder

Definition at line 132 of file soundclip.h.

Referenced by FIFE::SoundEmitter::getBitResolution(), FIFE::SoundEmitter::getDecodedLength(), FIFE::SoundEmitter::getSampleRate(), and FIFE::SoundEmitter::isStereo().

Here is the caller graph for this function:

bool FIFE::SoundClip::getStream	(	unsigned int	streamid,
		ALuint	buffer
	)

Refill a processed buffer with new data

Returns:

True if file was EOF

Parameters:

streamid

The stream ID

Definition at line 133 of file soundclip.cpp.

Referenced by acquireStream().

Here is the caller graph for this function:

float FIFE::SoundClip::getStreamPos	(	unsigned int	streamid,
		SoundPositionType	type
	)		const

Gets the stream position

Definition at line 111 of file soundclip.cpp.

Referenced by FIFE::SoundEmitter::getCursor().

Here is the caller graph for this function:

bool FIFE::SoundClip::isStream ( ) const

inline

Does this SoundClip require a streaming mechanism?

Returns:

Returns true if streaming is required, false if not.

Definition at line 69 of file soundclip.h.

Referenced by FIFE::SoundEmitter::getCursor(), FIFE::SoundEmitter::play(), FIFE::SoundEmitter::reset(), FIFE::SoundEmitter::setCursor(), FIFE::SoundEmitter::setLooping(), and FIFE::SoundEmitter::stop().

Here is the caller graph for this function:

void FIFE::SoundClip::quitStreaming

(

unsigned int

streamid

)

Quits Streaming

Definition at line 164 of file soundclip.cpp.

Referenced by FIFE::SoundEmitter::reset().

Here is the caller graph for this function:

bool FIFE::SoundClip::setStreamPos	(	unsigned int	streamid,
		SoundPositionType	type,
		float	value
	)

Sets the stream position

Returns:

True if position is invalid (EOF has been reached)

Definition at line 86 of file soundclip.cpp.

Referenced by FIFE::SoundEmitter::setCursor().

Here is the caller graph for this function:

---

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

• engine/core/audio/soundclip.h
• engine/core/audio/soundclip.cpp