#include <AtomSoundBase.h>

UAtomSoundBase の継承関係図

公開型
using	FAtomSoundClientPtr = IAtomSoundClient*

公開メンバ関数
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	GetDuration () 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	IsLooping () const
virtual CRIWARECORE_API bool	IsOneShot () const
virtual CRIWARECORE_API bool	IsParameterValid (const FAtomAisacParameter &InParameter) const
virtual CRIWARECORE_API bool	IsPlayable () const
virtual CRIWARECORE_API bool	IsPlayWhenSilent () const
virtual bool	IsSeekable () 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
virtual CRIWARECORE_API void	PostLoad () 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 ()

公開変数類
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

限定公開メンバ関数
virtual CRIWARECORE_API float	ComputeMaxDistance () const

非公開変数類
TArray< FAtomSoundClientPtr >	SourcesPlaying
FCriticalSection	SourcesPlayingCs

詳解

The base class for a playable sound object

型定義メンバ詳解

◆ FAtomSoundClientPtr

using UAtomSoundBase::FAtomSoundClientPtr = IAtomSoundClient*

構築子と解体子

◆ UAtomSoundBase()

UAtomSoundBase::UAtomSoundBase ( const FObjectInitializer & ObjectInitializer )

関数詳解

◆ AddAssetUserData()

void UAtomSoundBase::AddAssetUserData ( UAssetUserData * InUserData )

overridevirtual

◆ AddPlayingSource()

void UAtomSoundBase::AddPlayingSource ( const FAtomSoundClientPtr & Source )

For procedural sounds that doesn't have sound resource.

◆ BeginDestroy()

void UAtomSoundBase::BeginDestroy ( )

overridevirtual

◆ CanBeClusterRoot()

bool UAtomSoundBase::CanBeClusterRoot ( ) const

overridevirtual

◆ CanBeInCluster()

bool UAtomSoundBase::CanBeInCluster ( ) const

overridevirtual

◆ ComputeMaxDistance()

float UAtomSoundBase::ComputeMaxDistance ( ) const

protectedvirtual

◆ GetAllDefaultParameters()

virtual bool UAtomSoundBase::GetAllDefaultParameters ( TArray< FAtomAisacParameter > & OutParameters ) const

inlinevirtual

Gets all the default parameters for this Asset.

◆ GetAllSoundResources()

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

virtual

Gets all AtomSoundResource objects that this sound rely to.

UAtomSoundCue, UAtomSoundProxy, UAtomSoundWave, UAtomSoundWaveProceduralで再実装されています。

◆ GetAssetRegistryTags()

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

overridevirtual

UAtomSoundCueで再実装されています。

◆ GetAssetUserDataArray()

const TArray< UAssetUserData * > * UAtomSoundBase::GetAssetUserDataArray ( ) const

overridevirtual

◆ GetAssetUserDataOfClass()

UAssetUserData * UAtomSoundBase::GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass )

overridevirtual

◆ GetAtomBusSends()

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

virtual

Returns the sound submix sends for this sound.

UAtomSoundProxyで再実装されています。

◆ GetAtomRack()

UAtomRackBase * UAtomSoundBase::GetAtomRack ( ) const

virtual

Returns the AtomRack used for this sound.

UAtomSoundProxyで再実装されています。

◆ GetAttenuationSettingsToApply()

const FAtomAttenuationSettings * UAtomSoundBase::GetAttenuationSettingsToApply ( ) const

virtual

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

UAtomSoundCue, UAtomSoundProxy, UAtomSoundWaveで再実装されています。

◆ GetConcurrencyHandles()

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

virtual

Returns an array of FSoundConcurrencySettings handles.

UAtomSoundProxyで再実装されています。

◆ GetDuration()

float UAtomSoundBase::GetDuration ( ) const

virtual

Returns the length of the sound

UAtomSoundCue, UAtomSoundProxy, UAtomSoundSimple, UAtomSoundSourceBus, UAtomSoundWave, UAtomSoundWaveProcedural, UMySoundで再実装されています。

◆ GetMaxDistance()

float UAtomSoundBase::GetMaxDistance ( ) const

virtual

Returns the farthest distance at which the sound could be heard

UAtomSoundCue, UAtomSoundProxy, UAtomSoundSimple, UAtomSoundWave, UMySoundで再実装されています。

◆ GetModulationSettings()

virtual const FAtomSoundModulationRoutingSettings & UAtomSoundBase::GetModulationSettings ( ) const

inlinevirtual

Returns the priority to use when evaluating concurrency.

UAtomSoundProxyで再実装されています。

◆ GetPitchMultiplier()

float UAtomSoundBase::GetPitchMultiplier ( )

virtual

UAtomSoundCue, UAtomSoundProxy, UAtomSoundWaveで再実装されています。

◆ GetPriority()

float UAtomSoundBase::GetPriority ( ) const

virtual

Returns the priority to use when evaluating concurrency.

UAtomSoundProxyで再実装されています。

◆ GetSoundClass()

UAtomSoundClass * UAtomSoundBase::GetSoundClass ( ) const

virtual

Returns the AtomSoundClass used for this sound.

UAtomSoundProxyで再実装されています。

◆ GetSoundName()

virtual FString UAtomSoundBase::GetSoundName ( ) const

inlinevirtual

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

UAtomSoundCue, UAtomSoundWaveで再実装されています。

◆ GetSoundResource()

IAtomSoundResource * UAtomSoundBase::GetSoundResource ( )

virtual

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

UAtomSoundCue, UAtomSoundProxy, UAtomSoundWave, UAtomSoundWaveProceduralで再実装されています。

◆ GetSoundSourceBusSends()

void UAtomSoundBase::GetSoundSourceBusSends	(	EAtomBusSendStage	BusSendStage,
		TArray< FAtomSoundSourceBusSendInfo > &	OutSends ) const

virtual

Returns the sound source sends for this sound.

UAtomSoundProxyで再実装されています。

◆ GetVirtualizationMode()

EAtomVirtualizationMode UAtomSoundBase::GetVirtualizationMode ( ) const

virtual

Retruns the applied virtualization mode.

UAtomSoundCue, UAtomSoundProxyで再実装されています。

◆ GetVolumeMultiplier()

float UAtomSoundBase::GetVolumeMultiplier ( )

virtual

UAtomSoundCue, UAtomSoundProxy, UAtomSoundWaveで再実装されています。

◆ InitParameters()

void UAtomSoundBase::InitParameters	(	TArray< FAtomAisacParameter > &	ParametersToInit,
		FName	InFeatureName = NAME_None )

virtual

Called from the Game Thread prior to attempting to pass parameters to the ParameterTransmitter.

◆ IsGeneratingAudio()

bool UAtomSoundBase::IsGeneratingAudio ( ) const

inline

◆ IsLooping()

bool UAtomSoundBase::IsLooping ( ) const

virtual

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

UAtomSoundProxy, UAtomSoundSourceBusで再実装されています。

◆ IsOneShot()

bool UAtomSoundBase::IsOneShot ( ) const

virtual

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

UAtomSoundProxy, UAtomSoundSourceBusで再実装されています。

◆ IsParameterValid()

bool UAtomSoundBase::IsParameterValid ( const FAtomAisacParameter & InParameter ) const

virtual

Returns whether parameter is valid input for the given sound

◆ IsPlayable()

bool UAtomSoundBase::IsPlayable ( ) const

virtual

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

UAtomSoundCue, UAtomSoundProxy, UAtomSoundSimple, UAtomSoundSourceBus, UAtomSoundWave, UAtomSoundWaveProcedural, UMySoundで再実装されています。

◆ IsPlayWhenSilent()

bool UAtomSoundBase::IsPlayWhenSilent ( ) const

virtual

Returns true if any of the sounds in the sound continue to play even if silent.

UAtomSoundProxyで再実装されています。

◆ IsSeekable()

virtual bool UAtomSoundBase::IsSeekable ( ) const

inlinevirtual

Returns whether the sound is seekable.

UAtomExternalSound, UAtomSoundProxy, UAtomSoundSourceBusで再実装されています。

◆ IsStreaming()

virtual bool UAtomSoundBase::IsStreaming ( const TCHAR * PlatformName = nullptr ) const

inlinevirtual

UAtomSoundCue, UAtomSoundProxy, UAtomSoundWave, UAtomSoundWaveProceduralで再実装されています。

◆ Parse()

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

virtual

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

UAtomSoundCue, UAtomSoundProxy, UAtomSoundSimple, UMySoundで再実装されています。

◆ PostInitProperties()

void UAtomSoundBase::PostInitProperties ( )

overridevirtual

◆ PostLoad()

void UAtomSoundBase::PostLoad ( )

overridevirtual

UAtomExternalSound, UAtomSoundCue, UAtomSoundSimple, UAtomSoundSourceBus, UAtomSoundWave, UAtomSoundWaveProceduralで再実装されています。

◆ RemovePlayingSource()

void UAtomSoundBase::RemovePlayingSource ( const FAtomSoundClientPtr & Source )

◆ RemoveUserDataOfClass()

void UAtomSoundBase::RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass )

overridevirtual

◆ Serialize()

void UAtomSoundBase::Serialize ( FArchive & Ar )

overridevirtual

UAtomSoundSimpleで再実装されています。

◆ ShouldApplyInteriorVolumes()

bool UAtomSoundBase::ShouldApplyInteriorVolumes ( )

virtual

Returns whether or not any part of this sound wants interior volumes applied to it.

UAtomSoundProxyで再実装されています。

メンバ詳解

◆ AssetUserData

TArray<TObjectPtr<UAssetUserData> > UAtomSoundBase::AssetUserData

Set to true if fade is required when sound is abruptly stopped. Whether or not this source uses ambisonics format. If set, sound always uses the 'Master Ambisonics Submix' as set in the 'Audio' category of Project Settings' and ignores submix if provided locally or in the referenced SoundClass. Array of user data stored with the asset

◆ AtomBusSends

TArray<FAtomSoundToBusSend> UAtomSoundBase::AtomBusSends

Array of submix sends to which a prescribed amount (see 'Send Level') of this sound is sent.

◆ AtomRack

TObjectPtr<UAtomRackWithParentBase> UAtomSoundBase::AtomRack

Submix to route sound output to. If unset, falls back to referenced SoundClass submix. If SoundClass rack is unset, sends to the 'Main Rack' as set in the 'Atom' category of Project Settings'.

◆ AttenuationSettings

TObjectPtr<UAtomAttenuation> UAtomSoundBase::AttenuationSettings

Attenuation settings package for the sound

◆ bDebug

uint8 UAtomSoundBase::bDebug

When "atom.3dVisualize.Attenuation" has been specified, draw this sound's attenuation shape when the sound is audible. For debugging purpose only.

◆ bEnableBaseRack

uint8 UAtomSoundBase::bEnableBaseRack

If enabled, sound will route to the Master Rack by default or to the Base Rack if defined. If disabled, sound will route ONLY to the Bus Sends of Master Rack.

◆ bEnableBusSends

uint8 UAtomSoundBase::bEnableBusSends

Whether or not to enable Atom Bus Sends (submixes) other than the Base Rack Master Bus.

◆ bEnableSourceBusSends

uint8 UAtomSoundBase::bEnableSourceBusSends

Whether or not to enable sending this audio's output to buses.

◆ bIsSourceBus

uint8 UAtomSoundBase::bIsSourceBus

Set to true of this is a bus sound source. This will result in the sound not generating audio for itself, but generate audio through instances. Used only in Atom mixer.

◆ bOverrideConcurrency

uint8 UAtomSoundBase::bOverrideConcurrency

Whether or not to override the sound concurrency object with local concurrency settings.

◆ bOverrideVirtualizationMode

uint8 UAtomSoundBase::bOverrideVirtualizationMode

Whether or not to override the sound virtualization behavior with local settings.

◆ bProcedural

uint8 UAtomSoundBase::bProcedural

Set to true for programmatically generated audio.

◆ ConcurrencyOverrides

FAtomConcurrencySettings UAtomSoundBase::ConcurrencyOverrides

If Override Concurrency is true, concurrency settings to use.

◆ ConcurrencySet

TSet<TObjectPtr<UAtomConcurrency> > UAtomSoundBase::ConcurrencySet

Set of concurrency settings to observe (if override is set to false). Sound must pass all concurrency settings to play.

◆ CurrentPlayCount

TMap<FAtomRuntimeId, int32> UAtomSoundBase::CurrentPlayCount

Whether or not this sound has a delay node Map of device handle to number of times this sound is currently being played using that device(counted if sound is virtualized).

◆ Duration

float UAtomSoundBase::Duration

Duration of sound in seconds.

◆ MaxDistance

float UAtomSoundBase::MaxDistance

The max distance of the asset, as determined by attenuation settings.

◆ ModulationSettings

FAtomSoundModulationRoutingSettings UAtomSoundBase::ModulationSettings

Modulation Settings for sound parameters and AISAC.

◆ PreEffectSourceBusSends

TArray<FAtomSoundSourceBusSendInfo> UAtomSoundBase::PreEffectSourceBusSends

The source effect chain to use for this sound. This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed. This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

◆ Priority

float UAtomSoundBase::Priority

Used to determine whether sound can play or remain active if channel limit is met, where higher value is higher priority (see platform's Atom Settings 'Max Channels' property). Unless bypassed, value is weighted with the final volume of the sound to produce final runtime priority value.

◆ SoundClassObject

TObjectPtr<UAtomSoundClass> UAtomSoundBase::SoundClassObject

Sound class this sound belongs to

◆ SourcesPlaying

TArray<FAtomSoundClientPtr> UAtomSoundBase::SourcesPlaying

private

◆ SourcesPlayingCs

FCriticalSection UAtomSoundBase::SourcesPlayingCs

mutableprivate

the number of sounds currently playing this sound. (for procedural sound)

◆ VirtualizationMode

EAtomVirtualizationMode UAtomSoundBase::VirtualizationMode

Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted.

◆ WaveInfo

FAtomWaveInfo UAtomSoundBase::WaveInfo

このクラス詳解は次のファイルから抽出されました:

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

公開型

公開メンバ関数

公開変数類

限定公開メンバ関数

非公開変数類

詳解

型定義メンバ詳解

◆ FAtomSoundClientPtr

構築子と解体子

◆ UAtomSoundBase()

関数詳解

◆ AddAssetUserData()

◆ AddPlayingSource()

◆ BeginDestroy()

◆ CanBeClusterRoot()

◆ CanBeInCluster()

◆ ComputeMaxDistance()

◆ GetAllDefaultParameters()

◆ GetAllSoundResources()

◆ GetAssetRegistryTags()

◆ GetAssetUserDataArray()

◆ GetAssetUserDataOfClass()

◆ GetAtomBusSends()

◆ GetAtomRack()

◆ GetAttenuationSettingsToApply()

◆ GetConcurrencyHandles()

◆ GetDuration()

◆ GetMaxDistance()

◆ GetModulationSettings()

◆ GetPitchMultiplier()

◆ GetPriority()

◆ GetSoundClass()

◆ GetSoundName()

◆ GetSoundResource()

◆ GetSoundSourceBusSends()

◆ GetVirtualizationMode()

◆ GetVolumeMultiplier()

◆ InitParameters()

◆ IsGeneratingAudio()

◆ IsLooping()

◆ IsOneShot()

◆ IsParameterValid()

◆ IsPlayable()

◆ IsPlayWhenSilent()

◆ IsSeekable()

◆ IsStreaming()

◆ Parse()

◆ PostInitProperties()

◆ PostLoad()

◆ RemovePlayingSource()

◆ RemoveUserDataOfClass()

◆ Serialize()

◆ ShouldApplyInteriorVolumes()

メンバ詳解

◆ AssetUserData

◆ AtomBusSends

◆ AtomRack

◆ AttenuationSettings

◆ bDebug

◆ bEnableBaseRack

◆ bEnableBusSends

◆ bEnableSourceBusSends

◆ bIsSourceBus

◆ bOverrideConcurrency

◆ bOverrideVirtualizationMode

◆ bProcedural

◆ ConcurrencyOverrides

◆ ConcurrencySet

◆ CurrentPlayCount

◆ Duration

◆ MaxDistance

◆ ModulationSettings

◆ PreEffectSourceBusSends

◆ Priority

◆ SoundClassObject

◆ SourcesPlaying

◆ SourcesPlayingCs

◆ VirtualizationMode

◆ WaveInfo