UAtomSoundWaveProcedural Class Reference

#include <AtomSoundWaveProcedural.h>

Inheritance diagram for UAtomSoundWaveProcedural:

Public Member Functions
	UAtomSoundWaveProcedural (const FObjectInitializer &ObjectInitializer)
virtual IAtomSoundGeneratorPtr	CreateSoundGenerator (const FAtomSoundGeneratorInitParams &InParams)
virtual void	GetAllSoundResources (TArray< IAtomSoundResource * > &Resources) override
virtual float	GetDuration () const override
virtual IAtomSoundResource *	GetSoundResource () override
virtual bool	IsPlayable () const override
virtual bool	IsStreaming (const TCHAR *PlatformName=nullptr) const override
virtual void	OnEndGenerate (IAtomSoundGeneratorPtr Generator)
virtual void	PostLoad () override
Public Member Functions inherited from UAtomSoundBase
CRIWARECORE_API	UAtomSoundBase (const FObjectInitializer &ObjectInitializer)
virtual CRIWARECORE_API void	AddAssetUserData (UAssetUserData *InUserData) override
CRIWARECORE_API void	AddPlayingSource (const FAtomSoundClientPtr &Source)
virtual CRIWARECORE_API void	BeginDestroy () override
virtual CRIWARECORE_API bool	CanBeClusterRoot () const override
virtual CRIWARECORE_API bool	CanBeInCluster () const override
virtual bool	GetAllDefaultParameters (TArray< FAtomAisacParameter > &OutParameters) const
virtual CRIWARECORE_API void	GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
virtual CRIWARECORE_API const TArray< UAssetUserData * > *	GetAssetUserDataArray () const override
virtual CRIWARECORE_API UAssetUserData *	GetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
virtual CRIWARECORE_API void	GetAtomBusSends (TArray< FAtomSoundToBusSend > &OutSends) const
virtual CRIWARECORE_API UAtomRackBase *	GetAtomRack () const
virtual CRIWARECORE_API const FAtomAttenuationSettings *	GetAttenuationSettingsToApply () const
virtual CRIWARECORE_API void	GetConcurrencyHandles (TArray< FAtomConcurrencyHandle > &OutConcurrencyHandles) const
virtual CRIWARECORE_API float	GetMaxDistance () const
virtual const FAtomSoundModulationRoutingSettings &	GetModulationSettings () const
virtual CRIWARECORE_API float	GetPitchMultiplier ()
virtual CRIWARECORE_API float	GetPriority () const
virtual CRIWARECORE_API UAtomSoundClass *	GetSoundClass () const
virtual FString	GetSoundName () const
virtual CRIWARECORE_API void	GetSoundSourceBusSends (EAtomBusSendStage BusSendStage, TArray< FAtomSoundSourceBusSendInfo > &OutSends) const
virtual CRIWARECORE_API EAtomVirtualizationMode	GetVirtualizationMode () const
virtual CRIWARECORE_API float	GetVolumeMultiplier ()
virtual CRIWARECORE_API void	InitParameters (TArray< FAtomAisacParameter > &ParametersToInit, FName InFeatureName=NAME_None)
bool	IsGeneratingAudio () const
virtual CRIWARECORE_API bool	IsLooping () const
virtual CRIWARECORE_API bool	IsOneShot () const
virtual CRIWARECORE_API bool	IsParameterValid (const FAtomAisacParameter &InParameter) const
virtual CRIWARECORE_API bool	IsPlayWhenSilent () const
CRIWARECORE_API bool	IsProcedurallyGenerated () const
virtual bool	IsSeekable () const
virtual CRIWARECORE_API void	Parse (FAtomRuntime *AtomRuntime, const UPTRINT PlaybackInstanceHash, FAtomActiveSound &ActiveSound, const FAtomSoundParseParameters &ParseParams, TArray< FAtomPlaybackInstance * > &PlaybackInstances)
virtual CRIWARECORE_API void	PostInitProperties () override
CRIWARECORE_API void	RemovePlayingSource (const FAtomSoundClientPtr &Source)
virtual CRIWARECORE_API void	RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
virtual CRIWARECORE_API void	Serialize (FArchive &Ar) override
virtual CRIWARECORE_API bool	ShouldApplyInteriorVolumes ()

Protected Attributes
int32	NumBufferUnderrunSamples
int32	NumSamplesToGeneratePerCallback
int32	SampleByteSize

Additional Inherited Members
Public Types inherited from UAtomSoundBase
using	FAtomSoundClientPtr = IAtomSoundClient*
Public Attributes inherited from UAtomSoundBase
TArray< TObjectPtr< UAssetUserData > >	AssetUserData
TArray< FAtomSoundToBusSend >	AtomBusSends
TObjectPtr< UAtomRackWithParentBase >	AtomRack
TObjectPtr< UAtomAttenuation >	AttenuationSettings
uint8	bDebug: 1
uint8	bEnableBaseRack: 1
uint8	bEnableBusSends: 1
uint8	bEnableSourceBusSends: 1
uint8	bIsSourceBus: 1
uint8	bOverrideConcurrency: 1
uint8	bOverrideVirtualizationMode: 1
uint8	bProcedural: 1
FAtomConcurrencySettings	ConcurrencyOverrides
TSet< TObjectPtr< UAtomConcurrency > >	ConcurrencySet
TMap< FAtomRuntimeId, int32 >	CurrentPlayCount
float	Duration
float	MaxDistance
FAtomSoundModulationRoutingSettings	ModulationSettings
TArray< FAtomSoundSourceBusSendInfo >	PreEffectSourceBusSends
float	Priority
TObjectPtr< UAtomSoundClass >	SoundClassObject
EAtomVirtualizationMode	VirtualizationMode
FAtomWaveInfo	WaveInfo
Protected Member Functions inherited from UAtomSoundBase
virtual CRIWARECORE_API float	ComputeMaxDistance () const

Constructor & Destructor Documentation

UAtomSoundWaveProcedural()

UAtomSoundWaveProcedural::UAtomSoundWaveProcedural

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

CreateSoundGenerator()

virtual IAtomSoundGeneratorPtr UAtomSoundWaveProcedural::CreateSoundGenerator ( const FAtomSoundGeneratorInitParams & 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 Atom render thread.

Reimplemented in UAtomAudioLinkSound, and UAtomSynthSound.

GetAllSoundResources()

void UAtomSoundWaveProcedural::GetAllSoundResources ( TArray< IAtomSoundResource * > & Resources )

overridevirtual

Gets all AtomSoundResource objects that this sound rely to.

Reimplemented from UAtomSoundBase.

GetDuration()

float UAtomSoundWaveProcedural::GetDuration ( ) const

overridevirtual

Returns the length of the sound

Reimplemented from UAtomSoundBase.

GetSoundResource()

IAtomSoundResource * UAtomSoundWaveProcedural::GetSoundResource ( )

overridevirtual

Returns the parent AtomSoundResource object or null if it doesn't use any resource.

Reimplemented from UAtomSoundBase.

IsPlayable()

bool UAtomSoundWaveProcedural::IsPlayable ( ) const

overridevirtual

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

Reimplemented from UAtomSoundBase.

IsStreaming()

bool UAtomSoundWaveProcedural::IsStreaming ( const TCHAR * PlatformName = nullptr ) const

overridevirtual

Reimplemented from UAtomSoundBase.

OnEndGenerate()

virtual void UAtomSoundWaveProcedural::OnEndGenerate ( IAtomSoundGeneratorPtr Generator )

inlinevirtual

Called when the procedural sound wave is done generating on the render thread.Only used in the Atom mixer and when bProcedural is true.

PostLoad()

void UAtomSoundWaveProcedural::PostLoad ( )

overridevirtual

Reimplemented from UAtomSoundBase.

Reimplemented in UAtomExternalSound.

Member Data Documentation

NumBufferUnderrunSamples

int32 UAtomSoundWaveProcedural::NumBufferUnderrunSamples

protected

NumSamplesToGeneratePerCallback

int32 UAtomSoundWaveProcedural::NumSamplesToGeneratePerCallback

protected

SampleByteSize

int32 UAtomSoundWaveProcedural::SampleByteSize

protected

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:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomSoundWaveProcedural.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomSoundWaveProcedural.cpp