Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > NonRealtimeAudioRenderer > FMixerPlatformNonRealtime

Light Theme

Dark Theme

FMixerPlatformNonRealtime

Windows

MacOS

Linux

Inheritance Hierarchy

IAudioMixerDeviceChangedLister

IAudioMixerPlatformInterface

FMixerPlatformNonRealtime

References

Module	NonRealtimeAudioRenderer
Header	/Engine/Source/Runtime/NonRealtimeAudioRenderer/Public/AudioMixerPlatformNonRealtime.h
Include	#include "AudioMixerPlatformNonRealtime.h"

Syntax

class FMixerPlatformNonRealtime : public Audio::IAudioMixerPlatformInterface

Constructors

	Name	Description
	FMixerPlatformNonRealtime ( float InSampleRate, float InNumChannels )

Destructors

	Name	Description
	~FMixerPlatformNonRealtime()

Functions

		Name	Description
	void	CloseFile()
	void	OpenFileToWriteAudioTo ( const FString& OutPath )
	void	RenderAudio ( double NumSecondsToRender )

Overridden from IAudioMixerPlatformInterface

	Name	Description
bool	CheckAudioDeviceChange()	Check if audio device changed if applicable. Return true if audio device changed.
bool	CloseAudioStream()	Closes the audio stream (if it's open).
ICompressedA...	CreateCompressedAudioInfo ( USoundWave* SoundWave )	Creates a Compressed audio info class suitable for decompressing this SoundWave.
bool	DisablePCMAudioCaching()	Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms)
void	FadeIn()	Reset the fade state (use if reusing audio platform interface, e.g. in main audio device.
void	FadeOut()	Start a fadeout. Prevents pops during shutdown.
FString	GetDefaultDeviceName()	Return any optional device name defined in platform configuratio.
bool	GetDefaultOutputDeviceIndex ( uint32& OutDefaultDeviceIndex )	Returns the default device index.
bool	GetNumOutputDevices ( uint32& OutNumOutputDevices )	Returns the number of output devices.
bool	GetOutputDeviceInfo ( const uint32 InDeviceIndex, FAudioPlatformDeviceInfo& OutInfo )	Gets the device information of the given device index.
EAudioMixerP...	GetPlatformApi()	Returns the platform API enumeration.
FAudioPlatfo...	GetPlatformDeviceInfo()	Returns the platform device info of the currently open audio stream.
FAudioPlatfo...	GetPlatformSettings()	Gets the platform specific audio settings.
FName	GetRuntimeFormat ( USoundWave* InSoundWave )	Returns the name of the format of the input sound wave.
bool	HasCompressedAudioInfoClass ( USoundWave* InSoundWave )	Checks if the platform has a compressed audio format for sound waves.
bool	InitializeHardware()	Initialize the hardware.
bool	IsInitialized()	Is the hardware initialized.
bool	IsNonRealtime()	Whether this is an interface for a non-realtime renderer.
bool	MoveAudioStreamToNewAudioDevice ( const FString& InNewDeviceId )	Resets the audio stream to use a new audio device with the given device ID (empty string means default).
void	OnHardwareUpdate()	Function called at the beginning of every call of UpdateHardware on the audio thread.
bool	OpenAudioStream ( const FAudioMixerOpenStreamParams&... )	Opens up a new audio stream with the given parameters.
void	ResumePlaybackOnNewDevice()	Resumes playback on new audio device after device change.
uint32	RunInternal()	Wrapper around the thread Run. This is virtualized so a platform can fundamentally override the render function.
bool	StartAudioStream()	Starts the audio stream processing and generating audio.
bool	StopAudioStream()	Stops the audio stream (but keeps the audio stream open).
void	SubmitBuffer ( const uint8* Buffer )	Submit the given buffer to the platform's output audio device.
bool	SupportsRealtimeDecompression()	Whether or not the platform supports realtime decompression.
bool	TeardownHardware()	Teardown the hardware.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss