Navigation
API > API/Plugins > API/Plugins/Niagara
Class used to to capture the audio stream of an arbitrary submix.
| Name | FNiagaraSubmixListener |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudio.h |
| Include Path | #include "NiagaraDataInterfaceAudio.h" |
Syntax
class FNiagaraSubmixListener : public ISubmixBufferListener
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| NiagaraDataInterfaceAudio.h | |||
FNiagaraSubmixListener
(
const FNiagaraSubmixListener& Other |
NiagaraDataInterfaceAudio.h | ||
FNiagaraSubmixListener
(
FNiagaraSubmixListener&& Other |
Move submix listener. | NiagaraDataInterfaceAudio.h | |
FNiagaraSubmixListener
(
Audio::FPatchMixer& InMixer, |
Construct an FNiagaraSubmixListener | NiagaraDataInterfaceAudio.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNiagaraSubmixListener() |
NiagaraDataInterfaceAudio.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioDeviceId | Audio::FDeviceId | NiagaraDataInterfaceAudio.h | ||
| bIsRegistered | bool | NiagaraDataInterfaceAudio.h | ||
| MixerInput | Audio::FPatchInput | NiagaraDataInterfaceAudio.h | ||
| NumChannelsInSubmix | TAtomic< int32 > | NiagaraDataInterfaceAudio.h | ||
| Submix | USoundSubmix * | NiagaraDataInterfaceAudio.h | ||
| SubmixSampleRate | TAtomic< int32 > | NiagaraDataInterfaceAudio.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetNumChannels() |
Returns the number of channels of the current submix. | NiagaraDataInterfaceAudio.h | |
float GetSampleRate() |
Returns the current sample rate of the current submix. | NiagaraDataInterfaceAudio.h | |
void RegisterToSubmix() |
NiagaraDataInterfaceAudio.h |
Overridden from ISubmixBufferListener
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FString & GetListenerName() |
NiagaraDataInterfaceAudio.h | ||
virtual void OnNewSubmixBuffer
(
const USoundSubmix* OwningSubmix, |
NiagaraDataInterfaceAudio.h |