FAtomCueSheetResource Class Reference

#include <AtomCueSheetResource.h>

Inheritance diagram for FAtomCueSheetResource:

Public Member Functions
	FAtomCueSheetResource (UAtomCueSheet *InSource)
virtual bool	AsyncLoad (TFunction< void(EAtomResourceLoadResult)> OnLoadCompleted, ENamedThreads::Type CallbackThread, EAtomResourceScope Scope) override
bool	AttachWaveBank (IAtomSoundResource *AtomWaveBankSource, uint16 Index, bool bCanReplace=false, bool bAsyncLoad=false)
bool	DetachWaveBank (uint16 Index)
bool	GetCueInfoByIndex (int32 CueIndex, FAtomCueInfo &OutCueInfo) const
virtual FAtomCueSheetResource *	GetCueSheetResource () override
CriAtomAwbHn	GetNativeAwbHandle (int16 Index=INDEX_NONE)
CriAtomExAcbHn	GetNativeHandle () const
int32	GetNumCues () const
uint16	GetNumWaveBankSlots () const
FString	GetWaveBankSlotName (uint16 Index) const
bool	GetWaveformInfo (int32 CueID, FAtomWaveInfo &OutWaveInfo, bool bReadFromWaveBank=false, bool bForceFromWaveBank=false)
virtual bool	IsLoaded () const override
bool	IsWavedBankLoaded (uint16 Index)
virtual void	IterateOverSoundResourceDependencies (const FIterateDependenciesCallback &Callback) const override
virtual void	Teardown () override
virtual void	Unload () override
Public Member Functions inherited from FAtomStreamableResource< FCriAtomExAcbPtr >
	FAtomStreamableResource (IAtomSoundResource *InSource)
virtual IAtomSoundResource *	GetSoundResource () const override
virtual bool	IsAsyncLoading () const override
bool	IsUsingFileSystemBinder () const
virtual void	MakeSureIsLoaded (EAtomResourceScope Scope) override
virtual void	Update () override
Public Member Functions inherited from FAtomResource
	FAtomResource ()
virtual	~FAtomResource ()
virtual FAtomWaveBankResource *	GetWaveBankResource ()
virtual bool	Init (FAtomResourceId InResourceID)

Protected Member Functions
bool	AttachWaveBankInternal (IAtomSoundResource *WaveBankSource, uint16 Index, bool bCanReplace, bool bAsyncLoad)
Protected Member Functions inherited from FAtomStreamableResource< FCriAtomExAcbPtr >
void	ReleaseFsBinderWork ()
void	ReleaseResourceWork ()
void	SetFsBinderWork (int32 WorkSize)
void	SetFsHandle (FCriFsBinderPtr &InFsBinder)
void	SetNativeHandle (FCriAtomExAcbPtr &InCriHandle)
void	SetResourceWork (int32 WorkSize)

Protected Attributes
TMap< uint16, FAtomResourceHandle >	AttachedAwbResources
FCriticalSection	SDKCriticalSection
Protected Attributes inherited from FAtomStreamableResource< FCriAtomExAcbPtr >
bool	bIsStreamed
FCriAtomExAcbPtr	CriResource
FCriFsBinderPtr	FsBinder
void *	FsBinderWork
FLoadTask *	LoadTask
FCriticalSection	LoadTaskLock
uint8 *	LocalData
FOnLoadCompletedEvent	OnLoadCompletedEvent
void *	ResourceWork
IAtomSoundResource *	Source
Protected Attributes inherited from FAtomResource
FAtomResourceId	ResourceID

Additional Inherited Members
Protected Types inherited from FAtomResource
typedef TUniqueFunction< void(IAtomSoundResource *Dependency)>	FIterateDependenciesCallback

Constructor & Destructor Documentation

FAtomCueSheetResource()

FAtomCueSheetResource::FAtomCueSheetResource ( UAtomCueSheet * InSource )

inline

Member Function Documentation

AsyncLoad()

bool FAtomCueSheetResource::AsyncLoad ( TFunction< void(EAtomResourceLoadResult)> OnLoadCompleted, ENamedThreads::Type CallbackThread, EAtomResourceScope Scope )

overridevirtual

Reimplemented from FAtomResource.

AttachWaveBank()

bool FAtomCueSheetResource::AttachWaveBank	(	IAtomSoundResource *	AtomWaveBankSource,
		uint16	Index,
		bool	bCanReplace = false,
		bool	bAsyncLoad = false )

AttachWaveBankInternal()

bool FAtomCueSheetResource::AttachWaveBankInternal ( IAtomSoundResource * WaveBankSource, uint16 Index, bool bCanReplace, bool bAsyncLoad )

protected

DetachWaveBank()

bool FAtomCueSheetResource::DetachWaveBank

(

uint16

Index

)

GetCueInfoByIndex()

bool FAtomCueSheetResource::GetCueInfoByIndex	(	int32	CueIndex,
		FAtomCueInfo &	OutCueInfo ) const

Retrieves cue information by its index in this cue sheet resource.

GetCueSheetResource()

virtual FAtomCueSheetResource * FAtomCueSheetResource::GetCueSheetResource ( )

inlineoverridevirtual

Reimplemented from FAtomResource.

GetNativeAwbHandle()

CriAtomAwbHn FAtomCueSheetResource::GetNativeAwbHandle

(

int16

Index = INDEX_NONE

)

Retruns the native wave bank handle pointer used by this cue sheet to access to other native functions. (Use this with care)

GetNativeHandle()

CriAtomExAcbHn FAtomCueSheetResource::GetNativeHandle

(

)

const

Retruns the native handle pointer to access to other native functions. (Use this with care)

GetNumCues()

int32 FAtomCueSheetResource::GetNumCues

(

)

const

Retrieves the number of cues in this cue sheet resource.

GetNumWaveBankSlots()

uint16 FAtomCueSheetResource::GetNumWaveBankSlots

(

)

const

Retrieves the number of slot to native wave bank used by this cue sheet resource.

GetWaveBankSlotName()

FString FAtomCueSheetResource::GetWaveBankSlotName

(

uint16

Index

)

const

Retrieves the name of slot to native wave bank used by this cue sheet resource.

GetWaveformInfo()

bool FAtomCueSheetResource::GetWaveformInfo	(	int32	CueID,
		FAtomWaveInfo &	OutWaveInfo,
		bool	bReadFromWaveBank = false,
		bool	bForceFromWaveBank = false )

Retrieves first wave information of a cue. By default this function reads wave info from cue data. Use flags to try to read data from attached wave banks.

Parameters

bReadFromWaveBank	When streamed sound, tries to read data from attached wave bank else use cue info.
bForceFromWaveBank	Implies bReadFromWaveBank set to true. When streamed sound, tries to read data from attached wave bank else return false.

Returns

if the wave information was retreived.

IsLoaded()

bool FAtomCueSheetResource::IsLoaded ( ) const

overridevirtual

Reimplemented from FAtomStreamableResource< FCriAtomExAcbPtr >.

IsWavedBankLoaded()

bool FAtomCueSheetResource::IsWavedBankLoaded

(

uint16

Index

)

IterateOverSoundResourceDependencies()

void FAtomCueSheetResource::IterateOverSoundResourceDependencies ( const FIterateDependenciesCallback & Callback ) const

overridevirtual

Reimplemented from FAtomResource.

Teardown()

void FAtomCueSheetResource::Teardown ( )

overridevirtual

Reimplemented from FAtomResource.

Unload()

void FAtomCueSheetResource::Unload ( )

overridevirtual

Reimplemented from FAtomResource.

Member Data Documentation

AttachedAwbResources

TMap<uint16, FAtomResourceHandle> FAtomCueSheetResource::AttachedAwbResources

protected

SDKCriticalSection

FCriticalSection FAtomCueSheetResource::SDKCriticalSection

protected

---

The documentation for this class was generated from the following files:

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