Go to the documentation of this file.
88 for (
auto it =
Begin(); it !=
End(); ++it)
90 if ((*it).pluginID == pluginID)
132 for (
int i = 0; i < (int)in_uLength; ++i)
152 const char* in_szName
void Transfer(AkAudioObject &in_from)
Transfer function for transfer move policies.
AkString< AkPluginArrayAllocator, char > String
String type for use in 3D audio objects.
Definition of data structures for AkAudioObject.
AkAudioObject()
Constructor.
static const AkUInt64 kObjectKeyNumBits
AkPositioningData positioning
Positioning data for deferred 3D rendering.
AkRamp cumulativeGain
Cumulative ramping gain to apply when mixing down to speaker bed or final endpoint.
void Transfer(AkString< TAlloc, T_CHAR > &in_from)
AKRESULT Copy(const AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
static const AkUInt64 kObjectKeyMask
static const AkPipelineID AK_INVALID_PIPELINE_ID
Invalid pipeline ID (for profiling)
AkAudioObjectID key
Unique ID, local to a given bus. Only the lower 56 of 64 bits are used for the object itself....
AkUInt32 AkUniqueID
Unique 32-bit ID.
void CopyContents(const AkAudioObject &in_src)
Copies object metadata (everything but the key) from another object.
Specific implementation of array.
void TransferContents(AkAudioObject &in_src)
Moves object metadata (everything but the key) from another object.
AKRESULT SetName(AK::IAkPluginMemAlloc *in_pAllocator, const char *in_szName)
static const AkPriority AK_DEFAULT_PRIORITY
Default sound / I/O priority.
AkForceInline void Init(AK::IAkPluginMemAlloc *in_pAllocator)
bool Resize(AkUInt32 in_uiSize)
Resize the array to the specified size.
AkAudioBuffer ** ppObjectBuffers
Array of pointers to audio object buffers.
void ResetState()
Reset object state in preparation for next frame.
AkUInt32 uNumObjects
Number of audio objects.
ArrayCustomMetadata arCustomMetadata
Array of custom metadata, gathered from visited objects. Note: any custom metadata is expected to exi...
Volume ramp specified by end points "previous" and "next".
Iterator End() const
Returns the iterator to the end of the array.
AkUInt32 AkPluginID
Source or effect plug-in ID.
void Transfer(AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
AkPipelineID instigatorID
Profiling ID of the node from which the object stems (typically the voice, instance of a Property Con...
Iterator Begin() const
Returns the iterator to the first item of the array, will be End() if the array is empty.
AkUInt32 AkPipelineID
Unique node (bus, voice) identifier for profiling.
AkUInt64 AkAudioObjectID
Audio Object ID.
Positioning data of 3D audio objects.
A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separ...
uint64_t AkUInt64
Unsigned 64-bit integer.
uint32_t AkUInt32
Unsigned 32-bit integer.
void SetCustomMetadata(CustomMetadata *in_aCustomMetadata, AkUInt32 in_uLength)
void Term()
Term the array. Must be called before destroying the object.
~AkAudioObject()
Destructor.
AkPriority priority
Audio object playback priority. Object with a higher priority will be rendered using the hardware's o...
AkInt8 AkPriority
Priority.
String objectName
Name string of the object, to appear in the object profiler. This is normally used by out-of-place ob...
AkAudioObjects(AkUInt32 in_uNumObjects=0, AkAudioBuffer **in_ppObjectBuffers=nullptr, AkAudioObject **in_ppObjects=nullptr)
AkAudioObject ** ppObjects
Array of pointers to audio objects.
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID
Invalid audio object ID.
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