UAtomSoundSourceBus Class Reference

#include <AtomSoundSourceBus.h>

Inheritance diagram for UAtomSoundSourceBus:

Public Member Functions
	UAtomSoundSourceBus (const FObjectInitializer &ObjectInitializer)
virtual CRIWARECORE_API float	GetDuration () const override
virtual CRIWARECORE_API bool	IsLooping () const override
virtual CRIWARECORE_API bool	IsOneShot () const override
virtual CRIWARECORE_API bool	IsPlayable () const override
virtual CRIWARECORE_API bool	IsSeekable () const override
virtual CRIWARECORE_API 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	GetAllSoundResources (TArray< IAtomSoundResource * > &Resources)
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 IAtomSoundResource *	GetSoundResource ()
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	IsParameterValid (const FAtomAisacParameter &InParameter) const
virtual CRIWARECORE_API bool	IsPlayWhenSilent () const
CRIWARECORE_API bool	IsProcedurallyGenerated () const
virtual bool	IsStreaming (const TCHAR *PlatformName=nullptr) 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 ()

Public Attributes
TObjectPtr< UAtomAudioBus >	AudioBus
uint32	bAutoDeactivateWhenSilent:1
uint8	bLooping: 1
EAtomSourceBusChannels	SourceBusChannels
float	SourceBusDuration
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
CRIWARECORE_API void	Init ()
Protected Member Functions inherited from UAtomSoundBase
virtual CRIWARECORE_API float	ComputeMaxDistance () const

Additional Inherited Members
Public Types inherited from UAtomSoundBase
using	FAtomSoundClientPtr = IAtomSoundClient*

Constructor & Destructor Documentation

UAtomSoundSourceBus()

UAtomSoundSourceBus::UAtomSoundSourceBus

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

GetDuration()

float UAtomSoundSourceBus::GetDuration ( ) const

overridevirtual

Returns the length of the sound

Reimplemented from UAtomSoundBase.

Init()

void UAtomSoundSourceBus::Init ( )

protected

IsLooping()

virtual CRIWARECORE_API bool UAtomSoundSourceBus::IsLooping ( ) const

inlineoverridevirtual

Returns whether or not this sound is looping. - Seems pre-deprecated by Unreal MetaSound - Use IsOneShot().

Reimplemented from UAtomSoundBase.

IsOneShot()

virtual CRIWARECORE_API bool UAtomSoundSourceBus::IsOneShot ( ) const

inlineoverridevirtual

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

Reimplemented from UAtomSoundBase.

IsPlayable()

bool UAtomSoundSourceBus::IsPlayable ( ) const

overridevirtual

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

Reimplemented from UAtomSoundBase.

IsSeekable()

virtual CRIWARECORE_API bool UAtomSoundSourceBus::IsSeekable ( ) const

inlineoverridevirtual

Returns whether the sound is seekable.

Reimplemented from UAtomSoundBase.

PostLoad()

void UAtomSoundSourceBus::PostLoad ( )

overridevirtual

Reimplemented from UAtomSoundBase.

Member Data Documentation

AudioBus

TObjectPtr<UAtomAudioBus> UAtomSoundSourceBus::AudioBus

Audio bus to use as audio for this source bus. This source bus will sonify the audio from the audio bus.

bAutoDeactivateWhenSilent

uint32 UAtomSoundSourceBus::bAutoDeactivateWhenSilent

Stop the source bus when the volume goes to zero.

bLooping

uint8 UAtomSoundSourceBus::bLooping

If set, when played directly the bus will be played looping.

SourceBusChannels

EAtomSourceBusChannels UAtomSoundSourceBus::SourceBusChannels

How many channels to use for the source bus if the audio bus is not specified, otherwise it will use the audio bus object's channel count.

SourceBusDuration

float UAtomSoundSourceBus::SourceBusDuration

The duration (in seconds) to use for the source bus. A duration of 0.0 indicates to play the source bus indefinitely.

---

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

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