AUD_NULLDevice Class Reference

#include <AUD_NULLDevice.h>

Inheritance diagram for AUD_NULLDevice:

List of all members.

Classes
class	AUD_NULLHandle
Public Member Functions
	AUD_NULLDevice ()
virtual	~AUD_NULLDevice ()
virtual AUD_DeviceSpecs	getSpecs () const
virtual AUD_Reference < AUD_IHandle >	play (AUD_Reference< AUD_IReader > reader, bool keep=false)
virtual AUD_Reference < AUD_IHandle >	play (AUD_Reference< AUD_IFactory > factory, bool keep=false)
virtual void	stopAll ()
virtual void	lock ()
virtual void	unlock ()
virtual float	getVolume () const
virtual void	setVolume (float volume)

---

Detailed Description

This device plays nothing.

Definition at line 40 of file AUD_NULLDevice.h.

---

Constructor & Destructor Documentation

AUD_NULLDevice::AUD_NULLDevice

(

)

Creates a new NULL device.

Definition at line 113 of file AUD_NULLDevice.cpp.

AUD_NULLDevice::~AUD_NULLDevice

(

)

[virtual]

Definition at line 117 of file AUD_NULLDevice.cpp.

---

Member Function Documentation

AUD_DeviceSpecs AUD_NULLDevice::getSpecs

(

)

const [virtual]

Returns the specification of the device.

Implements AUD_IDevice.

Definition at line 121 of file AUD_NULLDevice.cpp.

References AUD_CHANNELS_INVALID, AUD_FORMAT_INVALID, AUD_RATE_INVALID, AUD_DeviceSpecs::channels, AUD_DeviceSpecs::format, and AUD_DeviceSpecs::rate.

float AUD_NULLDevice::getVolume

(

)

const [virtual]

Retrieves the overall device volume.

Returns:

The overall device volume.

Implements AUD_IDevice.

Definition at line 152 of file AUD_NULLDevice.cpp.

void AUD_NULLDevice::lock

(

)

[virtual]

Locks the device. Used to make sure that between lock and unlock, no buffers are read, so that it is possible to start, resume, pause, stop or seek several playback handles simultaneously.

Warning:

Make sure the locking time is as small as possible to avoid playback delays that result in unexpected noise and cracks.

Implements AUD_IDevice.

Definition at line 144 of file AUD_NULLDevice.cpp.

AUD_Reference< AUD_IHandle > AUD_NULLDevice::play	(	AUD_Reference< AUD_IReader >	reader,
		bool	keep = false
	)		[virtual]

Plays a sound source.

Parameters:

reader	The reader to play.
keep	When keep is true the sound source will not be deleted but set to paused when its end has been reached.

Returns:

Returns a handle with which the playback can be controlled. This is NULL if the sound couldn't be played back.

Exceptions:

AUD_Exception

Thrown if there's an unexpected (from the device side) error during creation of the reader.

Implements AUD_IDevice.

Definition at line 130 of file AUD_NULLDevice.cpp.

AUD_Reference< AUD_IHandle > AUD_NULLDevice::play	(	AUD_Reference< AUD_IFactory >	factory,
		bool	keep = false
	)		[virtual]

Plays a sound source.

Parameters:

factory	The factory to create the reader for the sound source.
keep	When keep is true the sound source will not be deleted but set to paused when its end has been reached.

Returns:

Returns a handle with which the playback can be controlled. This is NULL if the sound couldn't be played back.

Exceptions:

AUD_Exception

Thrown if there's an unexpected (from the device side) error during creation of the reader.

Implements AUD_IDevice.

Definition at line 135 of file AUD_NULLDevice.cpp.

void AUD_NULLDevice::setVolume

(

float

volume

)

[virtual]

Sets the overall device volume.

Parameters:

handle	The sound handle.
volume	The overall device volume.

Implements AUD_IDevice.

Definition at line 157 of file AUD_NULLDevice.cpp.

void AUD_NULLDevice::stopAll

(

)

[virtual]

Stops all playing sounds.

Implements AUD_IDevice.

Definition at line 140 of file AUD_NULLDevice.cpp.

void AUD_NULLDevice::unlock

(

)

[virtual]

Unlocks the previously locked device.

Implements AUD_IDevice.

Definition at line 148 of file AUD_NULLDevice.cpp.

---

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

• AUD_NULLDevice.h
• AUD_NULLDevice.cpp