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

#include <AudioMixerQuantizedCommands.h>

+ Inheritance diagram for Audio::FQuantizedPlayCommand:

Public Member Functions

AUDIOMIXER_API FQuantizedPlayCommand ()
 
 ~FQuantizedPlayCommand ()
 
virtual AUDIOMIXER_API TSharedPtr< IQuartzQuantizedCommandGetDeepCopyOfDerivedObject () const override
 
virtual AUDIOMIXER_API void OnQueuedCustom (const FQuartzQuantizedCommandInitInfo &InCommandInitInfo) override
 
virtual AUDIOMIXER_API void OnFinalCallbackCustom (int32 InNumFramesLeft) override
 
virtual AUDIOMIXER_API void CancelCustom () override
 
virtual bool RequiresAudioDevice () const override
 
virtual AUDIOMIXER_API FName GetCommandName () const override
 
virtual EQuartzCommandType GetCommandType () const
 
virtual int32 OverrideFramesUntilExec (int32 NumFramesUntilExec)
 
- Public Member Functions inherited from Audio::IQuartzQuantizedCommand
ENGINE_API IQuartzQuantizedCommand ()
 
virtual ENGINE_API ~IQuartzQuantizedCommand ()
 
ENGINE_API void AddSubscriber (FQuartzGameThreadSubscriber InSubscriber)
 
ENGINE_API void OnQueued (const FQuartzQuantizedCommandInitInfo &InCommandInitInfo)
 
ENGINE_API void OnScheduled (const FQuartzClockTickRate &InTickRate)
 
ENGINE_API void Update (int32 NumFramesUntilDeadline)
 
ENGINE_API void FailedToQueue (FQuartzQuantizedRequestData &InGameThreadData)
 
ENGINE_API void AboutToStart ()
 
ENGINE_API void OnFinalCallback (int32 InNumFramesLeft)
 
ENGINE_API void OnClockPaused ()
 
ENGINE_API void OnClockStarted ()
 
ENGINE_API void Cancel ()
 
virtual bool IsClockAltering ()
 
virtual bool ShouldDeadlineIgnoresBpmChanges ()
 

Protected Attributes

TSharedPtr< FQuartzClockOwningClockPtr { nullptr }
 
int32 SourceID { -1 }
 
bool bIsCanceled = false
 

Constructor & Destructor Documentation

◆ FQuantizedPlayCommand()

Audio::FQuantizedPlayCommand::FQuantizedPlayCommand ( )

◆ ~FQuantizedPlayCommand()

Audio::FQuantizedPlayCommand::~FQuantizedPlayCommand ( )
inline

Member Function Documentation

◆ CancelCustom()

void Audio::FQuantizedPlayCommand::CancelCustom ( )
overridevirtual

Reimplemented from Audio::IQuartzQuantizedCommand.

◆ GetCommandName()

FName Audio::FQuantizedPlayCommand::GetCommandName ( ) const
overridevirtual

◆ GetCommandType()

virtual EQuartzCommandType Audio::FQuantizedPlayCommand::GetCommandType ( ) const
inlinevirtual

◆ GetDeepCopyOfDerivedObject()

TSharedPtr< IQuartzQuantizedCommand > Audio::FQuantizedPlayCommand::GetDeepCopyOfDerivedObject ( ) const
overridevirtual

Reimplemented from Audio::IQuartzQuantizedCommand.

◆ OnFinalCallbackCustom()

void Audio::FQuantizedPlayCommand::OnFinalCallbackCustom ( int32  InNumFramesLeft)
overridevirtual

Reimplemented from Audio::IQuartzQuantizedCommand.

◆ OnQueuedCustom()

void Audio::FQuantizedPlayCommand::OnQueuedCustom ( const FQuartzQuantizedCommandInitInfo InCommandInitInfo)
overridevirtual

Reimplemented from Audio::IQuartzQuantizedCommand.

◆ OverrideFramesUntilExec()

int32 Audio::FQuantizedPlayCommand::OverrideFramesUntilExec ( int32  NumFramesUntilExec)
virtual

Reimplemented from Audio::IQuartzQuantizedCommand.

◆ RequiresAudioDevice()

virtual bool Audio::FQuantizedPlayCommand::RequiresAudioDevice ( ) const
inlineoverridevirtual

Reimplemented from Audio::IQuartzQuantizedCommand.

Member Data Documentation

◆ bIsCanceled

bool Audio::FQuantizedPlayCommand::bIsCanceled = false
protected

◆ OwningClockPtr

TSharedPtr<FQuartzClock> Audio::FQuantizedPlayCommand::OwningClockPtr { nullptr }
protected

◆ SourceID

int32 Audio::FQuantizedPlayCommand::SourceID { -1 }
protected

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