版本

menu_open
警告:系统已根据您所用大版本 (2022.1.17.8543) 自动跳转至最新文档。若想访问特定版本的文档,请从 Audiokinetic Launcher 下载离线文档,并在 Wwise 设计程序中勾选 Offline Documentation 选项。
Wwise SDK 2022.1.17
AkCommonDefs.h
void Transfer(AkAudioObject &in_from)
Transfer function for transfer move policies.
Definition: AkCommonDefs.h:382
AkString< AkPluginArrayAllocator, char > String
String type for use in 3D audio objects.
Definition: AkCommonDefs.h:352
AkForceInline bool HasLFE() const
Returns true if there is an LFE channel present.
Definition: AkCommonDefs.h:487
bool enableHeightSpread
When true, audio objects 3D spatialized onto a planar channel configuration will be given a minimum s...
Definition: AkCommonDefs.h:283
#define AkMin(x1, x2)
AkUInt8 AkDataInterleaveID
Data interleaved state ID
Definition: AkTypes.h:138
@ AK_DirectSpeakerAssignment
No panning: route to matching channels between input and output.
Definition: AkTypes.h:1156
AkUInt32 uAvailableSystemAudioObjects
How many System Audio Objects can currently be sent to the sink. This value can change at runtime dep...
Definition: AkCommonDefs.h:422
AkSampleType * GetChannel(AkUInt32 in_uIndex)
Definition: AkCommonDefs.h:565
#define AK_DEFAULT_TOP_Z
Definition: AkCommonDefs.h:241
uint16_t AkUInt16
Unsigned 16-bit integer
Audiokinetic namespace
AkForceInline bool HasData() const
Check if buffer has samples attached to it.
Definition: AkCommonDefs.h:530
AkAudioObject()
Constructor
Definition: AkCommonDefs.h:304
AkForceInline bool HasCenter() const
AkPositioningData positioning
Positioning data for deferred 3D rendering.
Definition: AkCommonDefs.h:320
@ SourceChannelOrdering_FuMa
Definition: AkCommonDefs.h:171
AkReal32 center
Center percentage [0,1]
Definition: AkCommonDefs.h:276
AkRamp cumulativeGain
Cumulative ramping gain to apply when mixing down to speaker bed or final endpoint
Definition: AkCommonDefs.h:321
AkForceInline AkChannelConfig GetChannelConfig() const
Definition: AkCommonDefs.h:492
void Transfer(AkString< TAlloc, T_CHAR > &in_from)
Definition: AkString.h:108
AkUInt64 AkAudioObjectID
Audio Object ID
Definition: AkTypes.h:156
AKRESULT Copy(const AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:827
@ SourceChannelOrdering_Standard
Definition: AkCommonDefs.h:167
AkReal32 panSpatMix
Panning vs 3D spatialization mix ([0,1], 1 being 100% spatialized).
Definition: AkCommonDefs.h:280
bool bMultiChannelObjects
Can handle multi-channel objects
Definition: AkCommonDefs.h:424
AkUInt32 AkPipelineID
Unique node (bus, voice) identifier for profiling.
Definition: AkTypes.h:154
AkAudioBuffer()
Constructor.
Definition: AkCommonDefs.h:458
AkUInt32 uMaxSystemAudioObjects
Maximum number of System Audio Objects that can be active concurrently. A value of zero indicates the...
Definition: AkCommonDefs.h:421
AkUInt32 uNumChannels
Number of channels.
AkAudioObjectID key
Unique ID, local to a given bus.
Definition: AkCommonDefs.h:318
AkForceInline void * DetachContiguousDeinterleavedData()
Detach deinterleaved data where channels are contiguous in memory. The address of the buffer is retur...
Definition: AkCommonDefs.h:611
AkForceInline AkUInt32 NumChannels() const
Get the number of channels.
Definition: AkCommonDefs.h:481
AkForceInline void Clear()
Clear members.
Definition: AkCommonDefs.h:471
#define AK_DEFAULT_LISTENER_FRONT_Y
Definition: AkCommonDefs.h:237
AKRESULT
Standard function call result.
Definition: AkTypes.h:199
AkUInt32 uChannelMask
Channel mask (configuration).
static AkUInt32 StandardToPipelineIndex(AkChannelConfig in_channelConfig, AkUInt32 in_uChannelIdx)
Definition: AkCommonDefs.h:537
@ AK_ChannelConfigType_Standard
Channels must be identified with standard defines in AkSpeakerConfigs.
AkForceInline bool HasCenter() const
Definition: AkCommonDefs.h:90
void Set(const AkVector &in_position, const AkVector &in_orientationFront, const AkVector &in_orientationTop)
Set position and orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:623
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID
Invalid audio object ID
Definition: AkTypes.h:177
AkUInt32 AkChannelMask
Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig....
Definition: AkTypes.h:149
AkChannelConfig channelConfig
Channel configuration.
Definition: AkCommonDefs.h:65
#define AK_DEFAULT_LISTENER_POSITION_Z
Definition: AkCommonDefs.h:235
@ SourceChannelOrdering_Film
Definition: AkCommonDefs.h:170
void RelocateMedia(AkUInt8 *in_pNewMedia, AkUInt8 *in_pOldMedia)
Definition: AkCommonDefs.h:625
uint8_t AkUInt8
Unsigned 8-bit integer
AkUInt32 uBitsPerSample
Number of bits per sample.
Definition: AkCommonDefs.h:67
#define AK_DEFAULT_LISTENER_POSITION_Y
Definition: AkCommonDefs.h:234
void CopyContents(const AkAudioObject &in_src)
Copy object metadata (everything but the key) from another object.
Definition: AkCommonDefs.h:358
Positioning data inherited from sound structures and mix busses.
Definition: AkCommonDefs.h:264
AkUInt32 uTypeID
Data type ID (AkDataTypeID).
Definition: AkCommonDefs.h:69
#define AK_DEFAULT_TOP_X
Definition: AkCommonDefs.h:239
Specific implementation of array
Definition: AkArray.h:241
AK::SpeakerVolumes::VectorPtr rms
Definition: AkCommonDefs.h:214
#define NULL
Definition: AkTypes.h:46
float AkReal32
32-bit floating point
AKRESULT eState
Execution status
Definition: AkCommonDefs.h:640
AK::SpeakerVolumes::VectorPtr truePeak
Definition: AkCommonDefs.h:210
AkReal32 panDU
Pan down-up [-1,1]
Definition: AkCommonDefs.h:279
AkUInt16 uValidFrames
Number of valid sample frames in the audio buffer
Definition: AkCommonDefs.h:646
uintptr_t AkUIntPtr
Integer (unsigned) type for pointers
static const AkPriority AK_DEFAULT_PRIORITY
Default sound / I/O priority
Definition: AkTypes.h:180
AKRESULT SetName(AK::IAkPluginMemAlloc *in_pAllocator, const char *in_szName)
Definition: AkCommonDefs.h:397
#define AK_DEFAULT_TOP_Y
Definition: AkCommonDefs.h:240
AkForceInline void Init(AK::IAkPluginMemAlloc *in_pAllocator)
AkReal32 * VectorPtr
Volume vector. Access each element with the standard bracket [] operator.
void * pData
Start of the audio buffer.
Definition: AkCommonDefs.h:636
AkAudioObjectDestination
Enum of the possible object destinations when reaching a 3D audio-capable sink
Definition: AkCommonDefs.h:429
AkChannelConfig channelConfig
Channel config.
Definition: AkCommonDefs.h:637
AkUInt32 AkUniqueID
Unique 32-bit ID
Definition: AkTypes.h:120
bool Resize(AkUInt32 in_uiSize)
Resize the array to the specified size.
Definition: AkArray.h:784
AkAudioBuffer ** ppObjectBuffers
Array of pointers to audio object buffers.
Definition: AkCommonDefs.h:659
Ak3DSpatializationMode
3D spatialization mode.
Definition: AkTypes.h:1189
AkReal32 fMeanPowerK
Definition: AkCommonDefs.h:218
#define AK_DEFAULT_LISTENER_POSITION_X
Default listener transform.
Definition: AkCommonDefs.h:233
const AkDataTypeID AK_FLOAT
Float data type
Definition: AkCommonDefs.h:50
AkUInt32 AkPluginID
Source or effect plug-in ID
Definition: AkTypes.h:131
AkUInt16 AkDataTypeID
Data sample type ID
Definition: AkTypes.h:137
void ResetState()
Reset object state in preparation for next frame.
Definition: AkCommonDefs.h:408
#define AKASSERT(Condition)
Definition: AkAssert.h:67
AkUInt32 uNumObjects
Number of audio objects.
Definition: AkCommonDefs.h:658
AkSpeakerPanningType panType
Speaker panning type.
Definition: AkCommonDefs.h:282
ArrayCustomMetadata arCustomMetadata
Array of custom metadata, gathered from visited objects. Note: any custom metadata is expected to exi...
Definition: AkCommonDefs.h:348
#define AKCODECID_BANK_BUS
Bank encoding for bus banks. These banks are contained in the /bus sub-folder.
Definition: AkTypes.h:1068
static const AkPipelineID AK_INVALID_PIPELINE_ID
Invalid pipeline ID (for profiling)
Definition: AkTypes.h:176
const AkUInt32 AK_LE_NATIVE_BITSPERSAMPLE
Native number of bits per sample.
Definition: AkCommonDefs.h:56
bool bPassthrough
Separate pass-through mix is supported.
Definition: AkCommonDefs.h:423
Volume ramp specified by end points "previous" and "next".
Definition: AkTypes.h:933
AkUInt16 uMaxFrames
Number of sample frames the buffer can hold. Access through AkAudioBuffer::MaxFrames().
Definition: AkCommonDefs.h:643
Iterator End() const
Returns the iterator to the end of the array
Definition: AkArray.h:335
AkPluginID pluginID
Full plugin ID, including company ID and plugin type. See AKMAKECLASSID macro.
Definition: AkCommonDefs.h:326
AkInt8 AkPriority
Priority
Definition: AkTypes.h:135
AkBehavioralPositioningData behavioral
Positioning data inherited from sound structures and mix busses.
Definition: AkCommonDefs.h:290
ArrayType::Iterator FindByPluginID(AkPluginID pluginID) const
Definition: AkCommonDefs.h:337
AkForceInline void Clear()
Clear the channel config. Becomes "invalid" (IsValid() returns false).
AkReal32 AkSampleType
Audio sample data type (32 bit floating point)
Definition: AkCommonDefs.h:447
AK::IAkPluginParam * pParam
Custom, pluggable medata. Note: any custom metadata is expected to exist for only the current sound e...
Definition: AkCommonDefs.h:327
void ClearReference()
Definition: AkString.h:49
const AkUInt32 AK_LE_NATIVE_SAMPLETYPE
Native data type.
Definition: AkCommonDefs.h:57
#define AK_DEFAULT_LISTENER_FRONT_X
Definition: AkCommonDefs.h:236
AkForceInline void AkMemSet(void *pDest, AkInt32 iVal, AkUInt32 uSize)
Platform Independent Helper
void Transfer(AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:814
AkPipelineID instigatorID
Profiling ID of the node from which the object stems (typically the voice, instance of an actor-mixer...
Definition: AkCommonDefs.h:350
Iterator Begin() const
Returns the iterator to the first item of the array, will be End() if the array is empty.
Definition: AkArray.h:327
Ak3dData threeD
3D data used for 3D spatialization.
Definition: AkCommonDefs.h:289
AkForceInline AkUInt32 GetNumNonZeroBits(AkUInt32 in_uWord)
Struct containing metering information about a buffer. Depending on when this struct is generated,...
Definition: AkCommonDefs.h:203
AkForceInline AkUInt32 GetBitsPerSample() const
Definition: AkCommonDefs.h:97
@ AK_DataNeeded
The consumer needs more.
Definition: AkTypes.h:225
Positioning data of 3D audio objects.
Definition: AkCommonDefs.h:288
A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separ...
Definition: AkCommonDefs.h:651
#define AKCODECID_BANK_EVENT
Bank encoding for event banks. These banks are contained in the /event sub-folder.
Definition: AkTypes.h:1067
AkUInt32 uBlockAlign
Number of bytes per sample frame. (For example a 5.1 PCM 16bit should have a uBlockAlign equal to 6(5...
Definition: AkCommonDefs.h:68
AkChannelConfig channelConfig
Channel configuration of the main mix.
Definition: AkCommonDefs.h:420
AkForceInline AkUInt32 GetInterleaveID() const
Definition: AkCommonDefs.h:118
#define AK_DEFAULT_LISTENER_FRONT_Z
Definition: AkCommonDefs.h:238
AkForceInline bool operator!=(const AkAudioFormat &in_other) const
Definition: AkCommonDefs.h:152
#define AKCODECID_BANK
Bank encoding
Definition: AkTypes.h:1045
void ZeroPadToMaxFrames()
Definition: AkCommonDefs.h:587
AkForceInline bool HasLFE() const
Definition: AkCommonDefs.h:81
@ AK_SpatializationMode_None
No spatialization
Definition: AkTypes.h:1190
AkForceInline AkUInt32 GetBlockAlign() const
Definition: AkCommonDefs.h:104
AKRESULT AllocCopy()
Definition: AkString.h:84
AkChannelMask uEmitterChannelMask
Emitter channel mask. With 3D spatialization, zeroed channels should be dropped.
Definition: AkCommonDefs.h:259
uint32_t AkUInt32
Unsigned 32-bit integer
void SetCustomMetadata(CustomMetadata *in_aCustomMetadata, AkUInt32 in_uLength)
Definition: AkCommonDefs.h:370
AkUInt8(* AkChannelMappingFunc)(const AkChannelConfig &config, AkUInt8 idx)
Definition: AkCommonDefs.h:163
AkSpeakerPanningType
Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....
Definition: AkTypes.h:1155
AkUInt32 eConfigType
Channel config type (AkChannelConfigType).
AkReal32 panLR
Pan left-right [-1,1]
Definition: AkCommonDefs.h:277
AkForceInline void AttachContiguousDeinterleavedData(void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig)
Attach deinterleaved data where channels are contiguous in memory. Allocation is performed outside.
Definition: AkCommonDefs.h:606
void Term()
Term the array. Must be called before destroying the object.
Definition: AkArray.h:537
AkReal32 spread
Spread [0,1]
Definition: AkCommonDefs.h:257
AkForceInline bool HasLFE() const
~AkAudioObject()
Destructor
Definition: AkCommonDefs.h:312
AkPriority priority
Audio object playback priority. Object with a higher priority will be rendered using the hardware's o...
Definition: AkCommonDefs.h:355
AkForceInline bool operator==(const AkAudioFormat &in_other) const
Definition: AkCommonDefs.h:142
AkSampleType * GetLFE()
Definition: AkCommonDefs.h:577
AkForceInline void * GetInterleavedData()
Definition: AkCommonDefs.h:503
String objectName
Name string of the object, to appear in the object profiler. This is normally used by out-of-place ob...
Definition: AkCommonDefs.h:353
Custom object metadata.
Definition: AkCommonDefs.h:325
AkForceInline AkUInt32 GetNumChannels() const
Definition: AkCommonDefs.h:74
void Term()
Definition: AkString.h:39
#define AK_SPEAKER_LOW_FREQUENCY
Low-frequency speaker bit mask
Array type for carrying custom metadata.
Definition: AkCommonDefs.h:333
static bool IsBankCodecID(AkUInt32 in_codecID)
Definition: AkCommonDefs.h:221
const AkDataTypeID AK_INT
Integer data type (uchar, short, and so on)
Definition: AkCommonDefs.h:49
#define AkForceInline
Definition: AkTypes.h:63
Defines the parameters of an audio buffer format.
Definition: AkCommonDefs.h:62
AkUInt32 uInterleaveID
Interleave ID (AkDataInterleaveID).
Definition: AkCommonDefs.h:70
AkUniqueID contextID
(Profiling) ID of the sound or bus from which the custom metadata was fetched.
Definition: AkCommonDefs.h:328
bool CheckValidSamples()
Position and orientation of objects in a "local" space
Definition: AkTypes.h:594
AkForceInline AkUInt32 GetTypeID() const
Definition: AkCommonDefs.h:111
AkForceInline bool IsValid() const
Returns true if valid, false otherwise (as when it is constructed, or invalidated using Clear()).
AkReal32 focus
Focus [0,1]
Definition: AkCommonDefs.h:258
AkTransform xform
Object position / orientation.
Definition: AkCommonDefs.h:256
AkForceInline void ClearData()
Clear data pointer.
Definition: AkCommonDefs.h:464
void AttachInterleavedData(void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames)
Attach interleaved data. Allocation is performed outside.
Definition: AkCommonDefs.h:509
AkAudioObjects(AkUInt32 in_uNumObjects=0, AkAudioBuffer **in_ppObjectBuffers=nullptr, AkAudioObject **in_ppObjects=nullptr)
Definition: AkCommonDefs.h:652
AkAudioObject ** ppObjects
Array of pointers to audio objects.
Definition: AkCommonDefs.h:660
AkUInt32 uSampleRate
Number of samples per second
Definition: AkCommonDefs.h:63
AK::SpeakerVolumes::VectorPtr peak
Definition: AkCommonDefs.h:206
const AkDataInterleaveID AK_NONINTERLEAVED
Non-interleaved data
Definition: AkCommonDefs.h:53
Ak3DSpatializationMode spatMode
3D spatialization mode.
Definition: AkCommonDefs.h:281
AkReal32 panBF
Pan back-front [-1,1]
Definition: AkCommonDefs.h:278
const AkDataInterleaveID AK_INTERLEAVED
Interleaved data
Definition: AkCommonDefs.h:52
AkSourceChannelOrdering
Definition: AkCommonDefs.h:166
void AttachInterleavedData(void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig)
Attach interleaved data with a new channel config. Allocation is performed outside.
Definition: AkCommonDefs.h:517
void SetAll(AkUInt32 in_uSampleRate, AkChannelConfig in_channelConfig, AkUInt32 in_uBitsPerSample, AkUInt32 in_uBlockAlign, AkUInt32 in_uTypeID, AkUInt32 in_uInterleaveID)
Definition: AkCommonDefs.h:125
const AkUInt32 AK_LE_NATIVE_INTERLEAVE
Native interleaved setting.
Definition: AkCommonDefs.h:58
AkForceInline AkUInt16 MaxFrames() const
Definition: AkCommonDefs.h:633

此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅