1. Epic GamesDeveloper
  3. FMixerPlatformNonRealtime

FMixerPlatformNonRealtime

API > API/Runtime > API/Runtime/NonRealtimeAudioRenderer

Inheritance Hierarchy

References

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

Syntax

class FMixerPlatformNonRealtime : public Audio::IAudioMixerPlatformInterface

Constructors

  Type Name Description
Public function  

FMixerPlatformNonRealtime ( float InSampleRate,
float InNumChannels
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void

OpenFileToWriteAudioTo ( const FString& OutPath
)

  
Public function void

RenderAudio ( double NumSecondsToRender
)

  

Overridden from IAudioMixerPlatformInterface

  Type Name Description
Public function Virtual bool Check if audio device changed if applicable. Return true if audio device changed.
Public function Virtual bool Closes the audio stream (if it's open).
Public function Virtual Const bool 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 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 FString Returns the platform API name.
Public function Virtual Const FAudioPlatformDeviceInfo Returns the platform device info of the currently open audio stream.
Public function Virtual Const FAudioPlatformSettings Gets the platform specific audio settings.
Public function Virtual bool Initialize the hardware.
Public function Virtual Const bool Is the hardware initialized.
Public function Virtual Const bool 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 Function called at the beginning of every call of UpdateHardware on the audio thread.
Public function Virtual bool Opens up a new audio stream with the given parameters.
Public function Virtual void Resumes playback on new audio device after device change.
Protected function Virtual uint32 Wrapper around the thread Run. This is virtualized so a platform can fundamentally override the render function.
Public function Virtual bool Starts the audio stream processing and generating audio.
Public function Virtual bool 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 bool Teardown the hardware.

Deprecated Functions

  Type Name Description
Public function Virtual Const ICompressedAudioInfo *

CreateCompressedAudioInfo ( const FName& InRuntimeFormat
)

 CreateCompressedAudioInfo is now deprecated. Please use IAudioInfoFactory::Create()
Public function Virtual Const FName

GetRuntimeFormat ( const USoundWave* InSoundWave
)

 GetRuntimeFormat is now deprecated. Please use USoundWave::GetRuntimeFormat()

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page