UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Audio::FWasapiAggregateRenderStream Class Reference

#include <WasapiAggregateRenderStream.h>

+ Inheritance diagram for Audio::FWasapiAggregateRenderStream:

Public Member Functions

virtual ~FWasapiAggregateRenderStream ()=default
 
virtual bool InitializeHardware (const FWasapiRenderStreamParams &InParams) override
 
virtual bool StartAudioStream () override
 
virtual void SubmitDirectOutBuffer (const int32 InChannelIndex, const FAlignedFloatBuffer &InBuffer) override
 
virtual void DeviceRenderCallback () override
 
- Public Member Functions inherited from Audio::FAudioMixerWasapiRenderStream
 FAudioMixerWasapiRenderStream ()
 
virtual ~FAudioMixerWasapiRenderStream ()
 
virtual bool TeardownHardware ()
 
virtual bool IsInitialized () const
 
virtual int32 GetNumFrames (const int32 InNumRequestedFrames) const
 
virtual bool OpenAudioStream (const FWasapiRenderStreamParams &InParams, HANDLE InEventHandle)
 
virtual bool CloseAudioStream ()
 
virtual bool StopAudioStream ()
 
virtual void SubmitBuffer (const uint8 *Buffer, const SIZE_T InNumFrames)
 
 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< IAudioClient2 > AudioClient
 
TComPtr< IAudioRenderClient > RenderClient
 
FWasapiAudioFormat AudioFormat
 
std::atomic< bool > bIsInitialized = false
 
std::atomic< EAudioOutputStreamState::Type > StreamState = EAudioOutputStreamState::Closed
 
FWasapiRenderStreamParams RenderStreamParams
 
uint32 DefaultDevicePeriod = 0
 
uint32 NumFramesPerDeviceBuffer = 0
 
uint32 CallbackBufferErrors = 0
 
FAlignedFloatBuffer DownmixScratchBuffer
 
TArray< float > MixdownGainsMap
 

Detailed Description

FWasapiAggregateRenderStream A render stream which can be sent to direct output channels which are channels of an aggregate device above the first 8 channels which are reserved for the main output of the editor/game.

Constructor & Destructor Documentation

◆ ~FWasapiAggregateRenderStream()

virtual Audio::FWasapiAggregateRenderStream::~FWasapiAggregateRenderStream ( )
virtualdefault

Member Function Documentation

◆ DeviceRenderCallback()

void Audio::FWasapiAggregateRenderStream::DeviceRenderCallback ( )
overridevirtual

Implements Audio::IDeviceRenderCallback.

◆ InitializeHardware()

bool Audio::FWasapiAggregateRenderStream::InitializeHardware ( const FWasapiRenderStreamParams &  InParams)
overridevirtual

Reimplemented from Audio::FAudioMixerWasapiRenderStream.

◆ StartAudioStream()

bool Audio::FWasapiAggregateRenderStream::StartAudioStream ( )
overridevirtual

Reimplemented from Audio::FAudioMixerWasapiRenderStream.

◆ SubmitDirectOutBuffer()

void Audio::FWasapiAggregateRenderStream::SubmitDirectOutBuffer ( const int32  InChannelIndex,
const FAlignedFloatBuffer &  InBuffer 
)
overridevirtual

Reimplemented from Audio::FAudioMixerWasapiRenderStream.

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