IThreadedAE Class Reference

#include <ThreadedAE.h>

Inheritance diagram for IThreadedAE:

Public Member Functions
virtual void	Run ()=0
virtual void	Stop ()=0
Public Member Functions inherited from IAE
virtual void	Shutdown ()
	Called when the application needs to terminate the engine.
virtual bool	Suspend ()=0
	Suspends output and de-initializes sink.
virtual bool	Resume ()=0
	Resumes output and re-initializes sink.
virtual bool	IsSuspended ()
	Get the current Suspend() state.
virtual float	GetVolume ()=0
	Returns the current master volume level of the AudioEngine.
virtual void	SetVolume (const float volume)=0
	Sets the master volume level of the AudioEngine.
virtual void	SetMute (const bool enabled)=0
	Set the mute state (does not affect volume level value)
virtual bool	IsMuted ()=0
	Get the current mute state.
virtual StreamPtr	MakeStream (AEAudioFormat &audioFormat, unsigned int options=0, IAEClockCallback *clock=NULL)=0
	Creates and returns a new IAEStream in the format specified, this function should never fail.
virtual SoundPtr	MakeSound (const std::string &file)=0
	Creates a new IAESound that is ready to play the specified file.
virtual void	EnumerateOutputDevices (AEDeviceList &devices, bool passthrough)=0
	Enumerate the supported audio output devices.
virtual bool	SupportsRaw (AEAudioFormat &format)
	Returns true if the AudioEngine supports AE_FMT_RAW streams for use with formats such as IEC61937.
virtual bool	SupportsSilenceTimeout ()
	Returns true if the AudioEngine supports drain mode which is not streaming silence when idle.
virtual bool	UsesDtsCoreFallback ()
	Returns true if the AudioEngine is currently configured to extract the DTS Core from DTS-HD streams.
virtual bool	HasStereoAudioChannelCount ()
	Returns true if the AudioEngine is currently configured for stereo audio.
virtual bool	HasHDAudioChannelCount ()
	Returns true if the AudioEngine is currently configured for HD audio (more than 5.1)
virtual void	RegisterAudioCallback (IAudioCallback *pCallback)
virtual void	UnregisterAudioCallback (IAudioCallback *pCallback)
virtual bool	SupportsQualityLevel (enum AEQuality level)
	Returns true if AudioEngine supports specified quality level.
virtual bool	IsSettingVisible (const std::string &settingId)
	AE decides whether this settings should be displayed.
virtual void	KeepConfiguration (unsigned int millis)
	Instruct AE to keep configuration for a specified time.
virtual void	DeviceChange ()
	Instruct AE to re-initialize, e.g. after ELD change event.
virtual void	DeviceCountChange (const std::string &driver)
	Instruct AE to re-initialize, e.g. after ELD change event.
virtual bool	GetCurrentSinkFormat (AEAudioFormat &SinkFormat)
	Get the current sink data format.
Public Member Functions inherited from IRunnable
virtual void	Cancel ()
virtual	~IRunnable ()=default

Additional Inherited Members
Public Types inherited from IAE
using	StreamPtr = std::unique_ptr< IAEStream, IAEStreamDeleter >
using	SoundPtr = std::unique_ptr< IAESound, IAESoundDeleter >
Protected Member Functions inherited from IAE
	IAE ()=default
virtual	~IAE ()=default
virtual void	Start ()=0
	Initializes the AudioEngine, called by CFactory when it is time to initialize the audio engine.

Member Function Documentation

Run()

virtual void IThreadedAE::Run ( )

pure virtual

Implements IRunnable.

Stop()

virtual void IThreadedAE::Stop ( )

pure virtual

---

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

• ThreadedAE.h