FPatchSplitter

This class is used to post audio from one source to multiple threads.

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/MultithreadedPatching.h

Include

#include "DSP/MultithreadedPatching.h"

Syntax

class FPatchSplitter

Remarks

This class is used to post audio from one source to multiple threads. This class is SPMC: multiple threads can call FPatchOutputStrongPtr->PopAudio safely, but only one thread can call PushAudio.

Constructors

Name Description

Public function

FPatchSplitter()

Constructor.

Destructors

Name Description

Public function

~FPatchSplitter()

The destructor will mark every still connected FPatchOutput as stale.

Functions

Name Description

Public function

FPatchOutput...

 

AddNewPatch

(
    int32 MaxLatencyInSamples,
    float InGain
)

Adds a new output.

Public function

int32

 

MaxNumberOfSamplesThatCanBePushed()

This function call gets the maximum number of samples that's safe to push.

Public function

int32

 

Num()

This returns the number of outputs currently connected to this patch splitter.

Public function

int32

 

PushAudio

(
    const float* InBuffer,
    int32 InNumSamples
)

This call pushes audio to all outputs connected to this splitter.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss