UAtomSoundHandleSubsystem类 参考

#include <AtomSoundHandleSubsystem.h>

类 UAtomSoundHandleSubsystem 继承关系图:

类
struct	FSoundHandle

Public 成员函数
virtual	~UAtomSoundHandleSubsystem () override=default
virtual Atom::FSoundHandleID	CreateSoundHandle (UAtomSoundBase *Sound, IAtomSoundHandleOwner *Owner) override
	This should create a sound and we should map it to an identifier. Then return the identifier to the owner to keep track of
virtual void	Deinitialize () override
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
virtual void	NotifyActiveSoundDeleting (const FAtomActiveSound &ActiveSound) override
virtual void	NotifyVirtualizedSoundDeleting (const FAtomActiveSound &ActiveSound) override
virtual Atom::EResult	Play (Atom::FSoundHandleID ID) override
	Play the sound that is represented by the sound handle with the following ID
virtual void	SetTransform (Atom::FSoundHandleID ID, const FTransform &Transform) override
	Set the transform on the sound that is represented by the sound handle with the following ID
virtual bool	ShouldCreateSubsystem (UObject *Outer) const override
virtual void	Stop (Atom::FSoundHandleID ID) override
	Stop the sound that is represented by the sound handle with the following ID
Public 成员函数 继承自 UAtomEngineSubsystem
CRIWARECORE_API	UAtomEngineSubsystem ()
virtual CRIWARECORE_API const FAtomRuntime *	GetAtomRuntime () const final
virtual CRIWARECORE_API FAtomRuntimeHandle	GetAtomRuntimeHandle () const final
virtual CRIWARECORE_API FAtomRuntimeId	GetAtomRuntimeID () const final
virtual CRIWARECORE_API FAtomRuntime *	GetMutableAtomRuntime () final
virtual CRIWARECORE_API Atom::FMixerSourceManager *	GetMutableSourceManager () final
virtual CRIWARECORE_API const Atom::FMixerSourceManager *	GetSourceManager () const final
virtual void	Update ()
Public 成员函数 继承自 IAtomActiveSoundUpdate
virtual void	ApplyInteriorSettings (const FAtomActiveSound &ActiveSound, FAtomSoundParseParameters &ParseParams)
virtual void	GatherInteriorData (const FAtomActiveSound &ActiveSound, FAtomSoundParseParameters &ParseParams)
virtual void	NotifyActiveSoundCreated (FAtomActiveSound &ActiveSound)
virtual void	NotifyActiveSoundOwner (FAtomActiveSound &ActiveSound, const UObject *Owner)
virtual void	NotifyVirtualizedSoundCreated (FAtomActiveSound &ActiveSound)
virtual void	OnNotifyPendingDelete (const FAtomActiveSound &ActiveSound)
Public 成员函数 继承自 IAtomSoundHandleSystem
virtual	~IAtomSoundHandleSystem ()=default

Protected 成员函数
void	NotifySoundDeleting (const FAtomActiveSound &ActiveSound)

Protected 属性
TMap< Atom::FSoundHandleID, FSoundHandle >	ActiveHandles
TMap< Atom::FSoundHandleID, IAtomSoundHandleOwner * >	Owners

额外继承的成员函数
静态 Public 成员函数 继承自 IAtomSoundHandleSystem
static FName	GetModularFeatureName ()
static TArray< IAtomSoundHandleSystem * >	GetRegisteredInterfaces ()

详细描述

An implementation of IAtomSoundHandleSystem using AtomEngineSubsystem

构造及析构函数说明

~UAtomSoundHandleSubsystem()

virtual UAtomSoundHandleSubsystem::~UAtomSoundHandleSubsystem ( )

overridevirtualdefault

成员函数说明

CreateSoundHandle()

Atom::FSoundHandleID UAtomSoundHandleSubsystem::CreateSoundHandle ( UAtomSoundBase * Sound, IAtomSoundHandleOwner * Owner )

overridevirtual

This should create a sound and we should map it to an identifier. Then return the identifier to the owner to keep track of

参数

Sound
Owner

返回

重载 IAtomSoundHandleSystem .

Deinitialize()

void UAtomSoundHandleSubsystem::Deinitialize ( )

overridevirtual

Initialize()

void UAtomSoundHandleSubsystem::Initialize ( FSubsystemCollectionBase & Collection )

overridevirtual

NotifyActiveSoundDeleting()

void UAtomSoundHandleSubsystem::NotifyActiveSoundDeleting ( const FAtomActiveSound & ActiveSound )

overridevirtual

Called when an active sound has just been removed from the audio engine, by being stopped or virtualized. In either case, the referenced ActiveSound object is about to be deleted; any pointers to it should be discarded.

NOTE! Called on the AudioThread

参数

ActiveSound

The active sound being deleted

重载 IAtomActiveSoundUpdate .

NotifySoundDeleting()

void UAtomSoundHandleSubsystem::NotifySoundDeleting ( const FAtomActiveSound & ActiveSound )

protected

NotifyVirtualizedSoundDeleting()

void UAtomSoundHandleSubsystem::NotifyVirtualizedSoundDeleting ( const FAtomActiveSound & ActiveSound )

overridevirtual

Called when a virtualized sound has just been removed from the audio engine, by being stopped or re-triggered. In either case, the referenced ActiveSound object is about to be deleted; any pointers to it should be discarded.

NOTE! Called on the AudioThread

参数

ActiveSound

The active sound being removed

重载 IAtomActiveSoundUpdate .

Play()

Atom::EResult UAtomSoundHandleSubsystem::Play ( Atom::FSoundHandleID ID )

overridevirtual

Play the sound that is represented by the sound handle with the following ID

参数

ID

重载 IAtomSoundHandleSystem .

SetTransform()

void UAtomSoundHandleSubsystem::SetTransform ( Atom::FSoundHandleID ID, const FTransform & Transform )

overridevirtual

Set the transform on the sound that is represented by the sound handle with the following ID

参数

ID
Transform

重载 IAtomSoundHandleSystem .

ShouldCreateSubsystem()

bool UAtomSoundHandleSubsystem::ShouldCreateSubsystem ( UObject * Outer ) const

overridevirtual

Stop()

void UAtomSoundHandleSubsystem::Stop ( Atom::FSoundHandleID ID )

overridevirtual

Stop the sound that is represented by the sound handle with the following ID

参数

ID

重载 IAtomSoundHandleSystem .

类成员变量说明

ActiveHandles

TMap<Atom::FSoundHandleID, FSoundHandle> UAtomSoundHandleSubsystem::ActiveHandles

protected

Owners

TMap<Atom::FSoundHandleID, IAtomSoundHandleOwner*> UAtomSoundHandleSubsystem::Owners

protected

---

该类的文档由以下文件生成:

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