#include <AudioMixerPlatformNonRealtime.h>

Inheritance diagram for Audio::FMixerPlatformNonRealtime:

Public Member Functions
	FMixerPlatformNonRealtime (float InSampleRate=48000, float InNumChannels=2)

	~FMixerPlatformNonRealtime ()

NONREALTIMEAUDIORENDERER_API void	RenderAudio (double NumSecondsToRender)

void	OpenFileToWriteAudioTo (const FString &OutPath)

void	CloseFile ()

virtual FString	GetPlatformApi () const override

virtual bool	InitializeHardware () override

virtual bool	CheckAudioDeviceChange () override

virtual bool	TeardownHardware () override

virtual bool	IsInitialized () const override

virtual bool	GetNumOutputDevices (uint32 &OutNumOutputDevices) override

virtual bool	GetOutputDeviceInfo (const uint32 InDeviceIndex, FAudioPlatformDeviceInfo &OutInfo) override

virtual bool	GetDefaultOutputDeviceIndex (uint32 &OutDefaultDeviceIndex) const override

virtual bool	OpenAudioStream (const FAudioMixerOpenStreamParams &Params) override

virtual bool	CloseAudioStream () override

virtual bool	StartAudioStream () override

virtual bool	StopAudioStream () override

virtual bool	MoveAudioStreamToNewAudioDevice (const FString &InNewDeviceId) override

virtual void	ResumePlaybackOnNewDevice () override

virtual FAudioPlatformDeviceInfo	GetPlatformDeviceInfo () const override

virtual void	SubmitBuffer (const uint8 *Buffer) override

virtual FString	GetDefaultDeviceName () override

virtual FAudioPlatformSettings	GetPlatformSettings () const override

virtual void	OnHardwareUpdate () override

virtual bool	IsNonRealtime () const override

virtual void	FadeOut () override

virtual void	FadeIn () override

Public Member Functions inherited from Audio::IAudioMixerPlatformInterface
virtual AUDIOMIXERCORE_API	~IAudioMixerPlatformInterface ()

virtual FString	GetCurrentDeviceName () const

virtual AUDIOMIXERCORE_API int32	GetIndexForDevice (const FString &InDeviceName)

virtual bool	MoveAudioStreamToNewAudioDevice ()

virtual bool	RequestDeviceSwap (const FString &DeviceID, bool bInForce, const TCHAR *InReason=nullptr)

virtual void	SubmitDirectOutBuffer (const int32 InDirectOutIndex, const Audio::FAlignedFloatBuffer &InBuffer)

virtual int32	GetNumFrames (const int32 InNumReqestedFrames)

virtual bool	DisablePCMAudioCaching () const

virtual bool	SupportsHardwareDecompression () const

virtual void	SuspendContext ()

virtual void	ResumeContext ()

virtual IAudioPlatformDeviceInfoCache *	GetDeviceInfoCache () const

virtual bool	IsDeviceInfoValid (const FAudioPlatformDeviceInfo &InDeviceInfo) const

virtual bool	ShouldUseDeviceInfoCache () const

AUDIOMIXERCORE_API uint32	Run () override

virtual class FSingleThreadRunnable *	GetSingleThreadInterface () override

virtual AUDIOMIXERCORE_API void	Tick () override

AUDIOMIXERCORE_API	IAudioMixerPlatformInterface ()

AUDIOMIXERCORE_API void	ReadNextBuffer ()

FString	GetLastError () const

AUDIOMIXERCORE_API void	PostInitializeHardware ()

bool	GetIsListeningForDeviceEvents () const

void	SetIsListeningForDeviceEvents (bool bInListeningForDeviceEvents)

Public Member Functions inherited from FRunnable
virtual bool	Init ()

virtual void	Stop ()

virtual void	Exit ()

virtual	~FRunnable ()

Public Member Functions inherited from FSingleThreadRunnable
virtual	~FSingleThreadRunnable ()

Public Member Functions inherited from Audio::IAudioMixerDeviceChangedListener
virtual	~IAudioMixerDeviceChangedListener ()=default

virtual void	RegisterDeviceChangedListener ()

virtual void	UnregisterDeviceChangedListener ()

virtual void	OnDefaultCaptureDeviceChanged (const EAudioDeviceRole InAudioDeviceRole, const FString &DeviceId)

virtual void	OnDefaultRenderDeviceChanged (const EAudioDeviceRole InAudioDeviceRole, const FString &DeviceId)

virtual void	OnDeviceAdded (const FString &DeviceId, bool bIsRenderDevice)

virtual void	OnDeviceRemoved (const FString &DeviceId, bool bIsRenderDevice)

virtual void	OnDeviceStateChanged (const FString &DeviceId, const EAudioDeviceState InState, bool bIsRenderDevice)

virtual void	OnFormatChanged (const FString &InDeviceId, const FFormatChangedData &InFormat)

virtual void	OnSessionDisconnect (EDisconnectReason InReason)

virtual FString	GetDeviceId () const

Protected Member Functions
virtual uint32	RunInternal () override

Protected Member Functions inherited from Audio::IAudioMixerPlatformInterface
AUDIOMIXERCORE_API uint32	MainAudioDeviceRun ()

void	AudioMixerPlatformLogOnce (const FString &LogDetails, const FString &FileName, int32 LineNumber, ELogVerbosity::Type InVerbosity=ELogVerbosity::Error)

AUDIOMIXERCORE_API void	BeginGeneratingAudio ()

AUDIOMIXERCORE_API void	StopGeneratingAudio ()

AUDIOMIXERCORE_API void	ApplyMasterAttenuation (TArrayView< const uint8 > &InOutPoppedAudio)

AUDIOMIXERCORE_API void	ApplyPrimaryAttenuation (TArrayView< const uint8 > &InOutPoppedAudio)

template<typename BufferType >
void	ApplyAttenuationInternal (TArrayView< BufferType > &InOutBuffer)

AUDIOMIXERCORE_API void	StartRunningNullDevice ()

AUDIOMIXERCORE_API void	StopRunningNullDevice ()

AUDIOMIXERCORE_API void	CreateNullDeviceThread (const TFunction< void()> InCallback, float InBufferDuration, bool bShouldPauseOnStart)

Additional Inherited Members
Public Types inherited from Audio::IAudioMixerDeviceChangedListener
enum class	EDisconnectReason { DeviceRemoval , ServerShutdown , FormatChanged , SessionLogoff , SessionDisconnected , ExclusiveModeOverride }

Static Public Member Functions inherited from Audio::IAudioMixerPlatformInterface
static AUDIOMIXERCORE_API bool	GetChannelTypeAtIndex (const int32 Index, EAudioMixerChannel::Type &OutType)

Protected Attributes inherited from Audio::IAudioMixerPlatformInterface
FAudioOutputStreamInfo	AudioStreamInfo

FAudioMixerOpenStreamParams	OpenStreamParams

Audio::FOutputBuffer	OutputBuffer

bool	bWarnedBufferUnderrun

TUniquePtr< FRunnableThread >	AudioRenderThread

FEvent *	AudioRenderEvent

FCriticalSection	DeviceSwapCriticalSection

FThreadSafeBool	bIsInDeviceSwap

FEvent *	AudioFadeEvent

int32	NumOutputBuffers

float	FadeVolume

FParam	FadeParam

FString	CurrentDeviceName

FString	LastError

int32	CallCounterApplyAttenuationInternal { 0 }

int32	CallCounterReadNextBuffer { 0 }

FThreadSafeBool	bPerformingFade

FThreadSafeBool	bFadedOut

FThreadSafeBool	bIsDeviceInitialized

FThreadSafeBool	bMoveAudioStreamToNewAudioDevice

FThreadSafeBool	bIsUsingNullDevice

FThreadSafeBool	bIsGeneratingAudio

const int32	InstanceID { -1 }

Static Protected Attributes inherited from Audio::IAudioMixerPlatformInterface
static AUDIOMIXERCORE_API FThreadSafeCounter	NextInstanceID

Constructor & Destructor Documentation

◆ FMixerPlatformNonRealtime()

Audio::FMixerPlatformNonRealtime::FMixerPlatformNonRealtime	(	float	InSampleRate = `48000`,
		float	InNumChannels = `2`
	)

◆ ~FMixerPlatformNonRealtime()

Audio::FMixerPlatformNonRealtime::~FMixerPlatformNonRealtime ( )

Member Function Documentation

◆ CheckAudioDeviceChange()

bool Audio::FMixerPlatformNonRealtime::CheckAudioDeviceChange ( )

overridevirtual

Check if audio device changed if applicable. Return true if audio device changed.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ CloseAudioStream()

bool Audio::FMixerPlatformNonRealtime::CloseAudioStream ( )

overridevirtual

Closes the audio stream (if it's open).

Implements Audio::IAudioMixerPlatformInterface.

◆ CloseFile()

void Audio::FMixerPlatformNonRealtime::CloseFile ( )

◆ FadeIn()

void Audio::FMixerPlatformNonRealtime::FadeIn ( )

overridevirtual

Reset the fade state (use if reusing audio platform interface, e.g. in main audio device.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ FadeOut()

void Audio::FMixerPlatformNonRealtime::FadeOut ( )

overridevirtual

Start a fadeout. Prevents pops during shutdown.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ GetDefaultDeviceName()

FString Audio::FMixerPlatformNonRealtime::GetDefaultDeviceName ( )

overridevirtual

Return any optional device name defined in platform configuratio.

Implements Audio::IAudioMixerPlatformInterface.

◆ GetDefaultOutputDeviceIndex()

bool Audio::FMixerPlatformNonRealtime::GetDefaultOutputDeviceIndex ( uint32 & OutDefaultDeviceIndex ) const

overridevirtual

Returns the default device index.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ GetNumOutputDevices()

bool Audio::FMixerPlatformNonRealtime::GetNumOutputDevices ( uint32 & OutNumOutputDevices )

overridevirtual

Returns the number of output devices.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ GetOutputDeviceInfo()

bool Audio::FMixerPlatformNonRealtime::GetOutputDeviceInfo	(	const uint32	InDeviceIndex,
		FAudioPlatformDeviceInfo &	OutInfo
	)

overridevirtual

Gets the device information of the given device index.

Implements Audio::IAudioMixerPlatformInterface.

◆ GetPlatformApi()

virtual FString Audio::FMixerPlatformNonRealtime::GetPlatformApi ( ) const

inlineoverridevirtual

Returns the platform API name.

Implements Audio::IAudioMixerPlatformInterface.

◆ GetPlatformDeviceInfo()

FAudioPlatformDeviceInfo Audio::FMixerPlatformNonRealtime::GetPlatformDeviceInfo ( ) const

overridevirtual

Returns the platform device info of the currently open audio stream.

Implements Audio::IAudioMixerPlatformInterface.

◆ GetPlatformSettings()

FAudioPlatformSettings Audio::FMixerPlatformNonRealtime::GetPlatformSettings ( ) const

overridevirtual

Gets the platform specific audio settings.

Implements Audio::IAudioMixerPlatformInterface.

◆ InitializeHardware()

bool Audio::FMixerPlatformNonRealtime::InitializeHardware ( )

overridevirtual

Initialize the hardware.

Implements Audio::IAudioMixerPlatformInterface.

◆ IsInitialized()

bool Audio::FMixerPlatformNonRealtime::IsInitialized ( ) const

overridevirtual

Is the hardware initialized.

Implements Audio::IAudioMixerPlatformInterface.

◆ IsNonRealtime()

bool Audio::FMixerPlatformNonRealtime::IsNonRealtime ( ) const

overridevirtual

Whether this is an interface for a non-realtime renderer. If true, synch events will behave differently to avoid deadlocks.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ MoveAudioStreamToNewAudioDevice()

bool Audio::FMixerPlatformNonRealtime::MoveAudioStreamToNewAudioDevice ( const FString & InNewDeviceId )

overridevirtual

Resets the audio stream to use a new audio device with the given device ID (empty string means default).

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ OnHardwareUpdate()

void Audio::FMixerPlatformNonRealtime::OnHardwareUpdate ( )

overridevirtual

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ OpenAudioStream()

bool Audio::FMixerPlatformNonRealtime::OpenAudioStream ( const FAudioMixerOpenStreamParams & Params )

overridevirtual

Opens up a new audio stream with the given parameters.

Implements Audio::IAudioMixerPlatformInterface.

◆ OpenFileToWriteAudioTo()

void Audio::FMixerPlatformNonRealtime::OpenFileToWriteAudioTo ( const FString & OutPath )

◆ RenderAudio()

void Audio::FMixerPlatformNonRealtime::RenderAudio ( double NumSecondsToRender )

◆ ResumePlaybackOnNewDevice()

void Audio::FMixerPlatformNonRealtime::ResumePlaybackOnNewDevice ( )

overridevirtual

Resumes playback on new audio device after device change.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ RunInternal()

uint32 Audio::FMixerPlatformNonRealtime::RunInternal ( )

overrideprotectedvirtual

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ StartAudioStream()

bool Audio::FMixerPlatformNonRealtime::StartAudioStream ( )

overridevirtual

Starts the audio stream processing and generating audio.

Implements Audio::IAudioMixerPlatformInterface.

◆ StopAudioStream()

bool Audio::FMixerPlatformNonRealtime::StopAudioStream ( )

overridevirtual

Stops the audio stream (but keeps the audio stream open).

Implements Audio::IAudioMixerPlatformInterface.

◆ SubmitBuffer()

void Audio::FMixerPlatformNonRealtime::SubmitBuffer ( const uint8 * Buffer )

overridevirtual

Submit the given buffer to the platform's output audio device.

Reimplemented from Audio::IAudioMixerPlatformInterface.

◆ TeardownHardware()

bool Audio::FMixerPlatformNonRealtime::TeardownHardware ( )

overridevirtual

Teardown the hardware.

Implements Audio::IAudioMixerPlatformInterface.

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

Engine/Source/Runtime/NonRealtimeAudioRenderer/Public/AudioMixerPlatformNonRealtime.h
Engine/Source/Runtime/NonRealtimeAudioRenderer/Private/AudioMixerPlatformNonRealtime.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FMixerPlatformNonRealtime()

◆ ~FMixerPlatformNonRealtime()

Member Function Documentation

◆ CheckAudioDeviceChange()

◆ CloseAudioStream()

◆ CloseFile()

◆ FadeIn()

◆ FadeOut()

◆ GetDefaultDeviceName()

◆ GetDefaultOutputDeviceIndex()

◆ GetNumOutputDevices()

◆ GetOutputDeviceInfo()

◆ GetPlatformApi()

◆ GetPlatformDeviceInfo()

◆ GetPlatformSettings()

◆ InitializeHardware()

◆ IsInitialized()

◆ IsNonRealtime()

◆ MoveAudioStreamToNewAudioDevice()

◆ OnHardwareUpdate()

◆ OpenAudioStream()

◆ OpenFileToWriteAudioTo()

◆ RenderAudio()

◆ ResumePlaybackOnNewDevice()

◆ RunInternal()

◆ StartAudioStream()

◆ StopAudioStream()

◆ SubmitBuffer()

◆ TeardownHardware()