UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FWasapiDefaultRenderStream Class Reference

#include <WasapiDefaultRenderStream.h>

+ Inheritance diagram for Audio::FWasapiDefaultRenderStream:

Public Member Functions

virtual ~FWasapiDefaultRenderStream ()=default
 
virtual bool InitializeHardware (const FWasapiRenderStreamParams &InParams) override
 
virtual bool TeardownHardware () override
 
virtual void SubmitBuffer (const uint8 *Buffer, const SIZE_T InNumFrames) override
 
virtual void DeviceRenderCallback () override
 
FAudioMixerReadNextBufferDelegateOnReadNextBuffer ()
 
- Public Member Functions inherited from Audio::FAudioMixerWasapiRenderStream
 FAudioMixerWasapiRenderStream ()
 
virtual ~FAudioMixerWasapiRenderStream ()
 
virtual bool IsInitialized () const
 
virtual int32 GetNumFrames (const int32 InNumRequestedFrames) const
 
virtual bool OpenAudioStream (const FWasapiRenderStreamParams &InParams, HANDLE InEventHandle)
 
virtual bool CloseAudioStream ()
 
virtual bool StartAudioStream ()
 
virtual bool StopAudioStream ()
 
virtual void SubmitDirectOutBuffer (const int32 InChannelIndex, const FAlignedFloatBuffer &InBuffer)
 
 UE_DEPRECATED (5.7, "GetMinimumBufferSize() is deprecated. Please use GetDefaultDevicePeriod() in the future.") static uint32 GetMinimumBufferSize(const uint32 InSampleRate)
 
- Public Member Functions inherited from Audio::IDeviceRenderCallback
virtual ~IDeviceRenderCallback ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from Audio::FAudioMixerWasapiRenderStream
uint32 GetDefaultDevicePeriod () const
 
- Protected Attributes inherited from Audio::FAudioMixerWasapiRenderStream
TComPtr< IAudioClient2AudioClient
 
TComPtr< IAudioRenderClientRenderClient
 
FWasapiAudioFormat AudioFormat
 
std::atomic< boolbIsInitialized = false
 
std::atomic< EAudioOutputStreamState::TypeStreamState = EAudioOutputStreamState::Closed
 
FWasapiRenderStreamParams RenderStreamParams
 
uint32 DefaultDevicePeriod = 0
 
uint32 NumFramesPerDeviceBuffer = 0
 
uint32 CallbackBufferErrors = 0
 
FAlignedFloatBuffer DownmixScratchBuffer
 
TArray< floatMixdownGainsMap
 

Detailed Description

FWasapiDefaultRenderStream The default channel output stream. This is the first eight channels which are reserved for the main outputs of the editor/game.

Constructor & Destructor Documentation

◆ ~FWasapiDefaultRenderStream()

virtual Audio::FWasapiDefaultRenderStream::~FWasapiDefaultRenderStream ( )
virtualdefault

Member Function Documentation

◆ DeviceRenderCallback()

void Audio::FWasapiDefaultRenderStream::DeviceRenderCallback ( )
overridevirtual

◆ InitializeHardware()

bool Audio::FWasapiDefaultRenderStream::InitializeHardware ( const FWasapiRenderStreamParams InParams)
overridevirtual

◆ OnReadNextBuffer()

FAudioMixerReadNextBufferDelegate & Audio::FWasapiDefaultRenderStream::OnReadNextBuffer ( )
inline

◆ SubmitBuffer()

void Audio::FWasapiDefaultRenderStream::SubmitBuffer ( const uint8 Buffer,
const SIZE_T  InNumFrames 
)
overridevirtual

◆ TeardownHardware()

bool Audio::FWasapiDefaultRenderStream::TeardownHardware ( )
overridevirtual

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