Version

menu_open
Wwise SDK 2023.1.2
AkMixerInputMap< KEY, USER_DATA > Class Template Reference

AkMixerInputMap: Map of inputs (identified with AK::IAkMixerInputContext *) to user-defined blocks of data. More...

#include <AkMixerInputMap.h>

Inheritance diagram for AkMixerInputMap< KEY, USER_DATA >:
AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocator > AkPluginArrayAllocator

Public Types

typedef AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocatorBaseClass
 

Public Member Functions

USER_DATA * Exists (KEY in_key)
 Returns the user data associated with given input context. Returns NULL if none found. More...
 
USER_DATA * AddInput (KEY in_key)
 Adds an input with new user data. More...
 
bool RemoveInput (KEY in_key)
 Removes an input and destroys its associated user data. More...
 
AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocator >::Iterator EraseSwap (typename AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocator >::Iterator &in_rIter)
 Erase the specified iterator in the array. but it does not guarantee the ordering in the array. More...
 
void Term ()
 Terminate array. More...
 
AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocator >::Iterator FindEx (KEY in_key) const
 Finds an item in the array. More...
 
void RemoveAll ()
 Removes and destroys all items in the array. More...
 
- Public Member Functions inherited from AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, 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 AkInputMapSlot< KEY, USER_DATA > & in_Item) const
 Returns the iterator th the specified item, will be End() if the item is not found. More...
 
Iterator BinarySearch (const AkInputMapSlot< KEY, USER_DATA > & 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 AkInputMapSlot< KEY, USER_DATA > * 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 AkInputMapSlot< KEY, USER_DATA > * Exists (const AkInputMapSlot< KEY, USER_DATA > & in_Item) const
 Returns a pointer to the specified item in the list if it exists, 0 if not found. More...
 
AkForceInline AkInputMapSlot< KEY, USER_DATA > * AddLast ()
 
AkForceInline AkInputMapSlot< KEY, USER_DATA > * AddLast (const AkInputMapSlot< KEY, USER_DATA > & in_rItem)
 Add an item in the array, and fills it with the provided item. More...
 
AkInputMapSlot< KEY, USER_DATA > & 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 AkInputMapSlot< KEY, USER_DATA > & in_rItem)
 Removes the specified item if found in the array. More...
 
AKRESULT RemoveSwap (const AkInputMapSlot< KEY, USER_DATA > & in_rItem)
 
void RemoveAll ()
 Removes all items in the array. More...
 
AkForceInline AkInputMapSlot< KEY, USER_DATA > & operator[] (unsigned int uiIndex) const
 Operator [], return a reference to the specified index. More...
 
Iterator Insert (Iterator &in_rIter)
 
AkInputMapSlot< KEY, USER_DATA > * 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< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocator, AkGrowByPolicy_DEFAULT, AkAssignmentMovePolicy< AkInputMapSlot< KEY, USER_DATA > > > &in_rSource)
 
AKRESULT Copy (const AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocator, AkGrowByPolicy_DEFAULT, AkAssignmentMovePolicy< AkInputMapSlot< KEY, USER_DATA > > > &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, size_t in_uNewSize)
 
AkForceInline void Free (void *in_pAddress)
 
AkForceInline void TransferMem (void *&io_pDest, AkPluginArrayAllocator &in_src, void *in_pSrc)
 
AkForceInline AK::IAkPluginMemAllocGetAllocator ()
 
- Protected Attributes inherited from AkArray< AkInputMapSlot< KEY, USER_DATA >, const AkInputMapSlot< KEY, USER_DATA > &, AkPluginArrayAllocator >
AkInputMapSlot< KEY, USER_DATA > * 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

template<class KEY, class USER_DATA>
class AkMixerInputMap< KEY, USER_DATA >

AkMixerInputMap: Map of inputs (identified with AK::IAkMixerInputContext *) to user-defined blocks of data.

Definition at line 73 of file AkMixerInputMap.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.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise