UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Friends | List of all members
ISubmixBufferListener Class Referenceabstract

#include <ISubmixBufferListener.h>

+ Inheritance diagram for ISubmixBufferListener:

Public Member Functions

virtual ~ISubmixBufferListener ()=default
 
virtual void OnNewSubmixBuffer (const USoundSubmix *OwningSubmix, float *AudioData, int32 NumSamples, int32 NumChannels, const int32 SampleRate, double AudioClock)=0
 
virtual bool IsRenderingAudio () const
 
virtual const FString & GetListenerName () const
 
- Public Member Functions inherited from TSharedFromThis< ISubmixBufferListener, ESPMode::ThreadSafe >
TSharedRef< ISubmixBufferListener, Mode > AsShared ()
 
TSharedRef< ISubmixBufferListener const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< ISubmixBufferListener, Mode > AsWeak ()
 
TWeakPtr< ISubmixBufferListener const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Friends

template<typename ObjectType , ESPMode Mode>
class SharedPointerInternals::TIntrusiveReferenceController
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< ISubmixBufferListener, ESPMode::ThreadSafe >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< ISubmixBufferListener, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

Abstract interface for receiving audio data from a given submix.

Constructor & Destructor Documentation

◆ ~ISubmixBufferListener()

virtual ISubmixBufferListener::~ISubmixBufferListener ( )
virtualdefault

Member Function Documentation

◆ GetListenerName()

virtual const FString & ISubmixBufferListener::GetListenerName ( ) const
inlinevirtual

◆ IsRenderingAudio()

virtual bool ISubmixBufferListener::IsRenderingAudio ( ) const
inlinevirtual

Called if the submix is evaluating disabling itself for the next buffer of audio in FMixerSubmix::IsRenderingAudio() if this returns true, FMixerSubmix::IsRenderingAudio() will return true. Otherwise the submix will evaluate playing sounds, children submixes, etc to see if it should auto-disable

This is called every evaluation. ISubmixListeners that intermittently render audio should only return true when they have work to do.

◆ OnNewSubmixBuffer()

virtual void ISubmixBufferListener::OnNewSubmixBuffer ( const USoundSubmix *  OwningSubmix,
float *  AudioData,
int32  NumSamples,
int32  NumChannels,
const int32  SampleRate,
double  AudioClock 
)
pure virtual

Called when a new buffer has been rendered for a given submix

Parameters
OwningSubmixThe submix object which has rendered a new buffer
AudioDataPtr to the audio buffer
NumSamplesThe number of audio samples in the audio buffer
NumChannelsThe number of channels of audio in the buffer (e.g. 2 for stereo, 6 for 5.1, etc)
SampleRateThe sample rate of the audio buffer
AudioClockDouble audio clock value, from start of audio rendering.

Friends And Related Symbol Documentation

◆ SharedPointerInternals::TIntrusiveReferenceController

template<typename ObjectType , ESPMode Mode>
friend class SharedPointerInternals::TIntrusiveReferenceController
friend
The documentation for this class was generated from the following file: