FNiagaraSubmixListener

Copyright Epic Games, Inc. All Rights Reserved.

Windows
MacOS
Linux

Inheritance Hierarchy

ISubmixBufferListener

FNiagaraSubmixListener

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudio.h

Include

#include "NiagaraDataInterfaceAudio.h"

Syntax

class FNiagaraSubmixListener : public ISubmixBufferListener

Remarks

Class used to to capture the audio stream of an arbitrary submix.

Constructors

Name Description

Public function

FNiagaraSubmixListener

(
    const FNiagaraSubmixListener& Othe...
)

Public function

FNiagaraSubmixListener

(
    FNiagaraSubmixListener&& Other
)

Move submix listener.

Public function

FNiagaraSubmixListener

(
    Audio::FPatchMixer& InMixer,
    int32 InNumSamplesToBuffer,
    Audio::FDeviceId InDeviceId,
    USoundSubmix* InSoundSubmix
)

Construct an FNiagaraSubmixListener

Destructors

Name Description

Public function Virtual

~FNiagaraSubmixListener()

Functions

Name Description

Public function Const

int32

 

GetNumChannels()

Returns the number of channels of the current submix.

Public function Const

float

 

GetSampleRate()

Returns the current sample rate of the current submix.

Public function

void

 

RegisterToSubmix()

Overridden from ISubmixBufferListener

Name Description

Public function Virtual

void

 

OnNewSubmixBuffer

(
    const USoundSubmix* OwningSubm...,
    float* AudioData,
    int32 NumSamples,
    int32 NumChannels,
    const int32 SampleRate,
    double AudioClock
)

Called when a new buffer has been rendered for a given submix

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