FMixerPlatformNonRealtime

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

NonRealtimeAudioRenderer

Header

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

Include

#include "AudioMixerPlatformNonRealtime.h"

Syntax

class FMixerPlatformNonRealtime : public Audio::IAudioMixerPlatformInterface

Constructors

Name Description

Public function

FMixerPlatformNonRealtime

(
    float InSampleRate,
    float InNumChannels
)

Destructors

Name Description

Public function

~FMixerPlatformNonRealtime()

Functions

Name Description

Public function

void

 

CloseFile()

Public function

void

 

OpenFileToWriteAudioTo

(
    const FString& OutPath
)

Public function

void

 

RenderAudio

(
    double NumSecondsToRender
)

Overridden from IAudioMixerPlatformInterface

Name Description

Public function Virtual

bool

 

CheckAudioDeviceChange()

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

Public function Virtual

bool

 

CloseAudioStream()

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

Public function Virtual

ICompressedA...

 

CreateCompressedAudioInfo

(
    USoundWave* SoundWave
)

Creates a Compressed audio info class suitable for decompressing this SoundWave.

Public function Virtual

ICompressedA...

 

CreateCompressedAudioInfo

(
    const FSoundWaveProxyPtr& InSoundW...
)

Public function Virtual Const

bool

 

DisablePCMAudioCaching()

Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms)

Public function Virtual

void

 

FadeIn()

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

Public function Virtual

void

 

FadeOut()

Start a fadeout. Prevents pops during shutdown.

Public function Virtual

FString

 

GetDefaultDeviceName()

Return any optional device name defined in platform configuratio.

Public function Virtual Const

bool

 

GetDefaultOutputDeviceIndex

(
    uint32& OutDefaultDeviceIndex
)

Returns the default device index.

Public function Virtual

bool

 

GetNumOutputDevices

(
    uint32& OutNumOutputDevices
)

Returns the number of output devices.

Public function Virtual

bool

 

GetOutputDeviceInfo

(
    const uint32 InDeviceIndex,
    FAudioPlatformDeviceInfo& OutInfo
)

Gets the device information of the given device index.

Public function Virtual Const

EAudioMixerP...

 

GetPlatformApi()

Returns the platform API enumeration.

Public function Virtual Const

FAudioPlatfo...

 

GetPlatformDeviceInfo()

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

Public function Virtual Const

FAudioPlatfo...

 

GetPlatformSettings()

Gets the platform specific audio settings.

Public function Virtual

FName

 

GetRuntimeFormat

(
    USoundWave* InSoundWave
)

Returns the name of the format of the input sound wave.

Public function Virtual

bool

 

HasCompressedAudioInfoClass

(
    USoundWave* InSoundWave
)

Checks if the platform has a compressed audio format for sound waves.

Public function Virtual

bool

 

InitializeHardware()

Initialize the hardware.

Public function Virtual Const

bool

 

IsInitialized()

Is the hardware initialized.

Public function Virtual Const

bool

 

IsNonRealtime()

Whether this is an interface for a non-realtime renderer.

Public function Virtual

bool

 

MoveAudioStreamToNewAudioDevice

(
    const FString& InNewDeviceId
)

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

Public function Virtual

void

 

OnHardwareUpdate()

Function called at the beginning of every call of UpdateHardware on the audio thread.

Public function Virtual

bool

 

OpenAudioStream

(
    const FAudioMixerOpenStreamParams&...
)

Opens up a new audio stream with the given parameters.

Public function Virtual

void

 

ResumePlaybackOnNewDevice()

Resumes playback on new audio device after device change.

Protected function Virtual

uint32

 

RunInternal()

Wrapper around the thread Run. This is virtualized so a platform can fundamentally override the render function.

Public function Virtual

bool

 

StartAudioStream()

Starts the audio stream processing and generating audio.

Public function Virtual

bool

 

StopAudioStream()

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

Public function Virtual

void

 

SubmitBuffer

(
    const uint8* Buffer
)

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

Public function Virtual Const

bool

 

SupportsRealtimeDecompression()

Whether or not the platform supports realtime decompression.

Public function Virtual

bool

 

TeardownHardware()

Teardown the hardware.