UST_AudioPlaybackEnginePlayer Class Reference

A class responsible for managing audio playback using a playback engine. More...

#include <ST_AudioPlaybackEnginePlayer.h>

Public Member Functions
virtual EAudioIOType	GetAudioIOType () const override
	Gets the type of audio I/O for this playback engine player.
Public Member Functions inherited from UST_AudioIOPlaybackBase
bool	IsPlaying () const
	Checks whether audio playback is currently active.
FDecoderConfig	GetDecoderConfig () const
	Returns the configuration of the audio decoder.
virtual EST_SampleFormat	GetAudioFormat () const override
	Returns the current audio format.
Public Member Functions inherited from UST_AudioIOBase
	UST_AudioIOBase ()
	~UST_AudioIOBase ()
bool	Activate ()
void	Deactivate ()
FAudioIOConfig	GetAudioIOConfig () const
FFFTIOData	GetFFTIOData () const
bool	RegisterSampler (UObject *Sampler, bool bSamplerActivates=false)
void	DeregisterSampler (UObject *Sampler, bool bZeroSamplersDeactivates=false)
template<typename InterfaceType>
bool	ContainsInterface () const
FIntPoint	GetIOId () const

Protected Member Functions
virtual bool	InitializeAudioIO () override
	Initializes the audio IO system for playback with the engine.
virtual void	DeinitializeAudioIO () override
	Deinitializes the audio IO system for playback.
Protected Member Functions inherited from UST_AudioIOPlaybackBase
virtual ma_decoder *	GetPlaybackDecoder () const override
	Retrieves the active audio decoder for playback.
void	SetIsPlaying (bool value)
	Sets whether the system is currently playing audio.
Protected Member Functions inherited from UST_AudioIOBase
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
virtual void	Deinitialize () override
void	BuildFFTIOData (uint32 PeriodSizeInFrames, ma_format Format, uint32 SampleRate, uint32 Channels)
void	DeinitializeFFT ()
virtual ma_encoder *	GetCaptureEncoder () const
void	GetDeviceInfo (EAudioIOType AudioIOType, FString FindDeviceName)

Additional Inherited Members
Static Public Member Functions inherited from UST_AudioIOPlaybackBase
static void	MA_PlaybackCallBack (ma_device *pDevice, void *pOutput, const void *pInput, ma_uint32 frameCount)
	Callback for handling audio playback data.
Static Public Member Functions inherited from UST_AudioIOBase
static void	MA_DataOrganiser (ma_device *pDevice, void *pSamples, uint64 PeriodSizeInFrames, ma_format Format, uint32 Channels)
Public Attributes inherited from UST_AudioIOBase
FCriticalSection	AudioBufferLock
void *	SampledAudioBuffers [BufferCount] = { nullptr, nullptr }
void *	CurrentAudioBuffer = nullptr
std::atomic< uint32 >	ReadIndex
std::atomic< uint32 >	WriteIndex
FOnAudioIOStatusChanged	OnAudioIOStatusChanged
FOnRawMagnitudesReady	OnRawMagnitudesReady
FOnFrequencyBandsReady	OnFrequencyBandsReady
FOnAmplitudesReady	OnAmplitudesReady
FOnPitchesReady	OnPitchesReady
FOnBeatDetected	OnBeatDetected
Static Public Attributes inherited from UST_AudioIOBase
static constexpr uint32	BufferCount = 2
Protected Attributes inherited from UST_AudioIOPlaybackBase
ma_device *	PlaybackDevice = nullptr
	Pointer to the Miniaudio playback device.
ma_decoder *	PlaybackDecoder = nullptr
	Pointer to the Miniaudio decoder for reading audio data.
Protected Attributes inherited from UST_AudioIOBase
bool	bActivated = false
bool	bIsProcessingFFT = false
FCriticalSection	SamplerRegistrationMutex
TArray< UObject * >	RegisteredSamplers
ma_device_id *	pDeviceID = NULL
	Pointer to the selected device ID.
ma_device_info *	pPlaybackDeviceInfos = nullptr
	Playback device information.
ma_device_info *	pCaptureDeviceInfos = nullptr
	Capture device information.
ma_uint32	playbackDeviceCount = 0
	Number of playback devices found.
ma_uint32	captureDeviceCount = 0
	Number of capture devices found.
FFFTIOData	CachedFFTIOData
	Cached FFT IO data.
FAudioIOConfig	CachedAudioIOConfig
	Cached audio IO configuration.

Detailed Description

A class responsible for managing audio playback using a playback engine.

Inherits from UST_AudioIOPlaybackBase and overrides audio IO functionality for managing audio playback with a specific playback engine.

Member Function Documentation

DeinitializeAudioIO()

void UST_AudioPlaybackEnginePlayer::DeinitializeAudioIO ( )

overrideprotectedvirtual

Deinitializes the audio IO system for playback.

This function cleans up and stops the playback engine, freeing resources used for audio playback. It overrides the base class method.

Reimplemented from UST_AudioIOPlaybackBase.

GetAudioIOType()

EAudioIOType UST_AudioPlaybackEnginePlayer::GetAudioIOType ( ) const

inlineoverridevirtual

Gets the type of audio I/O for this playback engine player.

Override to return the specific type for playback using the audio engine.

Returns

The type of the audio I/O, typically an EAudioIOType enumeration.

Reimplemented from UST_AudioIOBase.

InitializeAudioIO()

bool UST_AudioPlaybackEnginePlayer::InitializeAudioIO ( )

overrideprotectedvirtual

Initializes the audio IO system for playback with the engine.

This function sets up the necessary configuration and starts the playback engine for audio playback. It overrides the base class method.

Returns

true if initialization was successful; false otherwise.

Reimplemented from UST_AudioIOBase.

---

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

• C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Public/IO/Playback/ST_AudioPlaybackEnginePlayer.h
• C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Private/IO/Playback/ST_AudioPlaybackEnginePlayer.cpp