ncine::NullAudioDevice Class Reference

A fake audio device which doesn't play anything. More...

#include <IAudioDevice.h>

Inheritance diagram for ncine::NullAudioDevice:

Collaboration diagram for ncine::NullAudioDevice:

Public Member Functions
const Attributes &	attributes () const override
	Returns the audio device attributes.
const char *	name () const override
	Returns the name of the audio device.
bool	hasExtension (ALExtensions::Enum extensionName) const override
float	gain () const override
	Returns the listener gain value.
void	setGain (float gain) override
	Sets the listener gain value.
Vector3f	position () const override
	Returns the listener position vector.
void	setPosition (const Vector3f &position) override
	Sets the listener position vector.
void	setPosition (float x, float y, float z) override
	Sets the listener position vector through components.
Vector3f	velocity () const override
	Returns the listener velocity vector.
void	setVelocity (const Vector3f &velocity) override
	Sets the listener velocity vector.
void	setVelocity (float x, float y, float z) override
	Sets the listener velocity vector through components.
unsigned int	maxNumSources () const override
	Returns the maximum number of audio sources.
unsigned int	numAvailableSources () const override
	Returns the number of available audio sources.
unsigned int	numPlayers () const override
	Returns the number of active players.
const IAudioPlayer *	player (unsigned int index) const override
	Returns the specified active player object (const version)
IAudioPlayer *	player (unsigned int index) override
	Returns the specified active player object.
void	pausePlayers () override
	Pauses every player currently playing.
void	stopPlayers () override
	Stops every player currently playing.
void	pausePlayers (PlayerType playerType) override
	Pauses every player of the specified type.
void	stopPlayers (PlayerType playerType) override
	Stops every player of the specified type.
void	resumePlayers () override
	Resumes all and only the players that were paused by a pausePlayers() call.
void	pauseDevice () override
	Pauses all audio device activities using an OpenAL-soft extension (if available)
void	resumeDevice () override
void	registerPlayer (IAudioPlayer *player) override
	Registers a new stream player for buffer update.
void	unregisterPlayer (IAudioPlayer *player) override
	Remove a stream player from the array of active players.
void	updatePlayers () override
	Updates players state (and buffer queue in the case of stream players)
Public Member Functions inherited from ncine::IAudioDevice
virtual bool	hasExtension (ALExtensions::Enum extensionName) const =0
	Returns true if the specified OpenAL extension is available.

Additional Inherited Members
Public Types inherited from ncine::IAudioDevice
enum class	PlayerType { BUFFER , STREAM }
Static Public Attributes inherited from ncine::IAudioDevice
static const unsigned int	InvalidSource = ~0U

Detailed Description

A fake audio device which doesn't play anything.

Member Function Documentation

attributes()

const Attributes & ncine::NullAudioDevice::attributes ( ) const

inlineoverridevirtual

Returns the audio device attributes.

Implements ncine::IAudioDevice.

gain()

float ncine::NullAudioDevice::gain ( ) const

inlineoverridevirtual

Returns the listener gain value.

Implements ncine::IAudioDevice.

maxNumSources()

unsigned int ncine::NullAudioDevice::maxNumSources ( ) const

inlineoverridevirtual

Returns the maximum number of audio sources.

Implements ncine::IAudioDevice.

name()

const char * ncine::NullAudioDevice::name ( ) const

inlineoverridevirtual

Returns the name of the audio device.

Implements ncine::IAudioDevice.

numAvailableSources()

unsigned int ncine::NullAudioDevice::numAvailableSources ( ) const

inlineoverridevirtual

Returns the number of available audio sources.

Implements ncine::IAudioDevice.

numPlayers()

unsigned int ncine::NullAudioDevice::numPlayers ( ) const

inlineoverridevirtual

Returns the number of active players.

Implements ncine::IAudioDevice.

pauseDevice()

void ncine::NullAudioDevice::pauseDevice ( )

inlineoverridevirtual

Pauses all audio device activities using an OpenAL-soft extension (if available)

Note

If the extension is not available, all players are paused.

Implements ncine::IAudioDevice.

pausePlayers() [1/2]

void ncine::NullAudioDevice::pausePlayers ( )

inlineoverridevirtual

Pauses every player currently playing.

Note

Paused players can be resumed with resumePlayers().

Implements ncine::IAudioDevice.

pausePlayers() [2/2]

void ncine::NullAudioDevice::pausePlayers ( PlayerType  playerType )

inlineoverridevirtual

Pauses every player of the specified type.

Implements ncine::IAudioDevice.

player() [1/2]

const IAudioPlayer * ncine::NullAudioDevice::player ( unsigned int  index ) const

inlineoverridevirtual

Returns the specified active player object (const version)

Implements ncine::IAudioDevice.

player() [2/2]

IAudioPlayer * ncine::NullAudioDevice::player ( unsigned int  index )

inlineoverridevirtual

Returns the specified active player object.

Implements ncine::IAudioDevice.

position()

Vector3f ncine::NullAudioDevice::position ( ) const

inlineoverridevirtual

Returns the listener position vector.

Implements ncine::IAudioDevice.

registerPlayer()

void ncine::NullAudioDevice::registerPlayer ( IAudioPlayer *  player )

inlineoverridevirtual

Registers a new stream player for buffer update.

Implements ncine::IAudioDevice.

resumeDevice()

void ncine::NullAudioDevice::resumeDevice ( )

inlineoverridevirtual

Resumes all audio device activities using an OpenAL-soft extension (if available) /*!

Note

If the extension is not available, all paused players resume playing. *‍/

Implements ncine::IAudioDevice.

resumePlayers()

void ncine::NullAudioDevice::resumePlayers ( )

inlineoverridevirtual

Resumes all and only the players that were paused by a pausePlayers() call.

Implements ncine::IAudioDevice.

setGain()

void ncine::NullAudioDevice::setGain ( float  gain )

inlineoverridevirtual

Sets the listener gain value.

Implements ncine::IAudioDevice.

setPosition() [1/2]

void ncine::NullAudioDevice::setPosition ( const Vector3f &  position )

inlineoverridevirtual

Sets the listener position vector.

Implements ncine::IAudioDevice.

setPosition() [2/2]

void ncine::NullAudioDevice::setPosition ( float  x, float  y, float  z  )

inlineoverridevirtual

Sets the listener position vector through components.

Implements ncine::IAudioDevice.

setVelocity() [1/2]

void ncine::NullAudioDevice::setVelocity ( const Vector3f &  velocity )

inlineoverridevirtual

Sets the listener velocity vector.

Implements ncine::IAudioDevice.

setVelocity() [2/2]

void ncine::NullAudioDevice::setVelocity ( float  x, float  y, float  z  )

inlineoverridevirtual

Sets the listener velocity vector through components.

Implements ncine::IAudioDevice.

stopPlayers() [1/2]

void ncine::NullAudioDevice::stopPlayers ( )

inlineoverridevirtual

Stops every player currently playing.

Implements ncine::IAudioDevice.

stopPlayers() [2/2]

void ncine::NullAudioDevice::stopPlayers ( PlayerType  playerType )

inlineoverridevirtual

Stops every player of the specified type.

Implements ncine::IAudioDevice.

unregisterPlayer()

void ncine::NullAudioDevice::unregisterPlayer ( IAudioPlayer *  player )

inlineoverridevirtual

Remove a stream player from the array of active players.

Implements ncine::IAudioDevice.

updatePlayers()

void ncine::NullAudioDevice::updatePlayers ( )

inlineoverridevirtual

Updates players state (and buffer queue in the case of stream players)

Implements ncine::IAudioDevice.

velocity()

Vector3f ncine::NullAudioDevice::velocity ( ) const

inlineoverridevirtual

Returns the listener velocity vector.

Implements ncine::IAudioDevice.

---

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

• include/ncine/IAudioDevice.h