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

#include <SoundWaveProcedural.h>

+ Inheritance diagram for USoundWaveProcedural:

Public Member Functions

ENGINE_API USoundWaveProcedural (const FObjectInitializer &ObjectInitializer)
 
virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const override
 
virtual ENGINE_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
 
virtual ENGINE_API int32 GeneratePCMData (uint8 *PCMData, const int32 SamplesNeeded) override
 
virtual ENGINE_API bool HasCompressedData (FName Format, ITargetPlatform *TargetPlatform) const override
 
virtual ENGINE_API void BeginGetCompressedData (FName Format, const FPlatformAudioCookOverrides *CompressionOverrides, const ITargetPlatform *InTargetPlatform) override
 
virtual ENGINE_API FByteBulkDataGetCompressedData (FName Format, const FPlatformAudioCookOverrides *CompressionOverrides, const ITargetPlatform *InTargetPlatform) override
 
virtual ENGINE_API void InitAudioResource (FByteBulkData &CompressedData) override
 
virtual ENGINE_API bool InitAudioResource (FName Format) override
 
virtual ENGINE_API int32 GetResourceSizeForFormat (FName Format) override
 
virtual bool IsSeekable () const override
 
virtual int32 OnGeneratePCMAudio (TArray< uint8 > &OutAudio, int32 NumSamples)
 
ENGINE_API void QueueAudio (const uint8 *AudioData, const int32 BufferSize)
 
ENGINE_API void ResetAudio ()
 
ENGINE_API int32 GetAvailableAudioByteCount ()
 
- Public Member Functions inherited from USoundWave
void AddPlayingSource ()
 
void RemovePlayingSource ()
 
ENGINE_API ESoundAssetCompressionType GetSoundAssetCompressionType () const
 
ENGINE_API ESoundAssetCompressionType GetSoundAssetCompressionTypeEnum () const
 
ENGINE_API void SetSoundAssetCompressionType (ESoundAssetCompressionType InSoundAssetCompressionType, bool bMarkDirty=true)
 
ENGINE_API TArray< FSoundWaveCuePointGetCuePoints () const
 
ENGINE_API void SetAllCuePoints (TArray< FSoundWaveCuePoint > InCuePoints) const
 
ENGINE_API TArray< FSoundWaveCuePointGetLoopRegions () const
 
ENGINE_API FName GetRuntimeFormat () const
 
ENGINE_API void ResetInvalidTemplateArguments ()
 
ENGINE_API bool GetInterpolatedCookedFFTDataForTime (float InTime, uint32 &InOutLastIndex, TArray< FSoundWaveSpectralData > &OutData, bool bLoop)
 
ENGINE_API bool GetInterpolatedCookedEnvelopeDataForTime (float InTime, uint32 &InOutLastIndex, float &OutAmplitude, bool bLoop)
 
ENGINE_API void GetHandleForChunkOfAudio (TFunction< void(FAudioChunkHandle &&)> OnLoadCompleted, bool bForceSync=false, int32 ChunkIndex=1, ENamedThreads::Type CallbackThread=ENamedThreads::GameThread)
 
ENGINE_API void RetainCompressedAudio (bool bForceSync=false)
 
ENGINE_API void ReleaseCompressedAudio ()
 
ENGINE_API bool IsRetainingAudio ()
 
ENGINE_API void OverrideLoadingBehavior (ESoundWaveLoadingBehavior InLoadingBehavior)
 
ENGINE_API ESoundWaveLoadingBehavior GetLoadingBehavior (bool bCheckSoundClasses=true) const
 
ENGINE_API int32 GetCompressionQuality () const
 
ENGINE_API int32 GetResourceSize () const
 
ENGINE_API const uint8GetResourceData () const
 
virtual ENGINE_API void PostInitProperties () override
 
virtual ENGINE_API bool IsReadyForFinishDestroy () override
 
virtual ENGINE_API void FinishDestroy () override
 
virtual ENGINE_API void PostLoad () override
 
ENGINE_API bool LoadZerothChunk ()
 
ENGINE_API uint32 GetNumChunks () const
 
ENGINE_API uint32 GetSizeOfChunk (uint32 ChunkIndex) const
 
ENGINE_API void GetChunkSizeStats (uint32 &OutTotalBytesOfAudioData, uint32 &OutMaxChunkBytesOfAudioData) const
 
virtual ENGINE_API void BeginDestroy () override
 
virtual ENGINE_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize) override
 
virtual ENGINE_API FName GetExporterName () override
 
virtual ENGINE_API FString GetDesc () override
 
virtual ENGINE_API bool IsPlayable () const override
 
virtual ENGINE_API void Parse (class FAudioDevice *AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound &ActiveSound, const FSoundParseParameters &ParseParams, TArray< FWaveInstance * > &WaveInstances) override
 
virtual ENGINE_API float GetDuration () const override
 
virtual ENGINE_API float GetSubtitlePriority () const override
 
virtual ENGINE_API bool SupportsSubtitles () const override
 
virtual ENGINE_API bool GetSoundWavesWithCookedAnalysisData (TArray< USoundWave * > &OutSoundWaves) override
 
virtual ENGINE_API bool HasCookedFFTData () const override
 
virtual ENGINE_API bool HasCookedAmplitudeEnvelopeData () const override
 
virtual bool IsProcedurallyGenerated () const override
 
ENGINE_API FSoundWaveProxyPtr CreateSoundWaveProxy ()
 
virtual ENGINE_API TSharedPtr< Audio::IProxyDataCreateProxyData (const Audio::FProxyDataInitParams &InitParams) override
 
virtual void OnBeginGenerate ()
 
virtual void OnEndGenerate ()
 
virtual void OnEndGenerate (ISoundGeneratorPtr Generator)
 
ENGINE_API void AddPlayingSource (const FSoundWaveClientPtr &Source)
 
ENGINE_API void RemovePlayingSource (const FSoundWaveClientPtr &Source)
 
bool IsGeneratingAudio () const
 
void SetImportedSampleRate (uint32 InImportedSampleRate)
 
uint32 GetImportedSampleRate () const
 
ENGINE_API void SetSampleRate (uint32 InSampleRate, const bool bFromDecoders=false)
 
ENGINE_API void SetNumFrames (uint32 InNumFrames)
 
ENGINE_API uint32 GetNumFrames () const
 
ENGINE_API void FreeResources (bool bStopSoundsUsingThisResource=true)
 
ENGINE_API bool CleanupDecompressor (bool bForceCleanup=false)
 
ENGINE_API void RemoveAudioResource ()
 
ENGINE_API FWaveInstanceHandleStart (FActiveSound &ActiveSound, const UPTRINT WaveInstanceHash) const
 
virtual Audio::EAudioMixerStreamDataFormat::Type GetGeneratedPCMDataFormat () const
 
SIZE_T GetCompressedDataSize (FName Format, const FPlatformAudioCookOverrides *CompressionOverrides=GetPlatformCompressionOverridesForCurrentPlatform())
 
ENGINE_API void InvalidateCompressedData (bool bFreeResources=false, bool bRebuildStreamingChunks=true)
 
virtual class UCurveTableGetCurveData () const override
 
ENGINE_API bool HasStreamingChunks ()
 
ENGINE_API bool IsStreaming (const TCHAR *PlatformName=nullptr) const
 
ENGINE_API bool IsStreaming (const FPlatformAudioCookOverrides &Overrides) const
 
ENGINE_API bool ShouldUseStreamCaching () const
 
ENGINE_API TArrayView< const uint8GetZerothChunk (bool bForImmediatePlayback=false)
 
ENGINE_API void UpdatePlatformData ()
 
ENGINE_API void CleanupCachedRunningPlatformData ()
 
virtual ENGINE_API void SerializeCookedPlatformData (class FArchive &Ar)
 
ENGINE_API float GetSampleRateForCurrentPlatform () const
 
ENGINE_API float GetSampleRateForCompressionOverrides (const FPlatformAudioCookOverrides *CompressionOverrides) const
 
ENGINE_API void SetError (const TCHAR *InErrorMsg=nullptr)
 
ENGINE_API void ResetError ()
 
ENGINE_API bool HasError () const
 
ENGINE_API bool GetChunkData (int32 ChunkIndex, uint8 **OutChunkData, bool bMakeSureChunkIsLoaded=false)
 
void SetPrecacheState (ESoundWavePrecacheState InState)
 
ESoundWavePrecacheState GetPrecacheState () const
 
- Public Member Functions inherited from USoundBase
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 bool HasAttenuationNode () const
 
virtual ENGINE_API const FSoundAttenuationSettingsGetAttenuationSettingsToApply () const
 
virtual ENGINE_API float GetMaxDistance () 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 ENGINE_API bool ShouldApplyInteriorVolumes ()
 
virtual ENGINE_API bool IsLooping () const
 
virtual ENGINE_API bool IsOneShot () const
 
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 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 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 PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
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)
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) 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

FOnSoundWaveProceduralUnderflow OnSoundWaveProceduralUnderflow
 
int32 SampleByteSize
 
- Public Attributes inherited from USoundWave
int32 StreamingPriority
 
ESoundwaveSampleRateSettings SampleRateQuality
 
TEnumAsByte< EDecompressionTypeDecompressionType
 
TEnumAsByte< ESoundGroupSoundGroup
 
uint8 bLooping: 1
 
uint8 bStreaming: 1
 
FSoundModulationDefaultRoutingSettings ModulationSettings
 
TArray< floatFrequenciesToAnalyze
 
TArray< FSoundWaveSpectralTimeDataCookedSpectralTimeData
 
TArray< FSoundWaveEnvelopeTimeDataCookedEnvelopeTimeData
 
FThreadSafeCounter NumSourcesPlaying
 
uint8 bProcedural: 1
 
uint8 bRequiresStopFade:1
 
uint8 bIsSourceBus: 1
 
uint8 bCanProcessAsync: 1
 
uint8 bDynamicResource: 1
 
uint8 bMature: 1
 
uint8 bManualWordWrap: 1
 
uint8 bSingleLine: 1
 
uint8 bIsAmbisonics: 1
 
uint8 bDecompressedFromOgg: 1
 
ESoundWaveLoadingBehavior LoadingBehavior
 
FString SpokenText_DEPRECATED
 
float SubtitlePriority
 
float Volume
 
float Pitch
 
int32 NumChannels
 
int32 ResourceID
 
int32 TrackedMemoryUsage
 
TArray< struct FSubtitleCueSubtitles
 
FAsyncAudioDecompressAudioDecompressor
 
uint8CachedRealtimeFirstBuffer
 
int32 NumPrecacheFrames
 
int32 RawPCMDataSize
 
uint8RawPCMData
 
FGuid CompressedDataGuid
 
TSortedMap< FString, FStreamedAudioPlatformData * > CookedPlatformData
 
- Public Attributes inherited from USoundBase
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 void SerializeCuePoints (FArchive &Ar, const bool bIsLoadingFromCookedArchive)
 
- Protected Member Functions inherited from USoundBase
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)
 

Protected Attributes

int32 NumBufferUnderrunSamples
 
int32 NumSamplesToGeneratePerCallback
 
- Protected Attributes inherited from USoundWave
int32 SampleRate
 
TObjectPtr< class UCurveTableCurves
 
TObjectPtr< class UCurveTableInternalCurves
 

Additional Inherited Members

- Public Types inherited from USoundWave
using FSoundWaveClientPtr = ISoundWaveClient *
 
typedef FAsyncTask< class FAsyncAudioDecompressWorkerFAsyncAudioDecompress
 
- 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 USoundWave
static ENGINE_API ITargetPlatformGetRunningPlatform ()
 
static ENGINE_API const TCHARGetDefaultLoadingBehaviorCVarName ()
 
static ENGINE_API ESoundWaveLoadingBehavior GetDefaultLoadingBehavior ()
 
static ENGINE_API FName GetPlatformSpecificFormat (FName Format, const FPlatformAudioCookOverrides *CompressionOverrides)
 
static ENGINE_API const FPlatformAudioCookOverridesGetPlatformCompressionOverridesForCurrentPlatform ()
 
- 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)
 

Constructor & Destructor Documentation

◆ USoundWaveProcedural()

USoundWaveProcedural::USoundWaveProcedural ( const FObjectInitializer ObjectInitializer)

Member Function Documentation

◆ BeginGetCompressedData()

void USoundWaveProcedural::BeginGetCompressedData ( FName  Format,
const FPlatformAudioCookOverrides CompressionOverrides,
const ITargetPlatform InTargetPlatform 
)
overridevirtual

Reimplemented from USoundWave.

◆ GeneratePCMData()

int32 USoundWaveProcedural::GeneratePCMData ( uint8 PCMData,
const int32  SamplesNeeded 
)
overridevirtual

This is only used for DTYPE_Procedural audio. It's recommended to use USynthComponent base class for procedurally generated sound vs overriding this function. If a new component is not feasible, consider using USoundWaveProcedural base class vs USoundWave base class since as it implements GeneratePCMData for you and you only need to return PCM data.

Reimplemented from USoundWave.

◆ GetAssetRegistryTags() [1/2]

void USoundWaveProcedural::GetAssetRegistryTags ( FAssetRegistryTagsContext  Context) const
overridevirtual

Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

Parameters
OutTagsA list of key-value pairs associated with this object and their types

Reimplemented from USoundWave.

◆ GetAssetRegistryTags() [2/2]

void USoundWaveProcedural::GetAssetRegistryTags ( TArray< FAssetRegistryTag > &  OutTags) const
overridevirtual

Reimplemented from USoundWave.

◆ GetAvailableAudioByteCount()

int32 USoundWaveProcedural::GetAvailableAudioByteCount ( )

Query bytes queued for playback

◆ GetCompressedData()

FByteBulkData * USoundWaveProcedural::GetCompressedData ( FName  Format,
const FPlatformAudioCookOverrides CompressionOverrides,
const ITargetPlatform InTargetPlatform 
)
overridevirtual

Gets the compressed data from derived data cache for the specified platform Warning, the returned pointer isn't valid after we add new formats

Parameters
Formatformat of compressed data
CompressionOverridesoptional platform compression overrides
Returns
compressed data, if it could be obtained

Reimplemented from USoundWave.

◆ GetResourceSizeForFormat()

int32 USoundWaveProcedural::GetResourceSizeForFormat ( FName  Format)
overridevirtual
Parameters
FormatFormat to check
Returns
Sum of the size of waves referenced by this cue for the given platform.

Reimplemented from USoundWave.

◆ HasCompressedData()

bool USoundWaveProcedural::HasCompressedData ( FName  Format,
ITargetPlatform TargetPlatform 
) const
overridevirtual

Reimplemented from USoundWave.

◆ InitAudioResource() [1/2]

void USoundWaveProcedural::InitAudioResource ( FByteBulkData CompressedData)
overridevirtual

Copy the compressed audio data from the bulk data

Reimplemented from USoundWave.

◆ InitAudioResource() [2/2]

bool USoundWaveProcedural::InitAudioResource ( FName  Format)
overridevirtual

Copy the compressed audio data from derived data cache

Parameters
Formatto get the compressed audio in
Returns
true if the resource has been successfully initialized or it was already initialized.

Reimplemented from USoundWave.

◆ IsSeekable()

virtual bool USoundWaveProcedural::IsSeekable ( ) const
inlineoverridevirtual

Queries if Seeking is supported by the Decoder for this Wave.

Returns
true if Seeking is supported, false otherwise.

Reimplemented from USoundWave.

◆ OnGeneratePCMAudio()

virtual int32 USoundWaveProcedural::OnGeneratePCMAudio ( TArray< uint8 > &  OutAudio,
int32  NumSamples 
)
inlinevirtual

◆ QueueAudio()

void USoundWaveProcedural::QueueAudio ( const uint8 AudioData,
const int32  BufferSize 
)

Add data to the FIFO that feeds the audio device.

◆ ResetAudio()

void USoundWaveProcedural::ResetAudio ( )

Remove all queued data from the FIFO. This is only necessary if you want to start over, or GeneratePCMData() isn't going to be called, since that will eventually drain it.

◆ Serialize()

void USoundWaveProcedural::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 USoundWave.

◆ SerializeCuePoints()

virtual void USoundWaveProcedural::SerializeCuePoints ( FArchive Ar,
const bool  bIsLoadingFromCookedArchive 
)
inlineprotectedvirtual

Reimplemented from USoundWave.

Member Data Documentation

◆ NumBufferUnderrunSamples

int32 USoundWaveProcedural::NumBufferUnderrunSamples
protected

◆ NumSamplesToGeneratePerCallback

int32 USoundWaveProcedural::NumSamplesToGeneratePerCallback
protected

◆ OnSoundWaveProceduralUnderflow

FOnSoundWaveProceduralUnderflow USoundWaveProcedural::OnSoundWaveProceduralUnderflow

Called when GeneratePCMData is called but not enough data is available. Allows more data to be added, and will try again

◆ SampleByteSize

int32 USoundWaveProcedural::SampleByteSize

Size in bytes of a single sample of audio in the procedural audio buffer.


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