版本

menu_open
Wwise SDK 2023.1.8
AkCallback.h
Interface to retrieve contextual information for a mixer.
Definition: IAkPlugin.h:443
@ AK_MIDIEvent
Enable notifications for MIDI events. AkCallbackInfo can be cast to AkMIDIEventCallbackInfo.
Definition: AkCallback.h:70
@ AkGlobalCallbackLocation_Num
Total number of global callback locations.
Definition: AkCallback.h:358
const char * strLabel
Label of the marker (null-terminated)
Definition: AkCallback.h:119
AkUniqueID audioNodeID
Audio Node ID of playing item
Definition: AkCallback.h:131
Resources data summary structure containing general information about the system
Definition: AkCallback.h:244
AK::AkMetering ** ppSystemAudioObjectMetering
Metering information for each System Audio Object (number of elements is equal to uNumSystemAudioObje...
Definition: AkCallback.h:191
AkInt32 AkTimeMs
Time in ms
Definition: AkTypes.h:56
Audiokinetic namespace
char * pszUserCueName
Cue name (UTF-8 string). Set for notifications AK_MusicSyncUserCue. NULL if cue has no name.
Definition: AkCallback.h:239
@ AK_EndOfEvent
Callback triggered when reaching the end of an event. AkCallbackInfo can be cast to AkEventCallbackIn...
Definition: AkCallback.h:49
AkGameObjectID gameObjID
Game object ID
Definition: AkCallback.h:87
@ AkAudioDeviceEvent_Initialization
Sent after an Audio Device has initialized. Initialization might have failed, check the AKRESULT.
Definition: AkCallback.h:383
@ AK_MusicSyncEntry
Enable notifications on Music Entry Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:63
void(* AkResourceMonitorCallbackFunc)(const AkResourceMonitorDataSummary *in_pdataSummary)
Definition: AkCallback.h:375
@ AK_MusicSyncBar
Enable notifications on Music Bar. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:62
AkReal32 * pfBaseVolume
Base volume, common to all channels.
Definition: AkCallback.h:168
@ AkGlobalCallbackLocation_EndRender
End of frame rendering.
Definition: AkCallback.h:343
AkChannelConfig mainMixConfig
Channel configuration of the main mix
Definition: AkCallback.h:187
AkUInt32 uPlaylistSelection
Selection: set by sound engine, modified by callback function (if not in range 0 <= uPlaylistSelectio...
Definition: AkCallback.h:209
@ AkGlobalCallbackLocation_Begin
Start of audio processing. The number of frames about to be rendered depends on the sink/end-point an...
Definition: AkCallback.h:338
@ AkGlobalCallbackLocation_Register
Right after successful registration of callback/plugin. Typically used by plugins along with AkGlobal...
Definition: AkCallback.h:336
AkChannelConfig outputConfig
Channel configuration of the output bus.
Definition: AkCallback.h:167
@ AK_Duration
Callback triggered when the duration of the sound is known by the sound engine. AkCallbackInfo can be...
Definition: AkCallback.h:52
@ AkGlobalCallbackLocation_End
End of audio processing.
Definition: AkCallback.h:345
AkTimeMs iActiveDuration
Duration of the active region of the segment (between the Entry and Exit Cues), in milliseconds.
Definition: AkCallback.h:218
AkChannelConfig inputConfig
Channel configuration of the voice/bus.
Definition: AkCallback.h:166
AkUInt64 AkGameObjectID
Game object ID
Definition: AkTypes.h:60
@ AK_MusicSyncAll
Use this flag if you want to receive all notifications concerning AK_MusicSync registration.
Definition: AkCallback.h:68
@ AkGlobalCallbackLocation_Term
Sound engine termination.
Definition: AkCallback.h:347
AKRESULT
Standard function call result.
Definition: AkTypes.h:131
void(* AkGlobalCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkGlobalCallbackLocation in_eLocation, void *in_pCookie)
Definition: AkCallback.h:368
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkTypes.h:1153
AK::IAkMixerPluginContext * pMixerContext
Output mixing bus context. Use it to access a few useful panning and mixing services,...
Definition: AkCallback.h:170
Structure used to query info on active playing segments.
Definition: AkCallback.h:215
AkReal32 fBeatDuration
Beat Duration in seconds.
Definition: AkCallback.h:221
@ AK_CallbackBits
Bitmask for all callback types.
Definition: AkCallback.h:72
@ AkAudioDeviceEvent_SystemRemoval
Audio device was removed because of a system event (disconnection), hardware or driver problem....
Definition: AkCallback.h:385
void(* AkBusMeteringCallbackFunc)(AkBusMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:286
@ AkGlobalCallbackLocation_Suspend
Sound engine suspension through AK::SoundEngine::Suspend
Definition: AkCallback.h:354
AkCallbackType
Type of callback. Used as a bitfield in methods AK::SoundEngine::PostEvent() and AK::SoundEngine::Dyn...
Definition: AkCallback.h:48
AkReal32 fDuration
Duration of the sound (unit: milliseconds)
Definition: AkCallback.h:129
@ AkGlobalCallbackLocation_WakeupFromSuspend
Sound engine awakening through AK::SoundEngine::WakeupFromSuspend
Definition: AkCallback.h:355
@ AkGlobalCallbackLocation_Init
Sound engine initialization.
Definition: AkCallback.h:352
void(* AkOutputDeviceMeteringCallbackFunc)(AkOutputDeviceMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:296
AkTimeMs iPreEntryDuration
Duration of the pre-entry region of the segment, in milliseconds.
Definition: AkCallback.h:217
float AkReal32
32-bit floating point
AkChannelConfig passthroughMixConfig
Channel configuration of the passthrough mix (if any; will be invalid otherwise)
Definition: AkCallback.h:189
AK::AkMetering * pMetering
Struct containing metering information.
Definition: AkCallback.h:177
AK::AkMetering * pMainMixMetering
Metering information for the main mix
Definition: AkCallback.h:186
void * pCustomInfo
Custom info passed to the DynamicSequence::Open function
Definition: AkCallback.h:145
AkUniqueID eventID
Unique ID of Event, passed to PostEvent()
Definition: AkCallback.h:97
AkUInt32 uIdentifier
Cue point identifier
Definition: AkCallback.h:117
@ AK_Starvation
Callback triggered when playback skips a frame due to stream starvation. AkCallbackInfo can be cast t...
Definition: AkCallback.h:56
AkCallbackType musicSyncType
Would be either AK_MusicSyncEntry, AK_MusicSyncBeat, AK_MusicSyncBar, AK_MusicSyncExit,...
Definition: AkCallback.h:238
AkUInt32 AkUniqueID
Unique 32-bit ID
Definition: AkTypes.h:52
@ AK_EnableGetSourceStreamBuffering
Enable stream buffering information for use by AK::SoundEngine::GetSourceStreamBuffering().
Definition: AkCallback.h:77
AkReal32 fGridOffset
Grid offset in seconds.
Definition: AkCallback.h:224
AkUInt32 uLabelSize
Size of the label string (including the terminating null character)
Definition: AkCallback.h:120
AkUInt32 uPosition
Position in the cue point (unit: sample frames)
Definition: AkCallback.h:118
AkUInt32 physicalVoices
Number of active physical voices
Definition: AkCallback.h:247
@ AkAudioDeviceEvent_Removal
Audio device was removed through explicit call (AK::SoundEngine::RemoveOutput or AK::SoundEngine::Ter...
Definition: AkCallback.h:384
@ AkGlobalCallbackLocation_MonitorRecap
Send monitor data connection to recap.
Definition: AkCallback.h:350
void(* AkCaptureCallbackFunc)(AkAudioBuffer &in_CaptureBuffer, AkOutputDeviceID in_idOutput, void *in_pCookie)
Definition: AkCallback.h:408
AkPlayingID playingID
Playing ID of Event, returned by PostEvent()
Definition: AkCallback.h:236
@ AK_MusicSyncGrid
Enable notifications on Music Grid. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:65
void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:266
AkGlobalCallbackLocation
Bit field of various locations in the audio processing loop where the game can be called back.
Definition: AkCallback.h:335
AkReal32 totalCPU
Pourcentage of the cpu time used for processing audio. Please note that the numbers may add up when u...
Definition: AkCallback.h:245
AkTimeMs iPostExitDuration
Duration of the post-exit region of the segment, in milliseconds.
Definition: AkCallback.h:219
@ AkGlobalCallbackLocation_PreProcessMessageQueueForRender
Start of frame rendering, before having processed game messages.
Definition: AkCallback.h:340
AkUInt32 uPlaylistItemDone
Playlist node done: set by sound engine, modified by callback function (if set to anything but 0 then...
Definition: AkCallback.h:210
AkReal32 * pfEmitterListenerVolume
Emitter-listener pair-specific gain. When there are multiple emitter-listener pairs,...
Definition: AkCallback.h:169
#define AK_CALLBACK(_type, _name)
@ AK_EnableGetSourcePlayPosition
Enable play position information for use by AK::SoundEngine::GetSourcePlayPosition().
Definition: AkCallback.h:75
AkReal32 fEstimatedDuration
Estimated duration of the sound depending on source settings such as pitch. (unit: milliseconds)
Definition: AkCallback.h:130
void(* AkBusCallbackFunc)(AkSpeakerVolumeMatrixCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:276
AkUniqueID audioNodeID
Audio Node ID of finished item
Definition: AkCallback.h:144
AkUInt32 uNumSystemAudioObjects
Number of System Audio Objects going out of the output device
Definition: AkCallback.h:190
AkUniqueID playlistID
ID of playlist node
Definition: AkCallback.h:207
AkPlayingID playingID
Playing ID of Dynamic Sequence, returned by AK::SoundEngine:DynamicSequence::Open()
Definition: AkCallback.h:143
void * pCookie
User data, passed to PostEvent()
Definition: AkCallback.h:86
AkMeteringFlags eMeteringFlags
Metering flags that were asked for in RegisterOutputDeviceMeteringCallback(). You may only access cor...
Definition: AkCallback.h:192
@ AK_EndOfDynamicSequenceItem
Callback triggered when reaching the end of a dynamic sequence item. AkCallbackInfo can be cast to Ak...
Definition: AkCallback.h:50
void(* AkBankCallbackFunc)(AkUInt32 in_bankID, const void *in_pInMemoryBankPtr, AKRESULT in_eLoadResult, void *in_pCookie)
Definition: AkCallback.h:326
AK::AkMetering * pPassthroughMetering
Metering information for the passthrough mix (if any; will be null otherwise)
Definition: AkCallback.h:188
AkChannelConfig channelConfig
Channel configuration of the bus.
Definition: AkCallback.h:178
Struct containing metering information about a buffer. Depending on when this struct is generated,...
Definition: AkCommonDefs.h:205
@ AK_MusicPlaylistSelect
Callback triggered when music playlist container must select the next item to play....
Definition: AkCallback.h:58
@ AK_MusicSyncExit
Enable notifications on Music Exit Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:64
AkReal32 * MatrixPtr
Volume matrix. Access each input channel vector with AK::SpeakerVolumes::Matrix::GetChannel().
@ AK_MusicSyncBeat
Enable notifications on Music Beat. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:61
bool bStreaming
True if source is streaming, false otherwise.
Definition: AkCallback.h:133
AkReal32 fBarDuration
Bar Duration in seconds.
Definition: AkCallback.h:222
AkAudioDeviceEvent
Definition: AkCallback.h:382
uint32_t AkUInt32
Unsigned 32-bit integer
@ AK_EnableGetMusicPlayPosition
Enable play position information of music objects, queried via AK::MusicEngine::GetPlayingSegmentInfo...
Definition: AkCallback.h:76
void(* AkDeviceStatusCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, AkAudioDeviceEvent in_idEvent, AKRESULT in_AkResult)
Definition: AkCallback.h:390
AkUInt64 AkOutputDeviceID
Audio Output device ID
Definition: AkTypes.h:85
@ AK_MusicSyncPoint
Enable notifications on Music switch transition synchronization point. AkCallbackInfo can be cast to ...
Definition: AkCallback.h:67
AkReal32 pluginCPU
Pourcentage of the cpu time used by plugin processing. Please note that the numbers may add up when u...
Definition: AkCallback.h:246
AkTimeMs iCurrentPosition
Current position of the segment, relative to the Entry Cue, in milliseconds. Range is [-iPreEntryDura...
Definition: AkCallback.h:216
@ AkGlobalCallbackLocation_PostMessagesProcessed
After one or more messages have been processed, but before updating game object and listener position...
Definition: AkCallback.h:341
AkUInt32 uNumPlaylistItems
Number of items in playlist node (may be segments or other playlists)
Definition: AkCallback.h:208
AkReal32 fGridDuration
Grid duration in seconds.
Definition: AkCallback.h:223
AkUInt32 totalVoices
Number of active physical and virtual voices
Definition: AkCallback.h:249
@ AK_SpeakerVolumeMatrix
Callback triggered at each frame, letting the client modify the speaker volume matrix....
Definition: AkCallback.h:54
AK::SpeakerVolumes::MatrixPtr pVolumes
Pointer to volume matrix describing the contribution of each source channel to destination channels....
Definition: AkCallback.h:165
AkMeteringFlags eMeteringFlags
Metering flags that were asked for in RegisterBusMeteringCallback(). You may only access correspondin...
Definition: AkCallback.h:179
AkUInt32 nbActiveEvents
Number of events triggered at a certain time
Definition: AkCallback.h:250
AkUniqueID mediaID
Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file...
Definition: AkCallback.h:132
AkMIDIEvent midiEvent
MIDI event triggered by event.
Definition: AkCallback.h:106
AkUInt32 AkPlayingID
Playing ID
Definition: AkTypes.h:55
@ AK_Marker
Callback triggered when encountering a marker during playback. AkCallbackInfo can be cast to AkMarker...
Definition: AkCallback.h:51
AkTimeMs iRemainingLookAheadTime
Number of milliseconds remaining in the "looking-ahead" state of the segment, when it is silent but s...
Definition: AkCallback.h:220
AkPlayingID playingID
Playing ID of Event, returned by PostEvent()
Definition: AkCallback.h:96
@ AK_MusicSyncUserCue
Enable notifications on Music Custom Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:66
@ AkGlobalCallbackLocation_BeginRender
Start of frame rendering, after having processed game messages.
Definition: AkCallback.h:342
AkUInt32 virtualVoices
Number of active virtual voices
Definition: AkCallback.h:248
@ AK_MusicPlayStarted
Callback triggered when a "Play" or "Seek" command has been executed ("Seek" commands are issued from...
Definition: AkCallback.h:59
AkSegmentInfo segmentInfo
Segment information corresponding to the segment triggering this callback.
Definition: AkCallback.h:237
@ AkGlobalCallbackLocation_Monitor
Send monitor data
Definition: AkCallback.h:349

此页面对您是否有帮助?

需要技术支持?

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

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

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

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

开始 Wwise 之旅