1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceAudioPlayer

UNiagaraDataInterfaceAudioPlayer

This Data Interface can be used to play one-shot audio effects driven by particle data.

API > API/Plugins > API/Plugins/Niagara

This Data Interface can be used to play one-shot audio effects driven by particle data.

   
Name UNiagaraDataInterfaceAudioPlayer
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioPlayer.h
Include Path #include "NiagaraDataInterfaceAudioPlayer.h"

Syntax

UCLASS (EditInlineNew, Category="Audio", Meta=(DisplayName="Audio Player"), MinimalAPI)  
class UNiagaraDataInterfaceAudioPlayer : public UNiagaraDataInterface

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceAudioPlayer ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceAudioPlayer.h  

Constants

Name Type Remarks Include Path
PausePersistentAudioName const FName   NiagaraDataInterfaceAudioPlayer.h
PlayAudioName const FName   NiagaraDataInterfaceAudioPlayer.h
PlayPersistentAudioName const FName   NiagaraDataInterfaceAudioPlayer.h
SetInitialAudioBoolParamName const FName   NiagaraDataInterfaceAudioPlayer.h
SetInitialAudioFloatParamName const FName   NiagaraDataInterfaceAudioPlayer.h
SetInitialAudioIntegerParamName const FName   NiagaraDataInterfaceAudioPlayer.h
SetPersistentAudioBoolParamName const FName   NiagaraDataInterfaceAudioPlayer.h
SetPersistentAudioFloatParamName const FName   NiagaraDataInterfaceAudioPlayer.h
SetPersistentAudioIntegerParamName const FName   NiagaraDataInterfaceAudioPlayer.h
SetPersistentAudioLocationName const FName   NiagaraDataInterfaceAudioPlayer.h
SetPersistentAudioPitchName const FName   NiagaraDataInterfaceAudioPlayer.h
SetPersistentAudioRotationName const FName   NiagaraDataInterfaceAudioPlayer.h
SetPersistentAudioVolumeName const FName   NiagaraDataInterfaceAudioPlayer.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Attenuation TObjectPtr< USoundAttenuation > Optional sound attenuation setting to use NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • Category="Audio"
bAllowLoopingOneShotSounds bool Playing looping sounds as persistent audio is not a problem, as the sound is stopped when a particle dies, but one-shot audio outlives the niagara system and can never be stopped. NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Audio"
bLimitPlaysPerTick bool   NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Audio"
  • Meta=(InlineEditConditionToggle)
bOnlyActiveDuringGameplay bool If true then this data interface only processes sounds during active gameplay. NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Audio"
bStopWhenComponentIsDestroyed bool If false then it the audio component keeps playing after the niagara component was destroyed. NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Audio"
Concurrency TObjectPtr< USoundConcurrency > Optional sound concurrency setting to use NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • Category="Audio"
ConfigurationUserParameter FNiagaraUserParameterBinding If bound to a valid user parameter object of type UNiagaraDataInterfaceAudioPlayerSettings, then configured settings like sound attenuation are set via the user parameter. NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • Category="Parameters"
MaxPlaysPerTick int32 This sets the max number of sounds played each tick. NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Audio"
  • Meta=(EditCondition="bLimitPlaysPerTick", ClampMin="0", UIMin="0")
ParameterNames TArray< FName > A set of parameter names that can be referenced via index when setting sound cue parameters on persistent audio NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • Category="Parameters"
SoundToPlay TObjectPtr< USoundBase > Reference to the audio asset to play NiagaraDataInterfaceAudioPlayer.h
  • EditAnywhere
  • Category="Audio"

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void PlayOneShotAudio ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void PlayPersistentAudio ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void SetInitialParameterBool ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void SetInitialParameterFloat ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void SetInitialParameterInteger ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void SetParameterBool ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void SetParameterFloat ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void SetParameterInteger ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void SetPausedState ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void UpdateLocation ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void UpdatePitch ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void UpdateRotation ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

virtual void UpdateVolume ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceAudioPlayer.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceAudioPlayer.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceAudioPlayer.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceAudioPlayer.h  

virtual void GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
void* InstanceData,
FVMExternalFunction& OutFunc
)

 Returns the delegate for the passed function signature. NiagaraDataInterfaceAudioPlayer.h  

virtual bool HasPostSimulateTick()

   NiagaraDataInterfaceAudioPlayer.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceAudioPlayer.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceAudioPlayer.h  

virtual int32 PerInstanceDataSize ()

 Returns the size of the per instance data for this interface. NiagaraDataInterfaceAudioPlayer.h  

virtual bool PerInstanceTick ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceAudioPlayer.h  

virtual bool PerInstanceTickPostSimulate ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

   NiagaraDataInterfaceAudioPlayer.h  
When set to true the simulation may not complete in the same frame it started, allowing maximum overlap with the GameThread. NiagaraDataInterfaceAudioPlayer.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

 Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. NiagaraDataInterfaceAudioPlayer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceAudioPlayer.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceAudioPlayer.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceAudioPlayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page