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

#include <AudioMixerSource.h>

+ Inheritance diagram for Audio::FMixerSource:

Public Member Functions

 FMixerSource (FAudioDevice *InAudioDevice)
 
 ~FMixerSource ()
 
virtual bool Init (FWaveInstance *InWaveInstance) override
 
virtual void Update () override
 
virtual bool PrepareForInitialization (FWaveInstance *InWaveInstance) override
 
virtual bool IsPreparedToInit () override
 
virtual bool IsInitialized () const override
 
virtual void Play () override
 
virtual void Stop () override
 
virtual void StopNow () override
 
virtual bool IsStopping () override
 
virtual void Pause () override
 
virtual bool IsFinished () override
 
virtual float GetPlaybackPercent () const override
 
virtual int64 GetNumFramesPlayed () const override
 
virtual float GetEnvelopeValue () const override
 
virtual float GetRelativeRenderCost () const override
 
virtual void OnBeginGenerate () override
 
virtual void OnDone () override
 
virtual void OnEffectTailsDone () override
 
virtual void OnLoopEnd () override
 
- Public Member Functions inherited from FSoundSource
 FSoundSource (FAudioDevice *InAudioDevice)
 
virtual ENGINE_API ~FSoundSource ()
 
void SetPauseByGame (bool bInIsPauseByGame)
 
void SetPauseManually (bool bInIsPauseManually)
 
virtual ENGINE_API FString Describe (bool bUseLongName)
 
bool IsGameOnly () const
 
const FWaveInstance * GetWaveInstance () const
 
bool IsPlaying () const
 
bool IsPaused () const
 
bool IsPausedByGame () const
 
bool IsPausedManually () const
 
bool IsReverbApplied () const
 
ENGINE_API bool SetReverbApplied (bool bHardwareAvailable)
 
ENGINE_API float SetLFEBleed ()
 
ENGINE_API void SetFilterFrequency ()
 
ENGINE_API void UpdateStereoEmitterPositions ()
 
ENGINE_API FSpatializationParams GetSpatializationParams ()
 
virtual const FSoundBuffer * GetBuffer () const
 
int32 GetNumChannels () const
 
virtual void InitializeSourceEffects (uint32 InEffectVoiceId)
 
void SetVirtual ()
 
virtual ENGINE_API float GetSourceSampleRate () const
 
virtual ENGINE_API int32 GetNumTotalFrames () const
 
virtual ENGINE_API int32 GetStartFrame () const
 
ENGINE_API void GetChannelLocations (FVector &Left, FVector &Right) const
 
void NotifyPlaybackData ()
 
- Public Member Functions inherited from Audio::ISourceListener
virtual ~ISourceListener ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from FSoundSource
ENGINE_API void InitCommon ()
 
ENGINE_API void UpdateCommon ()
 
void UpdatePause ()
 
ENGINE_API float GetDebugVolume (const float InVolume)
 
- Protected Attributes inherited from FSoundSource
FAudioDevice * AudioDevice
 
FWaveInstance * WaveInstance
 
FSoundBuffer * Buffer
 
float LFEBleed
 
float LPFFrequency
 
float HPFFrequency
 
float LastLPFFrequency =MAX_FILTER_FREQUENCY
 
float LastHPFFrequency =MIN_FILTER_FREQUENCY
 
float PlaybackTime
 
float Pitch
 
int32 LastUpdate
 
int32 LastHeardUpdate
 
int32 TickCount
 
FVector LeftChannelSourceLocation
 
FVector RightChannelSourceLocation
 
int32 NumFramesPlayed
 
int32 NumTotalFrames
 
int32 StartFrame
 
int32 NumChannels = 0
 
uint32 VoiceId
 
FThreadSafeBool Playing
 
uint8 bReverbApplied: 1
 
uint8 bIsPausedByGame: 1
 
uint8 bIsManuallyPaused: 1
 
uint8 Paused: 1
 
uint8 bInitialized: 1
 
uint8 bIsPreviewSound: 1
 
uint32 bIsVirtual: 1
 

Detailed Description

FMixerSource Class which implements a sound source object for the audio mixer module.

Constructor & Destructor Documentation

◆ FMixerSource()

Audio::FMixerSource::FMixerSource ( FAudioDevice *  InAudioDevice)

Constructor.

◆ ~FMixerSource()

Audio::FMixerSource::~FMixerSource ( )

Destructor.

Member Function Documentation

◆ GetEnvelopeValue()

float Audio::FMixerSource::GetEnvelopeValue ( ) const
overridevirtual

Returns the source's envelope at the callback block rate. Only implemented in audio mixer.

Reimplemented from FSoundSource.

◆ GetNumFramesPlayed()

int64 Audio::FMixerSource::GetNumFramesPlayed ( ) const
overridevirtual

Returns the number of frames (Samples / NumChannels) played by the sound source.

Reimplemented from FSoundSource.

◆ GetPlaybackPercent()

float Audio::FMixerSource::GetPlaybackPercent ( ) const
overridevirtual

Returns the source's playback percent.

Reimplemented from FSoundSource.

◆ GetRelativeRenderCost()

float Audio::FMixerSource::GetRelativeRenderCost ( ) const
overridevirtual

Returns the source's estimated relative render cost (relative to a single decoded sound). Used for debug information and to constrain overall CPU usage.

Reimplemented from FSoundSource.

◆ Init()

bool Audio::FMixerSource::Init ( FWaveInstance *  InWaveInstance)
overridevirtual

Initializes the sound source.

Implements FSoundSource.

◆ IsFinished()

bool Audio::FMixerSource::IsFinished ( )
overridevirtual

Returns true if the sound source has finished playing.

Implements FSoundSource.

◆ IsInitialized()

bool Audio::FMixerSource::IsInitialized ( ) const
overridevirtual

Returns whether or not the sound source has initialized.

Reimplemented from FSoundSource.

◆ IsPreparedToInit()

bool Audio::FMixerSource::IsPreparedToInit ( )
overridevirtual

Returns if the source voice is prepared to initialize.

Reimplemented from FSoundSource.

◆ IsStopping()

virtual bool Audio::FMixerSource::IsStopping ( )
inlineoverridevirtual

Whether or not the source is stopping. Only implemented in audio mixer.

Reimplemented from FSoundSource.

◆ OnBeginGenerate()

void Audio::FMixerSource::OnBeginGenerate ( )
overridevirtual

Implements Audio::ISourceListener.

◆ OnDone()

void Audio::FMixerSource::OnDone ( )
overridevirtual

Implements Audio::ISourceListener.

◆ OnEffectTailsDone()

void Audio::FMixerSource::OnEffectTailsDone ( )
overridevirtual

Implements Audio::ISourceListener.

◆ OnLoopEnd()

virtual void Audio::FMixerSource::OnLoopEnd ( )
inlineoverridevirtual

Implements Audio::ISourceListener.

◆ Pause()

void Audio::FMixerSource::Pause ( )
overridevirtual

Pauses the sound source.

Implements FSoundSource.

◆ Play()

void Audio::FMixerSource::Play ( )
overridevirtual

Plays the sound source.

Implements FSoundSource.

◆ PrepareForInitialization()

bool Audio::FMixerSource::PrepareForInitialization ( FWaveInstance *  InWaveInstance)
overridevirtual

Reimplemented from FSoundSource.

◆ Stop()

void Audio::FMixerSource::Stop ( void  )
overridevirtual

Stops the sound source.

Reimplemented from FSoundSource.

◆ StopNow()

void Audio::FMixerSource::StopNow ( )
overridevirtual

Reimplemented from FSoundSource.

◆ Update()

void Audio::FMixerSource::Update ( )
overridevirtual

Updates the sound source.

Implements FSoundSource.

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