AUD_IHandle Class Reference

#include <AUD_IHandle.h>

Inheritance diagram for AUD_IHandle:

List of all members.

Public Member Functions
virtual	~AUD_IHandle ()
virtual bool	pause ()=0
virtual bool	resume ()=0
virtual bool	stop ()=0
virtual bool	getKeep ()=0
virtual bool	setKeep (bool keep)=0
virtual bool	seek (float position)=0
virtual float	getPosition ()=0
virtual AUD_Status	getStatus ()=0
virtual float	getVolume ()=0
virtual bool	setVolume (float volume)=0
virtual float	getPitch ()=0
virtual bool	setPitch (float pitch)=0
virtual int	getLoopCount ()=0
virtual bool	setLoopCount (int count)=0
virtual bool	setStopCallback (stopCallback callback=0, void *data=0)=0

---

Detailed Description

This class represents a playback handles for specific devices.

Definition at line 40 of file AUD_IHandle.h.

---

Constructor & Destructor Documentation

virtual AUD_IHandle::~AUD_IHandle

(

)

[inline, virtual]

Destroys the handle.

Definition at line 46 of file AUD_IHandle.h.

---

Member Function Documentation

virtual bool AUD_IHandle::getKeep

(

)

[pure virtual]

Gets the behaviour of the device for a played back sound when the sound doesn't return any more samples.

Returns:

• true if the source will be paused when it's end is reached
• false if the handle won't kept or is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual int AUD_IHandle::getLoopCount

(

)

[pure virtual]

Retrieves the loop count of a playing sound. A negative value indicates infinity.

Returns:

The remaining loop count.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual float AUD_IHandle::getPitch

(

)

[pure virtual]

Retrieves the pitch of a playing sound.

Returns:

The pitch.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual float AUD_IHandle::getPosition

(

)

[pure virtual]

Retrieves the current playback position of a sound.

Returns:

The playback position in seconds, or 0.0 if the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual AUD_Status AUD_IHandle::getStatus

(

)

[pure virtual]

Returns the status of a played back sound.

Returns:

• AUD_STATUS_INVALID if the sound has stopped or the handle is . invalid
• AUD_STATUS_PLAYING if the sound is currently played back.
• AUD_STATUS_PAUSED if the sound is currently paused.

See also:

AUD_Status

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual float AUD_IHandle::getVolume

(

)

[pure virtual]

Retrieves the volume of a playing sound.

Returns:

The volume.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::pause

(

)

[pure virtual]

Pauses a played back sound.

Returns:

• true if the sound has been paused.
• false if the sound isn't playing back or the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::resume

(

)

[pure virtual]

Resumes a paused sound.

Returns:

• true if the sound has been resumed.
• false if the sound isn't paused or the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::seek

(

float

position

)

[pure virtual]

Seeks in a played back sound.

Parameters:

position

The new position from where to play back, in seconds.

Returns:

• true if the handle is valid.
• false if the handle is invalid.

Warning:

Whether the seek works or not depends on the sound source.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::setKeep

(

bool

keep

)

[pure virtual]

Sets the behaviour of the device for a played back sound when the sound doesn't return any more samples.

Parameters:

keep	True when the source should be paused and not deleted.

Returns:

• true if the behaviour has been changed.
• false if the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::setLoopCount

(

int

count

)

[pure virtual]

Sets the loop count of a playing sound. A negative value indicates infinity.

Parameters:

count

The new loop count.

Returns:

• true if the handle is valid.
• false if the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::setPitch

(

float

pitch

)

[pure virtual]

Sets the pitch of a playing sound.

Parameters:

pitch

The pitch.

Returns:

• true if the handle is valid.
• false if the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::setStopCallback	(	stopCallback	callback = 0,
		void *	data = 0
	)		[pure virtual]

Sets the callback function that's called when the end of a playing sound is reached.

Parameters:

callback	The callback function.
data	The data that should be passed to the callback function.

Returns:

• true if the handle is valid.
• false if the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::setVolume

(

float

volume

)

[pure virtual]

Sets the volume of a playing sound.

Parameters:

volume

The volume.

Returns:

• true if the handle is valid.
• false if the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

virtual bool AUD_IHandle::stop

(

)

[pure virtual]

Stops a played back or paused sound. The handle is definitely invalid afterwards.

Returns:

• true if the sound has been stopped.
• false if the handle is invalid.

Implemented in AUD_SoftwareDevice::AUD_SoftwareHandle.

---

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

• AUD_IHandle.h