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

#include <BufferedSourceListener.h>

+ Inheritance diagram for FBufferedSourceListener:

Public Member Functions

AUDIOLINKENGINE_API FBufferedSourceListener (int32 InDefaultCircularBufferSize)
 
virtual AUDIOLINKENGINE_API ~FBufferedSourceListener ()
 
AUDIOLINKENGINE_API bool Start (FAudioDevice *InDevice) override
 
AUDIOLINKENGINE_API void Stop (FAudioDevice *InDevice) override
 
- Public Member Functions inherited from ISourceBufferListener
virtual ~ISourceBufferListener ()=default
 
- Public Member Functions inherited from IBufferedAudioOutput
virtual ~IBufferedAudioOutput ()=default
 
 DECLARE_DELEGATE_OneParam (FOnFormatKnown, FBufferFormat)
 
 DECLARE_DELEGATE_OneParam (FOnBufferStreamEnd, FBufferStreamEnd)
 
virtual IPushableAudioOutput * GetPushableInterface ()
 
virtual const IPushableAudioOutput * GetPushableInterface () const
 

Additional Inherited Members

- Protected Member Functions inherited from FBufferedListenerBase
AUDIOLINKENGINE_API FBufferedListenerBase (int32 InDefaultCircularBufferSize)
 
virtual ~FBufferedListenerBase ()=default
 
AUDIOLINKENGINE_API bool PopBuffer (float *InBuffer, int32 InBufferSizeInSamples, int32 &OutSamplesWritten) override
 
AUDIOLINKENGINE_API bool GetFormat (IBufferedAudioOutput::FBufferFormat &OutFormat) const override
 
AUDIOLINKENGINE_API void Reserve (int32 InNumSamplesToReserve, int32 InNumSamplesOfSilence) override
 
AUDIOLINKENGINE_API void SetFormatKnownDelegate (FOnFormatKnown InFormatKnownDelegate) override
 
AUDIOLINKENGINE_API void OnBufferReceived (const FBufferFormat &InFormat, TArrayView< const float > InBuffer)
 
AUDIOLINKENGINE_API void ResetFormat ()
 
AUDIOLINKENGINE_API void SetFormat (const FBufferFormat &InFormat)
 
AUDIOLINKENGINE_API bool IsStartedNonAtomic () const
 
AUDIOLINKENGINE_API bool TrySetStartedFlag ()
 
AUDIOLINKENGINE_API bool TryUnsetStartedFlag ()
 
AUDIOLINKENGINE_API bool TrySetStoppingFlag ()
 
- Protected Member Functions inherited from IBufferedAudioOutput
 IBufferedAudioOutput ()=default
 

Detailed Description

FBufferedSourceListener: Concrete implementation of both a buffer listener and buffered output. Contains a circular buffer.

Constructor & Destructor Documentation

◆ FBufferedSourceListener()

FBufferedSourceListener::FBufferedSourceListener ( int32  InDefaultCircularBufferSize)

Buffered Source Listener.

◆ ~FBufferedSourceListener()

FBufferedSourceListener::~FBufferedSourceListener ( )
virtual

Member Function Documentation

◆ Start()

bool FBufferedSourceListener::Start ( FAudioDevice *  InDevice)
overridevirtual
Parameters
InDeviceAudio Device to register this listener with.
InOnFirstBufferCallbackDelegate to fire when the format of the buffer is known.
Returns
success true, false otherwise.

Implements IBufferedAudioOutput.

◆ Stop()

void FBufferedSourceListener::Stop ( FAudioDevice *  InDevice)
overridevirtual

Stop the buffer by unregistering the buffer listener

Implements IBufferedAudioOutput.

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