Table of Contents

Wwise SDK 2019.1.6
AkMixerInputMap< USER_DATA > Class Template Reference

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

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

Public Types

typedef AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, 1 >  BaseClass
 

Public Member Functions

USER_DATA *  Exists (AK::IAkMixerInputContext *in_pInput)
  Returns the user data associated with given input context. Returns NULL if none found. More...
 
USER_DATA *  AddInput (AK::IAkMixerInputContext *in_pInput)
  Adds an input with new user data. More...
 
bool  RemoveInput (AK::IAkMixerInputContext *in_pInput)
  Removes an input and destroys its associated user data. More...
 
void  Term ()
  Terminate array. More...
 
AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, 1 >::Iterator  FindEx (AK::IAkMixerInputContext *in_pInput) 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< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, 1 >
  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< 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< 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)
 
AKRESULT  Reserve (AkUInt32 in_ulReserve)
  Pre-Allocate a number of spaces in the array. More...
 
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< 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< USER_DATA > *  Exists (const AkInputMapSlot< 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< USER_DATA > *  AddLast ()
 
AkForceInline AkInputMapSlot< USER_DATA > *  AddLast (const AkInputMapSlot< USER_DATA > & in_rItem)
  Add an item in the array, and fills it with the provided item. More...
 
AkInputMapSlot< 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< USER_DATA > & in_rItem)
  Removes the specified item if found in the array. More...
 
AKRESULT  RemoveSwap (const AkInputMapSlot< USER_DATA > & in_rItem)
 
void  RemoveAll ()
  Removes all items in the array. More...
 
AkForceInline AkInputMapSlot< USER_DATA > &  operator[] (unsigned int uiIndex) const
  Operator [], return a reference to the specified index. More...
 
AkInputMapSlot< USER_DATA > *  Insert (unsigned int in_uIndex)
 
bool  GrowArray (AkUInt32 in_uGrowBy=TGrowBy)
  Resize the array. More...
 
bool  Resize (AkUInt32 in_uiSize)
  Resize the array to the specified size. More...
 
void  Transfer (AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, TGrowBy, AkAssignmentMovePolicy< AkInputMapSlot< USER_DATA > > > &in_rSource)
 
AKRESULT  Copy (const AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, TGrowBy, AkAssignmentMovePolicy< AkInputMapSlot< 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 in_uOldSize, size_t in_uNewSize)
 
AkForceInline void  Free (void *in_pAddress)
 
AkForceInline AK::IAkPluginMemAlloc GetAllocator ()
 
- Protected Attributes inherited from AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, 1 >
AkInputMapSlot< 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 USER_DATA>
class AkMixerInputMap< USER_DATA >

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

Definition at line 100 of file AkMixerInputMap.h.


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