This device plays back through CoreAudio, the Apple audio API. More...
#include <CoreAudioDevice.h>
Inheritance diagram for CoreAudioDevice:
Public Member Functions | |
| CoreAudioDevice (DeviceSpecs specs, int buffersize=AUD_DEFAULT_BUFFER_SIZE) | |
| Opens the CoreAudio audio device for playback. | |
| virtual | ~CoreAudioDevice () |
| Closes the CoreAudio audio device. | |
| virtual ISynchronizer * | getSynchronizer () |
| Retrieves the synchronizer for this device, which enables accurate synchronization between audio playback and video playback for example. | |
 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 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 | |
| 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. | |
Additional Inherited Members | |
| Protected Member Functions inherited from OpenCloseDevice | |
| 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. | |
| 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 plays back through CoreAudio, the Apple audio API.
Constructor & Destructor Documentation
◆ CoreAudioDevice()
| CoreAudioDevice::CoreAudioDevice | ( | DeviceSpecs | specs, |
| int | buffersize = AUD_DEFAULT_BUFFER_SIZE ) |
Opens the CoreAudio audio device for playback.
- Parameters
-
specs The wanted audio specification. buffersize The size of the internal buffer.
- Note
- The specification really used for opening the device may differ.
- Exceptions
-
Exception Thrown if the audio device cannot be opened.
Member Function Documentation
◆ getSynchronizer()
|
virtual |
Retrieves the synchronizer for this device, which enables accurate synchronization between audio playback and video playback for example.
- Returns
- The synchronizer which will be the DefaultSynchronizer if synchonization is not supported.
Reimplemented from SoftwareDevice.
The documentation for this class was generated from the following file:
- coreaudio/CoreAudioDevice.h
