FAtomRuntime クラス

#include <AtomRuntime.h>

FAtomRuntime の継承関係図

クラス
struct	FAtomBusOutputParams
struct	FAtomClassDebugInfo
struct	FAtomRackInitParams
struct	FAtomSoundfieldRackInitParams
struct	FBusEffectToUpdateInfo
struct	FCreateComponentParams

公開型
using	FToggleSoloPtr = void (Atom::FAtomDebugger::*)(FName InName, bool bExclusive)

公開メンバ関数
	FAtomRuntime (ICriWarePlatformAtom *InPlatformAtom)
virtual	~FAtomRuntime ()
void	Activate (bool bFadeIn=false)
void	AddEnvelopeFollowerDelegate (UAtomBus *InBus, const FOnAtomBusEnvelopeBP &OnAtomBusEnvelopeBP)
void	AddLevelMeterDelegate (UAtomRackBase *InRack, const FOnAtomRackLevelMeterMeasureBP &OnAtomRackLevelMeterMeasureBP)
void	AddLoudnessMeterDelegate (UAtomRackBase *InRack, const FOnAtomRackLoudnessMeterMeasureBP &OnAtomRackTruePeakMeterMeasureBP)
void	AddNewActiveSound (const FAtomActiveSound &ActiveSound, const TArray< FAtomAisacParameter > *InDefaultParams=nullptr, const FString *EventLogID=nullptr)
void	AddNewActiveSound (const FAtomActiveSound &ActiveSound, TArray< FAtomAisacParameter > &&InDefaultParams)
void	AddNewActiveSound (TSharedRef< FAtomActiveSound > ActiveSound, TArray< FAtomAisacParameter > &&InDefaultParams, const FString *EventLogID=nullptr)
Audio::FPatchOutputStrongPtr	AddPatchForSubmix (uint32 InObjectId, float InPatchGain)
void	AddPerformanceMonitorDelegate (UAtomRackBase *InRack, const FOnAtomRackPerformanceMonitorResultBP &OnAtomRackPerformanceMonitorResultBP)
void	AddReferencedObjects (FReferenceCollector &Collector)
void	AddRenderedSamplesDelegate (UAtomRackBase *InRack, const FOnAtomRackRenderedSamplesBP &OnAtomRackRenderedSamplesBP)
void	AddSoundToStop (FAtomActiveSound *SoundToStop)
void	AddSpectralAnalysisDelegate (UAtomBus *InBus, const FAtomSoundSpectrumAnalyzerDelegateSettings &InDelegateSettings, const FOnAtomBusSpectralAnalysisBP &OnAtomBusSpectralAnalysisBP)
void	AddTruePeakMeterDelegate (UAtomRackBase *InRack, const FOnAtomRackTruePeakMeterMeasureBP &OnAtomRackTruePeakMeterMeasureBP)
void	AddUserAtomVoicePool (FName Name, const FAtomVoicesSettings &VoiceSettings, EAtomVoicePoolCodecType CodecType=EAtomVoicePoolCodecType::Standard, EAtomVoicePoolStreamingType StreamingType=EAtomVoicePoolStreamingType::Mixed)
void	AddVirtualLoop (const FAtomVirtualLoop &InVirtualLoop)
void	ApplyInteriorSettings (FAtomActiveSound &ActiveSound, FAtomSoundParseParameters &ParseParams) const
bool	AttachAisacPatchToCategory (const FAtomCategory &Category, const UAtomAisacPatch *AisacPatch)
void	AudioRenderThreadCommand (TFunction< void()> Command)
bool	CanHaveMultipleActiveSounds (uint64 AtomComponentID) const
void	CheckAtomThread () const
void	CheckAudioRenderingThread () const
float	ClampPitch (float InPitchScale) const
void	ClearListenerAttenuationOverride (int32 ListenerIndex)
void	Deactivate (bool bFadeOut=false)
void	Deinitialize ()
bool	DetachAisacPatchFromCategory (const FAtomCategory &Category, const UAtomAisacPatch *AisacPatch)
void	DrawRacks (FOutputDevice &InOutput, const TArray< FString > &InArgs) const
virtual void	FadeIn ()
virtual void	FadeOut ()
int32	FindClosestListenerIndex (const FTransform &SoundTransform) const
int32	FindClosestListenerIndex (const FVector &Position, float &OutSqDistance, bool AllowAttenuationOverrides) const
Atom::FMixerSubmixPtr	FindSubmixInstanceByObjectID (uint32 InObjectID) const
void	Flush (UWorld *WorldToFlush)
virtual void	FlushAudioRenderingCommands (bool bPumpSynchronously=false)
virtual void	FlushExtended (UWorld *WorldToFlush)
void	GameThreadMPSCCommand (TFunction< void()> InCommand)
void	GatherInteriorData (FAtomActiveSound &ActiveSound, FAtomSoundParseParameters &ParseParams) const
void	Get2DChannelMap (bool bIsVorbis, const int32 NumSourceChannels, const bool bIsCenterChannelOnly, Atom::FAlignedFloatBuffer &OutChannelMap) const
const TArray< FAtomPlaybackInstance * > &	GetActivePlaybackInstances () const
const TArray< FAtomActiveSound * > &	GetActiveSounds () const
CriAtomExAsrRackId	GetAsrRackId (const UAtomRackBase *InRack) const
double	GetAtomClock () const
FORCEINLINE const UAtomConfig *	GetAtomConfiguration () const
AtomModulation::FAtomModulationSystem *	GetAtomModulationSystem () const
FORCEINLINE FAtomRuntimeId	GetAtomRuntimeID () const
void	GetAzimuth (const FAtomAttenuationListenerData &OutListenerData, float &OutAzimuth, float &AbsoluteAzimuth) const
bool	GetBusEffectBypass (const UAtomBus *InBus, const UAtomBusEffectPreset *InEffectPreset) const
float	GetBusEffectParameter (const UAtomBus *InBus, const UAtomBusEffectPreset *InEffectPreset, int InParameterIndex) const
bool	GetBusEffectPreset (const UAtomBus *InBus, UAtomBusEffectPreset *InEffectPreset)
bool	GetBusPanning (const UAtomBus *InBus, FAtomPanning &OutPanning) const
float	GetBusVolume (const UAtomBus *InBus) const
const TArray< Atom::EMixerSpeaker > &	GetChannelArray () const
FAtomConcurrencyManager &	GetConcurrencyManager ()
const FAtomConcurrencyManager &	GetConcurrencyManager () const
bool	GetDefaultAtomSettings (uint32 WorldID, FAtomReverbSettings &OutReverbSettings, FAtomInteriorSettings &OutInteriorSettings) const
const Atom::FChannelPositionInfo *	GetDefaultChannelPositions () const
TArray< Atom::FChannelPositionInfo > *	GetDefaultPositionMap (int32 NumChannels)
bool	GetDistanceSquaredToListener (const FVector &Location, int32 ListenerIndex, float &OutSqDistance) const
bool	GetDistanceSquaredToNearestListener (const FVector &Location, float &OutSqDistance) const
float	GetDistanceToNearestListener (const FVector &Location) const
CriAtomExPlayerHn	GetExPlayerHandle (const FAtomPlaybackInstance *InPlaybackInstance) const
float	GetFocusFactor (const float Azimuth, const FAtomAttenuationSettings &AttenuationSettings) const
float	GetGameDeltaTime () const
const FAtomGlobalFocusSettings &	GetGlobalFocusSettings () const
TRange< float >	GetGlobalPitchRange () const
const FAtomDynamicParameter &	GetGlobalPitchScale () const
bool	GetListenerPosition (int32 ListenerIndex, FVector &OutPosition, bool bAllowOverride) const
const TArray< FAtomListener > &	GetListeners () const
bool	GetListenerTransform (int32 ListenerIndex, FTransform &OutTransform) const
FVector	GetListenerTransformedDirection (const FVector &Position, float *OutDistance)
bool	GetListenerWorldID (int32 ListenerIndex, uint32 &OutWorldID) const
void	GetMagnitudesForFrequencies (UAtomBus *InBus, const TArray< float > &InFrequencies, TArray< float > &OutMagnitudes)
Atom::FMixerSubmixWeakPtr	GetMainSubmix () const
UAtomBus &	GetMainSubmixObject () const
TArray< FName >	GetMappedOutputPortNames (const UAtomRackBase *AtomRack) const
FORCEINLINE UAtomRack *	GetMasterRack () const
int32	GetMaxChannels () const
void	GetMaxDistanceAndFocusFactor (UAtomSoundBase *Sound, const UWorld *World, const FVector &Location, const FAtomAttenuationSettings *AttenuationSettingsToApply, float &OutMaxDistance, float &OutFocusFactor)
int32	GetMaxSources () const
EAtomDebugState	GetMixDebugState () const
Atom::FMixerSourceVoice *	GetMixerSourceVoice ()
EAtomMonoChannelUpmixMethod	GetMonoChannelUpmixMethod () const
int32	GetNumRacks ()
void	GetPhasesForFrequencies (UAtomBus *InBus, const TArray< float > &InFrequencies, TArray< float > &OutPhases)
const TMap< FAtomPlaybackInstance *, FAtomSource * > &	GetPlaybackInstanceSourceMap () const
CriAtomPlayerHn	GetPlayerHandle (const FAtomPlaybackInstance *InPlaybackInstance) const
float	GetPrimaryVolume () const
int32	GetRackNumOutputChannels (UAtomRackBase *InRack) const
int32	GetRackSampleRate (UAtomRackBase *InRack) const
FString	GetRackSnapshotName (const UAtomRack *InRack) const
EAtomSpeakerChannelMap	GetRackSpeakerChannelMapToApply (const UAtomRack *InRack) const
float	GetRuntimeDeltaTime () const
int32	GetRuntimeNumOutputChannels () const
int32	GetRuntimeNumOutputFrames () const
int32	GetRuntimeSampleRate () const
FAtomSoundClassProperties *	GetSoundClassCurrentProperties (UAtomSoundClass *InSoundClass)
FAtomSoundClassDynamicProperties *	GetSoundClassDynamicProperties (UAtomSoundClass *InSoundClass)
void	GetSoundClassInfo (TMap< FName, FAtomClassDebugInfo > &AtomClassInfos)
FAtomSource *	GetSoundSource (const FAtomPlaybackInstance *InPlaybackInstance) const
Atom::FMixerSourceManager *	GetSourceManager ()
const Atom::FMixerSourceManager *	GetSourceManager () const
FORCEINLINE int32	GetSpatializationBusIndex () const
FORCEINLINE FString	GetSpatializationBusName () const
FORCEINLINE UAtomRackBase *	GetSpatializationRack () const
Atom::FMixerSubmixWeakPtr	GetSubmixInstance (const UAtomBus *InAtomBus) const
template<typename TSubsystemClass>
TSubsystemClass *	GetSubsystem () const
UAtomEngineSubsystem *	GetSubsystemBase (TSubclassOf< UAtomEngineSubsystem > SubsystemClass) const
UAtomComponent *	GetTestComponent (UWorld *InWorld)
float	GetTransientPrimaryVolume () const
const TMap< FAtomActiveSound *, FAtomVirtualLoop > &	GetVirtualLoops () const
void	HandleAtomDebugSound (const TArray< FString > &Args)
void	HandleAtomMemoryInfo (const TArray< FString > &Args, FOutputDevice &Ar)
void	HandleAtomMixDebugSound (const TArray< FString > &Args)
void	HandleAtomSoloCommon (const TArray< FString > &Args, FToggleSoloPtr FPtr)
void	HandleAtomSoloSoundClass (const TArray< FString > &Args)
void	HandleAtomSoloSoundCue (const TArray< FString > &Args)
void	HandleAtomSoloSoundWave (const TArray< FString > &Args)
void	HandleClearSoloCommand (FOutputDevice &Ar)
void	HandleDisableHPFCommand (FOutputDevice &Ar)
void	HandleDisableLPFCommand (FOutputDevice &Ar)
void	HandleDumpSoundInfoCommand (FOutputDevice &Ar)
void	HandleEnableHRTFForAllCommand (FOutputDevice &Ar)
void	HandleGetDynamicSoundVolumeCommand (const TArray< FString > &Args, FOutputDevice &Ar)
void	HandleListAtomComponentsCommand (FOutputDevice &Ar)
void	HandleListPlaybacksCommand (FOutputDevice &Ar)
void	HandleListSoundClassesCommand (FOutputDevice &Ar)
void	HandleListSoundClassVolumesCommand (FOutputDevice &Ar)
void	HandleListSoundDurationsCommand (FOutputDevice &Ar)
void	HandlePlayAllPIEAtomCommand (FOutputDevice &Ar)
void	HandleResetAllDynamicSoundVolumesCommand ()
void	HandleResetDynamicSoundVolumeCommand (const TArray< FString > &Args)
void	HandleResetSoundStateCommand (FOutputDevice &Ar)
void	HandleSDKOnAtomAudioFrameStart ()
void	HandleSDKOnAtomExBeatSync (const CriAtomExBeatSyncInfo *BeatSyncInfo)
void	HandleSDKOnAtomExSequencerEvent (const CriAtomExSequenceEventInfo *EventInfo)
void	HandleSetBaseSoundRackCommand (const TArray< FString > &Args, FOutputDevice &Ar)
void	HandleSetDynamicSoundCommand (const TArray< FString > &Args)
void	HandleShowSoundClassHierarchyCommand (FOutputDevice &Ar)
void	HandleSoloCommand (FOutputDevice &Ar)
void	HandleTestHPFCommand (FOutputDevice &Ar)
void	HandleTestLPFCommand (FOutputDevice &Ar)
bool	Init (FAtomRuntimeId InRuntimeID)
void	InitSoundClasses ()
void	InvalidateCachedInteriorVolumes () const
bool	IsActive () const
bool	IsAtomMixerPluginEnabled () const
bool	IsAtomRuntimeMuted () const
bool	IsAudioRenderingThread () const
bool	IsHRTFDisabled () const
bool	IsHRTFEnabledForAll () const
bool	IsManaRuntimePluginEnabled () const
bool	IsPendingStop (FAtomActiveSound *ActiveSound)
bool	IsSourceDataOverridePluginEnabled () const
bool	IsUsingFixedVoicePools () const
virtual bool	IsUsingUnrealSoundRenderer () const
void	IterateOverRacks (TFunctionRef< void(const UAtomRackBase *Rack)> Func) const
void	IterateOverVoicePools (TFunctionRef< void(EAtomVoicePoolCodecType CodecType, EAtomVoicePoolStreamingType StreamingType, int32 ID, int32 NumUsedVoices, int32 MaxVoices, int32 MaxChannels, int32 MaxSampleRate)> Func) const
void	LoadSubmixInstance (const UAtomBus *InAtomBus, bool bAllowReinit=false)
bool	LocationIsAudible (const FVector &Location, const float MaxDistance) const
bool	LocationIsAudible (const FVector &Location, int32 ListenerIndex, const float MaxDistance) const
Audio::FPatchOutputStrongPtr	MakePatch (int32 InFrames, int32 InChannels, float InGain) const
bool	MapOutputPortToRack (FName OutputPortName, const UAtomRackBase *AtomRack)
void	NotifyActiveSoundOcclusionTraceDone (FAtomActiveSound *ActiveSound, bool bIsOccluded)
void	NotifyPendingDelete (FAtomActiveSound &ActiveSound) const
void	OnPreGarbageCollect ()
void	OnRuntimeCreated (FAtomRuntimeId InDeviceID)
void	OnRuntimeDestroyed (FAtomRuntimeId InDeviceID)
void	PauseActiveSound (uint64 AtomComponentID, const bool bInIsPaused)
void	PlaySoundAtLocation (UAtomSoundBase *Sound, UWorld *World, float VolumeMultiplier, float PitchMultiplier, float StartTime, const FVector &Location, const FRotator &Rotation, UAtomAttenuation *AttenuationSettings, UAtomConcurrency *Concurrency, TArray< FAtomAisacParameter > &&Params, const AActor *OwningActor=nullptr)
void	PlaySoundAtLocation (UAtomSoundBase *Sound, UWorld *World, float VolumeMultiplier, float PitchMultiplier, float StartTime, const FVector &Location, const FRotator &Rotation, UAtomAttenuation *AttenuationSettings=nullptr, UAtomConcurrency *ConcurrencySettings=nullptr, const TArray< FAtomAisacParameter > *Params=nullptr, const AActor *OwningActor=nullptr)
void	RealizeVirtualLoop (FAtomVirtualLoop &VirtualLoop)
bool	RegisterAtomRack (const UAtomRackBase *AtomRack)
void	RegisterSoundClass (UAtomSoundClass *InSoundClass)
void	ReleaseMixerSourceVoice (Atom::FMixerSourceVoice *InSourceVoice)
void	RemoveActiveSound (FAtomActiveSound *ActiveSound)
void	RemoveEnvelopeFollowerDelegate (UAtomBus *InBus, const FOnAtomBusEnvelopeBP &OnAtomBusEnvelopeBP)
void	RemoveLevelMeterDelegate (UAtomRackBase *InRack, const FOnAtomRackLevelMeterMeasureBP &OnAtomRackLevelMeterMeasureBP)
void	RemoveLoudnessMeterDelegate (UAtomRackBase *InRack, const FOnAtomRackLoudnessMeterMeasureBP &OnAtomRackTruePeakMeterMeasureBP)
void	RemovePerformanceMonitorDelegate (UAtomRackBase *InRack, const FOnAtomRackPerformanceMonitorResultBP &OnAtomRackPerformanceMonitorResultBP)
void	RemoveRenderedSamplesDelegate (UAtomRackBase *InRack, const FOnAtomRackRenderedSamplesBP &OnAtomRackRenderedSamplesBP)
void	RemoveSpectralAnalysisDelegate (UAtomBus *InBus, const FOnAtomBusSpectralAnalysisBP &OnAtomBusSpectralAnalysisBP)
void	RemoveTruePeakMeterDelegate (UAtomRackBase *InRack, const FOnAtomRackTruePeakMeterMeasureBP &OnAtomRackTruePeakMeterMeasureBP)
void	RemoveUserAtomVoicePool (FName Name)
void	ResetInterpolation ()
void	ResetLoudnessMeterMeasuring (UAtomRackBase *InRack)
void	ResetPerformanceMonitor (UAtomRackBase *InRack)
virtual void	ResumeContext ()
void	RetriggerVirtualLoop (FAtomVirtualLoop &VirtualLoop)
void	SendCommandToActiveSounds (uint64 InAtomComponentID, TUniqueFunction< void(FAtomActiveSound &)> InFunc, const TStatId InStatId=TStatId())
bool	SetAtomConfiguration (const UAtomConfig *AtomConfig)
bool	SetBusChannelLevelMatrix (const UAtomBus *InBus)
bool	SetBusEffectBypass (const UAtomBus *InBus, const UAtomBusEffectPreset *InEffectPreset)
bool	SetBusEffectParameter (const UAtomBus *InBus, const UAtomBusEffectPreset *InEffectPreset, int InParameterIndex)
bool	SetBusEffectPreset (const UAtomBus *InBus, const UAtomBusEffectPreset *InEffectPreset)
void	SetBusModulationBaseLevels (UAtomBus *InAtomBus, float InVolumeModBase, float InWetModBase, float InDryModBase)
bool	SetBusPanning (const UAtomBus *InBus)
bool	SetBusSendLevel (const UAtomBus *InBus, const FAtomBusSend &InSend)
bool	SetBusVolume (const UAtomBus *InBus, float InBusVolume)
void	SetCanHaveMultipleActiveSounds (uint64 AtomComponentID, bool InCanHaveMultipleActiveSounds)
void	SetDefaultAtomSettings (UWorld *World, const FAtomReverbSettings &DefaultReverbSettings, const FAtomInteriorSettings &DefaultInteriorSettings)
void	SetGlobalFocusSettings (const FAtomGlobalFocusSettings &NewFocusSettings)
void	SetGlobalPitchModulation (float PitchScale, float TimeSec)
void	SetHRTFDisabled (bool InIsHRTFDisabled)
void	SetHRTFEnabledForAll (bool InbHRTFEnabledForAll)
void	SetListener (UWorld *World, const int32 ListenerIndex, const FTransform &ListenerTransform, const float InDeltaSeconds)
void	SetListenerAttenuationOverride (int32 ListenerIndex, const FVector AttenuationPosition)
void	SetMixDebugState (EAtomDebugState DebugState)
bool	SetRackDspBusSetting (const UAtomRack *InRack)
bool	SetRackSnapshot (const UAtomRack *InRack, float FadeSeconds)
void	SetRuntimeMuted (bool bMuted)
void	SetSoundClassDistanceScale (UAtomSoundClass *InSoundClass, float DistanceScale, float TimeSec)
void	SetSubmixDryLevel (UAtomBus *InAtomBus, float InDryLevel)
bool	SetSubmixEndpoint (const UAtomBus *InAtomBus, const UAtomEndpointBase *Endpoint=nullptr)
void	SetSubmixOutputVolume (UAtomBus *InAtomBus, float InOutputVolume)
void	SetSubmixWetLevel (UAtomBus *InAtomBus, float InWetLevel)
void	SetTransientPrimaryVolume (float TransientPrimaryVolume)
void	SetUseAttenuationForNonGameWorlds (bool bInUseAttenuationForNonGameWorlds)
void	ShowSoundClassHierarchy (FOutputDevice &Ar, UAtomSoundClass *SoundClass=nullptr, int32 Indent=0) const
bool	SoundIsAudible (UAtomSoundBase *Sound, const UWorld *World, const FVector &Location, const FAtomAttenuationSettings *AttenuationSettingsToApply, float MaxDistance, float FocusFactor) const
void	StartEnvelopeFollowing (UAtomBus *InBus)
void	StartLevelMeterMeasuring (UAtomRackBase *InRack, const FAtomLevelMeterSettings &InSettings)
void	StartLoudnessMeterMeasuring (UAtomRackBase *InRack, const FAtomLoudnessMeterSettings &InSettings)
void	StartSpectrumAnalysis (UAtomBus *InBus, const FAtomSoundSpectrumAnalyzerSettings &InSettings)
void	StartTruePeakMeterMeasuring (UAtomRackBase *InRack, const FAtomTruePeakMeterSettings &InSettings)
void	StopActiveSound (uint64 AtomComponentID, const FString *EventLogID=nullptr)
virtual void	StopAllSounds (bool bShouldStopUISounds=false)
void	StopEnvelopeFollowing (UAtomBus *InBus)
void	StopLevelMeterMeasuring (UAtomRackBase *InRack)
void	StopLoudnessMeterMeasuring (UAtomRackBase *InRack)
void	StopSoundsUsingResource (IAtomSoundResource *InSound, TArray< UAtomComponent * > *StoppedComponents=nullptr)
void	StopSpectrumAnalysis (UAtomBus *InBus)
void	StopTestComponent ()
void	StopTruePeakMeterMeasuring (UAtomRackBase *InRack)
void	Suspend (bool bGameTicking)
virtual void	SuspendContext ()
void	Teardown ()
void	UnlinkActiveSoundFromComponent (const FAtomActiveSound &InActiveSound)
void	UnloadSubmixInstance (const UAtomBus *InAtomBus)
bool	UnregisterAtomRack (const UAtomRackBase *AtomRack)
void	UnregisterSoundClass (UAtomSoundClass *InSoundClass)
void	Update (bool bGameTicking)
void	UpdateBusModulationSettings (UAtomBus *InAtomBus, const TSet< TObjectPtr< UAtomModulatorBase > > &InOutputModulation, const TSet< TObjectPtr< UAtomModulatorBase > > &InWetLevelModulation, const TSet< TObjectPtr< UAtomModulatorBase > > &InDryLevelModulation)
virtual void	UpdateGameThread ()

静的公開メンバ関数
static UAtomComponent *	CreateComponent (UAtomSoundBase *Sound, const FCreateComponentParams &Params=FCreateComponentParams())
static int32	FindClosestListenerIndex (const FTransform &SoundTransform, const TArray< FAtomListener > &InListeners)
static void	Get2DChannelMap (bool bIsVorbis, const int32 NumSourceChannels, const int32 NumOutputChannels, const bool bIsCenterChannelOnly, Atom::FAlignedFloatBuffer &OutChannelMap)
static int32	GetAtomDefaultVoicePoolIdentifier ()
static int32	GetAtomExSoundRendererNumChannels (EAtomSoundRendererType RendererType)
static int32	GetAtomExSoundRendererNumPorts (EAtomSoundRendererType RendererType)
static CriAtomSpeakerMapping	GetAtomExSoundRendererSpeakerMapping (EAtomSpeakerChannelMap ChannelMap)
static CriAtomSoundRendererType	GetAtomExSoundRendererType (EAtomSoundRendererType RendererType)
static FString	GetAtomLibraryVersionString ()
static FAtomRuntimeManager *	GetAtomRuntimeManager ()
static EAtomFormat	GetFormatFromAtomExFormat (CriAtomExFormat AtomExFormat)
static FAtomRuntimeHandle	GetMainAtomRuntime ()
static float	GetMaxWorldDistance ()
static EAtomPcmBitDepth	GetPcmBitDepthFromAtomPcmFormat (CriAtomPcmFormat AtomPcmFormat)
static int32	GetSoundfieldAtomExSoundRendererNumChannels (EAtomSoundfieldRendererType SoundfieldRendererType)
static CriAtomSpeakerMapping	GetSoundfieldAtomExSoundRendererSpeakerMapping (EAtomSoundfieldRendererType SoundfieldRendererType)
static CriAtomSoundRendererType	GetSoundfieldAtomExSoundRendererType (EAtomSoundfieldRendererType SoundfieldRendererType)
static EAtomSpeakerChannelMap	GetSpeakerChannelMapFromAtomSpeakerMapping (CriAtomSpeakerMapping AtomSpeakerMapping)
template<typename TSubsystemClass>
static FORCEINLINE TSubsystemClass *	GetSubsystem (const FAtomRuntimeHandle &InHandle)
static bool	IsSourceDataOverridePluginLoaded ()

公開変数類
EAtomDebugState	DebugState
TArray< FAtomListenerProxy >	ListenerProxies
TManaRuntimePtr	ManaRuntimeInterface
Atom::FQuartzClockManager	QuantizedEventClockManager
FCriticalSection	QuartzPersistentStateCritSec
TSharedPtr< Atom::FPersistentQuartzSubsystemData, ESPMode::ThreadSafe >	QuartzSubsystemData = nullptr
TArray< TAtomRuntimePluginPtr >	RuntimePluginInterfaces
TAtomSourceDataOverridePtr	SourceDataOverridePluginInterface

限定公開メンバ関数
bool	AddAtomAsrRack (FCriAtomExAsrRackId &&AsrRack, const UAtomRackBase &InAtomRack)
bool	AddAtomVoicePool (FCriAtomVoicePoolPtr &&VoicePool, EAtomVoicePoolCodecType CodecType, EAtomVoicePoolStreamingType StreamingType, int32 NumChannels, int32 SamplingRate, FName Name=NAME_None)
void	AddNewActiveSoundInternal (const FAtomActiveSound &InActiveSound, TArray< FAtomAisacParameter > &&InDefaultParams, FAtomVirtualLoop *InVirtualLoopToRetrigger=nullptr)
void	AddNewActiveSoundInternal (TSharedRef< FAtomActiveSound > InActiveSound, TArray< FAtomAisacParameter > &&InDefaultParams, FAtomVirtualLoop *InVirtualLoopToRetrigger=nullptr)
void	AddVirtualLoopFromMixer (const FAtomVirtualLoop &InVirtualLoop)
void	AddVirtualLoopInternal (const FAtomVirtualLoop &InVirtualLoop)
void	CreateAtomVoicePool (const FAtomVoicesSettings &VoiceSettings, EAtomVoicePoolCodecType CodecType, EAtomVoicePoolStreamingType StreamingType=EAtomVoicePoolStreamingType::Mixed, FName Name=NAME_None)
FAtomSource *	CreateSoundSource ()
FAtomSource *	CreateVoiceSource ()
virtual void	FinalizePlatformAtomLibrary ()=0
virtual FORCEINLINE CriAtomSoundRendererType	GetPlatformAtomExSoundRendererType (EAtomSoundRendererType RendererType)
virtual FORCEINLINE TSubclassOf< UAtomEndpointSettingsBase >	GetPlatformEndpointSettingsClass () const
virtual FORCEINLINE CriAtomSoundRendererType	GetPlatformSoundfieldAtomExSoundRendererType (EAtomSoundfieldRendererType SoundfieldRendererType)
virtual FORCEINLINE int32	GetPlatformSoundfieldRendererNumChannels (EAtomSoundfieldRendererType SoundfieldRendererType)
virtual FORCEINLINE CriAtomSpeakerMapping	GetPlatformSoundfieldRendererSpeakerMapping (EAtomSoundfieldRendererType SoundfieldRendererType)
virtual FORCEINLINE int32	GetPlatformSoundRendererNumChannels (EAtomSoundRendererType RendererType)
virtual FORCEINLINE int32	GetPlatformSoundRendererNumPorts (EAtomSoundRendererType RendererType)
virtual FORCEINLINE CriAtomSpeakerMapping	GetPlatformSoundRendererSpeakerMapping (EAtomSpeakerChannelMap SpeakerChannelMap)
int32	GetSortedActivePlaybackInstances (TArray< FAtomPlaybackInstance * > &InActiveSounds, const ESortedActivePlaybackGetType GetType)
void	HandlePause (bool bGameTicking, bool bGlobalPause=false)
virtual void	InitializePlatformAtomLibrary ()=0
void	InitializeSubsystemCollection ()
void	InitSoundParams (FAtomActiveSound &InOutActiveSound, TArray< FAtomAisacParameter > InDefaultParams, bool bInIsVirtualLoopRealzing) const
void	InitSoundSources ()
bool	IsMasterRack (const UAtomRackBase *InRack) const
bool	IsSpatializationRack (const UAtomRackBase *InRack) const
bool	LoadAtomRack (const UAtomRackBase &InAtomRack)
bool	LoadAtomRackBusSettings (const UAtomRack *Rack)
FCriAtomExAsrRackId	LoadGenericAtomRack (const FAtomRackInitParams &InitParams)
FCriAtomExAsrRackId	LoadGenericAtomSoundfieldRack (const FAtomSoundfieldRackInitParams &InitParams)
void	LoadMasterRack (const FSoftObjectPath &InObjectPath)
virtual FCriAtomExAsrRackId	LoadPlatformAtomRack (const FAtomRackInitParams &InitParams)
virtual FCriAtomExAsrRackId	LoadPlatformAtomSoundfieldRack (const FAtomSoundfieldRackInitParams &InitParams)
void	NotifySubsystemsActiveSoundCreated (FAtomActiveSound &ActiveSound) const
void	NotifySubsystemsActiveSoundDeleting (FAtomActiveSound &ActiveSound) const
void	NotifySubsystemsSetOwner (FAtomActiveSound &ActiveSound, const UObject *Owner) const
void	NotifySubsystemsVirtualizedSoundCreated (FAtomActiveSound &ActiveSound) const
void	NotifySubsystemsVirtualizedSoundDeleting (FAtomActiveSound &ActiveSound) const
void	OnProcessAudioStream ()
void	ProcessingPendingActiveSoundStops (bool bForceDelete=false)
void	RealizeVirtualLoopFromMixer (FAtomActiveSound &ActiveSound)
bool	RemoveVirtualLoop (FAtomActiveSound &ActiveSound)
void	ReportSoundFailedToStart (const uint64 AtomComponentID, FAtomVirtualLoop *VirtualLoop)
void	SendUpdateResultsToGameThread (int32 FirstActiveIndex)
virtual FORCEINLINE bool	SetPlatformAtomDSPBusOutput (CriAtomExAsrRackId RackID, const FString &DspBusName, const FAtomBusOutputParams &OutputParams)
void	SetupAtomDBAS ()
bool	ShouldUseAttenuation (const UWorld *World) const
bool	SoundIsAudible (const FAtomActiveSound &NewActiveSound)
void	StartSources (TArray< FAtomPlaybackInstance * > &InActiveSounds, int32 FirstActiveIndex, bool bGameTicking)
void	StopOldestStoppingSource ()
void	StopSources (TArray< FAtomPlaybackInstance * > &InActiveSounds, int32 FirstActiveIndex)
void	UpdateActiveSoundPlaybackTime (bool bIsGameTicking)
void	UpdateAtomEngineSubsystems ()
virtual void	UpdateAtomLibrary ()
void	UpdateAtomMixer ()
void	UpdateBusEffectParameters ()
void	UpdateConcurrency (TArray< FAtomPlaybackInstance * > &PlaybackInstances, TArray< FAtomActiveSound * > &ActiveSoundsCopy)
void	UpdateProfilers ()
void	UpdateRuntimeDeltaTime ()
void	UpdateVirtualLoops (bool bForceUpdate)
void	VirtualizeInactiveLoops ()

限定公開変数類
TMap< const UAtomRackBase *, FCriAtomExAsrRackId >	AsrRacks
FCriticalSection	AsrRacksCS
std::atomic< int32 >	AtomServerThreadID
TSet< FBusEffectToUpdateInfo >	BusEffectsToUpdate
TQueue< TFunction< void()> >	CommandQueue
FAtomConcurrencyManager	ConcurrencyManager
FCriAtomDbasId	DbasID
int	DbasMaxBPS
int	DbasMaxStreams
TArray< UAtomBus * >	DelegateBoundBuses
int32	GameOrAtomThreadID
TMpscQueue< TFunction< void()> >	GameThreadCommandQueue
TArray< FMatrix >	InverseListenerTransforms
TArray< FAtomListener >	Listeners
Atom::FMixerSubmixPtr	MainSubmixInstance
TMap< FName, TStrongObjectPtr< const UAtomRackBase > >	OutputPortRackMap
ICriWarePlatformAtom *	PlatformAtom
FAtomPluginInitializationParams	PluginInitializationParams
TUniquePtr< Atom::FMixerSourceManager >	SourceManager
TQueue< Atom::FMixerSourceVoice * >	SourceVoices
Atom::FSubmixMap	Submixes
TArray< Atom::FVoicePool >	VoicesPools

非公開メンバ関数
void	CacheChannelMap (const int32 NumSourceChannels, const int32 NumOutputChannels, const bool bIsCenterChannelOnly)
void	FinalizeAtomLibrary ()
Atom::FMixerPlatformInfo	GetPlatformInfo ()
void	InitializeAtomLibrary ()
void	InitializeChannelAzimuthMap (const int32 NumChannels)
void	InitializeChannelMaps ()
void	InitMasterRack ()
void	InitOuputPortMappings ()
void	InitRacks ()
void	InitSpatializationRack ()
void	NotifyPluginListenersWorldChanged (UWorld *World)
virtual void	OnListenerUpdated (const TArray< FAtomListener > &InListeners)
void	ParseSoundClasses (float InDeltaTime)
void	PumpCommandQueue ()
void	PumpGameThreadCommandQueue ()
void	RecurseIntoSoundClasses (UAtomSoundClass *CurrentClass, FAtomSoundClassProperties &ParentProperties)
void	ResetAudioRenderingThreadID ()
void	UpdateReferencedSounds ()
void	UpdateSoundClassProperties (float DeltaTime)

非公開変数類
TArray< FAtomPlaybackInstance * >	ActivePlaybackInstances
TArray< FAtomActiveSound * >	ActiveSounds
double	AtomClock
TMap< uint64, TArray< FAtomActiveSound * > >	AtomComponentIDToActiveSoundMap
TMap< uint64, bool >	AtomComponentIDToCanHaveMultipleActiveSoundsMap
const UAtomConfig *	AtomConfig
FCriticalSection	AudioRenderCritSec
uint8	bAllowCenterChannel3DPanning: 1
uint8	bAtomMixerInterfaceEnabled: 1
uint8	bGameWasTicking: 1
uint8	bHRTFDisabled: 1
bool	bHRTFDisabled_OnGameThread
uint8	bHRTFEnabledForAll: 1
bool	bHRTFEnabledForAll_OnGameThread
uint8	bIsAtomLibraryInitialized: 1
uint8	bIsInitialized: 1
uint8	bIsMasterRackInitialized: 1
uint8	bIsRuntimeMuted: 1
uint8	bManaRuntimeInterfaceEnabled: 1
uint8	bSourceDataOverrideInterfaceEnabled: 1
uint8	bUseAttenuationForNonGameWorlds: 1
uint8	bUseMixerVoiceManagement: 1
uint8	bUseUnrealSoundRenderer: 1
uint64	CurrentTick
Atom::FChannelPositionInfo	DefaultChannelAzimuthPositions [Atom::MaxSupportedSpeakers]
TMap< UAtomSoundClass *, FAtomSoundClassDynamicProperties >	DynamicSoundClassProperties
friend	FAtomSource
TArray< FAtomSource * >	FreeSources
FAtomGlobalFocusSettings	GlobalFocusSettings
FAtomGlobalFocusSettings	GlobalFocusSettings_GameThread
float	GlobalMaxPitch
float	GlobalMinPitch
FAtomDynamicParameter	GlobalPitchScale
double	LastUpdateTime
UAtomRack *	MasterRack
int32	MaxSources
TSharedPtr< AtomModulation::FAtomModulationSystem >	ModulationSystem
EAtomMonoChannelUpmixMethod	MonoChannelUpmixMethod
int32	NumReservedSources
uint32	OneShotCount
EAtomPanningMethod	PanningMethod
TArray< FAtomActiveSound * >	PendingSoundsToDelete
TSet< FAtomActiveSound * >	PendingSoundsToStop
Atom::FMixerPlatformInfo	PlatformInfo
TMap< FAtomPlaybackInstance *, FAtomSource * >	PlaybackInstanceSourceMap
TArray< UAtomSoundBase * >	PrecachingSounds
float	PreviousPrimaryVolume
float	PrimaryVolume
FCriticalSection	ReferencedSoundCriticalSection
TArray< UAtomSoundBase * >	ReferencedSounds
TArray< UAtomSoundBase * >	ReferencedSounds_AtomThread
TArray< Atom::FChannelPositionInfo >	RuntimeChannelAzimuthPositions
FDelegateHandle	RuntimeCreatedHandle
float	RuntimeDeltaTime
FDelegateHandle	RuntimeDestroyedHandle
FAtomRuntimeId	RuntimeID
TMap< UAtomSoundClass *, FAtomSoundClassProperties >	SoundClasses
TMap< UAtomSoundClass *, Atom::FMixerPlayerGroupPtr >	SoundClassPlayerGroups
TArray< FAtomSource * >	Sources
int32	SpatializationBusIndex
FString	SpatializationBusName
UAtomRackBase *	SpatializationRack
FAtomSubsystemCollection	SubsystemCollection
TStrongObjectPtr< UAtomSubsystemCollectionRoot >	SubsystemCollectionRoot
TStrongObjectPtr< UAtomComponent >	TestAtomComponent
TArray< FAtomSource * >	ToRemoveSources
float	TransientPrimaryVolume
TMap< FAtomActiveSound *, FAtomVirtualLoop >	VirtualLoops
TMap< uint32, TPair< FAtomReverbSettings, FAtomInteriorSettings > >	WorldIDToDefaultAtomVolumeSettingsMap

フレンド
class	FAtomConcurrencyManager

型定義メンバ詳解

FToggleSoloPtr

using FAtomRuntime::FToggleSoloPtr = void (Atom::FAtomDebugger::*)(FName InName, bool bExclusive)

Handles all argument parsing for the solo commands in one place

構築子と解体子

FAtomRuntime()

FAtomRuntime::FAtomRuntime

(

ICriWarePlatformAtom *

InPlatformAtom

)

~FAtomRuntime()

FAtomRuntime::~FAtomRuntime ( )

virtual

関数詳解

Activate()

void FAtomRuntime::Activate

(

bool

bFadeIn = false

)

AddAtomAsrRack()

bool FAtomRuntime::AddAtomAsrRack ( FCriAtomExAsrRackId && AsrRack, const UAtomRackBase & InAtomRack )

protected

Add a fully created asr rack.

AddAtomVoicePool()

bool FAtomRuntime::AddAtomVoicePool ( FCriAtomVoicePoolPtr && VoicePool, EAtomVoicePoolCodecType CodecType, EAtomVoicePoolStreamingType StreamingType, int32 NumChannels, int32 SamplingRate, FName Name = NAME_None )

protected

Add a fully created voice pool.

AddEnvelopeFollowerDelegate()

void FAtomRuntime::AddEnvelopeFollowerDelegate	(	UAtomBus *	InBus,
		const FOnAtomBusEnvelopeBP &	OnAtomBusEnvelopeBP )

Adds an envelope follower delegate to given UAtomBus for this runtime.

AddLevelMeterDelegate()

void FAtomRuntime::AddLevelMeterDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackLevelMeterMeasureBP &	OnAtomRackLevelMeterMeasureBP )

AddLoudnessMeterDelegate()

void FAtomRuntime::AddLoudnessMeterDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackLoudnessMeterMeasureBP &	OnAtomRackTruePeakMeterMeasureBP )

AddNewActiveSound() [1/3]

void FAtomRuntime::AddNewActiveSound	(	const FAtomActiveSound &	ActiveSound,
		const TArray< FAtomAisacParameter > *	InDefaultParams = nullptr,
		const FString *	EventLogID = nullptr )

Adds an active sound to the Atom runtime

AddNewActiveSound() [2/3]

void FAtomRuntime::AddNewActiveSound	(	const FAtomActiveSound &	ActiveSound,
		TArray< FAtomAisacParameter > &&	InDefaultParams )

Adds an active sound to the Atom runtime

AddNewActiveSound() [3/3]

void FAtomRuntime::AddNewActiveSound	(	TSharedRef< FAtomActiveSound >	ActiveSound,
		TArray< FAtomAisacParameter > &&	InDefaultParams,
		const FString *	EventLogID = nullptr )

Adds an active sound to the Atom runtime

AddNewActiveSoundInternal() [1/2]

void FAtomRuntime::AddNewActiveSoundInternal ( const FAtomActiveSound & InActiveSound, TArray< FAtomAisacParameter > && InDefaultParams, FAtomVirtualLoop * InVirtualLoopToRetrigger = nullptr )

protected

Adds an active sound to the Atom runtime.

AddNewActiveSoundInternal() [2/2]

void FAtomRuntime::AddNewActiveSoundInternal ( TSharedRef< FAtomActiveSound > InActiveSound, TArray< FAtomAisacParameter > && InDefaultParams, FAtomVirtualLoop * InVirtualLoopToRetrigger = nullptr )

protected

Adds an active sound to the Atom runtime.

AddPatchForSubmix()

Audio::FPatchOutputStrongPtr FAtomRuntime::AddPatchForSubmix	(	uint32	InObjectId,
		float	InPatchGain )

AddPerformanceMonitorDelegate()

void FAtomRuntime::AddPerformanceMonitorDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackPerformanceMonitorResultBP &	OnAtomRackPerformanceMonitorResultBP )

AddReferencedObjects()

void FAtomRuntime::AddReferencedObjects

(

FReferenceCollector &

Collector

)

Track references to UObjects

AddRenderedSamplesDelegate()

void FAtomRuntime::AddRenderedSamplesDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackRenderedSamplesBP &	OnAtomRackRenderedSamplesBP )

AddSoundToStop()

void FAtomRuntime::AddSoundToStop

(

FAtomActiveSound *

SoundToStop

)

Marks a sound to be stopped. Returns true if added to stop, false if already pending stop.

AddSpectralAnalysisDelegate()

void FAtomRuntime::AddSpectralAnalysisDelegate	(	UAtomBus *	InBus,
		const FAtomSoundSpectrumAnalyzerDelegateSettings &	InDelegateSettings,
		const FOnAtomBusSpectralAnalysisBP &	OnAtomBusSpectralAnalysisBP )

AddTruePeakMeterDelegate()

void FAtomRuntime::AddTruePeakMeterDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackTruePeakMeterMeasureBP &	OnAtomRackTruePeakMeterMeasureBP )

AddUserAtomVoicePool()

void FAtomRuntime::AddUserAtomVoicePool	(	FName	Name,
		const FAtomVoicesSettings &	VoiceSettings,
		EAtomVoicePoolCodecType	CodecType = EAtomVoicePoolCodecType::Standard,
		EAtomVoicePoolStreamingType	StreamingType = EAtomVoicePoolStreamingType::Mixed )

AddVirtualLoop()

void FAtomRuntime::AddVirtualLoop

(

const FAtomVirtualLoop &

InVirtualLoop

)

Add provided loop (virtualized active sound)

AddVirtualLoopFromMixer()

void FAtomRuntime::AddVirtualLoopFromMixer ( const FAtomVirtualLoop & InVirtualLoop )

protected

Add provided loop (virtualized active sound)

AddVirtualLoopInternal()

void FAtomRuntime::AddVirtualLoopInternal ( const FAtomVirtualLoop & InVirtualLoop )

protected

ApplyInteriorSettings()

void FAtomRuntime::ApplyInteriorSettings	(	FAtomActiveSound &	ActiveSound,
		FAtomSoundParseParameters &	ParseParams ) const

Applies interior settings from affecting volumes to the active sound (called on Atom thread)

AttachAisacPatchToCategory()

bool FAtomRuntime::AttachAisacPatchToCategory	(	const FAtomCategory &	Category,
		const UAtomAisacPatch *	AisacPatch )

AudioRenderThreadCommand()

void FAtomRuntime::AudioRenderThreadCommand

(

TFunction< void()>

Command

)

CacheChannelMap()

void FAtomRuntime::CacheChannelMap ( const int32 NumSourceChannels, const int32 NumOutputChannels, const bool bIsCenterChannelOnly )

private

CanHaveMultipleActiveSounds()

bool FAtomRuntime::CanHaveMultipleActiveSounds

(

uint64

AtomComponentID

)

const

Whether a given Audio Component ID should be allowed to have multiple associated Active Sounds

CheckAtomThread()

void FAtomRuntime::CheckAtomThread

(

)

const

CheckAudioRenderingThread()

void FAtomRuntime::CheckAudioRenderingThread

(

)

const

ClampPitch()

float FAtomRuntime::ClampPitch

(

float

InPitchScale

)

const

ClearListenerAttenuationOverride()

void FAtomRuntime::ClearListenerAttenuationOverride

(

int32

ListenerIndex

)

Removes a listener attenuation override (also called focus point) for the specified listener.

CreateAtomVoicePool()

void FAtomRuntime::CreateAtomVoicePool ( const FAtomVoicesSettings & VoiceSettings, EAtomVoicePoolCodecType CodecType, EAtomVoicePoolStreamingType StreamingType = EAtomVoicePoolStreamingType::Mixed, FName Name = NAME_None )

protected

Convenient function to create voices pools.

CreateComponent()

UAtomComponent * FAtomRuntime::CreateComponent ( UAtomSoundBase * Sound, const FCreateComponentParams & Params = FCreateComponentParams() )

static

Creates an Atom component to handle playing a sound.

引数

Sound	The UAtomSoundBase to play at the location.
Params	The parameter block of properties to create the component based on

戻り値

The created Atom component if the function successfully created one or a nullptr if not successful. Note: if audio is disabled or if there were no hardware audio devices available, this will return nullptr.

CreateSoundSource()

FAtomSource * FAtomRuntime::CreateSoundSource ( )

protected

Creates a new Atom source for any playback with single or mixed voices. (AtomExPlayer)

CreateVoiceSource()

FAtomSource * FAtomRuntime::CreateVoiceSource ( )

protected

Creates a new Atom source for single, non 3d, voice playback. (AtomPlayer)

Deactivate()

void FAtomRuntime::Deactivate

(

bool

bFadeOut = false

)

Deinitialize()

void FAtomRuntime::Deinitialize

(

)

De-initialization step that occurs after runtime destroyed broadcast, but before removal from the runtime manager.

DetachAisacPatchFromCategory()

bool FAtomRuntime::DetachAisacPatchFromCategory	(	const FAtomCategory &	Category,
		const UAtomAisacPatch *	AisacPatch )

DrawRacks()

void FAtomRuntime::DrawRacks	(	FOutputDevice &	InOutput,
		const TArray< FString > &	InArgs ) const

FadeIn()

virtual void FAtomRuntime::FadeIn ( )

inlinevirtual

FadeOut()

virtual void FAtomRuntime::FadeOut ( )

inlinevirtual

Optional fadeout and fade in of audio to avoid clicks when closing or opening/reusing Atom runtime.

FinalizeAtomLibrary()

void FAtomRuntime::FinalizeAtomLibrary ( )

private

FinalizePlatformAtomLibrary()

virtual void FAtomRuntime::FinalizePlatformAtomLibrary ( )

protectedpure virtual

FAtomRuntimeAndroid, FAtomRuntimeApple, FAtomRuntimeLinux, FAtomRuntimeUnrealAudio, FAtomRuntimeWindowsで実装されています。

FindClosestListenerIndex() [1/3]

int32 FAtomRuntime::FindClosestListenerIndex

(

const FTransform &

SoundTransform

)

const

Returns the index of the listener closest to the given sound transform

FindClosestListenerIndex() [2/3]

int32 FAtomRuntime::FindClosestListenerIndex ( const FTransform & SoundTransform, const TArray< FAtomListener > & InListeners )

static

Returns the index of the listener closest to the given sound transform

FindClosestListenerIndex() [3/3]

int32 FAtomRuntime::FindClosestListenerIndex	(	const FVector &	Position,
		float &	OutSqDistance,
		bool	AllowAttenuationOverrides ) const

FindSubmixInstanceByObjectID()

Atom::FMixerSubmixPtr FAtomRuntime::FindSubmixInstanceByObjectID

(

uint32

InObjectID

)

const

Flush()

void FAtomRuntime::Flush

(

UWorld *

WorldToFlush

)

Stop all the Atom components and sources attached to the world. nullptr world means all components.

FlushAudioRenderingCommands()

void FAtomRuntime::FlushAudioRenderingCommands ( bool bPumpSynchronously = false )

virtual

Allows Audio rendering command queue to flush during Atom runtime flush. (Override in platforms if need extra native audio rendering command)

引数

bPumpSynchronously

must be called in situations where the Atom render thread is not being called.

FlushExtended()

void FAtomRuntime::FlushExtended ( UWorld * WorldToFlush )

virtual

GameThreadMPSCCommand()

void FAtomRuntime::GameThreadMPSCCommand

(

TFunction< void()>

InCommand

)

GatherInteriorData()

void FAtomRuntime::GatherInteriorData	(	FAtomActiveSound &	ActiveSound,
		FAtomSoundParseParameters &	ParseParams ) const

Gathers data about interior volumes affecting the active sound (called on Atom thread)

Get2DChannelMap() [1/2]

void FAtomRuntime::Get2DChannelMap	(	bool	bIsVorbis,
		const int32	NumSourceChannels,
		const bool	bIsCenterChannelOnly,
		Atom::FAlignedFloatBuffer &	OutChannelMap ) const

Get2DChannelMap() [2/2]

void FAtomRuntime::Get2DChannelMap ( bool bIsVorbis, const int32 NumSourceChannels, const int32 NumOutputChannels, const bool bIsCenterChannelOnly, Atom::FAlignedFloatBuffer & OutChannelMap )

static

NO_LOGGING

GetActivePlaybackInstances()

const TArray< FAtomPlaybackInstance * > & FAtomRuntime::GetActivePlaybackInstances ( ) const

inline

GetActiveSounds()

const TArray< FAtomActiveSound * > & FAtomRuntime::GetActiveSounds ( ) const

inline

GetAsrRackId()

CriAtomExAsrRackId FAtomRuntime::GetAsrRackId

(

const UAtomRackBase *

InRack

)

const

Retreive the native implementation id for a given AtomRack. Returns -1 if fails.

GetAtomClock()

double FAtomRuntime::GetAtomClock ( ) const

inline

Returns the audio clock of the Atom runtime.

GetAtomConfiguration()

FORCEINLINE const UAtomConfig * FAtomRuntime::GetAtomConfiguration ( ) const

inline

Get the currently used Atom Config. (May be null, test-it before use.)

GetAtomDefaultVoicePoolIdentifier()

int32 FAtomRuntime::GetAtomDefaultVoicePoolIdentifier ( )

static

GetAtomExSoundRendererNumChannels()

int32 FAtomRuntime::GetAtomExSoundRendererNumChannels ( EAtomSoundRendererType RendererType )

static

GetAtomExSoundRendererNumPorts()

int32 FAtomRuntime::GetAtomExSoundRendererNumPorts ( EAtomSoundRendererType RendererType )

static

GetAtomExSoundRendererSpeakerMapping()

CriAtomSpeakerMapping FAtomRuntime::GetAtomExSoundRendererSpeakerMapping ( EAtomSpeakerChannelMap ChannelMap )

static

GetAtomExSoundRendererType()

CriAtomSoundRendererType FAtomRuntime::GetAtomExSoundRendererType ( EAtomSoundRendererType RendererType )

static

Generic platforms ASR settings

GetAtomLibraryVersionString()

FString FAtomRuntime::GetAtomLibraryVersionString ( )

static

GetAtomModulationSystem()

AtomModulation::FAtomModulationSystem * FAtomRuntime::GetAtomModulationSystem ( ) const

inline

GetAtomRuntimeID()

FORCEINLINE FAtomRuntimeId FAtomRuntime::GetAtomRuntimeID ( ) const

inline

GetAtomRuntimeManager()

FAtomRuntimeManager * FAtomRuntime::GetAtomRuntimeManager ( )

inlinestatic

Returns the Atom runtime manager

GetAzimuth()

void FAtomRuntime::GetAzimuth	(	const FAtomAttenuationListenerData &	OutListenerData,
		float &	OutAzimuth,
		float &	AbsoluteAzimuth ) const

Returns the azimuth angle of the sound relative to the sound's nearest listener. Used for 3d audio calculations.

GetBusEffectBypass()

bool FAtomRuntime::GetBusEffectBypass	(	const UAtomBus *	InBus,
		const UAtomBusEffectPreset *	InEffectPreset ) const

Get bus effect by-pass of AtomBusEffectPreset from Atom runtime bus.

GetBusEffectParameter()

float FAtomRuntime::GetBusEffectParameter	(	const UAtomBus *	InBus,
		const UAtomBusEffectPreset *	InEffectPreset,
		int	InParameterIndex ) const

Get bus effect parameter of AtomBusEffectPreset from Atom runtime bus.

GetBusEffectPreset()

bool FAtomRuntime::GetBusEffectPreset	(	const UAtomBus *	InBus,
		UAtomBusEffectPreset *	InEffectPreset )

Get all settings of AtomBusEffectPreset from Atom runtime bus.

GetBusPanning()

bool FAtomRuntime::GetBusPanning	(	const UAtomBus *	InBus,
		FAtomPanning &	OutPanning ) const

Get spatialization panning settings from Atom runtime bus.

GetBusVolume()

float FAtomRuntime::GetBusVolume

(

const UAtomBus *

InBus

)

const

Get bus volume setting from Atom runtime bus.

GetChannelArray()

const TArray< Atom::EMixerSpeaker > & FAtomRuntime::GetChannelArray

(

)

const

GetConcurrencyManager() [1/2]

FAtomConcurrencyManager & FAtomRuntime::GetConcurrencyManager ( )

inline

GetConcurrencyManager() [2/2]

const FAtomConcurrencyManager & FAtomRuntime::GetConcurrencyManager ( ) const

inline

GetDefaultAtomSettings()

bool FAtomRuntime::GetDefaultAtomSettings	(	uint32	WorldID,
		FAtomReverbSettings &	OutReverbSettings,
		FAtomInteriorSettings &	OutInteriorSettings ) const

Gets the default reverb and interior settings for the provided world. Returns true if settings with WorldID were located.

GetDefaultChannelPositions()

const Atom::FChannelPositionInfo * FAtomRuntime::GetDefaultChannelPositions

(

)

const

GetDefaultPositionMap()

TArray< Atom::FChannelPositionInfo > * FAtomRuntime::GetDefaultPositionMap

(

int32

NumChannels

)

GetDistanceSquaredToListener()

bool FAtomRuntime::GetDistanceSquaredToListener	(	const FVector &	Location,
		int32	ListenerIndex,
		float &	OutSqDistance ) const

Sets OutSqDistance to the distance from location to the appropriate listener representation, depending on calling thread. Returns true if listener position is valid, false if not (in which case, OutSqDistance is undefined).

GetDistanceSquaredToNearestListener()

bool FAtomRuntime::GetDistanceSquaredToNearestListener	(	const FVector &	Location,
		float &	OutSqDistance ) const

Sets OutSqDistance to the distance from location the closest listener, depending on calling thread. Returns true if listener position is valid, false if not (in which case, OutSqDistance is undefined).

GetDistanceToNearestListener()

float FAtomRuntime::GetDistanceToNearestListener

(

const FVector &

Location

)

const

Returns the distance to the nearest listener from the given location

GetExPlayerHandle()

CriAtomExPlayerHn FAtomRuntime::GetExPlayerHandle

(

const FAtomPlaybackInstance *

InPlaybackInstance

)

const

Retreive the SDK handle for a given AtomPlaybackInstance. Returns nullptr if fails.

GetFocusFactor()

float FAtomRuntime::GetFocusFactor	(	const float	Azimuth,
		const FAtomAttenuationSettings &	AttenuationSettings ) const

Returns the focus factor of a sound based on its position and listener data.

GetFormatFromAtomExFormat()

EAtomFormat FAtomRuntime::GetFormatFromAtomExFormat ( CriAtomExFormat AtomExFormat )

static

GetGameDeltaTime()

float FAtomRuntime::GetGameDeltaTime

(

)

const

Returns the game's delta time

GetGlobalFocusSettings()

const FAtomGlobalFocusSettings & FAtomRuntime::GetGlobalFocusSettings

(

)

const

GetGlobalPitchRange()

TRange< float > FAtomRuntime::GetGlobalPitchRange

(

)

const

Returns global pitch range.

GetGlobalPitchScale()

const FAtomDynamicParameter & FAtomRuntime::GetGlobalPitchScale ( ) const

inline

GetListenerPosition()

bool FAtomRuntime::GetListenerPosition	(	int32	ListenerIndex,
		FVector &	OutPosition,
		bool	bAllowOverride ) const

Returns a position from the appropriate listener representation, depending on calling thread.

引数

ListenerIndex	index of the listener or proxy
OutPosition	filled in position of the listener or proxy
bAllowOverride	if true we will use the attenuation override for position, if set

戻り値

true if successful

GetListeners()

const TArray< FAtomListener > & FAtomRuntime::GetListeners ( ) const

inline

GetListenerTransform()

bool FAtomRuntime::GetListenerTransform	(	int32	ListenerIndex,
		FTransform &	OutTransform ) const

Returns the transform of the appropriate listener representation, depending on calling thread

GetListenerTransformedDirection()

FVector FAtomRuntime::GetListenerTransformedDirection	(	const FVector &	Position,
		float *	OutDistance )

Gets the direction of the given position vector transformed relative to listener.

引数

Position	Input position vector to transform relative to listener
OutDistance	Optional output of distance from position to listener

戻り値

The input position relative to the listener.

GetListenerWorldID()

bool FAtomRuntime::GetListenerWorldID	(	int32	ListenerIndex,
		uint32 &	OutWorldID ) const

Returns the WorldID of the appropriate listener representation, depending on calling thread

GetMagnitudesForFrequencies()

void FAtomRuntime::GetMagnitudesForFrequencies	(	UAtomBus *	InBus,
		const TArray< float > &	InFrequencies,
		TArray< float > &	OutMagnitudes )

GetMainAtomRuntime()

FAtomRuntimeHandle FAtomRuntime::GetMainAtomRuntime ( )

inlinestatic

Returns the main Atom runtime of the engine

GetMainSubmix()

Atom::FMixerSubmixWeakPtr FAtomRuntime::GetMainSubmix

(

)

const

GetMainSubmixObject()

UAtomBus & FAtomRuntime::GetMainSubmixObject

(

)

const

GetMappedOutputPortNames()

TArray< FName > FAtomRuntime::GetMappedOutputPortNames

(

const UAtomRackBase *

AtomRack

)

const

Retrieves the names of output ports mapped with a given rack maps.

GetMasterRack()

FORCEINLINE UAtomRack * FAtomRuntime::GetMasterRack ( ) const

inline

Get the currently used master AtomRack.

GetMaxChannels()

int32 FAtomRuntime::GetMaxChannels

(

)

const

Returns the max channels used by the runtime.

GetMaxDistanceAndFocusFactor()

void FAtomRuntime::GetMaxDistanceAndFocusFactor	(	UAtomSoundBase *	Sound,
		const UWorld *	World,
		const FVector &	Location,
		const FAtomAttenuationSettings *	AttenuationSettingsToApply,
		float &	OutMaxDistance,
		float &	OutFocusFactor )

Gets the max distance and focus factor of a sound.

GetMaxSources()

int32 FAtomRuntime::GetMaxSources

(

)

const

Returns the maximum sources used by the runtime set on initialization, including the number of stopping sources reserved.

GetMaxWorldDistance()

float FAtomRuntime::GetMaxWorldDistance ( )

static

Returns the global maximum distance used in the Atom sound engine.

GetMixDebugState()

EAtomDebugState FAtomRuntime::GetMixDebugState ( ) const

inline

Gets the current Atom debug state

GetMixerSourceVoice()

Atom::FMixerSourceVoice * FAtomRuntime::GetMixerSourceVoice

(

)

GetMonoChannelUpmixMethod()

EAtomMonoChannelUpmixMethod FAtomRuntime::GetMonoChannelUpmixMethod ( ) const

inline

GetNumRacks()

int32 FAtomRuntime::GetNumRacks ( )

inline

GetPcmBitDepthFromAtomPcmFormat()

EAtomPcmBitDepth FAtomRuntime::GetPcmBitDepthFromAtomPcmFormat ( CriAtomPcmFormat AtomPcmFormat )

static

GetPhasesForFrequencies()

void FAtomRuntime::GetPhasesForFrequencies	(	UAtomBus *	InBus,
		const TArray< float > &	InFrequencies,
		TArray< float > &	OutPhases )

GetPlatformAtomExSoundRendererType()

virtual FORCEINLINE CriAtomSoundRendererType FAtomRuntime::GetPlatformAtomExSoundRendererType ( EAtomSoundRendererType RendererType )

inlineprotectedvirtual

FAtomRuntimeAndroid, FAtomRuntimeApple, FAtomRuntimeLinux, FAtomRuntimeUnrealAudio, FAtomRuntimeWindowsで再実装されています。

GetPlatformEndpointSettingsClass()

virtual FORCEINLINE TSubclassOf< UAtomEndpointSettingsBase > FAtomRuntime::GetPlatformEndpointSettingsClass ( ) const

inlineprotectedvirtual

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

GetPlatformInfo()

Atom::FMixerPlatformInfo FAtomRuntime::GetPlatformInfo ( )

private

GetPlatformSoundfieldAtomExSoundRendererType()

virtual FORCEINLINE CriAtomSoundRendererType FAtomRuntime::GetPlatformSoundfieldAtomExSoundRendererType ( EAtomSoundfieldRendererType SoundfieldRendererType )

inlineprotectedvirtual

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

GetPlatformSoundfieldRendererNumChannels()

virtual FORCEINLINE int32 FAtomRuntime::GetPlatformSoundfieldRendererNumChannels ( EAtomSoundfieldRendererType SoundfieldRendererType )

inlineprotectedvirtual

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

GetPlatformSoundfieldRendererSpeakerMapping()

virtual FORCEINLINE CriAtomSpeakerMapping FAtomRuntime::GetPlatformSoundfieldRendererSpeakerMapping ( EAtomSoundfieldRendererType SoundfieldRendererType )

inlineprotectedvirtual

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

GetPlatformSoundRendererNumChannels()

virtual FORCEINLINE int32 FAtomRuntime::GetPlatformSoundRendererNumChannels ( EAtomSoundRendererType RendererType )

inlineprotectedvirtual

FAtomRuntimeAndroid, FAtomRuntimeApple, FAtomRuntimeLinux, FAtomRuntimeUnrealAudio, FAtomRuntimeWindowsで再実装されています。

GetPlatformSoundRendererNumPorts()

virtual FORCEINLINE int32 FAtomRuntime::GetPlatformSoundRendererNumPorts ( EAtomSoundRendererType RendererType )

inlineprotectedvirtual

FAtomRuntimeAndroid, FAtomRuntimeApple, FAtomRuntimeLinux, FAtomRuntimeUnrealAudio, FAtomRuntimeWindowsで再実装されています。

GetPlatformSoundRendererSpeakerMapping()

virtual FORCEINLINE CriAtomSpeakerMapping FAtomRuntime::GetPlatformSoundRendererSpeakerMapping ( EAtomSpeakerChannelMap SpeakerChannelMap )

inlineprotectedvirtual

GetPlaybackInstanceSourceMap()

const TMap< FAtomPlaybackInstance *, FAtomSource * > & FAtomRuntime::GetPlaybackInstanceSourceMap ( ) const

inline

GetPlayerHandle()

CriAtomPlayerHn FAtomRuntime::GetPlayerHandle

(

const FAtomPlaybackInstance *

InPlaybackInstance

)

const

GetPrimaryVolume()

float FAtomRuntime::GetPrimaryVolume ( ) const

inline

Returns the volume that combines transient master volume and the FApp::GetVolumeMultiplier() value

GetRackNumOutputChannels()

int32 FAtomRuntime::GetRackNumOutputChannels

(

UAtomRackBase *

InRack

)

const

GetRackSampleRate()

int32 FAtomRuntime::GetRackSampleRate

(

UAtomRackBase *

InRack

)

const

GetRackSnapshotName()

FString FAtomRuntime::GetRackSnapshotName

(

const UAtomRack *

InRack

)

const

Get snapshot name from Atom runtime rack.

GetRackSpeakerChannelMapToApply()

EAtomSpeakerChannelMap FAtomRuntime::GetRackSpeakerChannelMapToApply

(

const UAtomRack *

InRack

)

const

Helper to get the speaker channel map to apply.

GetRuntimeDeltaTime()

float FAtomRuntime::GetRuntimeDeltaTime

(

)

const

Returns the current audio device update delta time.

GetRuntimeNumOutputChannels()

int32 FAtomRuntime::GetRuntimeNumOutputChannels

(

)

const

GetRuntimeNumOutputFrames()

int32 FAtomRuntime::GetRuntimeNumOutputFrames

(

)

const

GetRuntimeSampleRate()

int32 FAtomRuntime::GetRuntimeSampleRate

(

)

const

GetSortedActivePlaybackInstances()

int32 FAtomRuntime::GetSortedActivePlaybackInstances ( TArray< FAtomPlaybackInstance * > & InActiveSounds, const ESortedActivePlaybackGetType GetType )

protected

Iterate over the active AtomComponents for active sounds that could be playing.

戻り値

GetSoundClassCurrentProperties()

FAtomSoundClassProperties * FAtomRuntime::GetSoundClassCurrentProperties

(

UAtomSoundClass *

InSoundClass

)

Gets the current properties of a sound class, if the sound class hasn't been registered, then it returns nullptr.

GetSoundClassDynamicProperties()

FAtomSoundClassDynamicProperties * FAtomRuntime::GetSoundClassDynamicProperties

(

UAtomSoundClass *

InSoundClass

)

Returns the parameters which are dynamic from the given sound class.

GetSoundClassInfo()

void FAtomRuntime::GetSoundClassInfo

(

TMap< FName, FAtomClassDebugInfo > &

AtomClassInfos

)

Gets a summary of loaded sound collated by class

GetSoundfieldAtomExSoundRendererNumChannels()

int32 FAtomRuntime::GetSoundfieldAtomExSoundRendererNumChannels ( EAtomSoundfieldRendererType SoundfieldRendererType )

static

GetSoundfieldAtomExSoundRendererSpeakerMapping()

CriAtomSpeakerMapping FAtomRuntime::GetSoundfieldAtomExSoundRendererSpeakerMapping ( EAtomSoundfieldRendererType SoundfieldRendererType )

static

GetSoundfieldAtomExSoundRendererType()

CriAtomSoundRendererType FAtomRuntime::GetSoundfieldAtomExSoundRendererType ( EAtomSoundfieldRendererType SoundfieldRendererType )

static

GetSoundSource()

FAtomSource * FAtomRuntime::GetSoundSource

(

const FAtomPlaybackInstance *

InPlaybackInstance

)

const

GetSourceManager() [1/2]

Atom::FMixerSourceManager * FAtomRuntime::GetSourceManager

(

)

GetSourceManager() [2/2]

const Atom::FMixerSourceManager * FAtomRuntime::GetSourceManager

(

)

const

GetSpatializationBusIndex()

FORCEINLINE int32 FAtomRuntime::GetSpatializationBusIndex ( ) const

inline

GetSpatializationBusName()

FORCEINLINE FString FAtomRuntime::GetSpatializationBusName ( ) const

inline

GetSpatializationRack()

FORCEINLINE UAtomRackBase * FAtomRuntime::GetSpatializationRack ( ) const

inline

Get the currently used master AtomRack.

GetSpeakerChannelMapFromAtomSpeakerMapping()

EAtomSpeakerChannelMap FAtomRuntime::GetSpeakerChannelMapFromAtomSpeakerMapping ( CriAtomSpeakerMapping AtomSpeakerMapping )

static

GetSubmixInstance()

Atom::FMixerSubmixWeakPtr FAtomRuntime::GetSubmixInstance

(

const UAtomBus *

InAtomBus

)

const

GetSubsystem() [1/2]

template<typename TSubsystemClass>

TSubsystemClass * FAtomRuntime::GetSubsystem ( ) const

inline

Get a Subsystem of specified type.

GetSubsystem() [2/2]

template<typename TSubsystemClass>

FORCEINLINE TSubsystemClass * FAtomRuntime::GetSubsystem ( const FAtomRuntimeHandle & InHandle )

inlinestatic

Get a Subsystem of specified type from the provided AtomRuntimeHandle. Returns nullptr if the Subsystem cannot be found or the AtomRuntimeHandle is invalid.

GetSubsystemBase()

UAtomEngineSubsystem * FAtomRuntime::GetSubsystemBase ( TSubclassOf< UAtomEngineSubsystem > SubsystemClass ) const

inline

Get a Subsystem of specified type.

GetTestComponent()

UAtomComponent * FAtomRuntime::GetTestComponent

(

UWorld *

InWorld

)

GetTransientPrimaryVolume()

float FAtomRuntime::GetTransientPrimaryVolume ( ) const

inline

GetVirtualLoops()

const TMap< FAtomActiveSound *, FAtomVirtualLoop > & FAtomRuntime::GetVirtualLoops ( ) const

inline

HandleAtomDebugSound()

void FAtomRuntime::HandleAtomDebugSound

(

const TArray< FString > &

Args

)

HandleAtomMemoryInfo()

void FAtomRuntime::HandleAtomMemoryInfo	(	const TArray< FString > &	Args,
		FOutputDevice &	Ar )

HandleAtomMixDebugSound()

void FAtomRuntime::HandleAtomMixDebugSound

(

const TArray< FString > &

Args

)

HandleAtomSoloCommon()

void FAtomRuntime::HandleAtomSoloCommon	(	const TArray< FString > &	Args,
		FToggleSoloPtr	FPtr )

HandleAtomSoloSoundClass()

void FAtomRuntime::HandleAtomSoloSoundClass

(

const TArray< FString > &

Args

)

HandleAtomSoloSoundCue()

void FAtomRuntime::HandleAtomSoloSoundCue

(

const TArray< FString > &

Args

)

HandleAtomSoloSoundWave()

void FAtomRuntime::HandleAtomSoloSoundWave

(

const TArray< FString > &

Args

)

HandleClearSoloCommand()

void FAtomRuntime::HandleClearSoloCommand

(

FOutputDevice &

Ar

)

HandleDisableHPFCommand()

void FAtomRuntime::HandleDisableHPFCommand

(

FOutputDevice &

Ar

)

HandleDisableLPFCommand()

void FAtomRuntime::HandleDisableLPFCommand

(

FOutputDevice &

Ar

)

HandleDumpSoundInfoCommand()

void FAtomRuntime::HandleDumpSoundInfoCommand

(

FOutputDevice &

Ar

)

Exec command handlers.

HandleEnableHRTFForAllCommand()

void FAtomRuntime::HandleEnableHRTFForAllCommand

(

FOutputDevice &

Ar

)

HandleGetDynamicSoundVolumeCommand()

void FAtomRuntime::HandleGetDynamicSoundVolumeCommand	(	const TArray< FString > &	Args,
		FOutputDevice &	Ar )

HandleListAtomComponentsCommand()

void FAtomRuntime::HandleListAtomComponentsCommand

(

FOutputDevice &

Ar

)

HandleListPlaybacksCommand()

void FAtomRuntime::HandleListPlaybacksCommand

(

FOutputDevice &

Ar

)

Lists all the playing playback instances and their associated source.

HandleListSoundClassesCommand()

void FAtomRuntime::HandleListSoundClassesCommand

(

FOutputDevice &

Ar

)

Lists a summary of loaded sound collated by class.

HandleListSoundClassVolumesCommand()

void FAtomRuntime::HandleListSoundClassVolumesCommand

(

FOutputDevice &

Ar

)

HandleListSoundDurationsCommand()

void FAtomRuntime::HandleListSoundDurationsCommand

(

FOutputDevice &

Ar

)

HandlePause()

void FAtomRuntime::HandlePause ( bool bGameTicking, bool bGlobalPause = false )

protected

Handle pausing/unpausing of sources when entering or leaving pause mode, or global pause (like device suspend)

HandlePlayAllPIEAtomCommand()

void FAtomRuntime::HandlePlayAllPIEAtomCommand

(

FOutputDevice &

Ar

)

HandleResetAllDynamicSoundVolumesCommand()

void FAtomRuntime::HandleResetAllDynamicSoundVolumesCommand

(

)

HandleResetDynamicSoundVolumeCommand()

void FAtomRuntime::HandleResetDynamicSoundVolumeCommand

(

const TArray< FString > &

Args

)

HandleResetSoundStateCommand()

void FAtomRuntime::HandleResetSoundStateCommand

(

FOutputDevice &

Ar

)

HandleSDKOnAtomAudioFrameStart()

void FAtomRuntime::HandleSDKOnAtomAudioFrameStart

(

)

HandleSDKOnAtomExBeatSync()

void FAtomRuntime::HandleSDKOnAtomExBeatSync

(

const CriAtomExBeatSyncInfo *

BeatSyncInfo

)

HandleSDKOnAtomExSequencerEvent()

void FAtomRuntime::HandleSDKOnAtomExSequencerEvent

(

const CriAtomExSequenceEventInfo *

EventInfo

)

HandleSetBaseSoundRackCommand()

void FAtomRuntime::HandleSetBaseSoundRackCommand	(	const TArray< FString > &	Args,
		FOutputDevice &	Ar )

HandleSetDynamicSoundCommand()

void FAtomRuntime::HandleSetDynamicSoundCommand

(

const TArray< FString > &

Args

)

HandleShowSoundClassHierarchyCommand()

void FAtomRuntime::HandleShowSoundClassHierarchyCommand

(

FOutputDevice &

Ar

)

shows sound class hierarchy.

HandleSoloCommand()

void FAtomRuntime::HandleSoloCommand

(

FOutputDevice &

Ar

)

HandleTestHPFCommand()

void FAtomRuntime::HandleTestHPFCommand

(

FOutputDevice &

Ar

)

HandleTestLPFCommand()

void FAtomRuntime::HandleTestLPFCommand

(

FOutputDevice &

Ar

)

Init()

bool FAtomRuntime::Init

(

FAtomRuntimeId

InRuntimeID

)

Intialize this runtime and active it.

InitializeAtomLibrary()

void FAtomRuntime::InitializeAtomLibrary ( )

private

InitializeChannelAzimuthMap()

void FAtomRuntime::InitializeChannelAzimuthMap ( const int32 NumChannels )

private

InitializeChannelMaps()

void FAtomRuntime::InitializeChannelMaps ( )

private

InitializePlatformAtomLibrary()

virtual void FAtomRuntime::InitializePlatformAtomLibrary ( )

protectedpure virtual

FAtomRuntimeAndroid, FAtomRuntimeApple, FAtomRuntimeLinux, FAtomRuntimeUnrealAudio, FAtomRuntimeWindowsで実装されています。

InitializeSubsystemCollection()

void FAtomRuntime::InitializeSubsystemCollection ( )

protected

Create our subsystem collection root object and initialize subsystems

InitMasterRack()

void FAtomRuntime::InitMasterRack ( )

private

InitOuputPortMappings()

void FAtomRuntime::InitOuputPortMappings ( )

private

InitRacks()

void FAtomRuntime::InitRacks ( )

private

InitSoundClasses()

void FAtomRuntime::InitSoundClasses

(

)

Set up the sound class hierarchy.

InitSoundParams()

void FAtomRuntime::InitSoundParams ( FAtomActiveSound & InOutActiveSound, TArray< FAtomAisacParameter > InDefaultParams, bool bInIsVirtualLoopRealzing ) const

protected

Initializes the parameters on the active sound.

InitSoundSources()

void FAtomRuntime::InitSoundSources ( )

protected

Set up the initial sound sources for cue. Allows us to initialize sound source early on.

InitSpatializationRack()

void FAtomRuntime::InitSpatializationRack ( )

private

InvalidateCachedInteriorVolumes()

void FAtomRuntime::InvalidateCachedInteriorVolumes

(

)

const

When the set of Atom volumes have changed invalidate the cached values of active sounds

IsActive()

bool FAtomRuntime::IsActive

(

)

const

IsAtomMixerPluginEnabled()

bool FAtomRuntime::IsAtomMixerPluginEnabled ( ) const

inline

Whether or not Atom mixer plugin is present.

IsAtomRuntimeMuted()

bool FAtomRuntime::IsAtomRuntimeMuted

(

)

const

IsAudioRenderingThread()

bool FAtomRuntime::IsAudioRenderingThread

(

)

const

IsHRTFDisabled()

bool FAtomRuntime::IsHRTFDisabled

(

)

const

Whether or not HRTF is disabled.

IsHRTFEnabledForAll()

bool FAtomRuntime::IsHRTFEnabledForAll

(

)

const

Whether or not HRTF spatialization is enabled for all.

IsManaRuntimePluginEnabled()

bool FAtomRuntime::IsManaRuntimePluginEnabled ( ) const

inline

Whether or not Mana runtime plugin is present.

IsMasterRack()

bool FAtomRuntime::IsMasterRack ( const UAtomRackBase * InRack ) const

protected

IsPendingStop()

bool FAtomRuntime::IsPendingStop

(

FAtomActiveSound *

ActiveSound

)

Whether the provided ActiveSound is currently pending to stop.

IsSourceDataOverridePluginEnabled()

bool FAtomRuntime::IsSourceDataOverridePluginEnabled ( ) const

inline

Whether or not there's a source data override plugin enabled.

IsSourceDataOverridePluginLoaded()

bool FAtomRuntime::IsSourceDataOverridePluginLoaded ( )

inlinestatic

Whether or not there's a source data override plugin enabled.

IsSpatializationRack()

bool FAtomRuntime::IsSpatializationRack ( const UAtomRackBase * InRack ) const

protected

IsUsingFixedVoicePools()

bool FAtomRuntime::IsUsingFixedVoicePools ( ) const

inline

Whether the mixer source manager use user defined voice pools or generate voice pool on the fly for data asset sound.

IsUsingUnrealSoundRenderer()

virtual bool FAtomRuntime::IsUsingUnrealSoundRenderer ( ) const

inlinevirtual

Whether Atom routes any rack audio outputs to Unreal audio.

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

IterateOverRacks()

void FAtomRuntime::IterateOverRacks

(

TFunctionRef< void(const UAtomRackBase *Rack)>

Func

)

const

IterateOverVoicePools()

void FAtomRuntime::IterateOverVoicePools

(

TFunctionRef< void(EAtomVoicePoolCodecType CodecType, EAtomVoicePoolStreamingType StreamingType, int32 ID, int32 NumUsedVoices, int32 MaxVoices, int32 MaxChannels, int32 MaxSampleRate)>

Func

)

const

Function to iterate over voice pool informations.

LoadAtomRack()

bool FAtomRuntime::LoadAtomRack ( const UAtomRackBase & InAtomRack )

protected

Create and register a new atom rack.

LoadAtomRackBusSettings()

bool FAtomRuntime::LoadAtomRackBusSettings ( const UAtomRack * Rack )

protected

LoadGenericAtomRack()

FCriAtomExAsrRackId FAtomRuntime::LoadGenericAtomRack ( const FAtomRackInitParams & InitParams )

protected

Function to create and add a default standard asr rack.

LoadGenericAtomSoundfieldRack()

FCriAtomExAsrRackId FAtomRuntime::LoadGenericAtomSoundfieldRack ( const FAtomSoundfieldRackInitParams & InitParams )

protected

Function to create and add a default spatializer asr rack.

LoadMasterRack()

void FAtomRuntime::LoadMasterRack ( const FSoftObjectPath & InObjectPath )

protected

LoadPlatformAtomRack()

virtual FCriAtomExAsrRackId FAtomRuntime::LoadPlatformAtomRack ( const FAtomRackInitParams & InitParams )

inlineprotectedvirtual

FAtomRuntimeUnrealAudio, FAtomRuntimeWindowsで再実装されています。

LoadPlatformAtomSoundfieldRack()

virtual FCriAtomExAsrRackId FAtomRuntime::LoadPlatformAtomSoundfieldRack ( const FAtomSoundfieldRackInitParams & InitParams )

inlineprotectedvirtual

LoadSubmixInstance()

void FAtomRuntime::LoadSubmixInstance	(	const UAtomBus *	InAtomBus,
		bool	bAllowReinit = false )

LocationIsAudible() [1/2]

bool FAtomRuntime::LocationIsAudible	(	const FVector &	Location,
		const float	MaxDistance ) const

Checks to see if a coordinate is within a distance of any listener

LocationIsAudible() [2/2]

bool FAtomRuntime::LocationIsAudible	(	const FVector &	Location,
		int32	ListenerIndex,
		const float	MaxDistance ) const

Checks to see if a coordinate is within a distance of a specific listener

MakePatch()

Audio::FPatchOutputStrongPtr FAtomRuntime::MakePatch	(	int32	InFrames,
		int32	InChannels,
		float	InGain ) const

MapOutputPortToRack()

bool FAtomRuntime::MapOutputPortToRack	(	FName	OutputPortName,
		const UAtomRackBase *	AtomRack )

NotifyActiveSoundOcclusionTraceDone()

void FAtomRuntime::NotifyActiveSoundOcclusionTraceDone	(	FAtomActiveSound *	ActiveSound,
		bool	bIsOccluded )

Notify that a pending async occlusion trace finished on the active sound.

NotifyPendingDelete()

void FAtomRuntime::NotifyPendingDelete ( FAtomActiveSound & ActiveSound ) const

inline

Notifies subsystems an active sound is about to be deleted (called on audio thread) - Deprecated, see NotifySubsystemsActiveSoundDeleting

NotifyPluginListenersWorldChanged()

void FAtomRuntime::NotifyPluginListenersWorldChanged ( UWorld * World )

private

Notifies all plugin listeners belonging to this audio device that the world changed. Called in the game thread.

引数

World

Pointer to the UWorld the listener is in.

NotifySubsystemsActiveSoundCreated()

void FAtomRuntime::NotifySubsystemsActiveSoundCreated ( FAtomActiveSound & ActiveSound ) const

protected

Notifies subsystems an active sound has just been added (called on audio thread). Called both for brand new sounds and for virtualized sounds that have just become active.

NotifySubsystemsActiveSoundDeleting()

void FAtomRuntime::NotifySubsystemsActiveSoundDeleting ( FAtomActiveSound & ActiveSound ) const

protected

Notifies subsystems an active sound is about to be deleted (called on audio thread). Called when a sound is either stopped or virtualized. In either case, the referenced ActiveSound object no longer exists after this call; any pointers to it should be discarded.

NotifySubsystemsSetOwner()

void FAtomRuntime::NotifySubsystemsSetOwner ( FAtomActiveSound & ActiveSound, const UObject * Owner ) const

protected

Notifies subsystems an owning object has been associated with a sound.

NotifySubsystemsVirtualizedSoundCreated()

void FAtomRuntime::NotifySubsystemsVirtualizedSoundCreated ( FAtomActiveSound & ActiveSound ) const

protected

Notifies subsystems a virtualized sound has just been added (called on audio thread). Called both for brand new sounds and for active sounds that have just become virtualized.

NotifySubsystemsVirtualizedSoundDeleting()

void FAtomRuntime::NotifySubsystemsVirtualizedSoundDeleting ( FAtomActiveSound & ActiveSound ) const

protected

Notifies subsystems a virtualized sound is about to be deleted (called on audio thread). Called when a sound is either stopped or re-triggered. In either case, the referenced ActiveSound object no longer exists after this call; any pointers to it should be discarded.

OnListenerUpdated()

void FAtomRuntime::OnListenerUpdated ( const TArray< FAtomListener > & InListeners )

privatevirtual

This is overridden in Audio::FMixerDevice to propogate listener information to the audio thread.

OnPreGarbageCollect()

void FAtomRuntime::OnPreGarbageCollect

(

)

OnProcessAudioStream()

void FAtomRuntime::OnProcessAudioStream ( )

protected

Process audio stream data to mix in sync with ADX server thread.

OnRuntimeCreated()

void FAtomRuntime::OnRuntimeCreated

(

FAtomRuntimeId

InDeviceID

)

Called after FAtomRuntime creation and init.

OnRuntimeDestroyed()

void FAtomRuntime::OnRuntimeDestroyed

(

FAtomRuntimeId

InDeviceID

)

Called before FAtomRuntime teardown.

ParseSoundClasses()

void FAtomRuntime::ParseSoundClasses ( float InDeltaTime )

private

Parses the sound classes and propagates multiplicative properties down the tree.

PauseActiveSound()

void FAtomRuntime::PauseActiveSound	(	uint64	AtomComponentID,
		const bool	bInIsPaused )

Pauses the active sound for the specified Atom component

PlaySoundAtLocation() [1/2]

void FAtomRuntime::PlaySoundAtLocation	(	UAtomSoundBase *	Sound,
		UWorld *	World,
		float	VolumeMultiplier,
		float	PitchMultiplier,
		float	StartTime,
		const FVector &	Location,
		const FRotator &	Rotation,
		UAtomAttenuation *	AttenuationSettings,
		UAtomConcurrency *	Concurrency,
		TArray< FAtomAisacParameter > &&	Params,
		const AActor *	OwningActor = nullptr )

As above, but supporting move semantics to reduce copying of Params

PlaySoundAtLocation() [2/2]

void FAtomRuntime::PlaySoundAtLocation	(	UAtomSoundBase *	Sound,
		UWorld *	World,
		float	VolumeMultiplier,
		float	PitchMultiplier,
		float	StartTime,
		const FVector &	Location,
		const FRotator &	Rotation,
		UAtomAttenuation *	AttenuationSettings = nullptr,
		UAtomConcurrency *	ConcurrencySettings = nullptr,
		const TArray< FAtomAisacParameter > *	Params = nullptr,
		const AActor *	OwningActor = nullptr )

Plays a sound at the given location without creating an Atom component.

引数

Sound	The UAtomSoundBase to play at the location.
World	The world this sound is playing in.
VolumeMultiplier	The volume multiplier to set on the sound.
PitchMultiplier	The pitch multiplier to set on the sound.
StartTime	The initial time offset for the sound.
Location	The sound's position.
Rotation	The sound's rotation.
AttenuationSettings	The sound's attenuation settings to use (optional). Will default to the UAtomSoundBase's AttenuationSettings if not specified.
ConcurrencySettings	The sound's concurrency settings to use (optional). Will use the UAtomSoundBase's UAtomSoundConcurrency if not specified.
Params	An optional list of Atom component params to immediately apply to a sound.

ProcessingPendingActiveSoundStops()

void FAtomRuntime::ProcessingPendingActiveSoundStops ( bool bForceDelete = false )

protected

This is overridden in Audio::FMixerDevice to propogate listener information to the audio thread. Processes the set of pending sounds that need to be stopped.

PumpCommandQueue()

void FAtomRuntime::PumpCommandQueue ( )

private

PumpGameThreadCommandQueue()

void FAtomRuntime::PumpGameThreadCommandQueue ( )

private

RealizeVirtualLoop()

void FAtomRuntime::RealizeVirtualLoop

(

FAtomVirtualLoop &

VirtualLoop

)

Attempts to realize provided loop (virtualized active sound)

RealizeVirtualLoopFromMixer()

void FAtomRuntime::RealizeVirtualLoopFromMixer ( FAtomActiveSound & ActiveSound )

protected

Attempts to remove provided loop (virtualized active sound)

RecurseIntoSoundClasses()

void FAtomRuntime::RecurseIntoSoundClasses ( UAtomSoundClass * CurrentClass, FAtomSoundClassProperties & ParentProperties )

private

Internal helper function used by ParseSoundClasses to traverse the tree.

引数

CurrentClass	Subtree to deal with
ParentProperties	Propagated properties of parent node

RegisterAtomRack()

bool FAtomRuntime::RegisterAtomRack

(

const UAtomRackBase *

AtomRack

)

Resister an AtomRack to the Atom runtime.

RegisterSoundClass()

void FAtomRuntime::RegisterSoundClass

(

UAtomSoundClass *

InSoundClass

)

Registers a sound class with the Atom runtime.

ReleaseMixerSourceVoice()

void FAtomRuntime::ReleaseMixerSourceVoice

(

Atom::FMixerSourceVoice *

InSourceVoice

)

RemoveActiveSound()

void FAtomRuntime::RemoveActiveSound

(

FAtomActiveSound *

ActiveSound

)

Removes an active sound from the active sounds array

RemoveEnvelopeFollowerDelegate()

void FAtomRuntime::RemoveEnvelopeFollowerDelegate	(	UAtomBus *	InBus,
		const FOnAtomBusEnvelopeBP &	OnAtomBusEnvelopeBP )

RemoveLevelMeterDelegate()

void FAtomRuntime::RemoveLevelMeterDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackLevelMeterMeasureBP &	OnAtomRackLevelMeterMeasureBP )

RemoveLoudnessMeterDelegate()

void FAtomRuntime::RemoveLoudnessMeterDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackLoudnessMeterMeasureBP &	OnAtomRackTruePeakMeterMeasureBP )

RemovePerformanceMonitorDelegate()

void FAtomRuntime::RemovePerformanceMonitorDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackPerformanceMonitorResultBP &	OnAtomRackPerformanceMonitorResultBP )

RemoveRenderedSamplesDelegate()

void FAtomRuntime::RemoveRenderedSamplesDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackRenderedSamplesBP &	OnAtomRackRenderedSamplesBP )

RemoveSpectralAnalysisDelegate()

void FAtomRuntime::RemoveSpectralAnalysisDelegate	(	UAtomBus *	InBus,
		const FOnAtomBusSpectralAnalysisBP &	OnAtomBusSpectralAnalysisBP )

RemoveTruePeakMeterDelegate()

void FAtomRuntime::RemoveTruePeakMeterDelegate	(	UAtomRackBase *	InRack,
		const FOnAtomRackTruePeakMeterMeasureBP &	OnAtomRackTruePeakMeterMeasureBP )

RemoveUserAtomVoicePool()

void FAtomRuntime::RemoveUserAtomVoicePool

(

FName

Name

)

RemoveVirtualLoop()

bool FAtomRuntime::RemoveVirtualLoop ( FAtomActiveSound & ActiveSound )

protected

Remove virtualized sound to list.

ReportSoundFailedToStart()

void FAtomRuntime::ReportSoundFailedToStart ( const uint64 AtomComponentID, FAtomVirtualLoop * VirtualLoop )

protected

Reports if a sound fails to start when attempting to create a new active sound.

ResetAudioRenderingThreadID()

void FAtomRuntime::ResetAudioRenderingThreadID ( )

private

ResetInterpolation()

void FAtomRuntime::ResetInterpolation

(

)

Resets all interpolating values to defaults.

ResetLoudnessMeterMeasuring()

void FAtomRuntime::ResetLoudnessMeterMeasuring

(

UAtomRackBase *

InRack

)

ResetPerformanceMonitor()

void FAtomRuntime::ResetPerformanceMonitor

(

UAtomRackBase *

InRack

)

ResumeContext()

virtual void FAtomRuntime::ResumeContext ( )

inlinevirtual

Resume any context related objects

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

RetriggerVirtualLoop()

void FAtomRuntime::RetriggerVirtualLoop

(

FAtomVirtualLoop &

VirtualLoop

)

Attempts to retrigger a provided loop (virtualized active sound)

SendCommandToActiveSounds()

void FAtomRuntime::SendCommandToActiveSounds	(	uint64	InAtomComponentID,
		TUniqueFunction< void(FAtomActiveSound &)>	InFunc,
		const TStatId	InStatId = TStatId() )

Performs an operation on all active sounds requested to execute by an audio component.

SendUpdateResultsToGameThread()

void FAtomRuntime::SendUpdateResultsToGameThread ( int32 FirstActiveIndex )

protected

SetAtomConfiguration()

bool FAtomRuntime::SetAtomConfiguration

(

const UAtomConfig *

AtomConfig

)

Register ACF to Atom runtime.

SetBusChannelLevelMatrix()

bool FAtomRuntime::SetBusChannelLevelMatrix

(

const UAtomBus *

InBus

)

Apply level matrix setting from AtomBus to Atom runtime bus.

SetBusEffectBypass()

bool FAtomRuntime::SetBusEffectBypass	(	const UAtomBus *	InBus,
		const UAtomBusEffectPreset *	InEffectPreset )

Apply a bus effect by-pass from AtomBusEffectPreset to Atom runtime bus.

SetBusEffectParameter()

bool FAtomRuntime::SetBusEffectParameter	(	const UAtomBus *	InBus,
		const UAtomBusEffectPreset *	InEffectPreset,
		int	InParameterIndex )

Apply a bus effect parameter from AtomBusEffectPreset to Atom runtime bus.

SetBusEffectPreset()

bool FAtomRuntime::SetBusEffectPreset	(	const UAtomBus *	InBus,
		const UAtomBusEffectPreset *	InEffectPreset )

Apply all settings from AtomBusEffectPreset to Atom runtime bus.

SetBusModulationBaseLevels()

void FAtomRuntime::SetBusModulationBaseLevels	(	UAtomBus *	InAtomBus,
		float	InVolumeModBase,
		float	InWetModBase,
		float	InDryModBase )

SetBusPanning()

bool FAtomRuntime::SetBusPanning

(

const UAtomBus *

InBus

)

Apply spatialization panning settings from AtomBus to Atom runtime bus.

SetBusSendLevel()

bool FAtomRuntime::SetBusSendLevel	(	const UAtomBus *	InBus,
		const FAtomBusSend &	InSend )

Apply a bus send level from AtomBus to Atom runtime bus.

SetBusVolume()

bool FAtomRuntime::SetBusVolume	(	const UAtomBus *	InBus,
		float	InBusVolume )

Apply bus volume setting from AtomBus to Atom runtime bus.

SetCanHaveMultipleActiveSounds()

void FAtomRuntime::SetCanHaveMultipleActiveSounds	(	uint64	AtomComponentID,
		bool	InCanHaveMultipleActiveSounds )

Set whether a given Audio Component ID should be allowed to have multiple associated Active Sounds

SetDefaultAtomSettings()

void FAtomRuntime::SetDefaultAtomSettings	(	UWorld *	World,
		const FAtomReverbSettings &	DefaultReverbSettings,
		const FAtomInteriorSettings &	DefaultInteriorSettings )

Sets the default reverb and interior settings for the provided world.

SetGlobalFocusSettings()

void FAtomRuntime::SetGlobalFocusSettings

(

const FAtomGlobalFocusSettings &

NewFocusSettings

)

SetGlobalPitchModulation()

void FAtomRuntime::SetGlobalPitchModulation	(	float	PitchScale,
		float	TimeSec )

SetHRTFDisabled()

void FAtomRuntime::SetHRTFDisabled ( bool InIsHRTFDisabled )

inline

SetHRTFEnabledForAll()

void FAtomRuntime::SetHRTFEnabledForAll ( bool InbHRTFEnabledForAll )

inline

SetListener()

void FAtomRuntime::SetListener	(	UWorld *	World,
		const int32	ListenerIndex,
		const FTransform &	ListenerTransform,
		const float	InDeltaSeconds )

Sets the details about the listener

引数

World	The world the listener is being set on.
ListenerIndex	The index of the listener
ListenerTransform	The listener's world transform
DeltaSeconds	The amount of time over which velocity should be calculated. If 0, then velocity will not be calculated.

SetListenerAttenuationOverride()

void FAtomRuntime::SetListenerAttenuationOverride	(	int32	ListenerIndex,
		const FVector	AttenuationPosition )

Sets an override position for the specified listener to do attenuation calculations (also called focus point).

SetMixDebugState()

void FAtomRuntime::SetMixDebugState

(

EAtomDebugState

DebugState

)

SetPlatformAtomDSPBusOutput()

virtual FORCEINLINE bool FAtomRuntime::SetPlatformAtomDSPBusOutput ( CriAtomExAsrRackId RackID, const FString & DspBusName, const FAtomBusOutputParams & OutputParams )

inlineprotectedvirtual

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

SetRackDspBusSetting()

bool FAtomRuntime::SetRackDspBusSetting

(

const UAtomRack *

InRack

)

Attach the DspSetting from AtomRack to Atom runtime rack.

SetRackSnapshot()

bool FAtomRuntime::SetRackSnapshot	(	const UAtomRack *	InRack,
		float	FadeSeconds )

Apply snapshot from AtomRack to Atom runtime rack with given fade time in seconds.

SetRuntimeMuted()

void FAtomRuntime::SetRuntimeMuted

(

bool

bMuted

)

SetSoundClassDistanceScale()

void FAtomRuntime::SetSoundClassDistanceScale	(	UAtomSoundClass *	InSoundClass,
		float	DistanceScale,
		float	TimeSec )

Overrides the attenuation scale used on a sound class.

SetSubmixDryLevel()

void FAtomRuntime::SetSubmixDryLevel	(	UAtomBus *	InAtomBus,
		float	InDryLevel )

Set the wet-dry level of the given bus

SetSubmixEndpoint()

bool FAtomRuntime::SetSubmixEndpoint	(	const UAtomBus *	InAtomBus,
		const UAtomEndpointBase *	Endpoint = nullptr )

Apply endpoint of the given bus

SetSubmixOutputVolume()

void FAtomRuntime::SetSubmixOutputVolume	(	UAtomBus *	InAtomBus,
		float	InOutputVolume )

Set the wet-dry level of the given bus

SetSubmixWetLevel()

void FAtomRuntime::SetSubmixWetLevel	(	UAtomBus *	InAtomBus,
		float	InWetLevel )

Set the wet-dry level of the given bus

SetTransientPrimaryVolume()

void FAtomRuntime::SetTransientPrimaryVolume

(

float

TransientPrimaryVolume

)

SetupAtomDBAS()

void FAtomRuntime::SetupAtomDBAS ( )

protected

Setup Atom D-bas data stream system. (Optional)

SetUseAttenuationForNonGameWorlds()

void FAtomRuntime::SetUseAttenuationForNonGameWorlds ( bool bInUseAttenuationForNonGameWorlds )

inline

Set whether or not we force the use of attenuation for non-game worlds (as by default we only care about game worlds)

ShouldUseAttenuation()

bool FAtomRuntime::ShouldUseAttenuation ( const UWorld * World ) const

protected

Check whether we should use attenuation settings.

ShowSoundClassHierarchy()

void FAtomRuntime::ShowSoundClassHierarchy	(	FOutputDevice &	Ar,
		UAtomSoundClass *	SoundClass = nullptr,
		int32	Indent = 0 ) const

Lists a summary of loaded sound collated by class

SoundIsAudible() [1/2]

bool FAtomRuntime::SoundIsAudible ( const FAtomActiveSound & NewActiveSound )

protected

Checks if the given sound would be audible.

引数

NewActiveSound

The ActiveSound attempting to be created

戻り値

True if the sound is audible, false otherwise.

SoundIsAudible() [2/2]

bool FAtomRuntime::SoundIsAudible	(	UAtomSoundBase *	Sound,
		const UWorld *	World,
		const FVector &	Location,
		const FAtomAttenuationSettings *	AttenuationSettingsToApply,
		float	MaxDistance,
		float	FocusFactor ) const

Checks if the given sound would be audible.

引数

Sound	The sound to check if it would be audible
World	The world the sound is playing in
Location	The location the sound is playing in the world
AttenuationSettings	The (optional) attenuation settings the sound is using
MaxDistance	The computed max distance of the sound.
FocusFactor	The focus factor of the sound.

戻り値

Returns true if the sound is audible, false otherwise.

StartEnvelopeFollowing()

void FAtomRuntime::StartEnvelopeFollowing

(

UAtomBus *

InBus

)

This is called by an UAtomBus to start envelope following on a bus instance on this runtime.

StartLevelMeterMeasuring()

void FAtomRuntime::StartLevelMeterMeasuring	(	UAtomRackBase *	InRack,
		const FAtomLevelMeterSettings &	InSettings )

StartLoudnessMeterMeasuring()

void FAtomRuntime::StartLoudnessMeterMeasuring	(	UAtomRackBase *	InRack,
		const FAtomLoudnessMeterSettings &	InSettings )

StartSources()

void FAtomRuntime::StartSources ( TArray< FAtomPlaybackInstance * > & InActiveSounds, int32 FirstActiveIndex, bool bGameTicking )

protected

Start and/or update any sources that have a high enough priority to play

StartSpectrumAnalysis()

void FAtomRuntime::StartSpectrumAnalysis	(	UAtomBus *	InBus,
		const FAtomSoundSpectrumAnalyzerSettings &	InSettings )

StartTruePeakMeterMeasuring()

void FAtomRuntime::StartTruePeakMeterMeasuring	(	UAtomRackBase *	InRack,
		const FAtomTruePeakMeterSettings &	InSettings )

StopActiveSound()

void FAtomRuntime::StopActiveSound	(	uint64	AtomComponentID,
		const FString *	EventLogID = nullptr )

Removes the active sound for the specified Atom component

StopAllSounds()

void FAtomRuntime::StopAllSounds ( bool bShouldStopUISounds = false )

virtual

Stops all game sounds (and possibly UI) sounds

引数

bShouldStopUISounds

If true, this function will stop UI sounds as well

StopEnvelopeFollowing()

void FAtomRuntime::StopEnvelopeFollowing

(

UAtomBus *

InBus

)

This is called by an UAtomBus when we stop envelope following a bus instance on this runtime.

StopLevelMeterMeasuring()

void FAtomRuntime::StopLevelMeterMeasuring

(

UAtomRackBase *

InRack

)

StopLoudnessMeterMeasuring()

void FAtomRuntime::StopLoudnessMeterMeasuring

(

UAtomRackBase *

InRack

)

StopOldestStoppingSource()

void FAtomRuntime::StopOldestStoppingSource ( )

protected

Stops oldest sound source.

StopSoundsUsingResource()

void FAtomRuntime::StopSoundsUsingResource	(	IAtomSoundResource *	InSound,
		TArray< UAtomComponent * > *	StoppedComponents = nullptr )

Stop any playing sounds that are using a particular Sound with resource

引数

	InSound	Resource to stop any sounds that are using it
[out]	StoppedComponents	List of Audio Components that were stopped

StopSources()

void FAtomRuntime::StopSources ( TArray< FAtomPlaybackInstance * > & InActiveSounds, int32 FirstActiveIndex )

protected

Stop sources that need to be stopped, and touch the ones that need to be kept alive Stop sounds that are too low in priority to be played

StopSpectrumAnalysis()

void FAtomRuntime::StopSpectrumAnalysis

(

UAtomBus *

InBus

)

StopTestComponent()

void FAtomRuntime::StopTestComponent

(

)

StopTruePeakMeterMeasuring()

void FAtomRuntime::StopTruePeakMeterMeasuring

(

UAtomRackBase *

InRack

)

Suspend()

void FAtomRuntime::Suspend

(

bool

bGameTicking

)

Suspend/resume all sounds (global pause for device suspend/resume, etc.)

引数

bGameTicking

Whether the game is still ticking at the time of suspend

SuspendContext()

virtual void FAtomRuntime::SuspendContext ( )

inlinevirtual

Suspend any context related objects

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

Teardown()

void FAtomRuntime::Teardown

(

)

Remove runtime from active and unitialize it.

UnlinkActiveSoundFromComponent()

void FAtomRuntime::UnlinkActiveSoundFromComponent

(

const FAtomActiveSound &

InActiveSound

)

Disables ActiveSound from responding to calls from its associated AtomComponent.

UnloadSubmixInstance()

void FAtomRuntime::UnloadSubmixInstance

(

const UAtomBus *

InAtomBus

)

UnregisterAtomRack()

bool FAtomRuntime::UnregisterAtomRack

(

const UAtomRackBase *

AtomRack

)

Unresister an AtomRack to the Atom runtime.

UnregisterSoundClass()

void FAtomRuntime::UnregisterSoundClass

(

UAtomSoundClass *

InSoundClass

)

Unregisters a sound class.

Update()

void FAtomRuntime::Update

(

bool

bGameTicking

)

The Atom main "Tick" function.

引数

bGameTicking

Whether the game is still ticking at the time of update.

UpdateActiveSoundPlaybackTime()

void FAtomRuntime::UpdateActiveSoundPlaybackTime ( bool bIsGameTicking )

protected

Update the active sound playback time. This is done here to do after all audio is updated.

UpdateAtomEngineSubsystems()

void FAtomRuntime::UpdateAtomEngineSubsystems ( )

protected

Updates Atom engine subsystems on this runtimr.

UpdateAtomLibrary()

void FAtomRuntime::UpdateAtomLibrary ( )

protectedvirtual

Update the Atom library.

UpdateAtomMixer()

void FAtomRuntime::UpdateAtomMixer ( )

protected

Update Mixer and ASR.

UpdateBusEffectParameters()

void FAtomRuntime::UpdateBusEffectParameters ( )

protected

Update bus effect parameters that have been changed.

UpdateBusModulationSettings()

void FAtomRuntime::UpdateBusModulationSettings	(	UAtomBus *	InAtomBus,
		const TSet< TObjectPtr< UAtomModulatorBase > > &	InOutputModulation,
		const TSet< TObjectPtr< UAtomModulatorBase > > &	InWetLevelModulation,
		const TSet< TObjectPtr< UAtomModulatorBase > > &	InDryLevelModulation )

UpdateConcurrency()

void FAtomRuntime::UpdateConcurrency ( TArray< FAtomPlaybackInstance * > & PlaybackInstances, TArray< FAtomActiveSound * > & ActiveSoundsCopy )

protected

Stops quiet/low priority sounds due to being evaluated as not fulfilling concurrency requirements.

UpdateGameThread()

void FAtomRuntime::UpdateGameThread ( )

virtual

Update called on game thread.

UpdateProfilers()

void FAtomRuntime::UpdateProfilers ( )

protected

UpdateReferencedSounds()

void FAtomRuntime::UpdateReferencedSounds ( )

private

UpdateRuntimeDeltaTime()

void FAtomRuntime::UpdateRuntimeDeltaTime ( )

protected

Sets the update delta time for the audio frame

UpdateSoundClassProperties()

void FAtomRuntime::UpdateSoundClassProperties ( float DeltaTime )

private

Construct the CurrentSoundClassProperties map

引数

DeltaTime

The current frame delta. Used to interpolate sound class adjustments.

This contains the original sound class properties propagated properly, and all adjustments.

UpdateVirtualLoops()

void FAtomRuntime::UpdateVirtualLoops ( bool bForceUpdate )

protected

Update status of dormant virtualized sounds/loops.

VirtualizeInactiveLoops()

void FAtomRuntime::VirtualizeInactiveLoops ( )

protected

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

FAtomConcurrencyManager

friend class FAtomConcurrencyManager

friend

ThreadId for the low-level ASR audio mixer. The concurrency manager.

メンバ詳解

ActivePlaybackInstances

TArray<FAtomPlaybackInstance*> FAtomRuntime::ActivePlaybackInstances

private

ActiveSounds

TArray<FAtomActiveSound*> FAtomRuntime::ActiveSounds

private

Set of currently used sounds.

AsrRacks

TMap<const UAtomRackBase*, FCriAtomExAsrRackId> FAtomRuntime::AsrRacks

protected

AsrRacksCS

FCriticalSection FAtomRuntime::AsrRacksCS

mutableprotected

AtomClock

double FAtomRuntime::AtomClock

private

The audio clock from the Native Atom runtime.

AtomComponentIDToActiveSoundMap

TMap<uint64, TArray<FAtomActiveSound*> > FAtomRuntime::AtomComponentIDToActiveSoundMap

private

Map of Atom component to active sounds.

AtomComponentIDToCanHaveMultipleActiveSoundsMap

TMap<uint64, bool> FAtomRuntime::AtomComponentIDToCanHaveMultipleActiveSoundsMap

private

Used to determine if a given Audio Component should be allowed to have multiple simultaneous associated active sounds

AtomConfig

const UAtomConfig* FAtomRuntime::AtomConfig

private

AtomServerThreadID

std::atomic<int32> FAtomRuntime::AtomServerThreadID

mutableprotected

ThreadId for the low-level Atom server.

AudioRenderCritSec

FCriticalSection FAtomRuntime::AudioRenderCritSec

private

bAllowCenterChannel3DPanning

uint8 FAtomRuntime::bAllowCenterChannel3DPanning

private

Whether or not we allow center channel panning.

bAtomMixerInterfaceEnabled

uint8 FAtomRuntime::bAtomMixerInterfaceEnabled

private

bGameWasTicking

uint8 FAtomRuntime::bGameWasTicking

private

bHRTFDisabled

uint8 FAtomRuntime::bHRTFDisabled

private

Whether or not HRTF is disabled. This will make any sounds which are set to HRTF spatialize to spatialize with panning.

bHRTFDisabled_OnGameThread

bool FAtomRuntime::bHRTFDisabled_OnGameThread

private

Gamethread representation of whether HRTF is disabled for all 3d sounds.

bHRTFEnabledForAll

uint8 FAtomRuntime::bHRTFEnabledForAll

private

Whether HRTF is enabled for all 3d sounds. This will automatically make all 3d mono sounds HRTF spatialized.

bHRTFEnabledForAll_OnGameThread

bool FAtomRuntime::bHRTFEnabledForAll_OnGameThread

private

Gamethread representation of whether HRTF is enabled for all 3d sounds. (not bitpacked to avoid thread issues)

bIsAtomLibraryInitialized

uint8 FAtomRuntime::bIsAtomLibraryInitialized

private

Whether Native Atom runtime library has been initialized

bIsInitialized

uint8 FAtomRuntime::bIsInitialized

private

Whether Atom has been initialized

bIsMasterRackInitialized

uint8 FAtomRuntime::bIsMasterRackInitialized

private

Whether master rack has been initialized

bIsRuntimeMuted

uint8 FAtomRuntime::bIsRuntimeMuted

private

Whether Atom is active (current Atom in-focus in PIE)

bManaRuntimeInterfaceEnabled

uint8 FAtomRuntime::bManaRuntimeInterfaceEnabled

private

Whether or not there's a Mana Runtime plugin enabled.

bSourceDataOverrideInterfaceEnabled

uint8 FAtomRuntime::bSourceDataOverrideInterfaceEnabled

private

Whether or not there's a source data override plugin enabled.

bUseAttenuationForNonGameWorlds

uint8 FAtomRuntime::bUseAttenuationForNonGameWorlds

private

Whether or not we force the use of attenuation for non-game worlds (as by default we only care about game worlds)

BusEffectsToUpdate

TSet<FBusEffectToUpdateInfo> FAtomRuntime::BusEffectsToUpdate

protected

bUseMixerVoiceManagement

uint8 FAtomRuntime::bUseMixerVoiceManagement

private

Whether or not the mixer voice management is being used.

bUseUnrealSoundRenderer

uint8 FAtomRuntime::bUseUnrealSoundRenderer

private

Whether or not Atom routes any rack audio outputs to Unreal audio.

CommandQueue

TQueue<TFunction<void()> > FAtomRuntime::CommandQueue

protected

Command queue to send commands to audio render thread from game thread or audio thread.

ConcurrencyManager

FAtomConcurrencyManager FAtomRuntime::ConcurrencyManager

protected

CurrentTick

uint64 FAtomRuntime::CurrentTick

private

DbasID

FCriAtomDbasId FAtomRuntime::DbasID

protected

DbasMaxBPS

int FAtomRuntime::DbasMaxBPS

protected

DbasMaxStreams

int FAtomRuntime::DbasMaxStreams

protected

DebugState

EAtomDebugState FAtomRuntime::DebugState

The debug state of the audio device

DefaultChannelAzimuthPositions

Atom::FChannelPositionInfo FAtomRuntime::DefaultChannelAzimuthPositions[Atom::MaxSupportedSpeakers]

private

Contains a map of channel/speaker azimuth positions.

DelegateBoundBuses

TArray<UAtomBus*> FAtomRuntime::DelegateBoundBuses

protected

DynamicSoundClassProperties

TMap<UAtomSoundClass*, FAtomSoundClassDynamicProperties> FAtomRuntime::DynamicSoundClassProperties

private

FAtomSource

friend FAtomRuntime::FAtomSource

private

FreeSources

TArray<FAtomSource*> FAtomRuntime::FreeSources

private

GameOrAtomThreadID

int32 FAtomRuntime::GameOrAtomThreadID

mutableprotected

ThreadId for the game thread (or if Atom is running a separate thread, that ID)

GameThreadCommandQueue

TMpscQueue<TFunction<void()> > FAtomRuntime::GameThreadCommandQueue

protected

MPSC command queue to send commands to the game thread

GlobalFocusSettings

FAtomGlobalFocusSettings FAtomRuntime::GlobalFocusSettings

private

The global focus settings

GlobalFocusSettings_GameThread

FAtomGlobalFocusSettings FAtomRuntime::GlobalFocusSettings_GameThread

private

GlobalMaxPitch

float FAtomRuntime::GlobalMaxPitch

private

GlobalMinPitch

float FAtomRuntime::GlobalMinPitch

private

GlobalPitchScale

FAtomDynamicParameter FAtomRuntime::GlobalPitchScale

private

Global dynamic pitch scale parameter

InverseListenerTransforms

TArray<FMatrix> FAtomRuntime::InverseListenerTransforms

protected

Inverse listener transformations, used for spatialization

LastUpdateTime

double FAtomRuntime::LastUpdateTime

private

Timestamp of the last update

ListenerProxies

TArray<FAtomListenerProxy> FAtomRuntime::ListenerProxies

Listeners

TArray<FAtomListener> FAtomRuntime::Listeners

protected

MainSubmixInstance

Atom::FMixerSubmixPtr FAtomRuntime::MainSubmixInstance

protected

ManaRuntimeInterface

TManaRuntimePtr FAtomRuntime::ManaRuntimeInterface

The Mana interface.

MasterRack

UAtomRack* FAtomRuntime::MasterRack

private

MaxSources

int32 FAtomRuntime::MaxSources

private

The maximum number of sources. Value cannot change after initialization.

ModulationSystem

TSharedPtr<AtomModulation::FAtomModulationSystem> FAtomRuntime::ModulationSystem

private

MonoChannelUpmixMethod

EAtomMonoChannelUpmixMethod FAtomRuntime::MonoChannelUpmixMethod

private

What upmix method to use for mono channel upmixing.

NumReservedSources

int32 FAtomRuntime::NumReservedSources

private

The number of sources to reserve for stopping sounds.

OneShotCount

uint32 FAtomRuntime::OneShotCount

private

A count of the number of one-shot active sounds.

OutputPortRackMap

TMap<FName, TStrongObjectPtr<const UAtomRackBase> > FAtomRuntime::OutputPortRackMap

protected

PanningMethod

EAtomPanningMethod FAtomRuntime::PanningMethod

private

What panning method to use for panning.

PendingSoundsToDelete

TArray<FAtomActiveSound*> FAtomRuntime::PendingSoundsToDelete

private

A set of sounds which need to be deleted but weren't able to be deleted due to pending async operations

PendingSoundsToStop

TSet<FAtomActiveSound*> FAtomRuntime::PendingSoundsToStop

private

Set of sounds which will be stopped next frame update

PlatformAtom

ICriWarePlatformAtom* FAtomRuntime::PlatformAtom

protected

PlatformInfo

Atom::FMixerPlatformInfo FAtomRuntime::PlatformInfo

private

PlatformInfo shpould hold all capabilites by atom - MainRack.

PlaybackInstanceSourceMap

TMap<FAtomPlaybackInstance*, FAtomSource*> FAtomRuntime::PlaybackInstanceSourceMap

private

Set of sources used to play sounds.

PluginInitializationParams

FAtomPluginInitializationParams FAtomRuntime::PluginInitializationParams

protected

Cached parameters passed to the initialization of various Atom plugins

PrecachingSounds

TArray<UAtomSoundBase*> FAtomRuntime::PrecachingSounds

private

PreviousPrimaryVolume

float FAtomRuntime::PreviousPrimaryVolume

private

What the previous master volume was.

PrimaryVolume

float FAtomRuntime::PrimaryVolume

private

The master volume of the game combines the FApp::GetVolumeMultipler() value and the TransientPrimaryVolume.

QuantizedEventClockManager

Atom::FQuartzClockManager FAtomRuntime::QuantizedEventClockManager

QuartzPersistentStateCritSec

FCriticalSection FAtomRuntime::QuartzPersistentStateCritSec

QuartzSubsystemData

TSharedPtr<Atom::FPersistentQuartzSubsystemData, ESPMode::ThreadSafe> FAtomRuntime::QuartzSubsystemData = nullptr

ReferencedSoundCriticalSection

FCriticalSection FAtomRuntime::ReferencedSoundCriticalSection

private

ReferencedSounds

TArray<UAtomSoundBase*> FAtomRuntime::ReferencedSounds

private

Array of sound waves to add references to avoid GC until guaranteed to be done with precache or decodes.

ReferencedSounds_AtomThread

TArray<UAtomSoundBase*> FAtomRuntime::ReferencedSounds_AtomThread

private

RuntimeChannelAzimuthPositions

TArray<Atom::FChannelPositionInfo> FAtomRuntime::RuntimeChannelAzimuthPositions

private

The azimuth positions for submix channel types.

RuntimeCreatedHandle

FDelegateHandle FAtomRuntime::RuntimeCreatedHandle

private

RuntimeDeltaTime

float FAtomRuntime::RuntimeDeltaTime

private

RuntimeDestroyedHandle

FDelegateHandle FAtomRuntime::RuntimeDestroyedHandle

private

RuntimeID

FAtomRuntimeId FAtomRuntime::RuntimeID

private

The handle for this Atom runtime used in the Atom manager.

RuntimePluginInterfaces

TArray<TAtomRuntimePluginPtr> FAtomRuntime::RuntimePluginInterfaces

3rd party Runtime plugin interfaces.

SoundClasses

TMap<UAtomSoundClass*, FAtomSoundClassProperties> FAtomRuntime::SoundClasses

private

Current properties of all sound classes

SoundClassPlayerGroups

TMap<UAtomSoundClass*, Atom::FMixerPlayerGroupPtr> FAtomRuntime::SoundClassPlayerGroups

private

SourceDataOverridePluginInterface

TAtomSourceDataOverridePtr FAtomRuntime::SourceDataOverridePluginInterface

The source data override interface.

SourceManager

TUniquePtr<Atom::FMixerSourceManager> FAtomRuntime::SourceManager

protected

The Atom source manager.

Sources

TArray<FAtomSource*> FAtomRuntime::Sources

private

SourceVoices

TQueue<Atom::FMixerSourceVoice*> FAtomRuntime::SourceVoices

protected

Queue of mixer source voices controlled by AtomSourceManager. A Mixer Source Voice contains information about voice pool and settings in use for a specific sound source to play.

SpatializationBusIndex

int32 FAtomRuntime::SpatializationBusIndex

private

SpatializationBusName

FString FAtomRuntime::SpatializationBusName

private

SpatializationRack

UAtomRackBase* FAtomRuntime::SpatializationRack

private

Submixes

Atom::FSubmixMap FAtomRuntime::Submixes

protected

Map of UAtomBus ID static data objects to the dynamic mixer submix.

SubsystemCollection

FAtomSubsystemCollection FAtomRuntime::SubsystemCollection

private

Subsystems tied to this device's lifecycle

SubsystemCollectionRoot

TStrongObjectPtr<UAtomSubsystemCollectionRoot> FAtomRuntime::SubsystemCollectionRoot

private

Anchor used to connect UAtomEngineSubsystems to FAtomRuntime

TestAtomComponent

TStrongObjectPtr<UAtomComponent> FAtomRuntime::TestAtomComponent

private

An AtomComponent to play test sounds on

ToRemoveSources

TArray<FAtomSource*> FAtomRuntime::ToRemoveSources

private

TransientPrimaryVolume

float FAtomRuntime::TransientPrimaryVolume

private

transient master volume multiplier that can be modified at runtime without affecting user settings automatically reset to 1.0 on level change

VirtualLoops

TMap<FAtomActiveSound*, FAtomVirtualLoop> FAtomRuntime::VirtualLoops

private

Array of dormant sound/loops stopped due to proximity/applicable concurrency rules that can be retriggered.

VoicesPools

TArray<Atom::FVoicePool> FAtomRuntime::VoicesPools

protected

User defined voice pools classed by type. User pools share the same identifier and are assigned automaticaly by Atom. The AtomSourceManager will borrow them for Atom cue playback.

WorldIDToDefaultAtomVolumeSettingsMap

TMap<uint32, TPair<FAtomReverbSettings, FAtomInteriorSettings> > FAtomRuntime::WorldIDToDefaultAtomVolumeSettingsMap

private

Map of default Atom volume settings for worlds.

---

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

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