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

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioPlayer.h
Include #include "NiagaraDataInterfaceAudioPlayer.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere TObjectPtr< USoundAttenuation > Attenuation Optional sound attenuation setting to use
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bAllowLoopingOneShotSounds 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.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bLimitPlaysPerTick  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bOnlyActiveDuringGameplay If true then this data interface only processes sounds during active gameplay.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bStopWhenComponentIsDestroyed If false then it the audio component keeps playing after the niagara component was destroyed.
Public variable UProperty Category, EditAnywhere TObjectPtr< USoundConcurrency > Concurrency Optional sound concurrency setting to use
Public variable UProperty Category, EditAnywhere FNiagaraUserParameterBinding ConfigurationUserParameter If bound to a valid user parameter object of type UNiagaraDataInterfaceAudioPlayerSettings, then configured settings like sound attenuation are set via the user parameter.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 MaxPlaysPerTick This sets the max number of sounds played each tick.
Public variable UProperty Category, EditAnywhere TArray< FName > ParameterNames A set of parameter names that can be referenced via index when setting sound cue parameters on persistent audio
Public variable UProperty Category, EditAnywhere TObjectPtr< USoundBase > SoundToPlay Reference to the audio asset to play

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void

PlayOneShotAudio ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

PlayPersistentAudio ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

SetInitialParameterBool ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

SetInitialParameterFloat ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

SetInitialParameterInteger ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

SetParameterBool ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

SetParameterFloat ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

SetParameterInteger ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

SetPausedState ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

UpdateLocation ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

UpdatePitch ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

UpdateRotation ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

UpdateVolume ( FVectorVMExternalFunctionContext& Context
)

  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Protected function Virtual Const void  
Public function Virtual void

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

 Returns the delegate for the passed function signature.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface.
Public function Virtual Const int32 Returns the size of the per instance data for this interface.
Public function Virtual bool

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

 Ticks the per instance data for this interface, if it has any.
Public function Virtual bool

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

  
Public function Virtual Const bool When set to true the simulation may not complete in the same frame it started, allowing maximum overlap with the GameThread.
Public function Virtual bool Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Constants

Name Description
PausePersistentAudioName  
PlayAudioName  
PlayPersistentAudioName  
SetInitialAudioBoolParamName  
SetInitialAudioFloatParamName  
SetInitialAudioIntegerParamName  
SetPersistentAudioBoolParamName  
SetPersistentAudioFloatParamName  
SetPersistentAudioIntegerParamName  
SetPersistentAudioLocationName  
SetPersistentAudioPitchName  
SetPersistentAudioRotationName  
SetPersistentAudioVolumeName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page