Navigation
API > API/Plugins > API/Plugins/Niagara
Niagara data interface proxy for audio submix listener.
| Name | FNiagaraDataInterfaceProxySubmix |
| Type | struct |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudio.h |
| Include Path | #include "NiagaraDataInterfaceAudio.h" |
Syntax
struct FNiagaraDataInterfaceProxySubmix : public FNiagaraDataInterfaceProxy
Inheritance Hierarchy
- FNiagaraDataInterfaceProxy → FNiagaraDataInterfaceProxySubmix
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraDataInterfaceProxySubmix
(
const FNiagaraDataInterfaceProxySubmix& Other |
NiagaraDataInterfaceAudio.h | ||
FNiagaraDataInterfaceProxySubmix
(
int32 InNumSamplesToBuffer |
Construct a FNiagaraDataInterfaceProxySubmix | NiagaraDataInterfaceAudio.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNiagaraDataInterfaceProxySubmix() |
NiagaraDataInterfaceAudio.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsSubmixListenerRegistered | bool | NiagaraDataInterfaceAudio.h | ||
| DeviceCreatedHandle | FDelegateHandle | NiagaraDataInterfaceAudio.h | ||
| DeviceDestroyedHandle | FDelegateHandle | NiagaraDataInterfaceAudio.h | ||
| NumSamplesToBuffer | int32 | NiagaraDataInterfaceAudio.h | ||
| PatchMixer | Audio::FPatchMixer | Mixer for sending audio. | NiagaraDataInterfaceAudio.h | |
| SubmixListeners | TMap< Audio::FDeviceId, TSharedPtr< FNiagaraSubmixListener > > | Map of audio devices to submix listeners. Needed for editor where multiple audio devices may exist. | NiagaraDataInterfaceAudio.h | |
| SubmixRegisteredTo | USoundSubmix * | NiagaraDataInterfaceAudio.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetNumChannels() |
NiagaraDataInterfaceAudio.h | ||
int32 GetNumFramesAvailable () |
Returns the current number of frames buffered on this output. | NiagaraDataInterfaceAudio.h | |
int32 GetNumSamplesAvailable() |
Returns the current number of samples buffered on this output. | NiagaraDataInterfaceAudio.h | |
float GetSampleRate() |
NiagaraDataInterfaceAudio.h | ||
void OnBeginDestroy() |
NiagaraDataInterfaceAudio.h | ||
virtual void OnUpdateSubmix
(
USoundSubmix* Submix |
Called when the Submix property changes. | NiagaraDataInterfaceAudio.h | |
int32 PopAudio
(
float* OutBuffer, |
Copies the minimum of NumSamples or however many samples are available into OutBuffer. | NiagaraDataInterfaceAudio.h |
Overridden from FNiagaraDataInterfaceProxy
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 PerInstanceDataPassedToRenderThreadSize() |
NiagaraDataInterfaceAudio.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraDataInterfaceProxySubmix & operator=
(
const FNiagaraDataInterfaceProxySubmix& Other |
NiagaraDataInterfaceAudio.h |