Audaspace 1.7.0
A high level audio library.
Loading...
Searching...
No Matches
PulseAudioDevice Class Reference

This device plays back through PulseAudio, the simple direct media layer. More...

#include <PulseAudioDevice.h>

Inheritance diagram for PulseAudioDevice:

Public Member Functions

 PulseAudioDevice (const std::string &name, DeviceSpecs specs, int buffersize=AUD_DEFAULT_BUFFER_SIZE)
 Opens the PulseAudio audio device for playback.
virtual ~PulseAudioDevice ()
 Closes the PulseAudio audio device.
virtual void seekSynchronizer (double time)
virtual double getSynchronizerPosition ()
virtual void playSynchronizer ()
virtual void stopSynchronizer ()
Public Member Functions inherited from SoftwareDevice
void setQuality (ResampleQuality quality)
 Sets the resampling quality.
virtual DeviceSpecs getSpecs () const
 Returns the specification of the device.
virtual std::shared_ptr< IHandleplay (std::shared_ptr< IReader > reader, bool keep=false)
 Plays a sound source.
virtual std::shared_ptr< IHandleplay (std::shared_ptr< ISound > sound, bool keep=false)
 Plays a sound source.
virtual void stopAll ()
 Stops all playing sounds.
virtual void lock ()
 Locks the device.
virtual void unlock ()
 Unlocks the previously locked device.
virtual float getVolume () const
 Retrieves the overall device volume.
virtual void setVolume (float volume)
 Sets the overall device volume.
virtual Vector3 getListenerLocation () const
 Retrieves the listener location.
virtual void setListenerLocation (const Vector3 &location)
 Sets the listener location.
virtual Vector3 getListenerVelocity () const
 Retrieves the listener velocity.
virtual void setListenerVelocity (const Vector3 &velocity)
 Sets the listener velocity.
virtual Quaternion getListenerOrientation () const
 Retrieves the listener orientation.
virtual void setListenerOrientation (const Quaternion &orientation)
 Sets the listener orientation.
virtual float getSpeedOfSound () const
 Retrieves the speed of sound.
virtual void setSpeedOfSound (float speed)
 Sets the speed of sound.
virtual float getDopplerFactor () const
 Retrieves the doppler factor.
virtual void setDopplerFactor (float factor)
 Sets the doppler factor.
virtual DistanceModel getDistanceModel () const
 Retrieves the distance model.
virtual void setDistanceModel (DistanceModel model)
 Sets the distance model.
virtual void setSyncCallback (syncFunction function, void *data)
virtual int isSynchronizerPlaying ()
Public Member Functions inherited from IDevice
virtual ~IDevice ()
 Destroys the device.

Static Public Member Functions

static void registerPlugin ()
 Registers this plugin.
Static Public Member Functions inherited from SoftwareDevice
static void setPanning (IHandle *handle, float pan)
 Sets the panning of a specific handle.

Protected Member Functions

virtual void playing (bool playing)
 This function tells the device, to start or pause playback.
Protected Member Functions inherited from MixingThreadDevice
void startMixingThread (size_t buffersize)
 Starts the streaming thread.
void notifyMixingThread ()
 Notify the mixing thread.
RingBuffergetRingBuffer ()
 Get ring buffer for reading.
bool isMixingThreadRunning ()
 Returns whether the thread is running or not.
 MixingThreadDevice ()
 Empty default constructor.
void stopMixingThread ()
 Stops all playback and notifies the mixing thread to stop.
Protected Member Functions inherited from SoftwareDevice
void create ()
 Initializes member variables.
void destroy ()
 Uninitializes member variables.
void mix (data_t *buffer, int length)
 Mixes the next samples into the buffer.
void setSpecs (Specs specs)
 Sets the audio output specification of the device.
void setSpecs (DeviceSpecs specs)
 Sets the audio output specification of the device.
 SoftwareDevice ()
 Empty default constructor.

Additional Inherited Members

Public Types inherited from IDevice
typedef void(* syncFunction) (void *, int, float)
 The syncFunction is called when a synchronization event happens.
Protected Attributes inherited from SoftwareDevice
DeviceSpecs m_specs
 The specification of the device.
std::shared_ptr< Mixerm_mixer
 The mixer.
ResampleQuality m_quality
 Resampling quality.

Detailed Description

This device plays back through PulseAudio, the simple direct media layer.

Constructor & Destructor Documentation

◆ PulseAudioDevice()

PulseAudioDevice::PulseAudioDevice ( const std::string & name,
DeviceSpecs specs,
int buffersize = AUD_DEFAULT_BUFFER_SIZE )

Opens the PulseAudio audio device for playback.

Parameters
specsThe wanted audio specification.
buffersizeThe size of the internal buffer.
Note
The specification really used for opening the device may differ.
Exceptions
ExceptionThrown if the audio device cannot be opened.

Member Function Documentation

◆ getSynchronizerPosition()

virtual double PulseAudioDevice::getSynchronizerPosition ( )
virtual

Reimplemented from SoftwareDevice.

◆ playing()

virtual void PulseAudioDevice::playing ( bool playing)
protectedvirtual

This function tells the device, to start or pause playback.

Parameters
playingTrue if device should playback.
Note
This method is only called when the device is locked.

Reimplemented from MixingThreadDevice.

◆ playSynchronizer()

virtual void PulseAudioDevice::playSynchronizer ( )
virtual

Reimplemented from SoftwareDevice.

◆ seekSynchronizer()

virtual void PulseAudioDevice::seekSynchronizer ( double time)
virtual

Reimplemented from SoftwareDevice.

◆ stopSynchronizer()

virtual void PulseAudioDevice::stopSynchronizer ( )
virtual

Reimplemented from SoftwareDevice.


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