UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
USoundBase Class Reference

#include <SoundBase.h>

+ Inheritance diagram for USoundBase:

Public Member Functions

virtual ENGINE_API bool CanBeClusterRoot () const override
 
virtual ENGINE_API bool CanBeInCluster () const override
 
virtual ENGINE_API void PreSave (FObjectPreSaveContext SaveContext) override
 
virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API bool IsPlayable () const
 
virtual ENGINE_API bool SupportsSubtitles () const
 
virtual ENGINE_API bool HasAttenuationNode () const
 
virtual ENGINE_API const FSoundAttenuationSettingsGetAttenuationSettingsToApply () const
 
virtual ENGINE_API float GetMaxDistance () const
 
virtual ENGINE_API float GetDuration () const
 
ENGINE_API bool HasDelayNode () const
 
ENGINE_API bool HasConcatenatorNode () const
 
virtual ENGINE_API bool IsPlayWhenSilent () const
 
virtual ENGINE_API float GetVolumeMultiplier ()
 
virtual ENGINE_API float GetPitchMultiplier ()
 
virtual float GetSubtitlePriority () const
 
virtual ENGINE_API bool ShouldApplyInteriorVolumes ()
 
virtual class UCurveTableGetCurveData () const
 
virtual ENGINE_API bool IsLooping () const
 
virtual ENGINE_API bool IsOneShot () const
 
virtual bool IsProcedurallyGenerated () const
 
virtual void Parse (class FAudioDevice *AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound &ActiveSound, const FSoundParseParameters &ParseParams, TArray< FWaveInstance * > &WaveInstances)
 
virtual ENGINE_API USoundClassGetSoundClass () const
 
virtual ENGINE_API USoundSubmixBaseGetSoundSubmix () const
 
ENGINE_API void GetSoundSubmixSends (TArray< FSoundSubmixSendInfo > &OutSends) const
 
ENGINE_API void GetSoundSourceBusSends (EBusSendType BusSendType, TArray< FSoundSourceBusSendInfo > &OutSends) const
 
ENGINE_API void GetConcurrencyHandles (TArray< FConcurrencyHandle > &OutConcurrencyHandles) const
 
ENGINE_API float GetPriority () const
 
virtual ENGINE_API bool GetSoundWavesWithCookedAnalysisData (TArray< USoundWave * > &OutSoundWaves)
 
virtual bool HasCookedFFTData () const
 
virtual bool HasCookedAmplitudeEnvelopeData () const
 
virtual ENGINE_API void AddAssetUserData (UAssetUserData *InUserData) override
 
virtual ENGINE_API void RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API UAssetUserDataGetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API const TArray< UAssetUserData * > * GetAssetUserDataArray () const override
 
virtual ENGINE_API void InitParameters (TArray< FAudioParameter > &ParametersToInit, FName InFeatureName=NAME_None)
 
virtual void InitResources ()
 
virtual bool ImplementsParameterInterface (Audio::FParameterInterfacePtr InParameterInterface) const
 
virtual ISoundGeneratorPtr CreateSoundGenerator (const FSoundGeneratorInitParams &InParams)
 
virtual ISoundGeneratorPtr CreateSoundGenerator (const FSoundGeneratorInitParams &InParams, TArray< FAudioParameter > &&InDefaultParameters)
 
virtual ENGINE_API TSharedPtr< Audio::IParameterTransmitterCreateParameterTransmitter (Audio::FParameterTransmitterInitParams &&InParams) const
 
virtual ENGINE_API bool IsParameterValid (const FAudioParameter &InParameter) const
 
virtual bool GetAllDefaultParameters (TArray< FAudioParameter > &OutParameters) const
 
 UE_DEPRECATED (5.7, "This is no longer used.") virtual bool EnableSubmixSendsOnPreview() const
 
virtual bool IsAttenuationSettingsEditable () const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Public Attributes

TObjectPtr< USoundClassSoundClassObject
 
uint8 bDebug: 1
 
uint8 bOverrideConcurrency: 1
 
uint8 bEnableBusSends: 1
 
uint8 bEnableBaseSubmix: 1
 
uint8 bEnableSubmixSends: 1
 
uint8 bHasDelayNode: 1
 
uint8 bHasConcatenatorNode: 1
 
uint8 bBypassVolumeScaleForPriority: 1
 
EVirtualizationMode VirtualizationMode
 
TMap< Audio::FDeviceId, int32CurrentPlayCount
 
TSet< TObjectPtr< USoundConcurrency > > ConcurrencySet
 
FSoundConcurrencySettings ConcurrencyOverrides
 
float Duration
 
float MaxDistance
 
float TotalSamples
 
float Priority
 
TObjectPtr< USoundAttenuationAttenuationSettings
 
TObjectPtr< USoundSubmixBaseSoundSubmixObject
 
TArray< FSoundSubmixSendInfoSoundSubmixSends
 
TObjectPtr< USoundEffectSourcePresetChainSourceEffectChain
 
TArray< FSoundSourceBusSendInfoBusSends
 
TArray< FSoundSourceBusSendInfoPreEffectBusSends
 
TArray< TObjectPtr< UAssetUserData > > AssetUserData
 

Protected Member Functions

virtual ENGINE_API float ComputeMaxDistance () const
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Detailed Description

The base class for a playable sound object

Member Function Documentation

◆ AddAssetUserData()

void USoundBase::AddAssetUserData ( UAssetUserData InUserData)
overridevirtual

Reimplemented from IInterface_AssetUserData.

◆ CanBeClusterRoot()

bool USoundBase::CanBeClusterRoot ( ) const
overridevirtual

Called after load to determine if the object can be a cluster root

Returns
true if this object can be a cluster root

Reimplemented from UObjectBaseUtility.

Reimplemented in USoundCue.

◆ CanBeInCluster()

bool USoundBase::CanBeInCluster ( ) const
overridevirtual

Called during cluster construction if the object can be added to a cluster

Returns
true if this object can be inside of a cluster

Reimplemented from UObjectBaseUtility.

Reimplemented in USoundCue.

◆ ComputeMaxDistance()

float USoundBase::ComputeMaxDistance ( ) const
protectedvirtual

Reimplemented in USoundCue.

◆ CreateParameterTransmitter()

TSharedPtr< Audio::IParameterTransmitter > USoundBase::CreateParameterTransmitter ( Audio::FParameterTransmitterInitParams &&  InParams) const
virtual

Creates a parameter transmitter for communicating with active sound instances.

Reimplemented in USoundCue.

◆ CreateSoundGenerator() [1/2]

virtual ISoundGeneratorPtr USoundBase::CreateSoundGenerator ( const FSoundGeneratorInitParams InParams)
inlinevirtual

Creates a sound generator instance from this sound base. Return true if this is being implemented by a subclass. Sound generators procedurally generate audio in the audio render thread.

Reimplemented in UScrubbedSound.

◆ CreateSoundGenerator() [2/2]

virtual ISoundGeneratorPtr USoundBase::CreateSoundGenerator ( const FSoundGeneratorInitParams InParams,
TArray< FAudioParameter > &&  InDefaultParameters 
)
inlinevirtual

Creates a sound generator instance from this sound base. Return true if this is being implemented by a subclass. Sound generators procedurally generate audio in the audio render thread.

◆ GetAllDefaultParameters()

virtual bool USoundBase::GetAllDefaultParameters ( TArray< FAudioParameter > &  OutParameters) const
inlinevirtual

Gets all the default parameters for this Asset.

◆ GetAssetUserDataArray()

const TArray< UAssetUserData * > * USoundBase::GetAssetUserDataArray ( ) const
overridevirtual

Reimplemented from IInterface_AssetUserData.

◆ GetAssetUserDataOfClass()

UAssetUserData * USoundBase::GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData InUserDataClass)
overridevirtual

Returns an instance of the provided AssetUserData class if it's contained in the target asset.

Parameters
InUserDataClassUAssetUserData sub class to get
Returns
The instance of the UAssetUserData class contained, or null if it doesn't exist

Reimplemented from IInterface_AssetUserData.

◆ GetAttenuationSettingsToApply()

const FSoundAttenuationSettings * USoundBase::GetAttenuationSettingsToApply ( ) const
virtual

Returns a pointer to the attenuation settings that are to be applied for this node

Reimplemented in UDialogueSoundWaveProxy, and USoundCue.

◆ GetConcurrencyHandles()

void USoundBase::GetConcurrencyHandles ( TArray< FConcurrencyHandle > &  OutConcurrencyHandles) const

Returns an array of FSoundConcurrencySettings handles.

◆ GetCurveData()

virtual class UCurveTable * USoundBase::GetCurveData ( ) const
inlinevirtual

Returns curves associated with this sound if it has any. By default returns nullptr, but types supporting curves can return a corresponding curve table.

Reimplemented in UDialogueSoundWaveProxy, and USoundWave.

◆ GetDuration()

float USoundBase::GetDuration ( ) const
virtual

Returns the length of the sound

Reimplemented in UDialogueSoundWaveProxy, USoundCue, and USoundWave.

◆ GetMaxDistance()

float USoundBase::GetMaxDistance ( ) const
virtual

Returns the farthest distance at which the sound could be heard

Reimplemented in UDialogueSoundWaveProxy, and USoundCue.

◆ GetPitchMultiplier()

float USoundBase::GetPitchMultiplier ( )
virtual

Reimplemented in UDialogueSoundWaveProxy, and USoundCue.

◆ GetPriority()

float USoundBase::GetPriority ( ) const

Returns the priority to use when evaluating concurrency.

◆ GetSoundClass()

USoundClass * USoundBase::GetSoundClass ( ) const
virtual

Returns the SoundClass used for this sound.

Reimplemented in UDialogueSoundWaveProxy.

◆ GetSoundSourceBusSends()

void USoundBase::GetSoundSourceBusSends ( EBusSendType  BusSendType,
TArray< FSoundSourceBusSendInfo > &  OutSends 
) const

Returns the sound source sends for this sound.

◆ GetSoundSubmix()

USoundSubmixBase * USoundBase::GetSoundSubmix ( ) const
virtual

Returns the SoundSubmix used for this sound.

◆ GetSoundSubmixSends()

void USoundBase::GetSoundSubmixSends ( TArray< FSoundSubmixSendInfo > &  OutSends) const

Returns the sound submix sends for this sound.

◆ GetSoundWavesWithCookedAnalysisData()

bool USoundBase::GetSoundWavesWithCookedAnalysisData ( TArray< USoundWave * > &  OutSoundWaves)
virtual

Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data.

Reimplemented in USoundCue, and USoundWave.

◆ GetSubtitlePriority()

virtual float USoundBase::GetSubtitlePriority ( ) const
inlinevirtual

Returns the subtitle priority

Reimplemented in USoundCue, and USoundWave.

◆ GetVolumeMultiplier()

float USoundBase::GetVolumeMultiplier ( )
virtual

Reimplemented in UDialogueSoundWaveProxy, and USoundCue.

◆ HasAttenuationNode()

bool USoundBase::HasAttenuationNode ( ) const
virtual

Returns whether or not this sound base has an attenuation node.

◆ HasConcatenatorNode()

bool USoundBase::HasConcatenatorNode ( ) const

Returns whether or not this sound has a sequencer node, which means it's possible for the owning active sound to persist even though it's not generating audio.

◆ HasCookedAmplitudeEnvelopeData()

virtual bool USoundBase::HasCookedAmplitudeEnvelopeData ( ) const
inlinevirtual

Reimplemented in USoundCue, and USoundWave.

◆ HasCookedFFTData()

virtual bool USoundBase::HasCookedFFTData ( ) const
inlinevirtual

Queries if the sound has cooked FFT or envelope data.

Reimplemented in USoundCue, and USoundWave.

◆ HasDelayNode()

bool USoundBase::HasDelayNode ( ) const

Returns whether or not this sound has a delay node, which means it's possible for the sound to not generate audio for a while.

◆ ImplementsParameterInterface()

virtual bool USoundBase::ImplementsParameterInterface ( Audio::FParameterInterfacePtr  InParameterInterface) const
inlinevirtual

Whether or not the given sound is a generator and implements an interface with the given name.

◆ InitParameters()

void USoundBase::InitParameters ( TArray< FAudioParameter > &  ParametersToInit,
FName  InFeatureName = NAME_None 
)
virtual

Called from the Game Thread prior to attempting to pass parameters to the ParameterTransmitter.

◆ InitResources()

virtual void USoundBase::InitResources ( )
inlinevirtual

Called from the Game Thread prior to attempting to initialize a sound instance.

◆ IsAttenuationSettingsEditable()

virtual bool USoundBase::IsAttenuationSettingsEditable ( ) const
inlinevirtual

Only used as an edit condition for AttenuationSettings member, as base classes may choose to provide an attenuation override implementation

Reimplemented in USoundCue.

◆ IsLooping()

bool USoundBase::IsLooping ( ) const
virtual

Returns whether or not this sound is looping. TODO: Deprecate this to only use IsOneshot() in a MetaSound world.

◆ IsOneShot()

bool USoundBase::IsOneShot ( ) const
virtual

Query if it's one shot. One shot is defined as a sound which is intended to have a fixed duration.

◆ IsParameterValid()

bool USoundBase::IsParameterValid ( const FAudioParameter InParameter) const
virtual

Returns whether parameter is valid input for the given sound

◆ IsPlayable()

bool USoundBase::IsPlayable ( ) const
virtual

Returns whether the sound base is set up in a playable manner

Reimplemented in UDialogueSoundWaveProxy, USoundCue, and USoundWave.

◆ IsPlayWhenSilent()

bool USoundBase::IsPlayWhenSilent ( ) const
virtual

Returns true if any of the sounds in the sound have "play when silent" enabled.

Reimplemented in USoundCue.

◆ IsProcedurallyGenerated()

virtual bool USoundBase::IsProcedurallyGenerated ( ) const
inlinevirtual

Query if it's a procedurally generated sound.

Reimplemented in USoundWave.

◆ Parse()

virtual void USoundBase::Parse ( class FAudioDevice AudioDevice,
const UPTRINT  NodeWaveInstanceHash,
FActiveSound ActiveSound,
const FSoundParseParameters ParseParams,
TArray< FWaveInstance * > &  WaveInstances 
)
inlinevirtual

Parses the Sound to generate the WaveInstances to play.

Reimplemented in USoundCue, USoundWave, and UDialogueSoundWaveProxy.

◆ PreSave()

void USoundBase::PreSave ( FObjectPreSaveContext  SaveContext)
overridevirtual

Presave function. Gets called once before an object gets serialized for saving. This function is necessary for save time computation as Serialize gets called three times per object from within SavePackage.

Warning
: Objects created from within PreSave will NOT have PreSave called on them!!!

Reimplemented from UObject.

◆ RemoveUserDataOfClass()

void USoundBase::RemoveUserDataOfClass ( TSubclassOf< UAssetUserData InUserDataClass)
overridevirtual

Reimplemented from IInterface_AssetUserData.

◆ Serialize()

void USoundBase::Serialize ( FArchive Ar)
overridevirtual

Handles reading, writing, and reference collecting using FArchive. This implementation handles all FProperty serialization, but can be overridden for native variables.

Reimplemented from UObject.

Reimplemented in USoundWave, and USoundWaveProcedural.

◆ ShouldApplyInteriorVolumes()

bool USoundBase::ShouldApplyInteriorVolumes ( )
virtual

Returns whether or not any part of this sound wants interior volumes applied to it

Reimplemented in USoundCue.

◆ SupportsSubtitles()

bool USoundBase::SupportsSubtitles ( ) const
virtual

Returns whether sound supports subtitles.

Reimplemented in USoundWave.

◆ UE_DEPRECATED()

USoundBase::UE_DEPRECATED ( 5.  7,
"This is no longer used."   
) const
inline

Whether or not this sound allows submix sends on preview.

Member Data Documentation

◆ AssetUserData

TArray<TObjectPtr<UAssetUserData> > USoundBase::AssetUserData

Array of user data stored with the asset

◆ AttenuationSettings

TObjectPtr<USoundAttenuation> USoundBase::AttenuationSettings

Attenuation settings package for the sound

◆ bBypassVolumeScaleForPriority

uint8 USoundBase::bBypassVolumeScaleForPriority

Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).

◆ bDebug

uint8 USoundBase::bDebug

When "au.3dVisualize.Attenuation" has been specified, draw this sound's attenuation shape when the sound is audible. For debugging purposes only.

◆ bEnableBaseSubmix

uint8 USoundBase::bEnableBaseSubmix

If enabled, sound will route to the Master Submix by default or to the Base Submix if defined. If disabled, sound will route ONLY to the Submix Sends and/or Bus Sends

◆ bEnableBusSends

uint8 USoundBase::bEnableBusSends

Whether or not to enable sending this audio's output to buses.

◆ bEnableSubmixSends

uint8 USoundBase::bEnableSubmixSends

Whether or not to enable Submix Sends other than the Base Submix.

◆ bHasConcatenatorNode

uint8 USoundBase::bHasConcatenatorNode

Whether or not this sound has a concatenator node. If it does, we have to allow the sound to persist even though it may not have generate audible audio in a given audio thread frame.

◆ bHasDelayNode

uint8 USoundBase::bHasDelayNode

Whether or not this sound has a delay node

◆ bOverrideConcurrency

uint8 USoundBase::bOverrideConcurrency

Whether or not to override the sound concurrency object with local concurrency settings.

◆ BusSends

TArray<FSoundSourceBusSendInfo> USoundBase::BusSends

This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.

◆ ConcurrencyOverrides

FSoundConcurrencySettings USoundBase::ConcurrencyOverrides

If Override Concurrency is true, concurrency settings to use.

◆ ConcurrencySet

TSet<TObjectPtr<USoundConcurrency> > USoundBase::ConcurrencySet

Set of concurrency settings to observe (if override is set to false). Sound must pass all concurrency settings to play.

◆ CurrentPlayCount

TMap<Audio::FDeviceId, int32> USoundBase::CurrentPlayCount

Map of device handle to number of times this sound is currently being played using that device(counted if sound is virtualized).

◆ Duration

float USoundBase::Duration

Duration of sound in seconds.

◆ MaxDistance

float USoundBase::MaxDistance

The MaxDistance property is calculated statically on load or at asset edit time, but is not reliable at runtime. the GetMaxDistance function should be used to determine the applied max distance based on runtime behavior.

◆ PreEffectBusSends

TArray<FSoundSourceBusSendInfo> USoundBase::PreEffectBusSends

This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

◆ Priority

float USoundBase::Priority

Used to determine whether sound can play or remain active if channel limit is met, where higher value is higher priority (see platform's Audio Settings 'Max Channels' property). Unless bypassed, value is weighted with the final volume of the sound to produce final runtime priority value.

◆ SoundClassObject

TObjectPtr<USoundClass> USoundBase::SoundClassObject

Sound class this sound belongs to

◆ SoundSubmixObject

TObjectPtr<USoundSubmixBase> USoundBase::SoundSubmixObject

Submix to route sound output to. If unset, falls back to referenced SoundClass submix. If SoundClass submix is unset, sends to the 'Master Submix' as set in the 'Audio' category of Project Settings'.

◆ SoundSubmixSends

TArray<FSoundSubmixSendInfo> USoundBase::SoundSubmixSends

Array of submix sends to which a prescribed amount (see 'Send Level') of this sound is sent.

◆ SourceEffectChain

TObjectPtr<USoundEffectSourcePresetChain> USoundBase::SourceEffectChain

The source effect chain to use for this sound.

◆ TotalSamples

float USoundBase::TotalSamples

Total number of samples (in the thousands). Useful as a metric to analyze the relative size of a given sound asset in content browser.

◆ VirtualizationMode

EVirtualizationMode USoundBase::VirtualizationMode

Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted (limited to looping sounds).


The documentation for this class was generated from the following files: