OpenCloseDevice Class Referenceabstract
This device extends the SoftwareDevice with code for running mixing in a separate thread. More...
#include <OpenCloseDevice.h>
Inheritance diagram for OpenCloseDevice:
Protected Member Functions | |
| void | closeNow () |
| virtual void | playing (bool playing) |
| This function tells the device, to start or pause playback. | |
 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 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< IHandle > | play (std::shared_ptr< IReader > reader, bool keep=false) |
| Plays a sound source. | |
| virtual std::shared_ptr< IHandle > | play (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 ISynchronizer * | getSynchronizer () |
| Retrieves the synchronizer for this device, which enables accurate synchronization between audio playback and video playback for example. | |
| 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. | |
| Public Member Functions inherited from IDevice | |
| virtual | ~IDevice () |
| Destroys the device. | |
| Static Public Member Functions inherited from SoftwareDevice | |
| static void | setPanning (IHandle *handle, float pan) |
| Sets the panning of a specific handle. | |
| Protected Attributes inherited from SoftwareDevice | |
| DeviceSpecs | m_specs |
| The specification of the device. | |
| std::shared_ptr< Mixer > | m_mixer |
| The mixer. | |
| ResampleQuality | m_quality |
| Resampling quality. | |
Detailed Description
This device extends the SoftwareDevice with code for running mixing in a separate thread.
Member Function Documentation
◆ playing()
|
protectedvirtual |
This function tells the device, to start or pause playback.
- Parameters
-
playing True if device should playback.
- Note
- This method is only called when the device is locked.
Implements SoftwareDevice.
The documentation for this class was generated from the following file:
- devices/OpenCloseDevice.h
Generated by
1.13.2