FBufferedListenerBase Class Reference

#include <BufferedListenerBase.h>

Inheritance diagram for FBufferedListenerBase:

Protected Member Functions
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

Additional Inherited Members
Public Member Functions inherited from IBufferedAudioOutput
virtual	~IBufferedAudioOutput ()=default
	DECLARE_DELEGATE_OneParam (FOnFormatKnown, FBufferFormat)
	DECLARE_DELEGATE_OneParam (FOnBufferStreamEnd, FBufferStreamEnd)
virtual bool	Start (FAudioDevice *InAudioDevice)=0
virtual void	Stop (FAudioDevice *InAudioDevice)=0
virtual IPushableAudioOutput *	GetPushableInterface ()
virtual const IPushableAudioOutput *	GetPushableInterface () const

Detailed Description

Common base class of Buffered Listener objects.

Constructor & Destructor Documentation

FBufferedListenerBase()

FBufferedListenerBase::FBufferedListenerBase ( int32  InDefaultCircularBufferSize )

protected

~FBufferedListenerBase()

virtual FBufferedListenerBase::~FBufferedListenerBase ( )

protectedvirtualdefault

Member Function Documentation

GetFormat()

bool FBufferedListenerBase::GetFormat ( IBufferedAudioOutput::FBufferFormat &  OutFormat ) const

overrideprotectedvirtual

CONSUMER Thread. This will be called by the consuming data of the buffers.

Implements IBufferedAudioOutput.

IsStartedNonAtomic()

bool FBufferedListenerBase::IsStartedNonAtomic ( ) const

protected

OnBufferReceived()

void FBufferedListenerBase::OnBufferReceived ( const FBufferFormat &  InFormat, TArrayView< const float >  InBuffer  )

protected

AUDIO MIXER THREAD.

PopBuffer()

bool FBufferedListenerBase::PopBuffer ( float *  InBuffer, int32  InBufferSizeInSamples, int32 &  OutSamplesWritten  )

overrideprotectedvirtual

CONSUMER Thread. This will be called by the consuming data of the buffers.

Implements IBufferedAudioOutput.

Reserve()

void FBufferedListenerBase::Reserve ( int32  InNumSamplesToReserve, int32  InNumSamplesOfSilence  )

overrideprotectedvirtual

Reserve at least this many samples in buffer.

Parameters

InNumSamplesToReserve

Reserve this number of samples.

Implements IBufferedAudioOutput.

ResetFormat()

void FBufferedListenerBase::ResetFormat ( )

protected

SetBufferStreamEndDelegate()

void FBufferedListenerBase::SetBufferStreamEndDelegate ( FOnBufferStreamEnd  )

inlineoverrideprotectedvirtual

Implements IBufferedAudioOutput.

SetFormat()

void FBufferedListenerBase::SetFormat ( const FBufferFormat &  InFormat )

protected

SetFormatKnownDelegate()

void FBufferedListenerBase::SetFormatKnownDelegate ( FOnFormatKnown  InFormatKnownDelegate )

overrideprotectedvirtual

Implements IBufferedAudioOutput.

TrySetStartedFlag()

bool FBufferedListenerBase::TrySetStartedFlag ( )

protected

TrySetStoppingFlag()

bool FBufferedListenerBase::TrySetStoppingFlag ( )

protected

TryUnsetStartedFlag()

bool FBufferedListenerBase::TryUnsetStartedFlag ( )

protected

---

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

• Engine/Source/Runtime/AudioLink/AudioLinkEngine/Private/BufferedListenerBase.h
• Engine/Source/Runtime/AudioLink/AudioLinkEngine/Private/BufferedListenerBase.cpp