UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FSynchronizedProceduralDecodeHandle Class Reference
+ Inheritance diagram for Audio::FSynchronizedProceduralDecodeHandle:

Public Member Functions

 FSynchronizedProceduralDecodeHandle (const FProceduralAudioTaskData &InJobData, AudioTaskQueueId InQueueId)
 
virtual EAudioTaskType GetType () const override
 
virtual bool IsDone () const override
 
bool IsQueued () const
 
bool Dequeue (bool Run)
 
virtual void EnsureCompletion () override
 
virtual void CancelTask () override
 
virtual void GetResult (FProceduralAudioTaskResults &OutResult) override
 
- Public Member Functions inherited from Audio::FDecodeHandleBase
 FDecodeHandleBase ()
 
virtual ~FDecodeHandleBase ()
 
- Public Member Functions inherited from Audio::IAudioTask
virtual ~IAudioTask ()
 
virtual void GetResult (FDecodeAudioTaskResults &OutResult)
 

Static Public Member Functions

static void CreateSynchronizedRenderQueued (AudioTaskQueueId QueueId)
 
static void DestroySynchronizedRenderQueued (AudioTaskQueueId QueueId, bool RunCurrentQueue=false)
 
static int KickQueuedTasks (AudioTaskQueueId QueueId)
 

Additional Inherited Members

- Protected Attributes inherited from Audio::FDecodeHandleBase
FAsyncTask< FAsyncDecodeWorker > * Task
 

Constructor & Destructor Documentation

◆ FSynchronizedProceduralDecodeHandle()

Audio::FSynchronizedProceduralDecodeHandle::FSynchronizedProceduralDecodeHandle ( const FProceduralAudioTaskData InJobData,
AudioTaskQueueId  InQueueId 
)
inline

Member Function Documentation

◆ CancelTask()

virtual void Audio::FSynchronizedProceduralDecodeHandle::CancelTask ( )
inlineoverridevirtual

Reimplemented from Audio::FDecodeHandleBase.

◆ CreateSynchronizedRenderQueued()

static void Audio::FSynchronizedProceduralDecodeHandle::CreateSynchronizedRenderQueued ( AudioTaskQueueId  QueueId)
inlinestatic

◆ Dequeue()

bool Audio::FSynchronizedProceduralDecodeHandle::Dequeue ( bool  Run)
inline

◆ DestroySynchronizedRenderQueued()

static void Audio::FSynchronizedProceduralDecodeHandle::DestroySynchronizedRenderQueued ( AudioTaskQueueId  QueueId,
bool  RunCurrentQueue = false 
)
inlinestatic

◆ EnsureCompletion()

virtual void Audio::FSynchronizedProceduralDecodeHandle::EnsureCompletion ( )
inlineoverridevirtual

Reimplemented from Audio::FDecodeHandleBase.

◆ GetResult()

virtual void Audio::FSynchronizedProceduralDecodeHandle::GetResult ( FProceduralAudioTaskResults OutResult)
inlineoverridevirtual

Reimplemented from Audio::IAudioTask.

◆ GetType()

virtual EAudioTaskType Audio::FSynchronizedProceduralDecodeHandle::GetType ( ) const
inlineoverridevirtual

Implements Audio::IAudioTask.

◆ IsDone()

virtual bool Audio::FSynchronizedProceduralDecodeHandle::IsDone ( ) const
inlineoverridevirtual

Reimplemented from Audio::FDecodeHandleBase.

◆ IsQueued()

bool Audio::FSynchronizedProceduralDecodeHandle::IsQueued ( ) const
inline

◆ KickQueuedTasks()

static int Audio::FSynchronizedProceduralDecodeHandle::KickQueuedTasks ( AudioTaskQueueId  QueueId)
inlinestatic

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