An plAmplitudeAudioControlCollectionResource is used by the audio system to map a collection of audio controls to a single audio middleware. More...

#include <AudioControlCollectionResource.h>

Inheritance diagram for plAmplitudeAudioControlCollectionResource:

[legend]

Public Member Functions
void	Register ()
	Registers this collection to the audio system.

void	Unregister ()
	Removes the registered controls from the audio system.

const plAmplitudeAudioControlCollectionResourceDescriptor &	GetDescriptor () const
	Returns the resource descriptor for this resource.

Public Member Functions inherited from plResource
PL_ALWAYS_INLINE const plString &	GetResourceID () const
	Returns the unique ID that identifies this resource. On a file resource this might be a path. Can also be a GUID or any other scheme that uniquely identifies the resource.

PL_ALWAYS_INLINE plUInt64	GetResourceIDHash () const
	Returns the hash of the unique ID.

void	SetResourceDescription (plStringView sDescription)
	The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.

const plString &	GetResourceDescription () const
	The resource description allows to store an additional string that might be more descriptive during debugging, than the unique ID.

const plString &	GetResourceIdOrDescription () const
	The returns the resource description, if available, otherwise the resource ID.

PL_ALWAYS_INLINE plResourceState	GetLoadingState () const
	Returns the current state in which this resource is in.

PL_ALWAYS_INLINE plUInt8	GetNumQualityLevelsDiscardable () const
	Returns the current maximum quality level that the resource could have.

PL_ALWAYS_INLINE plUInt8	GetNumQualityLevelsLoadable () const
	Returns how many quality levels the resource may additionally load.

float	GetLoadingPriority (plTime now) const
	Returns the priority that is used by the resource manager to determine which resource to load next.

plResourcePriority	GetPriority () const
	Returns the current resource priority.

void	SetPriority (plResourcePriority priority)
	Changes the current resource priority.

PL_ALWAYS_INLINE const plBitflags< plResourceFlags > &	GetBaseResourceFlags () const
	Returns the basic flags for the resource type. Mostly used the resource manager.

PL_ALWAYS_INLINE const MemoryUsage &	GetMemoryUsage () const
	Returns the information about the current memory usage of the resource.

PL_ALWAYS_INLINE plTime	GetLastAcquireTime () const
	Returns the time at which the resource was (tried to be) acquired last. If a resource is acquired using plResourceAcquireMode::PointerOnly, this does not update the last acquired time, since the resource is not acquired for full use.

PL_ALWAYS_INLINE plInt32	GetReferenceCount () const
	Returns the reference count of this resource.

PL_ALWAYS_INLINE const plTimestamp &	GetLoadedFileModificationTime () const
	Returns the modification date of the file from which this resource was loaded.

PL_ALWAYS_INLINE plUInt32	GetCurrentResourceChangeCounter () const
	Returns the current value of the resource change counter. Can be used to detect whether the resource has changed since using it last time.

PL_ALWAYS_INLINE void	IncResourceChangeCounter ()
	Allows to manually increase the resource change counter to signal that dependent code might need to update.

virtual void	ResetResource ()
	If the resource has modifications from the original state, it should reset itself to that state now (or force a reload on itself).

void	PrintHandleStackTraces ()
	Prints the stack-traces for all handles that currently reference this resource.

Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const plRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
PL_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Private Member Functions
plResourceLoadDesc	UnloadData (Unload WhatToUnload) override
	Requests the resource to unload another quality level. If bFullUnload is true, the resource should unload all data, because it is going to be deleted afterwards.

plResourceLoadDesc	UpdateContent (plStreamReader *pStream) override
	Called whenever more data for the resource is available. The resource must read the stream to update it's data.

void	UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage) override
	This function must be overridden by all resource types.

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Public Attributes inherited from plResource
plEvent< const plResourceEvent &, plMutex >	m_ResourceEvents

Protected Types inherited from plResource
enum class	DoUpdate { OnMainThread , OnAnyThread }

enum class	Unload { AllQualityLevels , OneQualityLevel }

Protected Member Functions inherited from plResource
	plResource (DoUpdate ResourceUpdateThread, plUInt8 uiQualityLevelsLoadable)
	Default constructor.

virtual	~plResource ()
	virtual destructor.

MemoryUsage &	ModifyMemoryUsage ()
	Non-const version for resources that want to write this variable directly.

void	SetIsReloadable (bool bIsReloadable)
	Call this to specify whether a resource is reloadable.

void	SetHasLoadingFallback (bool bHasLoadingFallback)
	Used internally by the code injection macros.

Detailed Description

An plAmplitudeAudioControlCollectionResource is used by the audio system to map a collection of audio controls to a single audio middleware.

For each audio control should specify the control name, the control type, and the path to the generated middleware control file. Those controls will now be able to be used by the audio system through components.

Member Function Documentation

◆ Register()

void plAmplitudeAudioControlCollectionResource::Register ( )

Registers this collection to the audio system.

Note: This is called automatically at initialization by the audio system on the control collection asset having the same name than the current audio middleware.

Calling this twice has no effect.

◆ UnloadData()

plResourceLoadDesc plAmplitudeAudioControlCollectionResource::UnloadData ( Unload WhatToUnload )

overrideprivatevirtual

Requests the resource to unload another quality level. If bFullUnload is true, the resource should unload all data, because it is going to be deleted afterwards.

Implements plResource.

◆ Unregister()

void plAmplitudeAudioControlCollectionResource::Unregister ( )

Removes the registered controls from the audio system.

Calling this twice has no effect.

◆ UpdateContent()

plResourceLoadDesc plAmplitudeAudioControlCollectionResource::UpdateContent ( plStreamReader * pStream )

overrideprivatevirtual

Called whenever more data for the resource is available. The resource must read the stream to update it's data.

pStream may be nullptr in case the resource data could not be found.

Implements plResource.

◆ UpdateMemoryUsage()

void plAmplitudeAudioControlCollectionResource::UpdateMemoryUsage ( MemoryUsage & out_NewMemoryUsage )

overrideprivatevirtual

This function must be overridden by all resource types.

It has to compute the memory used by this resource. It is called by the resource manager whenever the resource's data has been loaded or unloaded.

Implements plResource.

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

Code/EnginePlugins/AudioSystem/AmplitudeAudioPlugin/Resources/AudioControlCollectionResource.h
Code/EnginePlugins/AudioSystem/AmplitudeAudioPlugin/Resources/AudioControlCollectionResource.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Register()

◆ UnloadData()

◆ Unregister()

◆ UpdateContent()

◆ UpdateMemoryUsage()