Navigation
API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP
References
| Module | SignalProcessing |
| Header | /Engine/Source/Runtime/SignalProcessing/Public/DSP/MultithreadedPatching.h |
| Include | #include "DSP/MultithreadedPatching.h" |
Syntax
struct FPatchOutput
Remarks
This class can be thought of as an output for a single constructed instance of FPatchInput. Each FPatchOutput can only be connected to one FPatchInput. To route multiple outputs, see FPatchSplitter. To route multiple inputs, see FPatchMixer.
Example usage:
FPatchOutputStrongPtr NewOutput(new FPatchOutput(4096)); FPatchInput NewInput(NewOutput);
// On one thread, push audio to the output: NewInput.PushAudio(AudioBufferPtr, AudioBufferNumSamples);
// and on a seperate thread, retrieve the audio: NewOutput->PopAudio(OutAudioBufferPtr, AudioBufferNumSamples);
Constructors
| Type | Name | Description | |
|---|---|---|---|
FPatchOutput () |
The default constructor will result in an uninitialized, disconnected patch point. | ||
FPatchOutput
(
int32 InMaxCapacity, |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| int32 | Returns the current number of samples buffered on this output. | ||
| bool | IsInputStale () |
Returns true if the input for this patch has been destroyed. | |
| int32 | MixInAudio
(
float* OutBuffer, |
Sums the minimum of NumSamples or however many samples are available into OutBuffer. | |
| int32 | Copies the minimum of NumSamples or however many samples are available into OutBuffer. | ||
| bool | WaitUntilNumSamplesAvailable
(
int32 NumSamples, |
Pauses the current thread until there are the given number of samples available to pop. |
Constants
| Name | Description |
|---|---|
| PatchIDCounter |