Version

menu_open
Wwise SDK 2023.1.4
AK::SoundEngine Namespace Reference

Namespaces

 DynamicDialogue
 
 DynamicSequence
 
 iOS
 
 Query
 

Classes

class  AkSyncCaller
 

Enumerations

enum  MultiPositionType : AkUInt8 { MultiPositionType_SingleSource, MultiPositionType_MultiSources, MultiPositionType_MultiDirections }
 

Functions

static AKRESULT RegisterAllPlugins ()
 This function is deprecated. All registration is automatic now. Kept for backward compatibility. More...
 
AKSOUNDENGINE_API SLObjectItf GetWwiseOpenSLInterface ()
 
AKRESULT GetFastPathSettings (AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings)
 
AKSOUNDENGINE_API AkDeviceID GetDeviceIDFromPlayerIndex (int playerIndex)
 
AKSOUNDENGINE_API AkUInt32 GetGameInputDeviceID (const IGameInputDevice *in_pGameInputDevice)
 
Initialization
AKSOUNDENGINE_API bool IsInitialized ()
 
AKSOUNDENGINE_API AKRESULT Init (AkInitSettings *in_pSettings, AkPlatformInitSettings *in_pPlatformSettings)
 
AKSOUNDENGINE_API void GetDefaultInitSettings (AkInitSettings &out_settings)
 
AKSOUNDENGINE_API void GetDefaultPlatformInitSettings (AkPlatformInitSettings &out_platformSettings)
 
AKSOUNDENGINE_API void Term ()
 
AKSOUNDENGINE_API AKRESULT GetAudioSettings (AkAudioSettings &out_audioSettings)
 
AKSOUNDENGINE_API AkChannelConfig GetSpeakerConfiguration (AkOutputDeviceID in_idOutput=0)
 
AKSOUNDENGINE_API AKRESULT GetOutputDeviceConfiguration (AkOutputDeviceID in_idOutput, AkChannelConfig &io_channelConfig, Ak3DAudioSinkCapabilities &io_capabilities)
 
AKSOUNDENGINE_API AKRESULT GetPanningRule (AkPanningRule &out_ePanningRule, AkOutputDeviceID in_idOutput=0)
 
AKSOUNDENGINE_API AKRESULT SetPanningRule (AkPanningRule in_ePanningRule, AkOutputDeviceID in_idOutput=0)
 
AKSOUNDENGINE_API AKRESULT GetSpeakerAngles (AkReal32 *io_pfSpeakerAngles, AkUInt32 &io_uNumAngles, AkReal32 &out_fHeightAngle, AkOutputDeviceID in_idOutput=0)
 
AKSOUNDENGINE_API AKRESULT SetSpeakerAngles (const AkReal32 *in_pfSpeakerAngles, AkUInt32 in_uNumAngles, AkReal32 in_fHeightAngle, AkOutputDeviceID in_idOutput=0)
 
AKSOUNDENGINE_API AKRESULT SetVolumeThreshold (AkReal32 in_fVolumeThresholdDB)
 
AKSOUNDENGINE_API AKRESULT SetMaxNumVoicesLimit (AkUInt16 in_maxNumberVoices)
 
AKSOUNDENGINE_API AKRESULT SetJobMgrMaxActiveWorkers (AkJobType in_jobType, AkUInt32 in_uNewMaxActiveWorkers)
 
Rendering Audio
AKSOUNDENGINE_API AKRESULT RenderAudio (bool in_bAllowSyncRender=true)
 
Component Registration
AKSOUNDENGINE_API AK::IAkGlobalPluginContextGetGlobalPluginContext ()
 
AKSOUNDENGINE_API AKRESULT RegisterPlugin (AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreatePluginCallback in_pCreateFunc, AkCreateParamCallback in_pCreateParamFunc, AkGetDeviceListCallback in_pGetDeviceList=NULL)
 
AKSOUNDENGINE_API AKRESULT RegisterPluginDLL (const AkOSChar *in_DllName, const AkOSChar *in_DllPath=NULL)
 
AKSOUNDENGINE_API bool IsPluginRegistered (AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID)
 
AKSOUNDENGINE_API AKRESULT RegisterCodec (AkUInt32 in_ulCompanyID, AkUInt32 in_ulCodecID, AkCreateFileSourceCallback in_pFileCreateFunc, AkCreateBankSourceCallback in_pBankCreateFunc)
 
AKSOUNDENGINE_API AKRESULT RegisterGlobalCallback (AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender, void *in_pCookie=NULL, AkPluginType in_eType=AkPluginTypeNone, AkUInt32 in_ulCompanyID=0, AkUInt32 in_ulPluginID=0)
 
AKSOUNDENGINE_API AKRESULT UnregisterGlobalCallback (AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender)
 
AKSOUNDENGINE_API AKRESULT RegisterResourceMonitorCallback (AkResourceMonitorCallbackFunc in_pCallback)
 
AKSOUNDENGINE_API AKRESULT UnregisterResourceMonitorCallback (AkResourceMonitorCallbackFunc in_pCallback)
 
AKSOUNDENGINE_API AKRESULT RegisterAudioDeviceStatusCallback (AK::AkDeviceStatusCallbackFunc in_pCallback)
 
AKSOUNDENGINE_API AKRESULT UnregisterAudioDeviceStatusCallback ()
 Unregisters the callback for the Audio Device status changes, registered by RegisterAudioDeviceStatusCallback
More...
 
AKSOUNDENGINE_API AkUInt32 GetIDFromString (const char *in_pszString)
 
Game Objects
AKSOUNDENGINE_API AKRESULT RegisterGameObj (AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT RegisterGameObj (AkGameObjectID in_gameObjectID, const char *in_pszObjName)
 
AKSOUNDENGINE_API AKRESULT UnregisterGameObj (AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT UnregisterAllGameObj ()
 
AKSOUNDENGINE_API AKRESULT SetPosition (AkGameObjectID in_GameObjectID, const AkSoundPosition &in_Position, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
 
AKSOUNDENGINE_API AKRESULT SetMultiplePositions (AkGameObjectID in_GameObjectID, const AkSoundPosition *in_pPositions, AkUInt16 in_NumPositions, MultiPositionType in_eMultiPositionType=MultiPositionType_MultiDirections, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
 
AKSOUNDENGINE_API AKRESULT SetMultiplePositions (AkGameObjectID in_GameObjectID, const AkChannelEmitter *in_pPositions, AkUInt16 in_NumPositions, MultiPositionType in_eMultiPositionType=MultiPositionType_MultiDirections, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
 
AKSOUNDENGINE_API AKRESULT SetScalingFactor (AkGameObjectID in_GameObjectID, AkReal32 in_fAttenuationScalingFactor)
 
AKSOUNDENGINE_API AKRESULT SetDistanceProbe (AkGameObjectID in_listenerGameObjectID, AkGameObjectID in_distanceProbeGameObjectID)
 
Listeners
AKSOUNDENGINE_API AKRESULT SetListeners (AkGameObjectID in_emitterGameObj, const AkGameObjectID *in_pListenerGameObjs, AkUInt32 in_uNumListeners)
 
AKSOUNDENGINE_API AKRESULT AddListener (AkGameObjectID in_emitterGameObj, AkGameObjectID in_listenerGameObj)
 
AKSOUNDENGINE_API AKRESULT RemoveListener (AkGameObjectID in_emitterGameObj, AkGameObjectID in_listenerGameObj)
 
AKSOUNDENGINE_API AKRESULT SetDefaultListeners (const AkGameObjectID *in_pListenerObjs, AkUInt32 in_uNumListeners)
 
AKSOUNDENGINE_API AKRESULT AddDefaultListener (AkGameObjectID in_listenerGameObj)
 
AKSOUNDENGINE_API AKRESULT RemoveDefaultListener (AkGameObjectID in_listenerGameObj)
 
AKSOUNDENGINE_API AKRESULT ResetListenersToDefault (AkGameObjectID in_emitterGameObj)
 
AKSOUNDENGINE_API AKRESULT SetListenerSpatialization (AkGameObjectID in_uListenerID, bool in_bSpatialized, AkChannelConfig in_channelConfig, AK::SpeakerVolumes::VectorPtr in_pVolumeOffsets=NULL)
 
Game Syncs
AKSOUNDENGINE_API AKRESULT 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)
 
AKSOUNDENGINE_API AKRESULT 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)
 
AKSOUNDENGINE_API AKRESULT SetRTPCValueByPlayingID (AkRtpcID in_rtpcID, AkRtpcValue in_value, AkPlayingID in_playingID, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
 
AKSOUNDENGINE_API AKRESULT SetRTPCValueByPlayingID (const char *in_pszRtpcName, AkRtpcValue in_value, AkPlayingID in_playingID, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
 
AKSOUNDENGINE_API AKRESULT ResetRTPCValue (AkRtpcID in_rtpcID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
 
AKSOUNDENGINE_API AKRESULT 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)
 
AKSOUNDENGINE_API AKRESULT SetSwitch (AkSwitchGroupID in_switchGroup, AkSwitchStateID in_switchState, AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT SetSwitch (const char *in_pszSwitchGroup, const char *in_pszSwitchState, AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT PostTrigger (AkTriggerID in_triggerID, AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT PostTrigger (const char *in_pszTrigger, AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT SetState (AkStateGroupID in_stateGroup, AkStateID in_state)
 
AKSOUNDENGINE_API AKRESULT SetState (const char *in_pszStateGroup, const char *in_pszState)
 
Environments
AKSOUNDENGINE_API AKRESULT SetGameObjectAuxSendValues (AkGameObjectID in_gameObjectID, AkAuxSendValue *in_aAuxSendValues, AkUInt32 in_uNumSendValues)
 
AKSOUNDENGINE_API AKRESULT RegisterBusVolumeCallback (AkUniqueID in_busID, AkBusCallbackFunc in_pfnCallback, void *in_pCookie=NULL)
 
AKSOUNDENGINE_API AKRESULT RegisterBusMeteringCallback (AkUniqueID in_busID, AkBusMeteringCallbackFunc in_pfnCallback, AkMeteringFlags in_eMeteringFlags, void *in_pCookie=NULL)
 
AKSOUNDENGINE_API AKRESULT RegisterOutputDeviceMeteringCallback (AkOutputDeviceID in_idOutput, AkOutputDeviceMeteringCallbackFunc in_pfnCallback, AkMeteringFlags in_eMeteringFlags, void *in_pCookie=NULL)
 
AKSOUNDENGINE_API AKRESULT SetGameObjectOutputBusVolume (AkGameObjectID in_emitterObjID, AkGameObjectID in_listenerObjID, AkReal32 in_fControlValue)
 
AKSOUNDENGINE_API AKRESULT SetActorMixerEffect (AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
 
AKSOUNDENGINE_API AKRESULT SetBusEffect (AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
 
AKSOUNDENGINE_API AKRESULT SetBusEffect (const char *in_pszBusName, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
 
AKSOUNDENGINE_API AKRESULT SetOutputDeviceEffect (AkOutputDeviceID in_outputDeviceID, AkUInt32 in_uFXIndex, AkUniqueID in_FXShareSetID)
 
AKSOUNDENGINE_API AKRESULT SetMixer (AkUniqueID in_audioNodeID, AkUniqueID in_shareSetID)
 
AKSOUNDENGINE_API AKRESULT SetMixer (const char *in_pszBusName, AkUniqueID in_shareSetID)
 
AKSOUNDENGINE_API AKRESULT SetBusConfig (AkUniqueID in_audioNodeID, AkChannelConfig in_channelConfig)
 
AKSOUNDENGINE_API AKRESULT SetBusConfig (const char *in_pszBusName, AkChannelConfig in_channelConfig)
 
AKSOUNDENGINE_API AKRESULT SetObjectObstructionAndOcclusion (AkGameObjectID in_EmitterID, AkGameObjectID in_ListenerID, AkReal32 in_fObstructionLevel, AkReal32 in_fOcclusionLevel)
 
AKSOUNDENGINE_API AKRESULT SetMultipleObstructionAndOcclusion (AkGameObjectID in_EmitterID, AkGameObjectID in_uListenerID, AkObstructionOcclusionValues *in_fObstructionOcclusionValues, AkUInt32 in_uNumOcclusionObstruction)
 
AKSOUNDENGINE_API AKRESULT GetContainerHistory (AK::IWriteBytes *in_pBytes)
 
AKSOUNDENGINE_API AKRESULT SetContainerHistory (AK::IReadBytes *in_pBytes)
 
Capture
AKSOUNDENGINE_API AKRESULT StartOutputCapture (const AkOSChar *in_CaptureFileName)
 
AKSOUNDENGINE_API AKRESULT StopOutputCapture ()
 
AKSOUNDENGINE_API AKRESULT AddOutputCaptureMarker (const char *in_MarkerText)
 
AKSOUNDENGINE_API AKRESULT AddOutputCaptureBinaryMarker (void *in_pMarkerData, AkUInt32 in_uMarkerDataSize)
 
AKSOUNDENGINE_API AkUInt32 GetSampleRate ()
 
AKSOUNDENGINE_API AKRESULT RegisterCaptureCallback (AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)
 
AKSOUNDENGINE_API AKRESULT UnregisterCaptureCallback (AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)
 
AKSOUNDENGINE_API AKRESULT StartProfilerCapture (const AkOSChar *in_CaptureFileName)
 
AKSOUNDENGINE_API AKRESULT StopProfilerCapture ()
 
Offline Rendering
AKSOUNDENGINE_API AKRESULT SetOfflineRenderingFrameTime (AkReal32 in_fFrameTimeInSeconds)
 
AKSOUNDENGINE_API AKRESULT SetOfflineRendering (bool in_bEnableOfflineRendering)
 
Secondary Outputs
AKSOUNDENGINE_API AKRESULT AddOutput (const AkOutputSettings &in_Settings, AkOutputDeviceID *out_pDeviceID=NULL, const AkGameObjectID *in_pListenerIDs=NULL, AkUInt32 in_uNumListeners=0)
 
AKSOUNDENGINE_API AKRESULT RemoveOutput (AkOutputDeviceID in_idOutput)
 
AKSOUNDENGINE_API AKRESULT ReplaceOutput (const AkOutputSettings &in_Settings, AkOutputDeviceID in_outputDeviceId, AkOutputDeviceID *out_pOutputDeviceId=NULL)
 
AKSOUNDENGINE_API AkOutputDeviceID GetOutputID (AkUniqueID in_idShareset, AkUInt32 in_idDevice)
 
AKSOUNDENGINE_API AkOutputDeviceID GetOutputID (const char *in_szShareSet, AkUInt32 in_idDevice)
 
AKSOUNDENGINE_API AKRESULT SetBusDevice (AkUniqueID in_idBus, AkUniqueID in_idNewDevice)
 
AKSOUNDENGINE_API AKRESULT SetBusDevice (const char *in_BusName, const char *in_DeviceName)
 
AKSOUNDENGINE_API AKRESULT GetDeviceList (AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkUInt32 &io_maxNumDevices, AkDeviceDescription *out_deviceDescriptions)
 
AKSOUNDENGINE_API AKRESULT GetDeviceList (AkUniqueID in_audioDeviceShareSetID, AkUInt32 &io_maxNumDevices, AkDeviceDescription *out_deviceDescriptions)
 
AKSOUNDENGINE_API AKRESULT SetOutputVolume (AkOutputDeviceID in_idOutput, AkReal32 in_fVolume)
 
AKSOUNDENGINE_API AKRESULT GetDeviceSpatialAudioSupport (AkUInt32 in_idDevice)
 
AKSOUNDENGINE_API AKRESULT Suspend (bool in_bRenderAnyway=false, bool in_bFadeOut=true)
 
AKSOUNDENGINE_API AKRESULT WakeupFromSuspend (AkUInt32 in_uDelayMs=0)
 
AKSOUNDENGINE_API AkUInt32 GetBufferTick ()
 
AKSOUNDENGINE_API AkUInt64 GetSampleTick ()
 

Event Management

enum  AkActionOnEventType {
  AkActionOnEventType_Stop = 0, AkActionOnEventType_Pause = 1, AkActionOnEventType_Resume = 2, AkActionOnEventType_Break = 3,
  AkActionOnEventType_ReleaseEnvelope = 4
}
 
AKSOUNDENGINE_API AkPlayingID 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)
 
AKSOUNDENGINE_API AkPlayingID 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)
 
AKSOUNDENGINE_API AKRESULT 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)
 
AKSOUNDENGINE_API AKRESULT 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)
 
AKSOUNDENGINE_API AkPlayingID PostMIDIOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkMIDIPost *in_pPosts, AkUInt16 in_uNumPosts, bool in_bAbsoluteOffsets=false, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API AKRESULT StopMIDIOnEvent (AkUniqueID in_eventID=AK_INVALID_UNIQUE_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API AKRESULT PinEventInStreamCache (AkUniqueID in_eventID, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
 
AKSOUNDENGINE_API AKRESULT PinEventInStreamCache (const char *in_pszEventName, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
 
AKSOUNDENGINE_API AKRESULT UnpinEventInStreamCache (AkUniqueID in_eventID)
 
AKSOUNDENGINE_API AKRESULT UnpinEventInStreamCache (const char *in_pszEventName)
 
AKSOUNDENGINE_API AKRESULT GetBufferStatusForPinnedEvent (AkUniqueID in_eventID, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
 
AKSOUNDENGINE_API AKRESULT GetBufferStatusForPinnedEvent (const char *in_pszEventName, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
 
AKSOUNDENGINE_API AKRESULT SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkTimeMs in_iPosition, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API AKRESULT SeekOnEvent (const char *in_pszEventName, AkGameObjectID in_gameObjectID, AkTimeMs in_iPosition, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API AKRESULT SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkReal32 in_fPercent, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API AKRESULT SeekOnEvent (const char *in_pszEventName, AkGameObjectID in_gameObjectID, AkReal32 in_fPercent, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API void CancelEventCallbackCookie (void *in_pCookie)
 
AKSOUNDENGINE_API void CancelEventCallbackGameObject (AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API void CancelEventCallback (AkPlayingID in_playingID)
 
AKSOUNDENGINE_API AKRESULT GetSourcePlayPosition (AkPlayingID in_PlayingID, AkTimeMs *out_puPosition, bool in_bExtrapolate=true)
 
AKSOUNDENGINE_API AKRESULT GetSourcePlayPositions (AkPlayingID in_PlayingID, AkSourcePosition *out_puPositions, AkUInt32 *io_pcPositions, bool in_bExtrapolate=true)
 
AKSOUNDENGINE_API AKRESULT GetSourceStreamBuffering (AkPlayingID in_PlayingID, AkTimeMs &out_buffering, bool &out_bIsBuffering)
 
AKSOUNDENGINE_API void StopAll (AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
 
AKSOUNDENGINE_API void StopPlayingID (AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
 
AKSOUNDENGINE_API void ExecuteActionOnPlayingID (AkActionOnEventType in_ActionType, AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
 
AKSOUNDENGINE_API void SetRandomSeed (AkUInt32 in_uSeed)
 
AKSOUNDENGINE_API void MuteBackgroundMusic (bool in_bMute)
 
AKSOUNDENGINE_API bool GetBackgroundMusicMute ()
 
AKSOUNDENGINE_API AKRESULT SendPluginCustomGameData (AkUniqueID in_busID, AkGameObjectID in_busObjectID, AkPluginType in_eType, AkUInt32 in_uCompanyID, AkUInt32 in_uPluginID, const void *in_pData, AkUInt32 in_uSizeInBytes)
 

Bank Management

enum  PreparationType { Preparation_Load, Preparation_Unload, Preparation_LoadAndDecode }
 
enum  AkBankContent { AkBankContent_StructureOnly, AkBankContent_All }
 
AKSOUNDENGINE_API AKRESULT ClearBanks ()
 
AKSOUNDENGINE_API AKRESULT SetBankLoadIOSettings (AkReal32 in_fThroughput, AkPriority in_priority)
 
AKSOUNDENGINE_API AKRESULT LoadBank (const char *in_pszString, AkBankID &out_bankID, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT LoadBank (AkBankID in_bankID, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryView (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryView (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID, AkBankType &out_bankType)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryCopy (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryCopy (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID, AkBankType &out_bankType)
 
AKSOUNDENGINE_API AKRESULT DecodeBank (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkMemPoolId in_uPoolForDecodedBank, void *&out_pDecodedBankPtr, AkUInt32 &out_uDecodedBankSize)
 
AKSOUNDENGINE_API AKRESULT LoadBank (const char *in_pszString, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT LoadBank (AkBankID in_bankID, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryView (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryView (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID, AkBankType &out_bankType)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryCopy (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT LoadBankMemoryCopy (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID, AkBankType &out_bankType)
 
AKSOUNDENGINE_API AKRESULT UnloadBank (const char *in_pszString, const void *in_pInMemoryBankPtr, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT UnloadBank (AkBankID in_bankID, const void *in_pInMemoryBankPtr, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT UnloadBank (const char *in_pszString, const void *in_pInMemoryBankPtr, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT UnloadBank (AkBankID in_bankID, const void *in_pInMemoryBankPtr, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API void CancelBankCallbackCookie (void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, const char *in_pszString, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, AkBankID in_bankID, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, const char *in_pszString, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, AkBankID in_bankID, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All, AkBankType in_bankType=AkBankType_User)
 
AKSOUNDENGINE_API AKRESULT ClearPreparedEvents ()
 
AKSOUNDENGINE_API AKRESULT PrepareEvent (PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent)
 
AKSOUNDENGINE_API AKRESULT PrepareEvent (PreparationType in_PreparationType, AkUniqueID *in_pEventID, AkUInt32 in_uNumEvent)
 
AKSOUNDENGINE_API AKRESULT PrepareEvent (PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT PrepareEvent (PreparationType in_PreparationType, AkUniqueID *in_pEventID, AkUInt32 in_uNumEvent, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT SetMedia (AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
 
AKSOUNDENGINE_API AKRESULT UnsetMedia (AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
 
AKSOUNDENGINE_API AKRESULT TryUnsetMedia (AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings, AKRESULT *out_pUnsetResults)
 
AKSOUNDENGINE_API AKRESULT PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, const char *in_pszGroupName, const char **in_ppszGameSyncName, AkUInt32 in_uNumGameSyncs)
 
AKSOUNDENGINE_API AKRESULT PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, AkUInt32 in_GroupID, AkUInt32 *in_paGameSyncID, AkUInt32 in_uNumGameSyncs)
 
AKSOUNDENGINE_API AKRESULT PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, const char *in_pszGroupName, const char **in_ppszGameSyncName, AkUInt32 in_uNumGameSyncs, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT 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