#include <MultithreadedPatching.h>

Public Member Functions
SIGNALPROCESSING_API	FPatchInput (const FPatchOutputStrongPtr &InOutput)

SIGNALPROCESSING_API	FPatchInput (const FPatchInput &Other)

SIGNALPROCESSING_API FPatchInput &	operator= (const FPatchInput &Other)

SIGNALPROCESSING_API FPatchInput &	operator= (FPatchInput &&Other)

SIGNALPROCESSING_API	FPatchInput (FPatchInput &&Other)

	FPatchInput ()=default

SIGNALPROCESSING_API	~FPatchInput ()

SIGNALPROCESSING_API int32	PushAudio (const float *InBuffer, int32 NumSamples)

SIGNALPROCESSING_API void	ClearAudio ()

SIGNALPROCESSING_API int32	GetNumSamplesAvailable () const

SIGNALPROCESSING_API void	SetGain (float InGain)

SIGNALPROCESSING_API bool	IsOutputStillActive () const

SIGNALPROCESSING_API bool	IsValid () const

SIGNALPROCESSING_API void	Reset ()

Friends
class	FPatchMixer

class	FPatchSplitter

Detailed Description

Handle to a patch. Should only be used by a single thread.

Constructor & Destructor Documentation

◆ FPatchInput() [1/4]

Audio::FPatchInput::FPatchInput ( const FPatchOutputStrongPtr & InOutput )

PatchInputs can only be created from explicit outputs.

◆ FPatchInput() [2/4]

Audio::FPatchInput::FPatchInput ( const FPatchInput & Other )

◆ FPatchInput() [3/4]

Audio::FPatchInput::FPatchInput ( FPatchInput && Other )

◆ FPatchInput() [4/4]

Audio::FPatchInput::FPatchInput ( )

default

Default constructed FPatchInput instances will always return -1 for PushAudio and true for IsOutputStillActive.

◆ ~FPatchInput()

Audio::FPatchInput::~FPatchInput ( )

Member Function Documentation

◆ ClearAudio()

void Audio::FPatchInput::ClearAudio ( )

Clears any audio queued up in the patch.

◆ GetNumSamplesAvailable()

int32 Audio::FPatchInput::GetNumSamplesAvailable ( ) const

Returns the current number of samples buffered in this input.

◆ IsOutputStillActive()

bool Audio::FPatchInput::IsOutputStillActive ( ) const

Returns false if this output was removed, either because someone called FPatchMixer::RemoveTap with this FPatchInput, or the FPatchMixer was destroyed.

◆ IsValid()

bool Audio::FPatchInput::IsValid ( ) const

Returns false if this output was not initialized properly.

◆ operator=() [1/2]

FPatchInput & Audio::FPatchInput::operator= ( const FPatchInput & Other )

◆ operator=() [2/2]

FPatchInput & Audio::FPatchInput::operator= ( FPatchInput && Other )

◆ PushAudio()

int32 Audio::FPatchInput::PushAudio	(	const float *	InBuffer,
		int32	NumSamples
	)

Pushes audio from InBuffer to the corresponding FPatchOutput. Pushes zeros if InBuffer is nullptr. Returns how many samples were able to be pushed, or -1 if the output was disconnected.

◆ Reset()

void Audio::FPatchInput::Reset ( )

◆ SetGain()

void Audio::FPatchInput::SetGain ( float InGain )

Friends And Related Symbol Documentation

◆ FPatchMixer

friend class FPatchMixer

friend

◆ FPatchSplitter

friend class FPatchSplitter