UAtomSoundCue Class Reference

#include <AtomSoundCue.h>

Inheritance diagram for UAtomSoundCue:

Public Member Functions
	UAtomSoundCue (const FObjectInitializer &ObjectInitializer)
void	CacheAggregateValues ()
virtual void	GetAllSoundResources (TArray< IAtomSoundResource * > &Resources) override
virtual void	GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
virtual const FAtomAttenuationSettings *	GetAttenuationSettingsToApply () const override
FString	GetCueName () const
virtual float	GetDuration () const
virtual float	GetMaxDistance () const
virtual float	GetPitchMultiplier () override
virtual FString	GetSoundName () const override
virtual IAtomSoundResource *	GetSoundResource () override
virtual EAtomVirtualizationMode	GetVirtualizationMode () const override
virtual float	GetVolumeMultiplier () override
void	Init (UAtomCueSheet *InCueSheet, const FAtomCueInfo &InCueInfo)
virtual bool	IsPlayable () const override
virtual bool	IsStreaming (const TCHAR *PlatformName=nullptr) const override
virtual void	Parse (FAtomRuntime *AtomRuntime, const UPTRINT PlaybackInstanceHash, FAtomActiveSound &ActiveSound, const FAtomSoundParseParameters &ParseParams, TArray< FAtomPlaybackInstance * > &PlaybackInstances) override
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 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 void	GetConcurrencyHandles (TArray< FAtomConcurrencyHandle > &OutConcurrencyHandles) const
virtual const FAtomSoundModulationRoutingSettings &	GetModulationSettings () const
virtual CRIWARECORE_API float	GetPriority () const
virtual CRIWARECORE_API UAtomSoundClass *	GetSoundClass () const
virtual CRIWARECORE_API void	GetSoundSourceBusSends (EAtomBusSendStage BusSendStage, TArray< FAtomSoundSourceBusSendInfo > &OutSends) const
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	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 ()

Public Attributes
FAtomAttenuationSettings	AttenuationOverrides
uint8	bOverrideAttenuation: 1
bool	bUseDynamicVoices = false
FAtomCueInfo	CueInfo
TObjectPtr< UAtomCueSheet >	CueSheet
float	PitchMultiplier
friend	UAtomCueSheet
friend	UAtomCueSheetFactory
int32	VoiceLimit = 1
FAtomCueVoiceSettings	VoiceSettingsOverrides
float	VolumeMultiplier
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

Additional Inherited Members
Public Types inherited from UAtomSoundBase
using	FAtomSoundClientPtr = IAtomSoundClient*
Protected Member Functions inherited from UAtomSoundBase
virtual CRIWARECORE_API float	ComputeMaxDistance () const

Constructor & Destructor Documentation

UAtomSoundCue()

UAtomSoundCue::UAtomSoundCue

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

CacheAggregateValues()

void UAtomSoundCue::CacheAggregateValues

(

)

Call to cache any values which need to be computed from the sound cue info. e.g. MaxDistance, Duration, etc.

GetAllSoundResources()

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

overridevirtual

Gets all AtomSoundResource objects that this sound rely to.

Reimplemented from UAtomSoundBase.

GetAssetRegistryTags()

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

overridevirtual

Reimplemented from UAtomSoundBase.

GetAttenuationSettingsToApply()

const FAtomAttenuationSettings * UAtomSoundCue::GetAttenuationSettingsToApply ( ) const

overridevirtual

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

Reimplemented from UAtomSoundBase.

GetCueName()

FString UAtomSoundCue::GetCueName ( ) const

inline

Helper that returns the name of this cue.

GetDuration()

float UAtomSoundCue::GetDuration ( ) const

virtual

Returns the length of the sound

Reimplemented from UAtomSoundBase.

GetMaxDistance()

float UAtomSoundCue::GetMaxDistance ( ) const

virtual

Returns the farthest distance at which the sound could be heard

Reimplemented from UAtomSoundBase.

GetPitchMultiplier()

float UAtomSoundCue::GetPitchMultiplier ( )

overridevirtual

Reimplemented from UAtomSoundBase.

GetSoundName()

FString UAtomSoundCue::GetSoundName ( ) const

overridevirtual

Returns the name to identify this sound with is parent bank name if exist.

Reimplemented from UAtomSoundBase.

GetSoundResource()

IAtomSoundResource * UAtomSoundCue::GetSoundResource ( )

overridevirtual

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

Reimplemented from UAtomSoundBase.

GetVirtualizationMode()

EAtomVirtualizationMode UAtomSoundCue::GetVirtualizationMode ( ) const

overridevirtual

Retruns the applied virtualization mode.

Reimplemented from UAtomSoundBase.

GetVolumeMultiplier()

float UAtomSoundCue::GetVolumeMultiplier ( )

overridevirtual

Reimplemented from UAtomSoundBase.

Init()

void UAtomSoundCue::Init	(	UAtomCueSheet *	InCueSheet,
		const FAtomCueInfo &	InCueInfo )

IsPlayable()

bool UAtomSoundCue::IsPlayable ( ) const

overridevirtual

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

Reimplemented from UAtomSoundBase.

IsStreaming()

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

overridevirtual

Reimplemented from UAtomSoundBase.

Parse()

void UAtomSoundCue::Parse ( FAtomRuntime * AtomRuntime, const UPTRINT InPlaybackInstanceHash, FAtomActiveSound & ActiveSound, const FAtomSoundParseParameters & ParseParams, TArray< FAtomPlaybackInstance * > & PlaybackInstances )

overridevirtual

Parses the Sound to generate and setup the PlaybackInstances to play.

Reimplemented from UAtomSoundBase.

PostLoad()

void UAtomSoundCue::PostLoad ( )

overridevirtual

Reimplemented from UAtomSoundBase.

Member Data Documentation

AttenuationOverrides

FAtomAttenuationSettings UAtomSoundCue::AttenuationOverrides

Attenuation settings to use if Override Attenuation is set to true

bOverrideAttenuation

uint8 UAtomSoundCue::bOverrideAttenuation

Indicates whether attenuation should use the Attenuation Overrides or the Attenuation Settings asset

bUseDynamicVoices

bool UAtomSoundCue::bUseDynamicVoices = false

Whether to play this cue over dynamically managed voices or over shared voices defined in project property.

CueInfo

FAtomCueInfo UAtomSoundCue::CueInfo

Cached cue information from cue sheet.

CueSheet

TObjectPtr<UAtomCueSheet> UAtomSoundCue::CueSheet

CueSheet holding this sound cue.

PitchMultiplier

float UAtomSoundCue::PitchMultiplier

Base pitch multiplier

UAtomCueSheet

friend UAtomSoundCue::UAtomCueSheet

UAtomCueSheetFactory

friend UAtomSoundCue::UAtomCueSheetFactory

VoiceLimit

int32 UAtomSoundCue::VoiceLimit = 1

The maximum number of voice instances this cue can play when dynamically managed. Voices that play above this number may be stopped or virtualized according virtualisation settings of the cue.

VoiceSettingsOverrides

FAtomCueVoiceSettings UAtomSoundCue::VoiceSettingsOverrides

Voice allocation settings to override for dynamically managed voices.

VolumeMultiplier

float UAtomSoundCue::VolumeMultiplier

Base volume multiplier

---

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

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