#include <AtomRuntimeManager.h>

クラス
struct	FAtomRuntimeContainer

公開メンバ関数
	FAtomRuntimeManager ()
	~FAtomRuntimeManager ()
void	AddReferencedObjects (FReferenceCollector &Collector)
bool	CreateMainAtomRuntime ()
void	FreeResource (IAtomSoundResource *InSound)
FAtomRuntimeHandle	GetActiveAtomRuntime ()
FAtomResourceManager &	GetAtomResourceManager () const
FAtomRuntimeHandle	GetAtomRuntime (FAtomRuntimeId InRuntimeID)
FAtomRuntime *	GetAtomRuntimeRaw (FAtomRuntimeId InRuntimeID)
const FAtomRuntime *	GetAtomRuntimeRaw (FAtomRuntimeId InRuntimeID) const
TArray< FAtomRuntime * >	GetAtomRuntimes () const
uint32	GetDefaultDSPBufferLength () const
FAtomRuntimeParams	GetDefaultParamsForNewWorld ()
float	GetDynamicSoundVolume (EAtomSoundType SoundType, const FName &SoundName) const
FAtomRuntimeHandle	GetMainAtomRuntimeHandle () const
FAtomRuntimeId	GetMainAtomRuntimeID () const
FAtomRuntime *	GetMainAtomRuntimeRaw () const
uint8	GetNumAtomRuntimes () const
uint8	GetNumMainAtomRuntimeWorlds () const
TArray< UWorld * >	GetWorldsUsingAtomRuntime (const FAtomRuntimeId &InRuntimeID)
void	InitSoundClasses ()
bool	IsValidAtomRuntime (FAtomRuntimeId RuntimeID) const
bool	IsVisualizeDebug3dEnabled () const
void	IterateOverAllRuntimes (TUniqueFunction< void(FAtomRuntimeId, const FAtomRuntime *)> ForEachRuntime) const
void	IterateOverAllRuntimes (TUniqueFunction< void(FAtomRuntimeId, FAtomRuntime *)> ForEachRuntime)
void	LogListOfAtomRuntimes ()
void	RegisterSoundClass (UAtomSoundClass *SoundClass)
void	RegisterWorld (UWorld *InWorld, FAtomRuntimeId RuntimeID)
FAtomRuntimeHandle	RequestAtomRuntime (const FAtomRuntimeParams &InParams)
void	ResetAllDynamicSoundVolumes ()
void	ResetDynamicSoundVolume (EAtomSoundType SoundType, const FName &SoundName)
void	SetActiveAtomRuntime (FAtomRuntimeId InRuntimeID)
void	SetAtomRuntimeWorld (UWorld &InWorld, FAtomRuntimeId InRuntimeID)
void	SetDynamicSoundVolume (EAtomSoundType SoundType, const FName &SoundName, float Volume)
void	StopSoundsUsingResource (IAtomSoundResource InSound, TArray< UAtomComponent > *StoppedComponents=nullptr)
void	ToggleVisualize3dDebug ()
void	UnregisterSoundClass (UAtomSoundClass *SoundClass)
void	UnregisterWorld (UWorld *InWorld, FAtomRuntimeId RuntimeID)
void	UpdateAtomRuntimes (bool bGameTicking)

静的公開メンバ関数
static FAtomRuntimeManager *	Get ()
static FAtomRuntimeHandle	GetAtomRuntimeFromWorld (const UWorld *InWorld)
static FAtomRuntime *	GetAtomRuntimeFromWorldContext (const UObject *WorldContextObject)
static FAtomRuntime *	GetAtomRuntimeRawFromWorld (const UWorld *InWorld)
static bool	Initialize ()
static void	Shutdown ()

非公開メンバ関数
void	AppWillEnterBackground ()
FAtomRuntimeHandle	BuildNewHandle (FAtomRuntimeContainer &Container, FAtomRuntimeId RuntimeID, const FAtomRuntimeParams &InParams)
FAtomRuntimeHandle	CreateNewRuntime (const FAtomRuntimeParams &InParams)
void	DecrementRuntime (FAtomRuntimeId RuntimeID, UWorld *InWorld)
uint32	GetNewRuntimeID ()
void	IncrementRuntime (FAtomRuntimeId RuntimeID)
bool	InitializeManager ()

静的非公開メンバ関数
static bool	CanUseAtomRuntime (const FAtomRuntimeParams &InParams, const FAtomRuntimeContainer &InContainer)

非公開変数類
FAtomRuntimeId	ActiveAtomRuntimeID
FString	AtomMixerModuleName
ICriWarePlatformAtom *	AtomRuntimeModule
TMap< TTuple< EAtomSoundType, FName >, float >	DynamicSoundVolumes
FAtomRuntimeHandle	MainAtomRuntimeHandle
FAtomResourceManager *	ResourceManager
uint32	RuntimeIDCounter
FCriticalSection	RuntimeMapCriticalSection
TMap< FAtomRuntimeId, FAtomRuntimeContainer >	Runtimes
FAtomCommandFence	SyncFence

静的非公開変数類
static FAtomRuntimeManager *	Singleton = nullptr

フレンド
class	FAtomRuntimeHandle

構築子と解体子

◆ FAtomRuntimeManager()

FAtomRuntimeManager::FAtomRuntimeManager ( )

Constructor

◆ ~FAtomRuntimeManager()

FAtomRuntimeManager::~FAtomRuntimeManager ( )

Destructor

関数詳解

◆ AddReferencedObjects()

void FAtomRuntimeManager::AddReferencedObjects ( FReferenceCollector & Collector )

Tracks objects in the all Atom runtimes.

◆ AppWillEnterBackground()

void FAtomRuntimeManager::AppWillEnterBackground ( )

private

Application enters background handler

◆ BuildNewHandle()

FAtomRuntimeHandle FAtomRuntimeManager::BuildNewHandle	(	FAtomRuntimeContainer &	Container,
		FAtomRuntimeId	RuntimeID,
		const FAtomRuntimeParams &	InParams )

private

◆ CanUseAtomRuntime()

bool FAtomRuntimeManager::CanUseAtomRuntime	(	const FAtomRuntimeParams &	InParams,
		const FAtomRuntimeContainer &	InContainer )

staticprivate

This function is used to check if we can use an existing Atom runtime.

◆ CreateMainAtomRuntime()

bool FAtomRuntimeManager::CreateMainAtomRuntime ( )

Creates the main Atom runtime.

◆ CreateNewRuntime()

FAtomRuntimeHandle FAtomRuntimeManager::CreateNewRuntime ( const FAtomRuntimeParams & InParams )

private

◆ DecrementRuntime()

void FAtomRuntimeManager::DecrementRuntime	(	FAtomRuntimeId	RuntimeID,
		UWorld *	InWorld )

private

◆ FreeResource()

void FAtomRuntimeManager::FreeResource ( IAtomSoundResource * InSound )

Frees the given sound resource from the resource manager

◆ Get()

FAtomRuntimeManager * FAtomRuntimeManager::Get ( )

static

◆ GetActiveAtomRuntime()

FAtomRuntimeHandle FAtomRuntimeManager::GetActiveAtomRuntime ( )

Returns a ptr to the active Atom runtime. If there is no active runtime then it will return the main Atom runtime.

◆ GetAtomResourceManager()

FAtomResourceManager & FAtomRuntimeManager::GetAtomResourceManager ( ) const

Gets a reference to the Atom resource Manager

◆ GetAtomRuntime()

FAtomRuntimeHandle FAtomRuntimeManager::GetAtomRuntime ( FAtomRuntimeId InRuntimeID )

Returns a strong handle to the audio device associated with the given Atom ID. if the Atom ID is invalid returns an invalid, zeroed handle.

◆ GetAtomRuntimeFromWorld()

FAtomRuntimeHandle FAtomRuntimeManager::GetAtomRuntimeFromWorld ( const UWorld * InWorld )

static

Get the associated runtime handle to a world.

◆ GetAtomRuntimeFromWorldContext()

FAtomRuntime * FAtomRuntimeManager::GetAtomRuntimeFromWorldContext ( const UObject * WorldContextObject )

static

Get the associated runtime raw pointer to a world context.

◆ GetAtomRuntimeRaw() [1/2]

FAtomRuntime * FAtomRuntimeManager::GetAtomRuntimeRaw ( FAtomRuntimeId InRuntimeID )

Returns a raw ptr to the Atom runtime associated with the handle If the handle is invalid then a nullptr will be returned.

◆ GetAtomRuntimeRaw() [2/2]

const FAtomRuntime * FAtomRuntimeManager::GetAtomRuntimeRaw ( FAtomRuntimeId InRuntimeID ) const

◆ GetAtomRuntimeRawFromWorld()

FAtomRuntime * FAtomRuntimeManager::GetAtomRuntimeRawFromWorld ( const UWorld * InWorld )

static

Get the associated runtime raw pointer to a world.

◆ GetAtomRuntimes()

TArray< FAtomRuntime * > FAtomRuntimeManager::GetAtomRuntimes ( ) const

Returns all the Atom runtimes managed by Atom manager.

◆ GetDefaultDSPBufferLength()

uint32 FAtomRuntimeManager::GetDefaultDSPBufferLength ( ) const

inline

Atom works best with 256 bytes buffers per channel.

◆ GetDefaultParamsForNewWorld()

FAtomRuntimeParams FAtomRuntimeManager::GetDefaultParamsForNewWorld ( )

◆ GetDynamicSoundVolume()

float FAtomRuntimeManager::GetDynamicSoundVolume	(	EAtomSoundType	SoundType,
		const FName &	SoundName ) const

Get, reset, or set a sound cue trim

◆ GetMainAtomRuntimeHandle()

FAtomRuntimeHandle FAtomRuntimeManager::GetMainAtomRuntimeHandle ( ) const

inline

Returns the handle to the main Atom runtime.

◆ GetMainAtomRuntimeID()

FAtomRuntimeId FAtomRuntimeManager::GetMainAtomRuntimeID ( ) const

inline

◆ GetMainAtomRuntimeRaw()

FAtomRuntime * FAtomRuntimeManager::GetMainAtomRuntimeRaw ( ) const

inline

◆ GetNewRuntimeID()

uint32 FAtomRuntimeManager::GetNewRuntimeID ( )

private

Creates a handle given the index and a generation value.

◆ GetNumAtomRuntimes()

uint8 FAtomRuntimeManager::GetNumAtomRuntimes ( ) const

Returns the current number of Atom runtimes.

◆ GetNumMainAtomRuntimeWorlds()

uint8 FAtomRuntimeManager::GetNumMainAtomRuntimeWorlds ( ) const

Returns the number of worlds (e.g. PIE viewports) using the main Atom runtime.

◆ GetWorldsUsingAtomRuntime()

TArray< UWorld * > FAtomRuntimeManager::GetWorldsUsingAtomRuntime ( const FAtomRuntimeId & InRuntimeID )

Returns all the worlds associated with the given Atom ID.

◆ IncrementRuntime()

void FAtomRuntimeManager::IncrementRuntime ( FAtomRuntimeId RuntimeID )

private

◆ Initialize()

bool FAtomRuntimeManager::Initialize ( )

static

Initialize the Atom manager. Return true if successfully initialized.

◆ InitializeManager()

bool FAtomRuntimeManager::InitializeManager ( )

private

◆ InitSoundClasses()

void FAtomRuntimeManager::InitSoundClasses ( )

Initializes sound classes for all active runtimes.

◆ IsValidAtomRuntime()

bool FAtomRuntimeManager::IsValidAtomRuntime ( FAtomRuntimeId RuntimeID ) const

Returns whether the Atom runtime handle is valid (i.e. points to an actual runtime instance).

◆ IsVisualizeDebug3dEnabled()

bool FAtomRuntimeManager::IsVisualizeDebug3dEnabled ( ) const

Is debug visualization of 3d sounds enabled

◆ IterateOverAllRuntimes() [1/2]

void FAtomRuntimeManager::IterateOverAllRuntimes ( TUniqueFunction< void(FAtomRuntimeId, const FAtomRuntime *)> ForEachRuntime ) const

◆ IterateOverAllRuntimes() [2/2]

void FAtomRuntimeManager::IterateOverAllRuntimes ( TUniqueFunction< void(FAtomRuntimeId, FAtomRuntime *)> ForEachRuntime )

Iterator for each Atom runtime.

◆ LogListOfAtomRuntimes()

void FAtomRuntimeManager::LogListOfAtomRuntimes ( )

◆ RegisterSoundClass()

void FAtomRuntimeManager::RegisterSoundClass ( UAtomSoundClass * SoundClass )

Registers the sound class for all active runtimes.

◆ RegisterWorld()

void FAtomRuntimeManager::RegisterWorld	(	UWorld *	InWorld,
		FAtomRuntimeId	RuntimeID )

Registers the world with the provided Atom ID.

◆ RequestAtomRuntime()

FAtomRuntimeHandle FAtomRuntimeManager::RequestAtomRuntime ( const FAtomRuntimeParams & InParams )

Creates an Atom runtime instance internally and returns a handle to the Atom runtime. This Atom runtime is guaranteed to be alive as long as the returned handle is in scope.

◆ ResetAllDynamicSoundVolumes()

void FAtomRuntimeManager::ResetAllDynamicSoundVolumes ( )

Reset all sound cue trims

◆ ResetDynamicSoundVolume()

void FAtomRuntimeManager::ResetDynamicSoundVolume	(	EAtomSoundType	SoundType,
		const FName &	SoundName )

◆ SetActiveAtomRuntime()

void FAtomRuntimeManager::SetActiveAtomRuntime ( FAtomRuntimeId InRuntimeID )

Sets which Atom runtime is the active Atom runtime.

◆ SetAtomRuntimeWorld()

void FAtomRuntimeManager::SetAtomRuntimeWorld	(	UWorld &	InWorld,
		FAtomRuntimeId	InRuntimeID )

Sets the Atom runtime associated with the given world.

◆ SetDynamicSoundVolume()

void FAtomRuntimeManager::SetDynamicSoundVolume	(	EAtomSoundType	SoundType,
		const FName &	SoundName,
		float	Volume )

◆ Shutdown()

void FAtomRuntimeManager::Shutdown ( )

static

◆ StopSoundsUsingResource()

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

Stops sounds using the given resource in all Atom runtimes.

◆ ToggleVisualize3dDebug()

void FAtomRuntimeManager::ToggleVisualize3dDebug ( )

Toggles 3d visualization of 3d sounds on/off

◆ UnregisterSoundClass()

void FAtomRuntimeManager::UnregisterSoundClass ( UAtomSoundClass * SoundClass )

Unregisters the sound class for all active runtimes.

◆ UnregisterWorld()

void FAtomRuntimeManager::UnregisterWorld	(	UWorld *	InWorld,
		FAtomRuntimeId	RuntimeID )

Unregisters the world from the provided Atom ID.

◆ UpdateAtomRuntimes()

void FAtomRuntimeManager::UpdateAtomRuntimes ( bool bGameTicking )

Update Atom runtimes.

◆ FAtomRuntimeHandle

friend class FAtomRuntimeHandle

friend

メンバ詳解

◆ ActiveAtomRuntimeID

FAtomRuntimeId FAtomRuntimeManager::ActiveAtomRuntimeID

private

Which audio device is currently active

◆ AtomMixerModuleName

FString FAtomRuntimeManager::AtomMixerModuleName

private

The Atom mixer module name. This is the Atom mixer module name to use. E.g. AtomMixerXAudio

◆ AtomRuntimeModule

ICriWarePlatformAtom* FAtomRuntimeManager::AtomRuntimeModule

private

Atom runtime module which creates (old backend) Atom mixer runtime.

◆ DynamicSoundVolumes

TMap<TTuple<EAtomSoundType, FName>, float> FAtomRuntimeManager::DynamicSoundVolumes

private

Dynamic volume map

◆ MainAtomRuntimeHandle

FAtomRuntimeHandle FAtomRuntimeManager::MainAtomRuntimeHandle

private

Handle to the main audio device.

◆ ResourceManager

FAtomResourceManager* FAtomRuntimeManager::ResourceManager

private

The Atom resource manager, should always exist.

◆ RuntimeIDCounter

uint32 FAtomRuntimeManager::RuntimeIDCounter

private

Counter used by GetNewAtomID() to generate a unique ID for a given Atom runtime.

◆ RuntimeMapCriticalSection

FCriticalSection FAtomRuntimeManager::RuntimeMapCriticalSection

mutableprivate

◆ Runtimes

TMap<FAtomRuntimeId, FAtomRuntimeContainer> FAtomRuntimeManager::Runtimes

private

Bank of Atom runtimes. Will increase in size as we create new Atom runtimes,

◆ Singleton

FAtomRuntimeManager * FAtomRuntimeManager::Singleton = nullptr

staticprivate

◆ SyncFence

FAtomCommandFence FAtomRuntimeManager::SyncFence

private

Audio Fence to ensure that we don't allow the audio thread to drift never endingly behind.

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

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

クラス

公開メンバ関数

静的公開メンバ関数

非公開メンバ関数

静的非公開メンバ関数

非公開変数類

静的非公開変数類

フレンド

構築子と解体子

◆ FAtomRuntimeManager()

◆ ~FAtomRuntimeManager()

関数詳解

◆ AddReferencedObjects()

◆ AppWillEnterBackground()

◆ BuildNewHandle()

◆ CanUseAtomRuntime()

◆ CreateMainAtomRuntime()

◆ CreateNewRuntime()

◆ DecrementRuntime()

◆ FreeResource()

◆ Get()

◆ GetActiveAtomRuntime()

◆ GetAtomResourceManager()

◆ GetAtomRuntime()

◆ GetAtomRuntimeFromWorld()

◆ GetAtomRuntimeFromWorldContext()

◆ GetAtomRuntimeRaw() [1/2]

◆ GetAtomRuntimeRaw() [2/2]

◆ GetAtomRuntimeRawFromWorld()

◆ GetAtomRuntimes()

◆ GetDefaultDSPBufferLength()

◆ GetDefaultParamsForNewWorld()

◆ GetDynamicSoundVolume()

◆ GetMainAtomRuntimeHandle()

◆ GetMainAtomRuntimeID()

◆ GetMainAtomRuntimeRaw()

◆ GetNewRuntimeID()

◆ GetNumAtomRuntimes()

◆ GetNumMainAtomRuntimeWorlds()

◆ GetWorldsUsingAtomRuntime()

◆ IncrementRuntime()

◆ Initialize()

◆ InitializeManager()

◆ InitSoundClasses()

◆ IsValidAtomRuntime()

◆ IsVisualizeDebug3dEnabled()

◆ IterateOverAllRuntimes() [1/2]

◆ IterateOverAllRuntimes() [2/2]

◆ LogListOfAtomRuntimes()

◆ RegisterSoundClass()

◆ RegisterWorld()

◆ RequestAtomRuntime()

◆ ResetAllDynamicSoundVolumes()

◆ ResetDynamicSoundVolume()

◆ SetActiveAtomRuntime()

◆ SetAtomRuntimeWorld()

◆ SetDynamicSoundVolume()

◆ Shutdown()

◆ StopSoundsUsingResource()

◆ ToggleVisualize3dDebug()

◆ UnregisterSoundClass()

◆ UnregisterWorld()

◆ UpdateAtomRuntimes()

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

◆ FAtomRuntimeHandle

メンバ詳解

◆ ActiveAtomRuntimeID

◆ AtomMixerModuleName

◆ AtomRuntimeModule

◆ DynamicSoundVolumes

◆ MainAtomRuntimeHandle

◆ ResourceManager

◆ RuntimeIDCounter

◆ RuntimeMapCriticalSection

◆ Runtimes

◆ Singleton

◆ SyncFence