#include <AE.h>
◆ IAE()
◆ ~IAE()
◆ DeviceChange()
| virtual void IAE::DeviceChange |
( |
| ) |
|
|
inlinevirtual |
◆ EnumerateOutputDevices()
| virtual void IAE::EnumerateOutputDevices |
( |
AEDeviceList & |
devices, |
|
|
bool |
passthrough |
|
) |
| |
|
pure virtual |
Enumerate the supported audio output devices
- Parameters
-
| devices | The device list to append supported devices to |
| passthrough | True if only passthrough devices are wanted |
Implemented in ActiveAE::CActiveAE.
◆ FreeSound()
◆ FreeStream()
| virtual bool IAE::FreeStream |
( |
IAEStream * |
stream, |
|
|
bool |
finish |
|
) |
| |
|
pure virtual |
This method will remove the specifyed stream from the engine. For OSX/IOS this is essential to reconfigure the audio output.
- Parameters
-
| stream | The stream to be altered |
| finish | if true AE will switch back to gui sound mode (if this is last stream) |
- Returns
- NULL
Implemented in ActiveAE::CActiveAE.
◆ GetCurrentSinkFormat()
| virtual bool IAE::GetCurrentSinkFormat |
( |
AEAudioFormat & |
SinkFormat | ) |
|
|
inlinevirtual |
Get the current sink data format
- Parameters
-
- Returns
- Returns true on success, else false.
Reimplemented in ActiveAE::CActiveAE.
◆ GetVolume()
| virtual float IAE::GetVolume |
( |
| ) |
|
|
pure virtual |
Returns the current master volume level of the AudioEngine
- Returns
- The volume level between 0.0 and 1.0
Implemented in ActiveAE::CActiveAE.
◆ HasHDAudioChannelCount()
| virtual bool IAE::HasHDAudioChannelCount |
( |
| ) |
|
|
inlinevirtual |
Returns true if the AudioEngine is currently configured for HD audio (more than 5.1)
- Returns
- true if the AudioEngine is currently configured for HD audio (more than 5.1)
Reimplemented in ActiveAE::CActiveAE.
◆ HasStereoAudioChannelCount()
| virtual bool IAE::HasStereoAudioChannelCount |
( |
| ) |
|
|
inlinevirtual |
Returns true if the AudioEngine is currently configured for stereo audio
- Returns
- true if the AudioEngine is currently configured for stereo audio
Reimplemented in ActiveAE::CActiveAE.
◆ IsMuted()
| virtual bool IAE::IsMuted |
( |
| ) |
|
|
pure virtual |
◆ IsSettingVisible()
| virtual bool IAE::IsSettingVisible |
( |
const std::string & |
settingId | ) |
|
|
inlinevirtual |
AE decides whether this settings should be displayed
- Returns
- true if AudioEngine wants to display this setting
Reimplemented in ActiveAE::CActiveAE.
◆ IsSuspended()
| virtual bool IAE::IsSuspended |
( |
| ) |
|
|
inlinevirtual |
Get the current Suspend() state Used by players to determine if audio is being processed Default is true so players drop audio or pause if engine unloaded
- Returns
- True if processing suspended
Reimplemented in ActiveAE::CActiveAE.
◆ KeepConfiguration()
| virtual void IAE::KeepConfiguration |
( |
unsigned int |
millis | ) |
|
|
inlinevirtual |
Instruct AE to keep configuration for a specified time
- Parameters
-
| millis | time for which old configuration should be kept |
Reimplemented in ActiveAE::CActiveAE.
◆ MakeSound()
| virtual IAESound * IAE::MakeSound |
( |
const std::string & |
file | ) |
|
|
pure virtual |
Creates a new IAESound that is ready to play the specified file
- Parameters
-
| file | The WAV file to load, this supports XBMC's VFS |
- Returns
- A new IAESound if the file could be loaded, otherwise NULL
Implemented in ActiveAE::CActiveAE.
◆ MakeStream()
Creates and returns a new IAEStream in the format specified, this function should never fail
- Parameters
-
| audioFormat | |
| options | A bit field of stream options (see: enum AEStreamOptions) |
- Returns
- a new IAEStream that will accept data in the requested format
Implemented in ActiveAE::CActiveAE.
◆ RegisterAudioCallback()
◆ Resume()
| virtual bool IAE::Resume |
( |
| ) |
|
|
pure virtual |
Resumes output and re-initializes sink Used to resume output from Suspend() state above
- Returns
- True if successful
Implemented in ActiveAE::CActiveAE.
◆ SetMute()
| virtual void IAE::SetMute |
( |
const bool |
enabled | ) |
|
|
pure virtual |
Set the mute state (does not affect volume level value)
- Parameters
-
Implemented in ActiveAE::CActiveAE.
◆ SetVolume()
| virtual void IAE::SetVolume |
( |
const float |
volume | ) |
|
|
pure virtual |
Sets the master volume level of the AudioEngine
- Parameters
-
| volume | The new volume level between 0.0 and 1.0 |
Implemented in ActiveAE::CActiveAE.
◆ Shutdown()
| virtual void IAE::Shutdown |
( |
| ) |
|
|
inlinevirtual |
Called when the application needs to terminate the engine
Reimplemented in ActiveAE::CActiveAE.
◆ Start()
| virtual void IAE::Start |
( |
| ) |
|
|
protectedpure virtual |
Initializes the AudioEngine, called by CFactory when it is time to initialize the audio engine. Do not call this directly, CApplication will call this when it is ready
Implemented in ActiveAE::CActiveAE.
◆ SupportsQualityLevel()
| virtual bool IAE::SupportsQualityLevel |
( |
enum AEQuality |
level | ) |
|
|
inlinevirtual |
Returns true if AudioEngine supports specified quality level
- Returns
- true if specified quality level is supported, otherwise false
Reimplemented in ActiveAE::CActiveAE.
◆ SupportsRaw()
◆ SupportsSilenceTimeout()
| virtual bool IAE::SupportsSilenceTimeout |
( |
| ) |
|
|
inlinevirtual |
Returns true if the AudioEngine supports drain mode which is not streaming silence when idle
- Returns
- true if the AudioEngine is capable of drain mode
Reimplemented in ActiveAE::CActiveAE.
◆ Suspend()
| virtual bool IAE::Suspend |
( |
| ) |
|
|
pure virtual |
Suspends output and de-initializes sink Used to avoid conflicts with external players or to reduce power consumption
- Returns
- True if successful
Implemented in ActiveAE::CActiveAE.
◆ UnregisterAudioCallback()
The documentation for this class was generated from the following file:
1.9.2