Version
menu_open
AK::SoundEngine

AK::SoundEngine Namespace Reference

Namespaces

namespace   DynamicDialogue
namespace   DynamicSequence
namespace   iOS
namespace   Query
namespace   Wii

Classes

class   AkSyncCaller

Enumerations

enum   MultiPositionType { MultiPositionType_SingleSource, MultiPositionType_MultiSources, MultiPositionType_MultiDirections }

Functions

static AKRESULT  RegisterAllEffectPlugins ()
static AKRESULT  RegisterAllSourcePlugins ()
static AKRESULT  RegisterConvolutionReverbPlugin ()
static AKRESULT  RegisterMcDSPPlugins ()
static AKRESULT  RegisteriZotopePlugins ()
static AKRESULT  RegisterCrankcaseAudioPlugins ()
static AKRESULT  RegisterSoundSeedPlugins ()
static AKRESULT  RegisterIOSONOPlugins ()
static AKRESULT  RegisterAuroPlugins ()
static AKRESULT  RegisterAllCodecPlugins ()
static AKRESULT  RegisterAllRumblePlugins ()
static AKRESULT  RegisterAllBuiltInPlugins ()
static AKRESULT  RegisterAllPlugins ()
AkUInt32 __cdecl  GetIDFromString (const char *in_pszString)
AKRESULT __cdecl  Suspend (bool in_bRenderAnyway=false)
AKRESULT __cdecl  WakeupFromSuspend ()
SLObjectItf __cdecl  GetWwiseOpenSLInterface ()
Initialization

bool __cdecl  IsInitialized ()
AKRESULT __cdecl  Init (AkInitSettings *in_pSettings, AkPlatformInitSettings *in_pPlatformSettings)
void __cdecl  GetDefaultInitSettings (AkInitSettings &out_settings)
void __cdecl  GetDefaultPlatformInitSettings (AkPlatformInitSettings &out_platformSettings)
void __cdecl  Term ()
AkChannelConfig __cdecl  GetSpeakerConfiguration (AkAudioOutputType in_eSinkType=AkOutput_Main, AkUInt32 in_iOutputID=0)
AKRESULT __cdecl  GetPanningRule (AkPanningRule &out_ePanningRule, AkAudioOutputType in_eSinkType=AkOutput_Main, AkUInt32 in_iOutputID=0)
AKRESULT __cdecl  SetPanningRule (AkPanningRule in_ePanningRule, AkAudioOutputType in_eSinkType=AkOutput_Main, AkUInt32 in_iOutputID=0)
AKRESULT __cdecl  GetSpeakerAngles (AkReal32 *io_pfSpeakerAngles, AkUInt32 &io_uNumAngles, AkReal32 &out_fHeightAngle, AkAudioOutputType in_eSinkType=AkOutput_Main, AkUInt32 in_iOutputID=0)
AKRESULT __cdecl  SetSpeakerAngles (AkReal32 *in_pfSpeakerAngles, AkUInt32 in_uNumAngles, AkReal32 in_fHeightAngle, AkAudioOutputType in_eSinkType=AkOutput_Main, AkUInt32 in_iOutputID=0)
AKRESULT __cdecl  SetVolumeThreshold (AkReal32 in_fVolumeThresholdDB)
AKRESULT __cdecl  SetMaxNumVoicesLimit (AkUInt16 in_maxNumberVoices)
Rendering Audio

AKRESULT __cdecl  RenderAudio ()
Component Registration

AKRESULT __cdecl  RegisterPlugin (AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreatePluginCallback in_pCreateFunc, AkCreateParamCallback in_pCreateParamFunc)
AKRESULT __cdecl  RegisterCodec (AkUInt32 in_ulCompanyID, AkUInt32 in_ulCodecID, AkCreateFileSourceCallback in_pFileCreateFunc, AkCreateBankSourceCallback in_pBankCreateFunc)
AKRESULT __cdecl  RegisterGlobalCallback (AkGlobalCallbackFunc in_pCallback)
AKRESULT __cdecl  UnregisterGlobalCallback (AkGlobalCallbackFunc in_pCallback)
Game Objects

AKRESULT __cdecl  RegisterGameObj (AkGameObjectID in_gameObjectID, AkUInt32 in_uListenerMask=0x01)
AKRESULT __cdecl  RegisterGameObj (AkGameObjectID in_gameObjectID, const char *in_pszObjName, AkUInt32 in_uListenerMask=0x01)
AKRESULT __cdecl  UnregisterGameObj (AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  UnregisterAllGameObj ()
AKRESULT __cdecl  SetPosition (AkGameObjectID in_GameObjectID, const AkSoundPosition &in_Position)
AKRESULT __cdecl  SetMultiplePositions (AkGameObjectID in_GameObjectID, const AkSoundPosition *in_pPositions, AkUInt16 in_NumPositions, MultiPositionType in_eMultiPositionType=MultiPositionType_MultiDirections)
AKRESULT __cdecl  SetAttenuationScalingFactor (AkGameObjectID in_GameObjectID, AkReal32 in_fAttenuationScalingFactor)
AKRESULT __cdecl  SetListenerScalingFactor (AkUInt32 in_uListenerIndex, AkReal32 in_fListenerScalingFactor)
Listeners

AKRESULT __cdecl  SetActiveListeners (AkGameObjectID in_GameObjectID, AkUInt32 in_uListenerMask)
AKRESULT __cdecl  SetListenerPosition (const AkListenerPosition &in_Position, AkUInt32 in_uIndex=0)
AKRESULT __cdecl  SetListenerSpatialization (AkUInt32 in_uIndex, bool in_bSpatialized, AkChannelConfig in_channelConfig, AK::SpeakerVolumes::VectorPtr in_pVolumeOffsets=NULL)
AKRESULT __cdecl  SetListenerPipeline (AkUInt32 in_uIndex, bool in_bAudio, bool in_bMotion)
Game Syncs

AKRESULT __cdecl  SetRTPCValue (AkRtpcID in_rtpcID, AkRtpcValue in_value, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKRESULT __cdecl  SetRTPCValue (const char *in_pszRtpcName, AkRtpcValue in_value, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKRESULT __cdecl  SetRTPCValueByPlayingID (AkRtpcID in_rtpcID, AkRtpcValue in_value, AkPlayingID in_playingID, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKRESULT __cdecl  SetRTPCValueByPlayingID (const char *in_pszRtpcName, AkRtpcValue in_value, AkPlayingID in_playingID, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKRESULT __cdecl  ResetRTPCValue (AkRtpcID in_rtpcID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKRESULT __cdecl  ResetRTPCValue (const char *in_pszRtpcName, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKRESULT __cdecl  SetSwitch (AkSwitchGroupID in_switchGroup, AkSwitchStateID in_switchState, AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  SetSwitch (const char *in_pszSwitchGroup, const char *in_pszSwitchState, AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  PostTrigger (AkTriggerID in_triggerID, AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  PostTrigger (const char *in_pszTrigger, AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  SetState (AkStateGroupID in_stateGroup, AkStateID in_state)
AKRESULT __cdecl  SetState (const char *in_pszStateGroup, const char *in_pszState)
Environments

AKRESULT __cdecl  SetGameObjectAuxSendValues (AkGameObjectID in_gameObjectID, AkAuxSendValue *in_aAuxSendValues, AkUInt32 in_uNumSendValues)
AKRESULT __cdecl  RegisterBusVolumeCallback (AkUniqueID in_busID, AkBusCallbackFunc in_pfnCallback)
AKRESULT __cdecl  RegisterBusMeteringCallback (AkUniqueID in_busID, AkBusMeteringCallbackFunc in_pfnCallback, AkMeteringFlags in_eMeteringFlags)
AKRESULT __cdecl  SetGameObjectOutputBusVolume (AkGameObjectID in_gameObjectID, AkReal32 in_fControlValue)
AKRESULT __cdecl  SetActorMixerEffect (AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
AKRESULT __cdecl  SetBusEffect (AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
AKRESULT __cdecl  SetBusEffect (const char *in_pszBusName, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
AKRESULT __cdecl  SetMixer (AkUniqueID in_audioNodeID, AkUniqueID in_shareSetID)
AKRESULT __cdecl  SetMixer (const char *in_pszBusName, AkUniqueID in_shareSetID)
AKRESULT __cdecl  SetObjectObstructionAndOcclusion (AkGameObjectID in_ObjectID, AkUInt32 in_uListener, AkReal32 in_fObstructionLevel, AkReal32 in_fOcclusionLevel)
Capture

AKRESULT __cdecl  StartOutputCapture (const AkOSChar *in_CaptureFileName)
AKRESULT __cdecl  StopOutputCapture ()
AKRESULT __cdecl  AddOutputCaptureMarker (const char *in_MarkerText)
AKRESULT __cdecl  StartProfilerCapture (const AkOSChar *in_CaptureFileName)
AKRESULT __cdecl  StopProfilerCapture ()
Secondary Outputs

AKRESULT __cdecl  AddSecondaryOutput (AkUInt32 in_iOutputID, AkAudioOutputType in_iDeviceType, AkUInt32 in_uListenerMask)
AKRESULT __cdecl  RemoveSecondaryOutput (AkUInt32 in_iOutputID, AkAudioOutputType in_iDeviceType)
AKRESULT __cdecl  SetSecondaryOutputVolume (AkUInt32 in_iOutputID, AkAudioOutputType in_iDeviceType, AkReal32 in_fVolume)
  Set the volume of a secondary output device.

Event Management



enum   AkActionOnEventType {
  AkActionOnEventType_Stop = 0, AkActionOnEventType_Pause = 1, AkActionOnEventType_Resume = 2, AkActionOnEventType_Break = 3,
  AkActionOnEventType_ReleaseEnvelope = 4
}
AkPlayingID __cdecl  PostEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkUInt32 in_cExternals=0, AkExternalSourceInfo *in_pExternalSources=NULL, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AkPlayingID __cdecl  PostEvent (const char *in_pszEventName, AkGameObjectID in_gameObjectID, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkUInt32 in_cExternals=0, AkExternalSourceInfo *in_pExternalSources=NULL, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKRESULT __cdecl  ExecuteActionOnEvent (AkUniqueID in_eventID, AkActionOnEventType in_ActionType, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKRESULT __cdecl  ExecuteActionOnEvent (const char *in_pszEventName, AkActionOnEventType in_ActionType, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKRESULT __cdecl  PinEventInStreamCache (AkUniqueID in_eventID, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
AKRESULT __cdecl  PinEventInStreamCache (const char *in_pszEventName, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
AKRESULT __cdecl  UnpinEventInStreamCache (AkUniqueID in_eventID)
AKRESULT __cdecl  UnpinEventInStreamCache (const char *in_pszEventName)
AKRESULT __cdecl  GetBufferStatusForPinnedEvent (AkUniqueID in_eventID, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
AKRESULT __cdecl  GetBufferStatusForPinnedEvent (const char *in_pszEventName, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
AKRESULT __cdecl  SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkTimeMs in_iPosition, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKRESULT __cdecl  SeekOnEvent (const char *in_pszEventName, AkGameObjectID in_gameObjectID, AkTimeMs in_iPosition, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKRESULT __cdecl  SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkReal32 in_fPercent, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKRESULT __cdecl  SeekOnEvent (const char *in_pszEventName, AkGameObjectID in_gameObjectID, AkReal32 in_fPercent, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
void __cdecl  CancelEventCallbackCookie (void *in_pCookie)
void __cdecl  CancelEventCallback (AkPlayingID in_playingID)
AKRESULT __cdecl  GetSourcePlayPosition (AkPlayingID in_PlayingID, AkTimeMs *out_puPosition, bool in_bExtrapolate=true)
AKRESULT __cdecl  GetSourceStreamBuffering (AkPlayingID in_PlayingID, AkTimeMs &out_buffering, bool &out_bIsBuffering)
void __cdecl  StopAll (AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
void __cdecl  StopPlayingID (AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
  Stop the current content playing associated to the specified playing ID.
void __cdecl  SetRandomSeed (AkUInt32 in_uSeed)
void __cdecl  MuteBackgroundMusic (bool in_bMute)

Bank Management



enum   PreparationType { Preparation_Load, Preparation_Unload }
enum   AkBankContent { AkBankContent_StructureOnly, AkBankContent_All }
AKRESULT __cdecl  ClearBanks ()
AKRESULT __cdecl  SetBankLoadIOSettings (AkReal32 in_fThroughput, AkPriority in_priority)
AKRESULT __cdecl  LoadBank (const char *in_pszString, AkMemPoolId in_memPoolId, AkBankID &out_bankID)
AKRESULT __cdecl  LoadBank (AkBankID in_bankID, AkMemPoolId in_memPoolId)
AKRESULT __cdecl  LoadBank (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
AKRESULT __cdecl  LoadBank (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkMemPoolId in_uPoolForBankMedia, AkBankID &out_bankID)
AKRESULT __cdecl  LoadBank (const char *in_pszString, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkMemPoolId in_memPoolId, AkBankID &out_bankID)
AKRESULT __cdecl  LoadBank (AkBankID in_bankID, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkMemPoolId in_memPoolId)
AKRESULT __cdecl  LoadBank (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID)
AKRESULT __cdecl  LoadBank (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkMemPoolId in_uPoolForBankMedia, AkBankID &out_bankID)
AKRESULT __cdecl  UnloadBank (const char *in_pszString, const void *in_pInMemoryBankPtr, AkMemPoolId *out_pMemPoolId=NULL)
AKRESULT __cdecl  UnloadBank (AkBankID in_bankID, const void *in_pInMemoryBankPtr, AkMemPoolId *out_pMemPoolId=NULL)
AKRESULT __cdecl  UnloadBank (const char *in_pszString, const void *in_pInMemoryBankPtr, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
AKRESULT __cdecl  UnloadBank (AkBankID in_bankID, const void *in_pInMemoryBankPtr, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
void __cdecl  CancelBankCallbackCookie (void *in_pCookie)
AKRESULT __cdecl  PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, const char *in_pszString, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All)
AKRESULT __cdecl  PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, AkBankID in_bankID, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All)
AKRESULT __cdecl  PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, const char *in_pszString, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All)
AKRESULT __cdecl  PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, AkBankID in_bankID, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All)
AKRESULT __cdecl  ClearPreparedEvents ()
AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent)
AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, AkUniqueID *in_pEventID, AkUInt32 in_uNumEvent)
AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, AkUniqueID *in_pEventID, AkUInt32 in_uNumEvent, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
AKRESULT __cdecl  SetMedia (AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
AKRESULT __cdecl  UnsetMedia (AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
AKRESULT __cdecl  PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, const char *in_pszGroupName, const char **in_ppszGameSyncName, AkUInt32 in_uNumGameSyncs)
AKRESULT __cdecl  PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, AkUInt32 in_GroupID, AkUInt32 *in_paGameSyncID, AkUInt32 in_uNumGameSyncs)
AKRESULT __cdecl  PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, const char *in_pszGroupName, const char **in_ppszGameSyncName, AkUInt32 in_uNumGameSyncs, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
AKRESULT __cdecl  PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, AkUInt32 in_GroupID, AkUInt32 *in_paGameSyncID, AkUInt32 in_uNumGameSyncs, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)

Detailed Description

Audiokinetic sound engine namespace

Remarks:
The functions in this namespace are thread-safe, unless stated otherwise.

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