FBufferedListenerBase

Common base class of Buffered Listener objects.

API > API/Runtime > API/Runtime/AudioLinkEngine

Common base class of Buffered Listener objects.

   
Name FBufferedListenerBase
Type class
Header File /Engine/Source/Runtime/AudioLink/AudioLinkEngine/Public/BufferedListenerBase.h
Include Path #include "BufferedListenerBase.h"

Syntax

class FBufferedListenerBase : public IBufferedAudioOutput

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FBufferedListenerBase ( int32 InDefaultCircularBufferSize
)

   BufferedListenerBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FBufferedListenerBase()

   BufferedListenerBase.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bStarted std::atomic< bool > Atomic flag we've been started BufferedListenerBase.h  
bStopping std::atomic< bool > Atomic flag we've been told to stop BufferedListenerBase.h  
CircularBuffer FLockingCircularSampleBuffer Buffer to hold the data for the single source we're listening to, interleaved. BufferedListenerBase.h  
FormatKnownRwLock FRWLock Read/Write slim lock protects format known optional BufferedListenerBase.h  
KnownFormat TOptional< FBufferFormat > Optional that holds the buffer format, if (and when) it's known. Protected by r/w Slim-lock BufferedListenerBase.h  
OnFormatKnown FOnFormatKnown Delegate that fires when the format it known. Normally on the first buffer received. BufferedListenerBase.h  

Functions

Protected

Name Remarks Include Path Unreal Specifiers

void FlushAndEnsureCapacity ( int32 InMinCapacity
)

   BufferedListenerBase.h  

void FlushAndResetFormat()

   BufferedListenerBase.h  

int32 GetNumBufferedSamples()

   BufferedListenerBase.h  

bool IsStartedNonAtomic()

   BufferedListenerBase.h  

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

 AUDIO MIXER THREAD. BufferedListenerBase.h  

void ResetFormat()

   BufferedListenerBase.h  

void SetFormat ( const FBufferFormat& InFormat
)

   BufferedListenerBase.h  

bool TrySetStartedFlag()

   BufferedListenerBase.h  

bool TrySetStoppingFlag()

   BufferedListenerBase.h  

bool TryUnsetStartedFlag()

   BufferedListenerBase.h  

Protected Virtual

Overridden from IBufferedAudioOutput

Name Remarks Include Path Unreal Specifiers

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

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

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

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

virtual void Reserve ( int32 InNumSamplesToReserve,
int32 InNumSamplesOfSilence
)

 Reserve at least this many samples in buffer. BufferedListenerBase.h  

virtual void SetBufferStreamEndDelegate ( FOnBufferStreamEnd
)

   BufferedListenerBase.h  

virtual void SetFormatKnownDelegate ( FOnFormatKnown InFormatKnownDelegate
)

   BufferedListenerBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page