ArrayCustomMetadata

Other Documentation

Wwise SDK 2022.1.4

Array type for carrying custom metadata. More...

#include <AkCommonDefs.h>

Inheritance diagram for AkAudioObject::ArrayCustomMetadata:

Public Types
using	ArrayType = AkArray< CustomMetadata, const CustomMetadata &, AkPluginArrayAllocator >

Public Member Functions
ArrayType::Iterator	FindByPluginID (AkPluginID pluginID) const

Public Member Functions inherited from AkArray< CustomMetadata, const CustomMetadata &, AkPluginArrayAllocator >
	AkArray ()
	Constructor. More...

	~AkArray ()
	Destructor. More...

Iterator	Begin () const
	Returns the iterator to the first item of the array, will be End() if the array is empty. More...

Iterator	End () const
	Returns the iterator to the end of the array. More...

Iterator	FindEx (const CustomMetadata & in_Item) const
	Returns the iterator th the specified item, will be End() if the item is not found. More...

Iterator	BinarySearch (const CustomMetadata & in_Item) const

Iterator	Erase (Iterator &in_rIter)
	Erase the specified iterator from the array. More...

void	Erase (unsigned int in_uIndex)
	Erase the item at the specified index. More...

Iterator	EraseSwap (Iterator &in_rIter)

void	EraseSwap (unsigned int in_uIndex)

bool	IsGrowingAllowed () const

AKRESULT	Reserve (AkUInt32 in_ulReserve)

AKRESULT	ReserveExtra (AkUInt32 in_ulReserve)

AkUInt32	Reserved () const

void	Term ()
	Term the array. Must be called before destroying the object. More...

AkForceInline AkUInt32	Length () const
	Returns the numbers of items in the array. More...

AkForceInline CustomMetadata *	Data () const
	Returns a pointer to the first item in the array. More...

AkForceInline bool	IsEmpty () const
	Returns true if the number items in the array is 0, false otherwise. More...

AkForceInline CustomMetadata *	Exists (const CustomMetadata & in_Item) const
	Returns a pointer to the specified item in the list if it exists, 0 if not found. More...

AkForceInline CustomMetadata *	AddLast ()

AkForceInline CustomMetadata *	AddLast (const CustomMetadata & in_rItem)
	Add an item in the array, and fills it with the provided item. More...

CustomMetadata &	Last ()
	Returns a reference to the last item in the array. More...

void	RemoveLast ()
	Removes the last item from the array. More...

AKRESULT	Remove (const CustomMetadata & in_rItem)
	Removes the specified item if found in the array. More...

AKRESULT	RemoveSwap (const CustomMetadata & in_rItem)

void	RemoveAll ()
	Removes all items in the array. More...

AkForceInline CustomMetadata &	operator[] (unsigned int uiIndex) const
	Operator [], return a reference to the specified index. More...

CustomMetadata *	Insert (unsigned int in_uIndex)

bool	GrowArray ()

bool	GrowArray (AkUInt32 in_uGrowBy)
	Resize the array. More...

bool	Resize (AkUInt32 in_uiSize)
	Resize the array to the specified size. More...

void	Transfer (AkArray< CustomMetadata, const CustomMetadata &, AkPluginArrayAllocator, AkGrowByPolicy_DEFAULT, AkAssignmentMovePolicy< CustomMetadata > > &in_rSource)

AKRESULT	Copy (const AkArray< CustomMetadata, const CustomMetadata &, AkPluginArrayAllocator, AkGrowByPolicy_DEFAULT, AkAssignmentMovePolicy< CustomMetadata > > &in_rSource)

Public Member Functions inherited from AkPluginArrayAllocator
AkForceInline	AkPluginArrayAllocator ()

AkForceInline void	Init (AK::IAkPluginMemAlloc *in_pAllocator)

Additional Inherited Members
Protected Member Functions inherited from AkPluginArrayAllocator
AkForceInline void *	Alloc (size_t in_uSize)

AkForceInline void *	ReAlloc (void *in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)

AkForceInline void	Free (void *in_pAddress)

AkForceInline void	TransferMem (void &io_pDest, AkPluginArrayAllocator &in_src, void in_pSrc)

AkForceInline AK::IAkPluginMemAlloc *	GetAllocator ()

Protected Attributes inherited from AkArray< CustomMetadata, const CustomMetadata &, AkPluginArrayAllocator >
CustomMetadata *	m_pItems
	pointer to the beginning of the array. More...

AkUInt32	m_uLength
	number of items in the array. More...

AkUInt32	m_ulReserved
	how many we can have at most (currently allocated). More...

Detailed Description

Array type for carrying custom metadata.

Definition at line 332 of file AkCommonDefs.h.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Get started with Wwise