ncine::IAudioDevice Class Reference

Audio device interface class. More...

#include <IAudioDevice.h>

Inheritance diagram for ncine::IAudioDevice:

Classes
struct	ALExtensions
	OpenAL queryable extensions. More...
struct	Attributes
	Audio device attributes class. More...

Public Types
enum class	PlayerType { BUFFER , STREAM }

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

Static Public Attributes
static const unsigned int	InvalidSource = ~0U

Detailed Description

Audio device interface class.

Member Function Documentation

attributes()

virtual const Attributes & ncine::IAudioDevice::attributes ( ) const

pure virtual

Returns the audio device attributes.

Implemented in ncine::NullAudioDevice.

gain()

virtual float ncine::IAudioDevice::gain ( ) const

pure virtual

Returns the listener gain value.

Implemented in ncine::NullAudioDevice.

maxNumSources()

virtual unsigned int ncine::IAudioDevice::maxNumSources ( ) const

pure virtual

Returns the maximum number of audio sources.

Implemented in ncine::NullAudioDevice.

name()

virtual const char * ncine::IAudioDevice::name ( ) const

pure virtual

Returns the name of the audio device.

Implemented in ncine::NullAudioDevice.

numAvailableSources()

virtual unsigned int ncine::IAudioDevice::numAvailableSources ( ) const

pure virtual

Returns the number of available audio sources.

Implemented in ncine::NullAudioDevice.

numPlayers()

virtual unsigned int ncine::IAudioDevice::numPlayers ( ) const

pure virtual

Returns the number of active players.

Implemented in ncine::NullAudioDevice.

pauseDevice()

virtual void ncine::IAudioDevice::pauseDevice ( )

pure virtual

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

Note

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

Implemented in ncine::NullAudioDevice.

pausePlayers() [1/2]

virtual void ncine::IAudioDevice::pausePlayers ( )

pure virtual

Pauses every player currently playing.

Note

Paused players can be resumed with resumePlayers().

Implemented in ncine::NullAudioDevice.

pausePlayers() [2/2]

virtual void ncine::IAudioDevice::pausePlayers ( PlayerType  playerType )

pure virtual

Pauses every player of the specified type.

Implemented in ncine::NullAudioDevice.

player() [1/2]

virtual const IAudioPlayer * ncine::IAudioDevice::player ( unsigned int  index ) const

pure virtual

Returns the specified active player object (const version)

Implemented in ncine::NullAudioDevice.

player() [2/2]

virtual IAudioPlayer * ncine::IAudioDevice::player ( unsigned int  index )

pure virtual

Returns the specified active player object.

Implemented in ncine::NullAudioDevice.

position()

virtual Vector3f ncine::IAudioDevice::position ( ) const

pure virtual

Returns the listener position vector.

Implemented in ncine::NullAudioDevice.

registerPlayer()

virtual void ncine::IAudioDevice::registerPlayer ( IAudioPlayer *  player )

pure virtual

Registers a new stream player for buffer update.

Implemented in ncine::NullAudioDevice.

resumeDevice()

virtual void ncine::IAudioDevice::resumeDevice ( )

pure virtual

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

Note

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

Implemented in ncine::NullAudioDevice.

resumePlayers()

virtual void ncine::IAudioDevice::resumePlayers ( )

pure virtual

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

Implemented in ncine::NullAudioDevice.

setGain()

virtual void ncine::IAudioDevice::setGain ( float  gain )

pure virtual

Sets the listener gain value.

Implemented in ncine::NullAudioDevice.

setPosition() [1/2]

virtual void ncine::IAudioDevice::setPosition ( const Vector3f &  position )

pure virtual

Sets the listener position vector.

Implemented in ncine::NullAudioDevice.

setPosition() [2/2]

virtual void ncine::IAudioDevice::setPosition ( float  x, float  y, float  z  )

pure virtual

Sets the listener position vector through components.

Implemented in ncine::NullAudioDevice.

setVelocity() [1/2]

virtual void ncine::IAudioDevice::setVelocity ( const Vector3f &  velocity )

pure virtual

Sets the listener velocity vector.

Implemented in ncine::NullAudioDevice.

setVelocity() [2/2]

virtual void ncine::IAudioDevice::setVelocity ( float  x, float  y, float  z  )

pure virtual

Sets the listener velocity vector through components.

Implemented in ncine::NullAudioDevice.

stopPlayers() [1/2]

virtual void ncine::IAudioDevice::stopPlayers ( )

pure virtual

Stops every player currently playing.

Implemented in ncine::NullAudioDevice.

stopPlayers() [2/2]

virtual void ncine::IAudioDevice::stopPlayers ( PlayerType  playerType )

pure virtual

Stops every player of the specified type.

Implemented in ncine::NullAudioDevice.

unregisterPlayer()

virtual void ncine::IAudioDevice::unregisterPlayer ( IAudioPlayer *  player )

pure virtual

Remove a stream player from the array of active players.

Implemented in ncine::NullAudioDevice.

updatePlayers()

virtual void ncine::IAudioDevice::updatePlayers ( )

pure virtual

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

Implemented in ncine::NullAudioDevice.

velocity()

virtual Vector3f ncine::IAudioDevice::velocity ( ) const

pure virtual

Returns the listener velocity vector.

Implemented in ncine::NullAudioDevice.

---

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

• include/ncine/IAudioDevice.h