#include <BufferedSubmixListener.h>

Inheritance diagram for FBufferedSubmixListener:

Public Member Functions
AUDIOLINKENGINE_API	FBufferedSubmixListener (int32 InDefaultCircularBufferSize, bool bInZeroInputBuffer, const FString *InName)

virtual AUDIOLINKENGINE_API	~FBufferedSubmixListener ()

AUDIOLINKENGINE_API bool	Start (FAudioDevice *InDevice) override

AUDIOLINKENGINE_API void	Stop (FAudioDevice *InDevice) override

Public Member Functions inherited from ISubmixBufferListener
virtual	~ISubmixBufferListener ()=default

virtual bool	IsRenderingAudio () 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

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 TSharedFromThis< ISubmixBufferListener, ESPMode::ThreadSafe >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

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

void	SetBufferStreamEndDelegate (FOnBufferStreamEnd) 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

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

Concrete Submix Buffer Listener

Constructor & Destructor Documentation

◆ FBufferedSubmixListener()

FBufferedSubmixListener::FBufferedSubmixListener	(	int32	InDefaultCircularBufferSize,
		bool	bInZeroInputBuffer,
		const FString *	InName
	)

Constructor

Parameters

InDefaultCircularBufferSize	Size of the circular buffer in samples by default.
bInZeroInputBuffer	The passed in buffer will be set zeroed after we've buffered it.
InName(Optional)	Optional name to track listener lifetime with.

Buffered Submix Listener.

◆ ~FBufferedSubmixListener()

FBufferedSubmixListener::~FBufferedSubmixListener ( )

virtual

Member Function Documentation

◆ Start()

bool FBufferedSubmixListener::Start ( FAudioDevice * InDevice )

overridevirtual

Starts the Submix buffer listener by registering it with the passed in Audio Device.

Parameters

InDevice	Audio Device to register this submix listener with.
InOnFirstBufferCallback	Delegate to fire when the format of the buffer is known.

Returns: success true, false otherwise.

Implements IBufferedAudioOutput.

◆ Stop()

void FBufferedSubmixListener::Stop ( FAudioDevice * InDevice )