FPatchInput | Unreal Engine 5.6 Documentation

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


Name	FPatchInput
Type	class
Header File	/Engine/Source/Runtime/SignalProcessing/Public/DSP/MultithreadedPatching.h
Include Path	#include "DSP/MultithreadedPatching.h"

Syntax

class FPatchInput

Name	Remarks	Include Path
FPatchInput ()	Default constructed FPatchInput instances will always return -1 for PushAudio and true for IsOutputStillActive.	DSP/MultithreadedPatching.h
FPatchInput ( const FPatchOutputStrongPtr& InOutput )	PatchInputs can only be created from explicit outputs.	DSP/MultithreadedPatching.h
FPatchInput ( const FPatchInput& Other )		DSP/MultithreadedPatching.h
FPatchInput ( FPatchInput&& Other )		DSP/MultithreadedPatching.h

Name	Remarks	Include Path	Unreal Specifiers
~FPatchInput()		DSP/MultithreadedPatching.h

Name	Type	Remarks	Include Path	Unreal Specifiers
OutputHandle	FPatchOutputStrongPtr	Strong pointer to our destination buffer.	DSP/MultithreadedPatching.h
PushCallsCounter	int32	Counter of the number of push calls.	DSP/MultithreadedPatching.h

Name	Remarks	Include Path
void ClearAudio()	Clears any audio queued up in the patch.	DSP/MultithreadedPatching.h
int32 GetNumSamplesAvailable()	Returns the current number of samples buffered in this input.	DSP/MultithreadedPatching.h
bool IsOutputStillActive()	Returns false if this output was removed, either because someone called FPatchMixer::RemoveTap with this FPatchInput, or the FPatchMixer was destroyed.	DSP/MultithreadedPatching.h
bool IsValid()	Returns false if this output was not initialized properly.	DSP/MultithreadedPatching.h
int32 PushAudio ( const float* InBuffer, int32 NumSamples )	Pushes audio from InBuffer to the corresponding FPatchOutput.	DSP/MultithreadedPatching.h
void Reset()		DSP/MultithreadedPatching.h
void SetGain ( float InGain )		DSP/MultithreadedPatching.h

Name	Remarks	Include Path	Unreal Specifiers
FPatchInput & operator= ( const FPatchInput& Other )		DSP/MultithreadedPatching.h
FPatchInput & operator= ( FPatchInput&& Other )		DSP/MultithreadedPatching.h