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

#include <AudioMixerWasapiDeviceThread.h>

Public Member Functions

 FAudioMixerWasapiDeviceThread ()=delete
 
 FAudioMixerWasapiDeviceThread (const TFunction< void()> &InDeviceRenderCallback, HANDLE &OutEventHandle)
 
 FAudioMixerWasapiDeviceThread (const TFunction< void()> &InDeviceRenderCallback, TArray< HANDLE > &OutEventHandles, const int32 InNumRequestedHandles)
 
bool Start ()
 
void Stop ()
 
void Abort ()
 

Detailed Description

FAudioMixerWasapiDeviceThread - Manages both the FAudioMixerWasapiRunnable object and the thread whose context it runs in.

Constructor & Destructor Documentation

◆ FAudioMixerWasapiDeviceThread() [1/3]

Audio::FAudioMixerWasapiDeviceThread::FAudioMixerWasapiDeviceThread ( )
delete

◆ FAudioMixerWasapiDeviceThread() [2/3]

Audio::FAudioMixerWasapiDeviceThread::FAudioMixerWasapiDeviceThread ( const TFunction< void()> &  InDeviceRenderCallback,
HANDLE &  OutEventHandle 
)

◆ FAudioMixerWasapiDeviceThread() [3/3]

Audio::FAudioMixerWasapiDeviceThread::FAudioMixerWasapiDeviceThread ( const TFunction< void()> &  InDeviceRenderCallback,
TArray< HANDLE > &  OutEventHandles,
const int32  InNumRequestedHandles 
)

Member Function Documentation

◆ Abort()

void Audio::FAudioMixerWasapiDeviceThread::Abort ( )

Abort - Performs non-graceful shutdown of thread which will close the underlying thread handle without waiting for it to finish.

◆ Start()

bool Audio::FAudioMixerWasapiDeviceThread::Start ( )

Start - Creates the FRunnableThread object which immediately begins running the FAudioMixerWasapiRunnable member.

Returns
- Boolean indicating of the thread was successfully created.

◆ Stop()

void Audio::FAudioMixerWasapiDeviceThread::Stop ( )

Stop - Gracefully shuts down the thread.


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