#include <AtomActiveSound.h>

クラス
struct	FAsyncTraceDetails

公開型
enum class	EFadeOut : uint8 { None , User , Concurrency }

公開メンバ関数
	FAtomActiveSound ()
	FAtomActiveSound (const FAtomActiveSound &)
	~FAtomActiveSound ()
FAtomPlaybackInstance &	AddPlaybackInstance (const UPTRINT PlaybackInstanceHash)
void	AddReferencedObjects (FReferenceCollector &Collector)
bool	CanDelete () const
bool	CanVirtualizeWhenSilent () const
void	ClearAllCueSelectorLabels ()
void	ClearAtomComponent ()
void	CollectAttenuationShapesForVisualization (TMultiMap< EAtomAttenuationShape, FAtomAttenuationSettings::AttenuationShapeDetails > &ShapeDetailsMap) const
int32	FindClosestListener () const
int32	FindClosestListener (const TArray< struct FAtomListener > &InListeners) const
FAtomPlaybackInstance *	FindPlaybackInstance (const UPTRINT PlaybackInstanceHash)
void	GetAisacControls (TArray< FAtomAisacParameter > &OutParameters) const
bool	GetAlwaysPlay () const
void	GetAtomBusSends (TArray< FAtomSoundToBusSend > &OutSends) const
uint64	GetAtomComponentID () const
FString	GetAtomComponentName () const
FName	GetAtomComponentUserID () const
void	GetAtomRackSends (TArray< FAtomSoundToRackSend > &OutSends) const
FAtomRuntime *	GetAtomRuntime () const
int32	GetClosestListenerIndex () const
bool	GetConcurrencyFadeDuration (float &OutFadeDuration) const
void	GetConcurrencyHandles (TArray< FAtomConcurrencyHandle > &OutConcurrencyHandles) const
void	GetCueSelectorParameters (TArray< FAtomSelectorParam > &OutParameters) const
float	GetHighestPriority (bool bIgnoreAlwaysPlay=false) const
uint32	GetInstanceID () const
void	GetMultiplePositions (TArray< FTransform > &OutPositions)
TArray< TTuple< EAtomBusSendStage, FAtomSoundSourceBusSendInfo > > const &	GetNewSourceBusSends () const
uint32	GetObjectId () const
uint32	GetOwnerID () const
FString	GetOwnerName () const
float	GetPitch () const
const TMap< UPTRINT, FAtomPlaybackInstance * > &	GetPlaybackInstances () const
int32	GetPlayCount () const
uint32	GetPlayOrder () const
UAtomSoundBase *	GetSound () const
UAtomSoundClass *	GetSoundClass () const
UAtomRackBase *	GetSoundRack () const
void	GetSourceBusSends (EAtomBusSendStage BusSendStage, TArray< FAtomSoundSourceBusSendInfo > &OutSends) const
float	GetTotalConcurrencyVolumeScale () const
float	GetVolume () const
TWeakObjectPtr< UWorld >	GetWeakWorld () const
UWorld *	GetWorld () const
uint32	GetWorldID () const
bool	HasNewSourceBusSends () const
bool	IsLooping () const
bool	IsOneShot () const
bool	IsPlayingAudio () const
bool	IsPlayWhenSilent () const
bool	IsPreviewSound () const
void	OnCueBeatSync (const TSharedPtr< const FAtomBeatSyncInfo > &BeatSyncInfo)
void	OnCueSequencerEvent (const TSharedPtr< const FAtomSequencerEventInfo > &EventInfo)
void	ParseAttenuation (FAtomSoundParseParameters &OutParseParams, int32 ListenerIndex, const FAtomAttenuationSettings &InAttenuationSettings)
void	RemoveCueSelectorLabel (const FAtomSelectorParam &SelectorParam)
void	RemovePlaybackInstance (const UPTRINT PlaybackInstanceHash)
void	ResetNewSourceBusSends ()
void	SetAisacControl (const FAtomAisacParameter &Parameter)
void	SetAtomBusSend (const FAtomSoundToBusSend &BusSend)
void	SetAtomComponent (const FAtomActiveSound &ActiveSound)
void	SetAtomComponent (const UAtomComponent &Component)
void	SetAtomRackSend (const FAtomSoundToRackSend &RackSend)
void	SetAtomRuntime (FAtomRuntime *InAtomRuntime)
void	SetAttenuationSettingsAsset (TObjectPtr< UAtomAttenuation > InSoundAttenuation)
void	SetAttenuationSettingsOverride (bool bInIsAttenuationSettingsOverridden)
void	SetCueBeatSyncInfo (const TSharedPtr< const FAtomBeatSyncInfo > &BeatSyncInfo)
void	SetCueBeatSyncOffset (int32 Offset)
void	SetCueBlockIndex (int32 BlockIndex)
void	SetCueNextBlockIndex (int32 BlockIndex)
void	SetCueSelectorLabel (const FAtomSelectorParam &SelectorParam)
void	SetMultiplePositions (const TArray< FTransform > &InPositions, EAtomMultiPositionType InMultiPositionType)
void	SetNewModulationRouting (const FAtomSoundModulationRoutingSettings &NewRouting)
void	SetOwner (const AActor *Owner)
void	SetPitch (float Value)
void	SetSound (UAtomSoundBase *InSound)
void	SetSoundClass (UAtomSoundClass *SoundClass)
void	SetSourceBusSend (EAtomBusSendStage BusSendStage, const FAtomSoundSourceBusSendInfo &SourceBusSendInfo)
void	SetVirtualized (bool bIsVirtualized)
void	SetVolume (float Value)
void	SetWorld (UWorld *World)
void	Stop ()
void	UpdateAttenuation (float DeltaTime, FAtomSoundParseParameters &ParseParams, int32 ListenerIndex, const FAtomAttenuationSettings *SettingsAttenuationNode=nullptr)
void	UpdateFocusData (float DeltaTime, const FAtomAttenuationListenerData &ListenerData, FAtomAttenuationFocusData *OutFocusData=nullptr)
void	UpdatePlaybackInstances (TArray< FAtomPlaybackInstance * > &OutPlaybackInstances, const float DeltaTime)

静的公開メンバ関数
static FAtomActiveSound *	CreateVirtualCopy (const FAtomActiveSound &ActiveSoundToCopy, FAtomRuntime &AtomRuntime)
static void	ExecuteOnSoundFinishedCallback (bool bEndReached, const TFunction< void(bool bEndReached)> &OnSoundFinished, const ENamedThreads::Type &CallbackThread)
static void	OcclusionTraceDone (const FTraceHandle &TraceHandle, FTraceDatum &TraceDatum)

公開変数類
TArray< FName >	AdditionalAisacPatchNames
TArray< FAtomAisacParameter >	AisacParametersOverride
FAtomEnvelope	AmplitudeEnvelope
FAtomAttenuationSettings	AttenuationSettings
uint8	bAllowSpatialization: 1
uint8	bAlwaysPlay: 1
uint8	bApplyInteriorVolumes: 1
FThreadSafeBool	bAsyncOcclusionPending
uint8	bEnableAmplitudeEnvelope: 1
uint8	bEnableHighPassFilter: 1
uint8	bEnableLowPassFilter: 1
uint8	bEnableMainRackOutputOverride: 1
uint8	bEnableSoundBusSendRoutingOverride: 1
uint8	bEnableSourceBusSendRoutingOverride: 1
uint8	bFinished: 1
uint8	bForceUseAtomPlayer: 1
uint8	bGotInteriorSettings: 1
uint8	bHasActiveMainRackOutputOverride: 1
uint8	bHasActiveSoundBusSendRoutingOverride: 1
uint8	bHasActiveSourceBusSendRoutingOverride: 1
uint8	bHasAttenuationSettings: 1
uint8	bHasCheckedOcclusion: 1
bool	bHasNewSourceBusSends
uint8	bHasVirtualized: 1
uint8	bIgnoreForFlushing: 1
uint8	bIsAttenuationSettingsOverridden: 1
uint8	bIsFirstAttenuationUpdate: 1
FThreadSafeBool	bIsOccluded
uint8	bIsPaused: 1
uint8	bIsPendingVirtualization: 1
uint8	bIsPlayingAudio: 1
uint8	bIsPreviewSound: 1
uint8	bIsRealizingWithFadeIn: 1
uint8	bIsStopping: 1
uint8	bIsUISound: 1
uint8	bLocationDefined: 1
uint8	bModulationRoutingUpdated: 1
uint8	bShouldRemainActiveIfDropped: 1
uint8	bShouldStopDueToMaxConcurrency: 1
uint8	bStartedWithinNonBinauralRadius: 1
uint8	bUpdateMultiEnvelopeValue: 1
uint8	bUpdatePlaybackTime: 1
uint8	bUpdatePlayPercentage: 1
uint8	bUpdateSingleEnvelopeValue: 1
uint8	bVirtualizedDueToMaxConcurrency: 1
uint8	bWarnedAboutOrphanedLooping: 1
TArray< FName >	CategoryNames
FAtomVolumeFader	ComponentVolumeFader
TMap< FAtomConcurrencyGroupId, FAtomConcurrencySoundData >	ConcurrencyGroupData
TSet< TObjectPtr< UAtomConcurrency > >	ConcurrencySet
int32	CueBeatSyncOffset
int32	CueFirstBlockIndex
int32	CueNextBlockIndex
TArray< FAtomSelectorParam >	CueSelectorParams
FAtomDynamicParameter	CurrentOcclusionFilterFrequency
FAtomDynamicParameter	CurrentOcclusionVolumeAttenuation
int32	EnvelopeFollowerAttackTime
int32	EnvelopeFollowerReleaseTime
EFadeOut	FadeOut
FAtomAttenuationFocusData	FocusData
float	HighPassFilterFrequency
TSharedPtr< Atom::FAtomExPlayer, ESPMode::ThreadSafe >	InstancePlayer
FVector	LastLocation
float	LastOcclusionCheckTime
float	LowPassFilterFrequency
float	MaxDistance
float	MinCurrentPitch
FAtomSoundModulationRoutingSettings	ModulationRouting
TArray< FTransform >	MultiPositions
EAtomMultiPositionType	MultiPositionType
TArray< TTuple< EAtomBusSendStage, FAtomSoundSourceBusSendInfo > >	NewSourceBusSends
float	OcclusionCheckInterval
TFunction< FAtomSource (FAtomRuntime , FAtomPlaybackInstance *)>	OnCreateSource
TFunction< void(bool bWasEndReached)>	OnSoundFinished
FAtomPcmFilterFunction	PcmFilterFunction
float	PitchMultiplier
float	PlaybackTime
float	PlaybackTimeNonVirtualized
float	PlaybackTimeUnscaled
float	Priority
Atom::FQuartzQuantizedRequestData	QuantizedRequestData
float	RequestedStartTime
FAtomSourceVoiceEffect	SourceVoiceEffect
ENamedThreads::Type	ThreadToCallOnSoundFinishedOn
FTransform	Transform
uint8	UserIndex
float	VolumeConcurrency
float	VolumeMultiplier

非公開メンバ関数
void	CheckOcclusion (const FVector ListenerLocation, const FVector SoundLocation, const FAtomAttenuationSettings *AttenuationSettingsPtr)
float	GetAttenuationFrequency (const FAtomAttenuationSettings *InSettings, const FAtomAttenuationListenerData &ListenerData, const FVector2D &FrequencyRange, const FRuntimeFloatCurve &CustomCurve)
bool	IsStopping () const
void	MarkPendingDestroy (bool bDestroyNow)
void	UpdateConcurrencyVolumeScalars (const float DeltaTime)
bool	UpdateStoppingSources (uint64 CurrentTick, bool bEnsureStopped)

非公開変数類
TArray< FAtomSoundToBusSend >	AtomBusSendsOverride
uint64	AtomComponentID
FName	AtomComponentName
FName	AtomComponentUserID
TArray< FAtomSoundToRackSend >	AtomRackSendsOverride
FAtomRuntime *	AtomRuntime
int32	ClosestListenerIndex
uint32	OwnerID
FName	OwnerName
TMap< UPTRINT, FAtomPlaybackInstance * >	PlaybackInstances
uint32	PlayOrder
TObjectPtr< UAtomSoundBase >	Sound
TObjectPtr< UAtomAttenuation >	SoundAttenuation
TObjectPtr< UAtomSoundClass >	SoundClassOverride
TArray< FAtomSoundSourceBusSendInfo >	SourceBusSendsOverride [(int32) EAtomBusSendStage::Count]
TWeakObjectPtr< UWorld >	World
uint32	WorldID

静的非公開変数類
static FTraceDelegate	ActiveSoundTraceDelegate
static TMap< FTraceHandle, FAsyncTraceDetails >	TraceToActiveSoundMap

フレンド
class	FAtomRuntime
FArchive &	operator<< (FArchive &Ar, FAtomActiveSound *ActiveSound)

列挙型メンバ詳解

◆ EFadeOut

enum class FAtomActiveSound::EFadeOut : uint8

strong

列挙値
None
User
Concurrency

構築子と解体子

◆ FAtomActiveSound() [1/2]

FAtomActiveSound::FAtomActiveSound ( )

◆ FAtomActiveSound() [2/2]

FAtomActiveSound::FAtomActiveSound ( const FAtomActiveSound & )

default

◆ ~FAtomActiveSound()

FAtomActiveSound::~FAtomActiveSound ( )

関数詳解

◆ AddPlaybackInstance()

FAtomPlaybackInstance & FAtomActiveSound::AddPlaybackInstance ( const UPTRINT PlaybackInstanceHash )

Add newly created playback instance to active sound

◆ AddReferencedObjects()

void FAtomActiveSound::AddReferencedObjects ( FReferenceCollector & Collector )

◆ CanDelete()

bool FAtomActiveSound::CanDelete ( ) const

inline

Returns whether or not the active sound can be deleted.

◆ CanVirtualizeWhenSilent()

bool FAtomActiveSound::CanVirtualizeWhenSilent ( ) const

Whether or not the sound reference is valid and set to use virtual voice when silent.

◆ CheckOcclusion()

void FAtomActiveSound::CheckOcclusion	(	const FVector	ListenerLocation,
		const FVector	SoundLocation,
		const FAtomAttenuationSettings *	AttenuationSettingsPtr )

private

if OcclusionCheckInterval > 0.0, checks if the sound has become (un)occluded during playback and calls eventOcclusionChanged() if so primarily used for gameplay-relevant ambient sounds CurrentLocation is the location of this component that will be used for playback

引数

ListenerLocation location of the closest listener to the sound

◆ ClearAllCueSelectorLabels()

void FAtomActiveSound::ClearAllCueSelectorLabels ( )

◆ ClearAtomComponent()

void FAtomActiveSound::ClearAtomComponent ( )

◆ CollectAttenuationShapesForVisualization()

void FAtomActiveSound::CollectAttenuationShapesForVisualization ( TMultiMap< EAtomAttenuationShape, FAtomAttenuationSettings::AttenuationShapeDetails > & ShapeDetailsMap ) const

◆ CreateVirtualCopy()

FAtomActiveSound * FAtomActiveSound::CreateVirtualCopy	(	const FAtomActiveSound &	ActiveSoundToCopy,
		FAtomRuntime &	AtomRuntime )

static

◆ ExecuteOnSoundFinishedCallback()

void FAtomActiveSound::ExecuteOnSoundFinishedCallback	(	bool	bEndReached,
		const TFunction< void(bool bEndReached)> &	OnSoundFinished,
		const ENamedThreads::Type &	CallbackThread )

static

◆ FindClosestListener() [1/2]

int32 FAtomActiveSound::FindClosestListener ( ) const

◆ FindClosestListener() [2/2]

int32 FAtomActiveSound::FindClosestListener ( const TArray< struct FAtomListener > & InListeners ) const

◆ FindPlaybackInstance()

FAtomPlaybackInstance * FAtomActiveSound::FindPlaybackInstance ( const UPTRINT PlaybackInstanceHash )

Find an existing playback instance attached (if any)

◆ GetAisacControls()

void FAtomActiveSound::GetAisacControls ( TArray< FAtomAisacParameter > & OutParameters ) const

Gets the AISAC control with values set for this sound instance.

◆ GetAlwaysPlay()

bool FAtomActiveSound::GetAlwaysPlay ( ) const

Returns whether or not sound or any active playback instances it manages are set to always play.

◆ GetAtomBusSends()

void FAtomActiveSound::GetAtomBusSends ( TArray< FAtomSoundToBusSend > & OutSends ) const

Gets the rack bus sends to use for this sound instance.

◆ GetAtomComponentID()

uint64 FAtomActiveSound::GetAtomComponentID ( ) const

inline

◆ GetAtomComponentName()

FString FAtomActiveSound::GetAtomComponentName ( ) const

◆ GetAtomComponentUserID()

FName FAtomActiveSound::GetAtomComponentUserID ( ) const

inline

◆ GetAtomRackSends()

void FAtomActiveSound::GetAtomRackSends ( TArray< FAtomSoundToRackSend > & OutSends ) const

Gets the rack sends to use for this sound instance.

◆ GetAtomRuntime()

FAtomRuntime * FAtomActiveSound::GetAtomRuntime ( ) const

inline

◆ GetAttenuationFrequency()

float FAtomActiveSound::GetAttenuationFrequency	(	const FAtomAttenuationSettings *	InSettings,
		const FAtomAttenuationListenerData &	ListenerData,
		const FVector2D &	FrequencyRange,
		const FRuntimeFloatCurve &	CustomCurve )

private

Helper function which retrieves attenuation frequency value for HPF and LPF distance-based filtering.

◆ GetClosestListenerIndex()

int32 FAtomActiveSound::GetClosestListenerIndex ( ) const

inline

◆ GetConcurrencyFadeDuration()

bool FAtomActiveSound::GetConcurrencyFadeDuration ( float & OutFadeDuration ) const

◆ GetConcurrencyHandles()

void FAtomActiveSound::GetConcurrencyHandles ( TArray< FAtomConcurrencyHandle > & OutConcurrencyHandles ) const

Gets the sound concurrency handles applicable to this sound instance.

◆ GetCueSelectorParameters()

void FAtomActiveSound::GetCueSelectorParameters ( TArray< FAtomSelectorParam > & OutParameters ) const

◆ GetHighestPriority()

float FAtomActiveSound::GetHighestPriority ( bool bIgnoreAlwaysPlay = false ) const

Returns the highest effective priority of the child wave instances. If bIgnoreAlwaysPlay set to true, gives highest priority disregarding always play priority override.

◆ GetInstanceID()

uint32 FAtomActiveSound::GetInstanceID ( ) const

inline

Returns a unique identifier for this active sound object

◆ GetMultiplePositions()

void FAtomActiveSound::GetMultiplePositions ( TArray< FTransform > & OutPositions )

Gets the multiple source positions in use.

◆ GetNewSourceBusSends()

TArray< TTuple< EAtomBusSendStage, FAtomSoundSourceBusSendInfo > > const & FAtomActiveSound::GetNewSourceBusSends ( ) const

Lets the audio thread know if additional Source Bus Send information has been added

戻り値: the array of Sound Bus Sends that have not yet been added to the render thread

◆ GetObjectId()

uint32 FAtomActiveSound::GetObjectId ( ) const

inline

◆ GetOwnerID()

uint32 FAtomActiveSound::GetOwnerID ( ) const

inline

Returns the unique ID of the active sound's owner if it exists. Returns 0 if the sound doesn't have an owner.

◆ GetOwnerName()

FString FAtomActiveSound::GetOwnerName ( ) const

◆ GetPitch()

float FAtomActiveSound::GetPitch ( ) const

inline

◆ GetPlaybackInstances()

const TMap< UPTRINT, FAtomPlaybackInstance * > & FAtomActiveSound::GetPlaybackInstances ( ) const

inline

◆ GetPlayCount()

int32 FAtomActiveSound::GetPlayCount ( ) const

◆ GetPlayOrder()

uint32 FAtomActiveSound::GetPlayOrder ( ) const

inline

◆ GetSound()

UAtomSoundBase * FAtomActiveSound::GetSound ( ) const

inline

◆ GetSoundClass()

UAtomSoundClass * FAtomActiveSound::GetSoundClass ( ) const

Get the sound class to apply on this sound instance

◆ GetSoundRack()

UAtomRackBase * FAtomActiveSound::GetSoundRack ( ) const

Get the sound rack to use for this sound instance

◆ GetSourceBusSends()

void FAtomActiveSound::GetSourceBusSends	(	EAtomBusSendStage	BusSendStage,
		TArray< FAtomSoundSourceBusSendInfo > &	OutSends ) const

Gets the sound source bus sends to use for this sound instance.

◆ GetTotalConcurrencyVolumeScale()

float FAtomActiveSound::GetTotalConcurrencyVolumeScale ( ) const

Check whether to apply the radio filter Gets total concurrency gain stage based on all concurrency memberships of sound

◆ GetVolume()

float FAtomActiveSound::GetVolume ( ) const

Gets volume product all gain stages pertaining to active sound

◆ GetWeakWorld()

TWeakObjectPtr< UWorld > FAtomActiveSound::GetWeakWorld ( ) const

inline

◆ GetWorld()

UWorld * FAtomActiveSound::GetWorld ( ) const

inline

◆ GetWorldID()

uint32 FAtomActiveSound::GetWorldID ( ) const

inline

◆ HasNewSourceBusSends()

bool FAtomActiveSound::HasNewSourceBusSends ( ) const

Checks whether there are Source Bus Sends that have not yet been updated

戻り値: true when there are new Source Bus Sends, false otherwise

◆ IsLooping()

bool FAtomActiveSound::IsLooping ( ) const

inline

Whether or not the active sound is a looping sound.

◆ IsOneShot()

bool FAtomActiveSound::IsOneShot ( ) const

inline

Whether or not the active sound a one-shot sound.

◆ IsPlayingAudio()

bool FAtomActiveSound::IsPlayingAudio ( ) const

inline

Whether or not the active sound is currently playing audible sound.

◆ IsPlayWhenSilent()

bool FAtomActiveSound::IsPlayWhenSilent ( ) const

Whether or not sound reference is valid and continue to play if silent.

◆ IsPreviewSound()

bool FAtomActiveSound::IsPreviewSound ( ) const

inline

◆ IsStopping()

bool FAtomActiveSound::IsStopping ( ) const

inlineprivate

Whether or not the active sound is stopping.

◆ MarkPendingDestroy()

void FAtomActiveSound::MarkPendingDestroy ( bool bDestroyNow )

private

Marks the active sound as pending delete and begins termination of internal resources. Only to be called from the owning audio device.

◆ OcclusionTraceDone()

void FAtomActiveSound::OcclusionTraceDone	(	const FTraceHandle &	TraceHandle,
		FTraceDatum &	TraceDatum )

static

Delegate callback function when an async occlusion trace completes.

◆ OnCueBeatSync()

void FAtomActiveSound::OnCueBeatSync ( const TSharedPtr< const FAtomBeatSyncInfo > & BeatSyncInfo )

◆ OnCueSequencerEvent()

void FAtomActiveSound::OnCueSequencerEvent ( const TSharedPtr< const FAtomSequencerEventInfo > & EventInfo )

◆ ParseAttenuation()

void FAtomActiveSound::ParseAttenuation	(	FAtomSoundParseParameters &	OutParseParams,
		int32	ListenerIndex,
		const FAtomAttenuationSettings &	InAttenuationSettings )

Applies the active sound's attenuation settings to the input parse params using the given listener.

◆ RemoveCueSelectorLabel()

void FAtomActiveSound::RemoveCueSelectorLabel ( const FAtomSelectorParam & SelectorParam )

◆ RemovePlaybackInstance()

void FAtomActiveSound::RemovePlaybackInstance ( const UPTRINT PlaybackInstanceHash )

◆ ResetNewSourceBusSends()

void FAtomActiveSound::ResetNewSourceBusSends ( )

Resets internal data of new Source Bus Sends

◆ SetAisacControl()

void FAtomActiveSound::SetAisacControl ( const FAtomAisacParameter & Parameter )

Sets the value of an AISAC control to use for this sound instance.

◆ SetAtomBusSend()

void FAtomActiveSound::SetAtomBusSend ( const FAtomSoundToBusSend & BusSend )

Sets the amount of audio from this active sound to send to the rack bus.

◆ SetAtomComponent() [1/2]

void FAtomActiveSound::SetAtomComponent ( const FAtomActiveSound & ActiveSound )

◆ SetAtomComponent() [2/2]

void FAtomActiveSound::SetAtomComponent ( const UAtomComponent & Component )

◆ SetAtomRackSend()

void FAtomActiveSound::SetAtomRackSend ( const FAtomSoundToRackSend & RackSend )

Sets the amount of audio from this active sound to send to the rack.

◆ SetAtomRuntime()

void FAtomActiveSound::SetAtomRuntime ( FAtomRuntime * InAtomRuntime )

inline

◆ SetAttenuationSettingsAsset()

void FAtomActiveSound::SetAttenuationSettingsAsset ( TObjectPtr< UAtomAttenuation > InSoundAttenuation )

◆ SetAttenuationSettingsOverride()

void FAtomActiveSound::SetAttenuationSettingsOverride ( bool bInIsAttenuationSettingsOverridden )

◆ SetCueBeatSyncInfo()

void FAtomActiveSound::SetCueBeatSyncInfo ( const TSharedPtr< const FAtomBeatSyncInfo > & BeatSyncInfo )

◆ SetCueBeatSyncOffset()

void FAtomActiveSound::SetCueBeatSyncOffset ( int32 Offset )

◆ SetCueBlockIndex()

void FAtomActiveSound::SetCueBlockIndex ( int32 BlockIndex )

◆ SetCueNextBlockIndex()

void FAtomActiveSound::SetCueNextBlockIndex ( int32 BlockIndex )

◆ SetCueSelectorLabel()

void FAtomActiveSound::SetCueSelectorLabel ( const FAtomSelectorParam & SelectorParam )

Cues parameters

◆ SetMultiplePositions()

void FAtomActiveSound::SetMultiplePositions	(	const TArray< FTransform > &	InPositions,
		EAtomMultiPositionType	InMultiPositionType )

Sets multiple source postions. When MultiPositionType is set to SingleSource, sound transform is user or first position if passed list is not empty.

◆ SetNewModulationRouting()

void FAtomActiveSound::SetNewModulationRouting ( const FAtomSoundModulationRoutingSettings & NewRouting )

◆ SetOwner()

void FAtomActiveSound::SetOwner ( const AActor * Owner )

◆ SetPitch()

void FAtomActiveSound::SetPitch ( float Value )

◆ SetSound()

void FAtomActiveSound::SetSound ( UAtomSoundBase * InSound )

◆ SetSoundClass()

void FAtomActiveSound::SetSoundClass ( UAtomSoundClass * SoundClass )

◆ SetSourceBusSend()

void FAtomActiveSound::SetSourceBusSend	(	EAtomBusSendStage	BusSendStage,
		const FAtomSoundSourceBusSendInfo &	SourceBusSendInfo )

Sets the amount of audio from this active sound to send to the source bus.

◆ SetVirtualized()

void FAtomActiveSound::SetVirtualized ( bool bIsVirtualized )

◆ SetVolume()

void FAtomActiveSound::SetVolume ( float Value )

◆ SetWorld()

void FAtomActiveSound::SetWorld ( UWorld * World )

◆ Stop()

void FAtomActiveSound::Stop ( )

◆ UpdateAttenuation()

void FAtomActiveSound::UpdateAttenuation	(	float	DeltaTime,
		FAtomSoundParseParameters &	ParseParams,
		int32	ListenerIndex,
		const FAtomAttenuationSettings *	SettingsAttenuationNode = nullptr )

Updates the active sound's attenuation settings to the input parse params using the given listener

◆ UpdateConcurrencyVolumeScalars()

void FAtomActiveSound::UpdateConcurrencyVolumeScalars ( const float DeltaTime )

private

Updates ramping concurrency volume scalars

◆ UpdateFocusData()

void FAtomActiveSound::UpdateFocusData	(	float	DeltaTime,
		const FAtomAttenuationListenerData &	ListenerData,
		FAtomAttenuationFocusData *	OutFocusData = nullptr )

Updates the provided focus data using the local

◆ UpdatePlaybackInstances()

void FAtomActiveSound::UpdatePlaybackInstances	(	TArray< FAtomPlaybackInstance * > &	OutPlaybackInstances,
		const float	DeltaTime )

◆ UpdateStoppingSources()

bool FAtomActiveSound::UpdateStoppingSources	(	uint64	CurrentTick,
		bool	bEnsureStopped )

private

Called when an active sound has been stopped but needs to update it's stopping sounds. Returns true when stopping sources have finished stopping.

◆ FAtomRuntime

friend class FAtomRuntime

friend

This is a friend so the Atom runtime can call Stop() on the active sound.

◆ operator<<

FArchive & operator<<	(	FArchive &	Ar,
		FAtomActiveSound *	ActiveSound )

friend

Friend archive function used for serialization.

メンバ詳解

◆ ActiveSoundTraceDelegate

FTraceDelegate FAtomActiveSound::ActiveSoundTraceDelegate

staticprivate

◆ AdditionalAisacPatchNames

TArray<FName> FAtomActiveSound::AdditionalAisacPatchNames

Optional AISAC to attach.

◆ AisacParametersOverride

TArray<FAtomAisacParameter> FAtomActiveSound::AisacParametersOverride

Optional override the AISAC modulations.

◆ AmplitudeEnvelope

FAtomEnvelope FAtomActiveSound::AmplitudeEnvelope

An envelope to apply to volume amplitude.

◆ AtomBusSendsOverride

TArray<FAtomSoundToBusSend> FAtomActiveSound::AtomBusSendsOverride

private

Optional override the rack bus sends for the sound.

◆ AtomComponentID

uint64 FAtomActiveSound::AtomComponentID

private

◆ AtomComponentName

FName FAtomActiveSound::AtomComponentName

private

◆ AtomComponentUserID

FName FAtomActiveSound::AtomComponentUserID

private

◆ AtomRackSendsOverride

TArray<FAtomSoundToRackSend> FAtomActiveSound::AtomRackSendsOverride

private

Optional override the rack sends for the sound.

◆ AtomRuntime

FAtomRuntime* FAtomActiveSound::AtomRuntime

private

◆ AttenuationSettings

FAtomAttenuationSettings FAtomActiveSound::AttenuationSettings

The Attenuation setting to apply. (only works for ExPlayer)

◆ bAllowSpatialization

uint8 FAtomActiveSound::bAllowSpatialization

Is this sound allowed to be spatialized?

◆ bAlwaysPlay

uint8 FAtomActiveSound::bAlwaysPlay

Whether to artificially prioritize the component to play

◆ bApplyInteriorVolumes

uint8 FAtomActiveSound::bApplyInteriorVolumes

Whether some part of this sound will want interior sounds to be applied

◆ bAsyncOcclusionPending

FThreadSafeBool FAtomActiveSound::bAsyncOcclusionPending

Whether or not there is an async occlusion trace pending

◆ bEnableAmplitudeEnvelope

uint8 FAtomActiveSound::bEnableAmplitudeEnvelope

◆ bEnableHighPassFilter

uint8 FAtomActiveSound::bEnableHighPassFilter

Whether or not we have a low-pass filter enabled on this active sound.

◆ bEnableLowPassFilter

uint8 FAtomActiveSound::bEnableLowPassFilter

Whether or not we have a low-pass filter enabled on this active sound.

◆ bEnableMainRackOutputOverride

uint8 FAtomActiveSound::bEnableMainRackOutputOverride

◆ bEnableSoundBusSendRoutingOverride

uint8 FAtomActiveSound::bEnableSoundBusSendRoutingOverride

◆ bEnableSourceBusSendRoutingOverride

uint8 FAtomActiveSound::bEnableSourceBusSendRoutingOverride

What the value of the enablement overrides are.

◆ bFinished

uint8 FAtomActiveSound::bFinished

Whether the current component has finished playing

◆ bForceUseAtomPlayer

uint8 FAtomActiveSound::bForceUseAtomPlayer

Whether or not the active sound will request a provided AtomSource object instead of a regular AtomRuntime sound source (pool of FAtomExPlayer).

◆ bGotInteriorSettings

uint8 FAtomActiveSound::bGotInteriorSettings

Whether we have queried for the interior settings at least once

◆ bHasActiveMainRackOutputOverride

uint8 FAtomActiveSound::bHasActiveMainRackOutputOverride

◆ bHasActiveSoundBusSendRoutingOverride

uint8 FAtomActiveSound::bHasActiveSoundBusSendRoutingOverride

◆ bHasActiveSourceBusSendRoutingOverride

uint8 FAtomActiveSound::bHasActiveSourceBusSendRoutingOverride

Whether or not we are overriding the routing enablement options on sounds.

◆ bHasAttenuationSettings

uint8 FAtomActiveSound::bHasAttenuationSettings

Does this sound have attenuation settings specified.

◆ bHasCheckedOcclusion

uint8 FAtomActiveSound::bHasCheckedOcclusion

Whether or not the sound has checked if it was occluded already. Used to initialize a sound as occluded and bypassing occlusion interpolation.

◆ bHasNewSourceBusSends

bool FAtomActiveSound::bHasNewSourceBusSends

◆ bHasVirtualized

uint8 FAtomActiveSound::bHasVirtualized

Whether or not sound has been virtualized and then realized

◆ bIgnoreForFlushing

uint8 FAtomActiveSound::bIgnoreForFlushing

If true, this sound will not be stopped when flushing the Atom runtime.

◆ bIsAttenuationSettingsOverridden

uint8 FAtomActiveSound::bIsAttenuationSettingsOverridden

If this is true the active sound uses the overridden struct of the sound not the attenuation settings asset.

◆ bIsFirstAttenuationUpdate

uint8 FAtomActiveSound::bIsFirstAttenuationUpdate

◆ bIsOccluded

FThreadSafeBool FAtomActiveSound::bIsOccluded

whether we were occluded the last time we checked

◆ bIsPaused

uint8 FAtomActiveSound::bIsPaused

Whether or not the active sound is paused. Independently set vs global pause or unpause.

◆ bIsPendingVirtualization

uint8 FAtomActiveSound::bIsPendingVirtualization

Whether or not sound is actually virtualizing by ADX.

◆ bIsPlayingAudio

uint8 FAtomActiveSound::bIsPlayingAudio

Whether or not this active sound is playing audio, as in making audible sounds.

◆ bIsPreviewSound

uint8 FAtomActiveSound::bIsPreviewSound

Whether or not this audio component is a music clip Whether or not the audio component should be excluded from reverb EQ processing Whether or not this sound class forces sounds to the center channel Whether or not this active sound is a preview sound

◆ bIsRealizingWithFadeIn

uint8 FAtomActiveSound::bIsRealizingWithFadeIn

Whether or not sound is actually fadein due concurrency realizing.

◆ bIsStopping

uint8 FAtomActiveSound::bIsStopping

Whether or not the active sound is stopping.

◆ bIsUISound

uint8 FAtomActiveSound::bIsUISound

Whether or not this sound plays when the game is paused in the UI

◆ bLocationDefined

uint8 FAtomActiveSound::bLocationDefined

If true, the decision on whether to apply the radio filter has been made. If true, this sound will not be stopped when flushing the audio device. Whether the Location of the component is well defined

◆ bModulationRoutingUpdated

uint8 FAtomActiveSound::bModulationRoutingUpdated

◆ bShouldRemainActiveIfDropped

uint8 FAtomActiveSound::bShouldRemainActiveIfDropped

Whether the playback instances should remain active if they're dropped by the prioritization code. Useful for e.g. vehicle sounds that shouldn't cut out.

◆ bShouldStopDueToMaxConcurrency

uint8 FAtomActiveSound::bShouldStopDueToMaxConcurrency

Whether or not to stop this active sound due to max concurrency.

◆ bStartedWithinNonBinauralRadius

uint8 FAtomActiveSound::bStartedWithinNonBinauralRadius

◆ bUpdateMultiEnvelopeValue

uint8 FAtomActiveSound::bUpdateMultiEnvelopeValue

Whether or not this active sound will update the average envelope value of every playback instance that plays a sound source. Based on set delegates on Atom component.

◆ bUpdatePlaybackTime

uint8 FAtomActiveSound::bUpdatePlaybackTime

Whether or not the active sound should update it's owning Atom component's playback time.

◆ bUpdatePlayPercentage

uint8 FAtomActiveSound::bUpdatePlayPercentage

Whether or not this active sound will update play percentage. Based on set delegates on Atom component.

◆ bUpdateSingleEnvelopeValue

uint8 FAtomActiveSound::bUpdateSingleEnvelopeValue

Whether or not this active sound will update the envelope value of every playback instance that plays a sound source. Based on set delegates on Atom component.

◆ bVirtualizedDueToMaxConcurrency

uint8 FAtomActiveSound::bVirtualizedDueToMaxConcurrency

Whether or not sound is actually virtualized due to max concurrency.

◆ bWarnedAboutOrphanedLooping

uint8 FAtomActiveSound::bWarnedAboutOrphanedLooping

For debugging purposes, output to the log once that a looping sound has been orphaned

◆ CategoryNames

TArray<FName> FAtomActiveSound::CategoryNames

Optional Atom Categories to use. (Note: Not exposed by UAtomComponent, acessible only by c++.)

◆ ClosestListenerIndex

int32 FAtomActiveSound::ClosestListenerIndex

private

Cached index to the closest listener. So we don't have to do the work to find it twice.

◆ ComponentVolumeFader

FAtomVolumeFader FAtomActiveSound::ComponentVolumeFader

Fader that tracks component volume

◆ ConcurrencyGroupData

TMap<FAtomConcurrencyGroupId, FAtomConcurrencySoundData> FAtomActiveSound::ConcurrencyGroupData

The concurrent groups that this sound is actively playing in.

◆ ConcurrencySet

TSet<TObjectPtr<UAtomConcurrency> > FAtomActiveSound::ConcurrencySet

Optional UAtomConcurrency to override for the sound.

◆ CueBeatSyncOffset

int32 FAtomActiveSound::CueBeatSyncOffset

◆ CueFirstBlockIndex

int32 FAtomActiveSound::CueFirstBlockIndex

When a Soundcue is used as sound, this defines the index of the first block to playback when sound starts.

◆ CueNextBlockIndex

int32 FAtomActiveSound::CueNextBlockIndex

When a Soundcue is used as sound, this defines the next index to setup, this value is reset eachtime it is applied to playback.

◆ CueSelectorParams

TArray<FAtomSelectorParam> FAtomActiveSound::CueSelectorParams

When a Soundcue is used as sound, this defines the selector to use. Possible selectors are defined by the currently used AtomConfig.

◆ CurrentOcclusionFilterFrequency

FAtomDynamicParameter FAtomActiveSound::CurrentOcclusionFilterFrequency

The interpolated parameter for the low-pass frequency due to occlusion.

◆ CurrentOcclusionVolumeAttenuation

FAtomDynamicParameter FAtomActiveSound::CurrentOcclusionVolumeAttenuation

The interpolated parameter for the volume attenuation due to occlusion.

◆ EnvelopeFollowerAttackTime

int32 FAtomActiveSound::EnvelopeFollowerAttackTime

Source buffer listener

◆ EnvelopeFollowerReleaseTime

int32 FAtomActiveSound::EnvelopeFollowerReleaseTime

◆ FadeOut

EFadeOut FAtomActiveSound::FadeOut

Type of fade out currently being applied

◆ FocusData

FAtomAttenuationFocusData FAtomActiveSound::FocusData

Cached data pertaining to focus system updated each frame

◆ HighPassFilterFrequency

float FAtomActiveSound::HighPassFilterFrequency

The high-pass filter frequency to apply if bEnableHighPassFilter is true.

◆ InstancePlayer

TSharedPtr<Atom::FAtomExPlayer, ESPMode::ThreadSafe> FAtomActiveSound::InstancePlayer

◆ LastLocation

FVector FAtomActiveSound::LastLocation

Location last time playback was updated.

◆ LastOcclusionCheckTime

float FAtomActiveSound::LastOcclusionCheckTime

Last time we checked for occlusion.

◆ LowPassFilterFrequency

float FAtomActiveSound::LowPassFilterFrequency

The low-pass filter frequency to apply if bEnableLowPassFilter is true.

◆ MaxDistance

float FAtomActiveSound::MaxDistance

The max distance this sound will be audible.

◆ MinCurrentPitch

float FAtomActiveSound::MinCurrentPitch

◆ ModulationRouting

FAtomSoundModulationRoutingSettings FAtomActiveSound::ModulationRouting

Modulation and AISAC control routings.

◆ MultiPositions

TArray<FTransform> FAtomActiveSound::MultiPositions

Multi-Position locations and directions.

◆ MultiPositionType

EAtomMultiPositionType FAtomActiveSound::MultiPositionType

Multi-Position type

◆ NewSourceBusSends

TArray<TTuple<EAtomBusSendStage, FAtomSoundSourceBusSendInfo> > FAtomActiveSound::NewSourceBusSends

◆ OcclusionCheckInterval

float FAtomActiveSound::OcclusionCheckInterval

The time in seconds with which to check for occlusion from its closest listener

◆ OnCreateSource

TFunction<FAtomSource* (FAtomRuntime*, FAtomPlaybackInstance*)> FAtomActiveSound::OnCreateSource

If set, overrides standard mixer source creation and create an unpooled mixer source.

◆ OnSoundFinished

TFunction<void(bool bWasEndReached)> FAtomActiveSound::OnSoundFinished

Helper that notifies when this active sound finished to play.

◆ OwnerID

uint32 FAtomActiveSound::OwnerID

private

◆ OwnerName

FName FAtomActiveSound::OwnerName

private

◆ PcmFilterFunction

FAtomPcmFilterFunction FAtomActiveSound::PcmFilterFunction

If set, enables pcm data filter and call this function at each frame.

◆ PitchMultiplier

float FAtomActiveSound::PitchMultiplier

◆ PlaybackInstances

TMap<UPTRINT, FAtomPlaybackInstance*> FAtomActiveSound::PlaybackInstances

private

◆ PlaybackTime

float FAtomActiveSound::PlaybackTime

Duration between now and when the sound has been started.

◆ PlaybackTimeNonVirtualized

float FAtomActiveSound::PlaybackTimeNonVirtualized

If virtualized, duration between last time virtualized and now.

◆ PlaybackTimeUnscaled

float FAtomActiveSound::PlaybackTimeUnscaled

Unscaled duration between now and when the sound has been started. This value is not scaled by the playback rate of the sound

◆ PlayOrder

uint32 FAtomActiveSound::PlayOrder

private

◆ Priority

float FAtomActiveSound::Priority

The product of the component priority and the UAtomSoundBase priority

◆ QuantizedRequestData

Atom::FQuartzQuantizedRequestData FAtomActiveSound::QuantizedRequestData

Quantization information

◆ RequestedStartTime

float FAtomActiveSound::RequestedStartTime

◆ Sound

TObjectPtr<UAtomSoundBase> FAtomActiveSound::Sound

private

◆ SoundAttenuation

TObjectPtr<UAtomAttenuation> FAtomActiveSound::SoundAttenuation

private

◆ SoundClassOverride

TObjectPtr<UAtomSoundClass> FAtomActiveSound::SoundClassOverride

private

Optional SoundClass to override for the sound.

◆ SourceBusSendsOverride

TArray<FAtomSoundSourceBusSendInfo> FAtomActiveSound::SourceBusSendsOverride[(int32) EAtomBusSendStage::Count]

private

Optional override for the source bus sends for the sound.

◆ SourceVoiceEffect

FAtomSourceVoiceEffect FAtomActiveSound::SourceVoiceEffect

An effect to apply to voices.

◆ ThreadToCallOnSoundFinishedOn

ENamedThreads::Type FAtomActiveSound::ThreadToCallOnSoundFinishedOn

The thread that will be used to call the function in OnSoundFinished.

◆ TraceToActiveSoundMap

TMap< FTraceHandle, FAtomActiveSound::FAsyncTraceDetails > FAtomActiveSound::TraceToActiveSoundMap

staticprivate

◆ Transform

FTransform FAtomActiveSound::Transform

◆ UserIndex

uint8 FAtomActiveSound::UserIndex

◆ VolumeConcurrency

float FAtomActiveSound::VolumeConcurrency

The volume used to determine concurrency resolution for "quietest" active sound. If negative, tracking is disabled for lifetime of ActiveSound.

◆ VolumeMultiplier

float FAtomActiveSound::VolumeMultiplier

◆ World

TWeakObjectPtr<UWorld> FAtomActiveSound::World

private

◆ WorldID

uint32 FAtomActiveSound::WorldID

private

この構造体詳解は次のファイルから抽出されました:

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

クラス

公開型

公開メンバ関数

静的公開メンバ関数

公開変数類

非公開メンバ関数

非公開変数類

静的非公開変数類

フレンド

列挙型メンバ詳解

◆ EFadeOut

構築子と解体子

◆ FAtomActiveSound() [1/2]

◆ FAtomActiveSound() [2/2]

◆ ~FAtomActiveSound()

関数詳解

◆ AddPlaybackInstance()

◆ AddReferencedObjects()

◆ CanDelete()

◆ CanVirtualizeWhenSilent()

◆ CheckOcclusion()

◆ ClearAllCueSelectorLabels()

◆ ClearAtomComponent()

◆ CollectAttenuationShapesForVisualization()

◆ CreateVirtualCopy()

◆ ExecuteOnSoundFinishedCallback()

◆ FindClosestListener() [1/2]

◆ FindClosestListener() [2/2]

◆ FindPlaybackInstance()

◆ GetAisacControls()

◆ GetAlwaysPlay()

◆ GetAtomBusSends()

◆ GetAtomComponentID()

◆ GetAtomComponentName()

◆ GetAtomComponentUserID()

◆ GetAtomRackSends()

◆ GetAtomRuntime()

◆ GetAttenuationFrequency()

◆ GetClosestListenerIndex()

◆ GetConcurrencyFadeDuration()

◆ GetConcurrencyHandles()

◆ GetCueSelectorParameters()

◆ GetHighestPriority()

◆ GetInstanceID()

◆ GetMultiplePositions()

◆ GetNewSourceBusSends()

◆ GetObjectId()

◆ GetOwnerID()

◆ GetOwnerName()

◆ GetPitch()

◆ GetPlaybackInstances()

◆ GetPlayCount()

◆ GetPlayOrder()

◆ GetSound()

◆ GetSoundClass()

◆ GetSoundRack()

◆ GetSourceBusSends()

◆ GetTotalConcurrencyVolumeScale()

◆ GetVolume()

◆ GetWeakWorld()

◆ GetWorld()

◆ GetWorldID()

◆ HasNewSourceBusSends()

◆ IsLooping()

◆ IsOneShot()

◆ IsPlayingAudio()

◆ IsPlayWhenSilent()

◆ IsPreviewSound()

◆ IsStopping()

◆ MarkPendingDestroy()

◆ OcclusionTraceDone()

◆ OnCueBeatSync()

◆ OnCueSequencerEvent()

◆ ParseAttenuation()

◆ RemoveCueSelectorLabel()

◆ RemovePlaybackInstance()

◆ ResetNewSourceBusSends()

◆ SetAisacControl()

◆ SetAtomBusSend()

◆ SetAtomComponent() [1/2]