#include <Atom.h>

公開メンバ関数
CRIWARECORE_API	FAtomPlaybackInstance (const UPTRINT PlaybackInstanceHash, FAtomActiveSound &ActiveSound)
CRIWARECORE_API	FAtomPlaybackInstance (FAtomPlaybackInstance &&)=default
CRIWARECORE_API void	AddReferencedObjects (FReferenceCollector &Collector)
CRIWARECORE_API float	GetActualVolume () const
CRIWARECORE_API float	GetDistanceAndOcclusionAttenuation () const
CRIWARECORE_API float	GetDistanceAttenuation () const
CRIWARECORE_API float	GetDynamicVolume () const
CRIWARECORE_API FAtomAisacControlSettings	GetEffectiveAisacModulationSettings (const FAtomAisacControl &InAisacControl) const
CRIWARECORE_API float	GetEffectiveAisacModulationValue (const FAtomAisacControl &InAisacControl) const
CRIWARECORE_API FAtomSoundModulationSettings	GetEffectiveModulationSettings (const EAtomModulationDestination InDestination) const
CRIWARECORE_API float	GetEffectiveModulationValue (const EAtomModulationDestination InDestination) const
float	GetEnvelopeValue () const
CRIWARECORE_API FString	GetName () const
CRIWARECORE_API float	GetOcclusionAttenuation () const
CRIWARECORE_API float	GetPitch () const
uint32	GetPlayOrder () const
float	GetRelativeRenderCost () const
bool	GetSpatializationIsExternalSend () const
CRIWARECORE_API float	GetTimeStretchRatio () const
CRIWARECORE_API bool	GetUseSpatialization () const
CRIWARECORE_API float	GetVolume () const
float	GetVolumeMultiplier () const
CRIWARECORE_API float	GetVolumeWeightedPriority () const
CRIWARECORE_API float	GetVolumeWithDistanceAndOcclusionAttenuation () const
CRIWARECORE_API bool	IsPlaying () const
CRIWARECORE_API bool	IsSeekable () const
bool	IsStopping () const
CRIWARECORE_API bool	IsStreaming () const
CRIWARECORE_API void	NotifyFinished (const bool bStopped=false)
CRIWARECORE_API FAtomPlaybackInstance &	operator= (FAtomPlaybackInstance &&)=default
void	SetDistanceAttenuation (const float InDistanceAttenuation)
void	SetEnvelopeValue (const float InEnvelopeValue)
void	SetOcclusionAttenuation (const float InOcclusionAttenuation)
void	SetPitch (const float InPitch)
void	SetRelativeRenderCost (float InRelativeRenderCost)
void	SetSpatializationIsExternalSend (const bool InSpatializationIsExternalSend)
void	SetStopping (bool bInIsStopping)
void	SetUseSpatialization (const bool InUseSpatialization)
void	SetVolume (const float InVolume)
void	SetVolumeMultiplier (const float InVolumeMultiplier)
CRIWARECORE_API bool	ShouldStopDueToMaxConcurrency () const
CRIWARECORE_API void	StopWithoutNotification ()
bool	WasCreatedByMixer () const

公開変数類
float	AbsoluteAzimuth
FAtomActiveSound *	ActiveSound
TArray< FName >	AdditionalAisacPatchNames
TArray< FAtomAisacParameter >	AisacControlParams
float	AmbientZoneFilterFrequency
FAtomEnvelope	AmplitudeEnvelope
TArray< UAtomRuntimePluginSettingsBase * >	AtomRuntimePluginSettingsArray
float	AttenuationDistance
float	AttenuationHighpassFilterFrequency
float	AttenuationLowpassFilterFrequency
uint32	bAlreadyNotifiedHook: 1
uint32	bCenterChannelOnly: 1
uint32	bEnableAmplitudeEnvelope: 1
uint32	bEnableHighPassFilter: 1
uint32	bEnableLowPassFilter: 1
uint32	bEnableSoundBusSends: 1
uint32	bEnableSoundRack: 1
uint32	bEnableSourceBusSends: 1
uint32	bEnableSourceDataOverride: 1
uint32	bIsAmbisonics: 1
uint32	bIsFinished: 1
uint32	bIsOccluded: 1
uint32	bIsPaused: 1
uint32	bIsStarted: 1
uint32	bIsStopping: 1
uint32	bIsUISound: 1
uint32	bReportedSpatializationWarning: 1
uint32	bSpatializationIsExternalSend: 1
TArray< FAtomAttenuationBusSendSettings >	BusSendSettings
TArray< FName >	CategoryNames
int32	CueBeatSyncOffset
int32	CueNextBlockIndex
TArray< FAtomSelectorParam >	CueSelectorParams
int32	EnvelopeFollowerAttackTime
int32	EnvelopeFollowerReleaseTime
float	HighPassFilterFrequency
float	ListenerToSoundDistance
float	ListenerToSoundDistanceForPanning
EAtomLoopingMode	LoopingMode
float	LowPassFilterFrequency
TArray< FTransform >	MultiPositions
EAtomMultiPositionType	MultiPositionType
float	NonSpatializedRadiusEnd
EAtomNonSpatializedRadiusSpeakerMapMode	NonSpatializedRadiusMode
float	NonSpatializedRadiusStart
FAtomNotifyPlaybackFinishedHooks	NotifyPlaybackFinishedHooks
float	OcclusionFilterFrequency
float	Pitch
UPTRINT	PlaybackInstanceHash
float	PlaybackTime
float	Priority
TUniquePtr< Atom::FQuartzQuantizedRequestData >	QuantizedRequestData
TArray< FAtomSoundToBusSend >	SoundBusSends
TObjectPtr< UAtomSoundClass >	SoundClass
float	SoundClassFilterFrequency
float	SoundClassHighPassFilterFrequency
TObjectPtr< UAtomSoundBase >	SoundData
FAtomPlaybackInfo	SoundInfo
UAtomRackBase *	SoundRack
TArray< FAtomSoundSourceBusSendInfo >	SourceBusSends [(int32) EAtomBusSendStage::Count]
UAtomSourceDataOverridePluginSourceSettingsBase *	SourceDataOverridePluginSettings
FAtomSourceVoiceEffect	SourceVoiceEffect
EAtomSpatializationAlgorithm	SpatializationMethod
float	StartTime
float	StereoSpread
FTransform	Transform
uint8	UserIndex

非公開メンバ関数
void	CalculateInheritedModulationSettingsAndValue (const EAtomModulationDestination InDestination, FAtomSoundModulationSettings &InOutSettings, float &OutValue) const
void	CalculateInheritedModulationSettingsAndValue (const FAtomAisacControl &InAisacControl, FAtomAisacControlSettings &InOutSettings, float &OutValue) const
void	CalculateInheritedModulationSettingsAndValueInternal (const Atom::FModulationParameter &InParam, const FAtomSoundModulationSettings &InActiveSettings, EAtomModulationRouting InActiveRouting, const FAtomSoundModulationSettings &InInstanceSettings, EAtomModulationRouting InInstanceRouting, const UAtomSoundClass *InSoundClass, TFunctionRef< FAtomSoundModulationSettings()> InGetSoundClassModulationSettingsFunction, FAtomSoundModulationSettings &InOutSettings, float &OutValue) const

静的非公開メンバ関数
static Atom::FModulationParameter	GetParameterBasedOnDestination (const EAtomModulationDestination InDestination)

非公開変数類
uint32	bUseSpatialization: 1
float	DistanceAttenuation
float	EnvelopValue
float	OcclusionAttenuation
uint32	PlayOrder
float	RelativeRenderCost
float	Volume
float	VolumeMultiplier

静的非公開変数類
static uint32	PlayOrderCounter = 0

フレンド
uint32	GetTypeHash (FAtomPlaybackInstance *A)
FArchive &	operator<< (FArchive &Ar, FAtomPlaybackInstance *PlaybackInstance)

詳解

Structure encapsulating all information required to play on a source.

構築子と解体子

◆ FAtomPlaybackInstance() [1/2]

FAtomPlaybackInstance::FAtomPlaybackInstance	(	const UPTRINT	PlaybackInstanceHash,
		FAtomActiveSound &	ActiveSound )

Constructor, initializing all member variables.

◆ FAtomPlaybackInstance() [2/2]

CRIWARECORE_API FAtomPlaybackInstance::FAtomPlaybackInstance ( FAtomPlaybackInstance && )

default

関数詳解

◆ AddReferencedObjects()

void FAtomPlaybackInstance::AddReferencedObjects ( FReferenceCollector & Collector )

Function used by the GC.

◆ CalculateInheritedModulationSettingsAndValue() [1/2]

void FAtomPlaybackInstance::CalculateInheritedModulationSettingsAndValue	(	const EAtomModulationDestination	InDestination,
		FAtomSoundModulationSettings &	InOutSettings,
		float &	OutValue ) const

private

This function calculates the effective modulation settings and current value, based on the currently configured modulation routing settings (e.g. it will use inherited modulators if that destination's routing is set to Inherit).

◆ CalculateInheritedModulationSettingsAndValue() [2/2]

void FAtomPlaybackInstance::CalculateInheritedModulationSettingsAndValue	(	const FAtomAisacControl &	InAisacControl,
		FAtomAisacControlSettings &	InOutSettings,
		float &	OutValue ) const

private

◆ CalculateInheritedModulationSettingsAndValueInternal()

void FAtomPlaybackInstance::CalculateInheritedModulationSettingsAndValueInternal	(	const Atom::FModulationParameter &	InParam,
		const FAtomSoundModulationSettings &	InActiveSettings,
		EAtomModulationRouting	InActiveRouting,
		const FAtomSoundModulationSettings &	InInstanceSettings,
		EAtomModulationRouting	InInstanceRouting,
		const UAtomSoundClass *	InSoundClass,
		TFunctionRef< FAtomSoundModulationSettings()>	InGetSoundClassModulationSettingsFunction,
		FAtomSoundModulationSettings &	InOutSettings,
		float &	OutValue ) const

private

◆ GetActualVolume()

float FAtomPlaybackInstance::GetActualVolume ( ) const

Returns the actual volume the wave instance will play at, including all gain stages.

◆ GetDistanceAndOcclusionAttenuation()

float FAtomPlaybackInstance::GetDistanceAndOcclusionAttenuation ( ) const

Returns the combined distance and occlusion attenuation of the source voice.

◆ GetDistanceAttenuation()

float FAtomPlaybackInstance::GetDistanceAttenuation ( ) const

Returns the distance attenuation of the source voice.

◆ GetDynamicVolume()

float FAtomPlaybackInstance::GetDynamicVolume ( ) const

Returns the dynamic volume of the sound.

◆ GetEffectiveAisacModulationSettings()

FAtomAisacControlSettings FAtomPlaybackInstance::GetEffectiveAisacModulationSettings ( const FAtomAisacControl & InAisacControl ) const

◆ GetEffectiveAisacModulationValue()

float FAtomPlaybackInstance::GetEffectiveAisacModulationValue ( const FAtomAisacControl & InAisacControl ) const

◆ GetEffectiveModulationSettings()

FAtomSoundModulationSettings FAtomPlaybackInstance::GetEffectiveModulationSettings ( const EAtomModulationDestination InDestination ) const

◆ GetEffectiveModulationValue()

float FAtomPlaybackInstance::GetEffectiveModulationValue ( const EAtomModulationDestination InDestination ) const

◆ GetEnvelopeValue()

float FAtomPlaybackInstance::GetEnvelopeValue ( ) const

inline

Gets the envelope value of the waveinstance. Only returns non-zero values if it's a real voice. Only implemented in the audio mixer.

◆ GetName()

FString FAtomPlaybackInstance::GetName ( ) const

Returns the sound name of the contained USoundBase.

◆ GetOcclusionAttenuation()

float FAtomPlaybackInstance::GetOcclusionAttenuation ( ) const

Returns the occlusion attenuation of the source voice.

◆ GetParameterBasedOnDestination()

Atom::FModulationParameter FAtomPlaybackInstance::GetParameterBasedOnDestination ( const EAtomModulationDestination InDestination )

staticprivate

◆ GetPitch()

float FAtomPlaybackInstance::GetPitch ( ) const

Returns the pitch of the playback instance.

◆ GetPlayOrder()

uint32 FAtomPlaybackInstance::GetPlayOrder ( ) const

inline

◆ GetRelativeRenderCost()

float FAtomPlaybackInstance::GetRelativeRenderCost ( ) const

inline

Retrieves the relative render cost of wave instance.

◆ GetSpatializationIsExternalSend()

bool FAtomPlaybackInstance::GetSpatializationIsExternalSend ( ) const

inline

Whether spatialization is an external send

◆ GetTimeStretchRatio()

float FAtomPlaybackInstance::GetTimeStretchRatio ( ) const

Returns the time stretch ratio of the playback instance.

◆ GetUseSpatialization()

bool FAtomPlaybackInstance::GetUseSpatialization ( ) const

Whether this playback will be spatialized, which controls 3D effects like panning

◆ GetVolume()

float FAtomPlaybackInstance::GetVolume ( ) const

Returns the volume of the wave instance (ignoring application muting).

◆ GetVolumeMultiplier()

float FAtomPlaybackInstance::GetVolumeMultiplier ( ) const

inline

Returns the volume multiplier on the wave instance.

◆ GetVolumeWeightedPriority()

float FAtomPlaybackInstance::GetVolumeWeightedPriority ( ) const

Returns the weighted priority of the wave instance.

◆ GetVolumeWithDistanceAndOcclusionAttenuation()

float FAtomPlaybackInstance::GetVolumeWithDistanceAndOcclusionAttenuation ( ) const

Returns the volume of the sound including distance attenuation.

◆ IsPlaying()

bool FAtomPlaybackInstance::IsPlaying ( ) const

Returns whether or not the WaveInstance is actively playing sound or set to play when silent.

◆ IsSeekable()

bool FAtomPlaybackInstance::IsSeekable ( ) const

◆ IsStopping()

bool FAtomPlaybackInstance::IsStopping ( ) const

inline

◆ IsStreaming()

bool FAtomPlaybackInstance::IsStreaming ( ) const

Checks whether wave is streaming and streaming is supported.

◆ NotifyFinished()

void FAtomPlaybackInstance::NotifyFinished ( const bool bStopped = false )

Notifies the wave instance that the current playback has finished.

Notifies the playback instance that it has finished.

◆ operator=()

CRIWARECORE_API FAtomPlaybackInstance & FAtomPlaybackInstance::operator= ( FAtomPlaybackInstance && )

default

◆ SetDistanceAttenuation()

void FAtomPlaybackInstance::SetDistanceAttenuation ( const float InDistanceAttenuation )

inline

◆ SetEnvelopeValue()

void FAtomPlaybackInstance::SetEnvelopeValue ( const float InEnvelopeValue )

inline

Sets the envelope value of the wave instance. Only set if the wave instance is actually generating real audio with a source voice. Only implemented in the audio mixer.

◆ SetOcclusionAttenuation()

void FAtomPlaybackInstance::SetOcclusionAttenuation ( const float InOcclusionAttenuation )

inline

◆ SetPitch()

void FAtomPlaybackInstance::SetPitch ( const float InPitch )

inline

◆ SetRelativeRenderCost()

void FAtomPlaybackInstance::SetRelativeRenderCost ( float InRelativeRenderCost )

inline

Sets the relative render cost of the wave instance.

◆ SetSpatializationIsExternalSend()

void FAtomPlaybackInstance::SetSpatializationIsExternalSend ( const bool InSpatializationIsExternalSend )

inline

Whether spatialization is an external send

◆ SetStopping()

void FAtomPlaybackInstance::SetStopping ( bool bInIsStopping )

inline

◆ SetUseSpatialization()

void FAtomPlaybackInstance::SetUseSpatialization ( const bool InUseSpatialization )

inline

Whether to use spatialization, which controls 3D effects like panning

◆ SetVolume()

void FAtomPlaybackInstance::SetVolume ( const float InVolume )

inline

Setters for various values on wave instances.

◆ SetVolumeMultiplier()

void FAtomPlaybackInstance::SetVolumeMultiplier ( const float InVolumeMultiplier )

inline

◆ ShouldStopDueToMaxConcurrency()

bool FAtomPlaybackInstance::ShouldStopDueToMaxConcurrency ( ) const

Returns

◆ StopWithoutNotification()

void FAtomPlaybackInstance::StopWithoutNotification ( )

Stops the wave instance without notifying NotifyWaveInstanceFinishedHook.

Stops the wave instance without notifying NotifyWaveInstanceFinishedHook. This will NOT stop wave instance if it is set up to loop indefinitely or set to remain active.

◆ WasCreatedByMixer()

bool FAtomPlaybackInstance::WasCreatedByMixer ( ) const

inline

Whether this playback instance was initial playback or created in mixer by ADX sound engine.

◆ GetTypeHash

uint32 GetTypeHash ( FAtomPlaybackInstance * A )

friend

◆ operator<<

FArchive & operator<<	(	FArchive &	Ar,
		FAtomPlaybackInstance *	PlaybackInstance )

friend

Friend archive function used for serialization.

メンバ詳解

◆ AbsoluteAzimuth

float FAtomPlaybackInstance::AbsoluteAzimuth

The absolute position of the wave instance relative to forward vector of listener.

◆ ActiveSound

FAtomActiveSound* FAtomPlaybackInstance::ActiveSound

Active Sound this playback instance belongs to.

◆ AdditionalAisacPatchNames

TArray<FName> FAtomPlaybackInstance::AdditionalAisacPatchNames

◆ AisacControlParams

TArray<FAtomAisacParameter> FAtomPlaybackInstance::AisacControlParams

◆ AmbientZoneFilterFrequency

float FAtomPlaybackInstance::AmbientZoneFilterFrequency

The low pass filter frequency to use due to ambient zones.

◆ AmplitudeEnvelope

FAtomEnvelope FAtomPlaybackInstance::AmplitudeEnvelope

Which output target the sound should play on. The envelope to apply to volume amplitude.

◆ AtomRuntimePluginSettingsArray

TArray<UAtomRuntimePluginSettingsBase*> FAtomPlaybackInstance::AtomRuntimePluginSettingsArray

The runtime plugin settings array to use for the playback instance.

◆ AttenuationDistance

float FAtomPlaybackInstance::AttenuationDistance

Distance over which the sound is attenuated.

◆ AttenuationHighpassFilterFrequency

float FAtomPlaybackInstance::AttenuationHighpassFilterFrequency

The high pass filter frequency to use due to distance attenuation. (using in audio mixer only)

◆ AttenuationLowpassFilterFrequency

float FAtomPlaybackInstance::AttenuationLowpassFilterFrequency

The low pass filter frequency to use due to distance attenuation.

◆ bAlreadyNotifiedHook

uint32 FAtomPlaybackInstance::bAlreadyNotifiedHook

Whether the notify finished hook has been called since the last update/parsenodes

◆ bCenterChannelOnly

uint32 FAtomPlaybackInstance::bCenterChannelOnly

Whether or not this wave is music Whether or not this wave has reverb applied Whether or not this sound class forces sounds to the center channel

◆ bEnableAmplitudeEnvelope

uint32 FAtomPlaybackInstance::bEnableAmplitudeEnvelope

◆ bEnableHighPassFilter

uint32 FAtomPlaybackInstance::bEnableHighPassFilter

Whether or not to enable the high pass filter

◆ bEnableLowPassFilter

uint32 FAtomPlaybackInstance::bEnableLowPassFilter

Whether or not to enable the low pass filter

◆ bEnableSoundBusSends

uint32 FAtomPlaybackInstance::bEnableSoundBusSends

Whether or not to enable bus sends in addition to the Main rack.

◆ bEnableSoundRack

uint32 FAtomPlaybackInstance::bEnableSoundRack

Whether or not to render to the main rack.

◆ bEnableSourceBusSends

uint32 FAtomPlaybackInstance::bEnableSourceBusSends

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

◆ bEnableSourceDataOverride

uint32 FAtomPlaybackInstance::bEnableSourceDataOverride

Whether or not to use source data overrides.

◆ bIsAmbisonics

uint32 FAtomPlaybackInstance::bIsAmbisonics

Whether or not this wave instance is ambisonics.

◆ bIsFinished

uint32 FAtomPlaybackInstance::bIsFinished

Whether wave instanced is finished

◆ bIsOccluded

uint32 FAtomPlaybackInstance::bIsOccluded

Whether or not the sound is occluded.

◆ bIsPaused

uint32 FAtomPlaybackInstance::bIsPaused

Whether or not this sound is manually paused

◆ bIsStarted

uint32 FAtomPlaybackInstance::bIsStarted

Set to true if the sound nodes state that the radio filter should be applied Whether wave instanced has been started

◆ bIsStopping

uint32 FAtomPlaybackInstance::bIsStopping

Whether or not this wave instance is stopping.

◆ bIsUISound

uint32 FAtomPlaybackInstance::bIsUISound

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

◆ bReportedSpatializationWarning

uint32 FAtomPlaybackInstance::bReportedSpatializationWarning

Prevent spamming of spatialization of surround sounds by tracking if the warning has already been emitted

◆ bSpatializationIsExternalSend

uint32 FAtomPlaybackInstance::bSpatializationIsExternalSend

Whether the spatialization method is an external send

◆ bUseSpatialization

uint32 FAtomPlaybackInstance::bUseSpatialization

private

Whether to use spatialization

◆ BusSendSettings

TArray<FAtomAttenuationBusSendSettings> FAtomPlaybackInstance::BusSendSettings

The output reverb send level to use for tje wave instance. The submix send settings to use.

◆ CategoryNames

TArray<FName> FAtomPlaybackInstance::CategoryNames

◆ CueBeatSyncOffset

int32 FAtomPlaybackInstance::CueBeatSyncOffset

◆ CueNextBlockIndex

int32 FAtomPlaybackInstance::CueNextBlockIndex

◆ CueSelectorParams

TArray<FAtomSelectorParam> FAtomPlaybackInstance::CueSelectorParams

◆ DistanceAttenuation

float FAtomPlaybackInstance::DistanceAttenuation

private

Volume attenuation due to distance.

◆ EnvelopeFollowerAttackTime

int32 FAtomPlaybackInstance::EnvelopeFollowerAttackTime

The envelope follower attack time in milliseconds.

◆ EnvelopeFollowerReleaseTime

int32 FAtomPlaybackInstance::EnvelopeFollowerReleaseTime

The envelope follower release time in milliseconds.

◆ EnvelopValue

float FAtomPlaybackInstance::EnvelopValue

private

The current envelope value of the wave instance.

◆ HighPassFilterFrequency

float FAtomPlaybackInstance::HighPassFilterFrequency

The high pass filter frequency to use

◆ ListenerToSoundDistance

float FAtomPlaybackInstance::ListenerToSoundDistance

The distance from this wave instance to the closest listener.

◆ ListenerToSoundDistanceForPanning

float FAtomPlaybackInstance::ListenerToSoundDistanceForPanning

The distance from this wave instance to the closest listener. (ignoring attenuation override)

◆ LoopingMode

EAtomLoopingMode FAtomPlaybackInstance::LoopingMode

Voice center channel volume Volume of the radio filter effect The volume at which the radio filter kicks in The amount of a sound to bleed to the LFE channel Looping mode - None, loop with notification, forever

◆ LowPassFilterFrequency

float FAtomPlaybackInstance::LowPassFilterFrequency

The low pass filter frequency to use

◆ MultiPositions

TArray<FTransform> FAtomPlaybackInstance::MultiPositions

Multi-Position locations and directions.

◆ MultiPositionType

EAtomMultiPositionType FAtomPlaybackInstance::MultiPositionType

Multi-Position type

◆ NonSpatializedRadiusEnd

float FAtomPlaybackInstance::NonSpatializedRadiusEnd

At what distance we are fully non-spatialized

◆ NonSpatializedRadiusMode

EAtomNonSpatializedRadiusSpeakerMapMode FAtomPlaybackInstance::NonSpatializedRadiusMode

How we are doing the non-spatialized radius feature.

◆ NonSpatializedRadiusStart

float FAtomPlaybackInstance::NonSpatializedRadiusStart

At what distance we start transforming into non-spatialized soundsource

◆ NotifyPlaybackFinishedHooks

FAtomNotifyPlaybackFinishedHooks FAtomPlaybackInstance::NotifyPlaybackFinishedHooks

Sound effect chain Objects to notify when the current playback finishes

◆ OcclusionAttenuation

float FAtomPlaybackInstance::OcclusionAttenuation

private

Volume attenuation due to occlusion.

◆ OcclusionFilterFrequency

float FAtomPlaybackInstance::OcclusionFilterFrequency

The low pass filter frequency to use if the sound is occluded.

◆ Pitch

float FAtomPlaybackInstance::Pitch

Current pitch scale.

◆ PlaybackInstanceHash

UPTRINT FAtomPlaybackInstance::PlaybackInstanceHash

Hash value for finding the playback instance based on the path through the cue to get to it

◆ PlaybackTime

float FAtomPlaybackInstance::PlaybackTime

The playback time of the wave instance. Updated from active sound.

◆ PlayOrder

uint32 FAtomPlaybackInstance::PlayOrder

private

Cached play order

◆ PlayOrderCounter

uint32 FAtomPlaybackInstance::PlayOrderCounter = 0

staticprivate

Static helper to create good unique type hashes

Helper to create good play order for FAtomPlaybackInstance instances

◆ Priority

float FAtomPlaybackInstance::Priority

An audio component priority value that scales with volume (post all gain stages) and is used to determine voice playback priority.

◆ QuantizedRequestData

TUniquePtr<Atom::FQuartzQuantizedRequestData> FAtomPlaybackInstance::QuantizedRequestData

Quantized Request data

◆ RelativeRenderCost

float FAtomPlaybackInstance::RelativeRenderCost

private

The estimated relative render cost of the playback instance. 1.0 is cost of a single decoding sound source. Used for limited the overall voice count.

◆ SoundBusSends

TArray<FAtomSoundToBusSend> FAtomPlaybackInstance::SoundBusSends

Sound bus sends (submix)

◆ SoundClass

TObjectPtr<UAtomSoundClass> FAtomPlaybackInstance::SoundClass

Sound class

◆ SoundClassFilterFrequency

float FAtomPlaybackInstance::SoundClassFilterFrequency

The low pass filter frequency to use from sound class.

◆ SoundClassHighPassFilterFrequency

float FAtomPlaybackInstance::SoundClassHighPassFilterFrequency

The high pass filter frequency to use from sound class.

◆ SoundData

TObjectPtr<UAtomSoundBase> FAtomPlaybackInstance::SoundData

Sound data

◆ SoundInfo

FAtomPlaybackInfo FAtomPlaybackInstance::SoundInfo

Source Buffer listener

◆ SoundRack

UAtomRackBase* FAtomPlaybackInstance::SoundRack

Sound Rack or Endpoint object to send audio to for mixing.

◆ SourceBusSends

TArray<FAtomSoundSourceBusSendInfo> FAtomPlaybackInstance::SourceBusSends[(int32) EAtomBusSendStage::Count]

The source bus and/or audio bus sends.

◆ SourceDataOverridePluginSettings

UAtomSourceDataOverridePluginSourceSettingsBase* FAtomPlaybackInstance::SourceDataOverridePluginSettings

The occlusion plugin settings to use for the wave instance. The occlusion plugin settings to use for the wave instance. The occlusion plugin settings to use for the wave instance. The source data override plugin settings to use for the wave instance.

◆ SourceVoiceEffect

FAtomSourceVoiceEffect FAtomPlaybackInstance::SourceVoiceEffect

◆ SpatializationMethod

EAtomSpatializationAlgorithm FAtomPlaybackInstance::SpatializationMethod

Which spatialization method to use to spatialize 3d sounds.

◆ StartTime

float FAtomPlaybackInstance::StartTime

An offset/seek time to play this wave instance.

◆ StereoSpread

float FAtomPlaybackInstance::StereoSpread

Amount of spread for 3d multi-channel asset spatialization

◆ Transform

FTransform FAtomPlaybackInstance::Transform

Current location and direction (scale not used).

◆ UserIndex

uint8 FAtomPlaybackInstance::UserIndex

User / Controller index that owns the sound

◆ Volume

float FAtomPlaybackInstance::Volume

private

Current volume

◆ VolumeMultiplier

float FAtomPlaybackInstance::VolumeMultiplier

private

Current volume multiplier - used to zero the volume without stopping the source

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

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

公開メンバ関数

公開変数類

非公開メンバ関数

静的非公開メンバ関数

非公開変数類

静的非公開変数類

フレンド

詳解

構築子と解体子

◆ FAtomPlaybackInstance() [1/2]

◆ FAtomPlaybackInstance() [2/2]

関数詳解

◆ AddReferencedObjects()

◆ CalculateInheritedModulationSettingsAndValue() [1/2]

◆ CalculateInheritedModulationSettingsAndValue() [2/2]

◆ CalculateInheritedModulationSettingsAndValueInternal()

◆ GetActualVolume()

◆ GetDistanceAndOcclusionAttenuation()

◆ GetDistanceAttenuation()

◆ GetDynamicVolume()

◆ GetEffectiveAisacModulationSettings()

◆ GetEffectiveAisacModulationValue()

◆ GetEffectiveModulationSettings()

◆ GetEffectiveModulationValue()

◆ GetEnvelopeValue()

◆ GetName()

◆ GetOcclusionAttenuation()

◆ GetParameterBasedOnDestination()

◆ GetPitch()

◆ GetPlayOrder()

◆ GetRelativeRenderCost()

◆ GetSpatializationIsExternalSend()

◆ GetTimeStretchRatio()

◆ GetUseSpatialization()

◆ GetVolume()

◆ GetVolumeMultiplier()

◆ GetVolumeWeightedPriority()

◆ GetVolumeWithDistanceAndOcclusionAttenuation()

◆ IsPlaying()

◆ IsSeekable()

◆ IsStopping()

◆ IsStreaming()

◆ NotifyFinished()

◆ operator=()

◆ SetDistanceAttenuation()

◆ SetEnvelopeValue()

◆ SetOcclusionAttenuation()

◆ SetPitch()

◆ SetRelativeRenderCost()

◆ SetSpatializationIsExternalSend()

◆ SetStopping()

◆ SetUseSpatialization()

◆ SetVolume()

◆ SetVolumeMultiplier()

◆ ShouldStopDueToMaxConcurrency()

◆ StopWithoutNotification()

◆ WasCreatedByMixer()

フレンドと関連関数の詳解

◆ GetTypeHash

◆ operator<<

メンバ詳解

◆ AbsoluteAzimuth

◆ ActiveSound

◆ AdditionalAisacPatchNames

◆ AisacControlParams

◆ AmbientZoneFilterFrequency

◆ AmplitudeEnvelope

◆ AtomRuntimePluginSettingsArray

◆ AttenuationDistance

◆ AttenuationHighpassFilterFrequency

◆ AttenuationLowpassFilterFrequency

◆ bAlreadyNotifiedHook

◆ bCenterChannelOnly

◆ bEnableAmplitudeEnvelope

◆ bEnableHighPassFilter

◆ bEnableLowPassFilter

◆ bEnableSoundBusSends

◆ bEnableSoundRack

◆ bEnableSourceBusSends

◆ bEnableSourceDataOverride