IBufferedAudioOutput Class Reference

#include <IBufferedAudioOutput.h>

Inheritance diagram for IBufferedAudioOutput:

Classes
struct	FBufferFormat
struct	FBufferStreamEnd

Public Member Functions
virtual	~IBufferedAudioOutput ()=default
	DECLARE_DELEGATE_OneParam (FOnFormatKnown, FBufferFormat)
virtual void	SetFormatKnownDelegate (FOnFormatKnown InFormatKnownDelegate)=0
	DECLARE_DELEGATE_OneParam (FOnBufferStreamEnd, FBufferStreamEnd)
virtual void	SetBufferStreamEndDelegate (FOnBufferStreamEnd InBufferStreamEndDelegate)=0
virtual bool	Start (FAudioDevice *InAudioDevice)=0
virtual void	Stop (FAudioDevice *InAudioDevice)=0
virtual bool	PopBuffer (float *InBuffer, int32 InBufferSizeInSamples, int32 &OutSamplesWritten)=0
virtual bool	GetFormat (FBufferFormat &OutFormat) const =0
virtual void	Reserve (int32 InNumSamplesToReserve, int32 InNumSamplesOfSilence=0)=0
virtual IPushableAudioOutput *	GetPushableInterface ()
virtual const IPushableAudioOutput *	GetPushableInterface () const

Protected Member Functions
	IBufferedAudioOutput ()=default

Detailed Description

Abstract interface for communication with outputting audio objects Examples concrete implementation of these are (source, submix etc).

Constructor & Destructor Documentation

IBufferedAudioOutput()

IBufferedAudioOutput::IBufferedAudioOutput ( )

protecteddefault

~IBufferedAudioOutput()

virtual IBufferedAudioOutput::~IBufferedAudioOutput ( )

virtualdefault

Member Function Documentation

DECLARE_DELEGATE_OneParam() [1/2]

IBufferedAudioOutput::DECLARE_DELEGATE_OneParam	(	FOnBufferStreamEnd	,
		FBufferStreamEnd
	)

DECLARE_DELEGATE_OneParam() [2/2]

IBufferedAudioOutput::DECLARE_DELEGATE_OneParam	(	FOnFormatKnown	,
		FBufferFormat
	)

GetFormat()

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

pure virtual

Gets the format of the buffer, if its known.

Returns

success true, false otherwise.

Implemented in FBufferedListenerBase.

GetPushableInterface() [1/2]

virtual IPushableAudioOutput * IBufferedAudioOutput::GetPushableInterface ( )

inlinevirtual

GetPushableInterface() [2/2]

virtual const IPushableAudioOutput * IBufferedAudioOutput::GetPushableInterface ( ) const

inlinevirtual

PopBuffer()

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

pure virtual

Attempts to Atomically copy a buffer sized amount of Buffered Sample data from the interface.

Parameters

InBuffer	Sample Buffer to Write to
InBufferSizeInSamples	Buffer Size in total samples.
OutSamplesWritten	Number of Samples Written to the buffer

Returns

false no more data, true more data to come

Implemented in FBufferedListenerBase.

Reserve()

virtual void IBufferedAudioOutput::Reserve ( int32  InNumSamplesToReserve, int32  InNumSamplesOfSilence = 0  )

pure virtual

Reserve at least this many samples in buffer.

Parameters

InNumSamplesToReserve

Reserve this number of samples.

Implemented in FBufferedListenerBase.

SetBufferStreamEndDelegate()

virtual void IBufferedAudioOutput::SetBufferStreamEndDelegate ( FOnBufferStreamEnd  InBufferStreamEndDelegate )

pure virtual

Implemented in FBufferedListenerBase.

SetFormatKnownDelegate()

virtual void IBufferedAudioOutput::SetFormatKnownDelegate ( FOnFormatKnown  InFormatKnownDelegate )

pure virtual

Implemented in FBufferedListenerBase.

Start()

virtual bool IBufferedAudioOutput::Start ( FAudioDevice *  InAudioDevice )

pure virtual

Implemented in FBufferedSourceListener, and FBufferedSubmixListener.

Stop()

virtual void IBufferedAudioOutput::Stop ( FAudioDevice *  InAudioDevice )

pure virtual

Implemented in FBufferedSourceListener, and FBufferedSubmixListener.

---

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

• Engine/Source/Runtime/AudioLink/AudioLinkEngine/Public/IBufferedAudioOutput.h