Table of Contents

Wwise SDK 2019.2.3
AK::SoundEngine Namespace Reference

Namespaces

  DynamicDialogue
 
  DynamicSequence
 
  iOS
 
  Query
 

Classes

class   AkSyncCaller
 

Enumerations

enum   MultiPositionType { 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 __cdecl  GetWwiseOpenSLInterface ()
 
AKRESULT  GetFastPathSettings (AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings)
 
AKSOUNDENGINE_API AkUInt32 __cdecl  GetDeviceID (const ggp::Keyboard &in_keyboard)
 
AKSOUNDENGINE_API AkUInt32 __cdecl  GetDeviceID (const ggp::Gamepad &in_gamepad)
 

Event Management

enum   AkActionOnEventType {
  AkActionOnEventType_Stop = 0, AkActionOnEventType_Pause = 1, AkActionOnEventType_Resume = 2, AkActionOnEventType_Break = 3,
  AkActionOnEventType_ReleaseEnvelope = 4
}
 
AKSOUNDENGINE_API 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)
 
AKSOUNDENGINE_API 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)
 
AKSOUNDENGINE_API 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)
 
AKSOUNDENGINE_API 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)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PostMIDIOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkMIDIPost *in_pPosts, AkUInt16 in_uNumPosts)
 
AKSOUNDENGINE_API AKRESULT __cdecl  StopMIDIOnEvent (AkUniqueID in_eventID=AK_INVALID_UNIQUE_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PinEventInStreamCache (AkUniqueID in_eventID, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PinEventInStreamCache (const char *in_pszEventName, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
 
AKSOUNDENGINE_API AKRESULT __cdecl  UnpinEventInStreamCache (AkUniqueID in_eventID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  UnpinEventInStreamCache (const char *in_pszEventName)
 
AKSOUNDENGINE_API AKRESULT __cdecl  GetBufferStatusForPinnedEvent (AkUniqueID in_eventID, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
 
AKSOUNDENGINE_API AKRESULT __cdecl  GetBufferStatusForPinnedEvent (const char *in_pszEventName, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
 
AKSOUNDENGINE_API AKRESULT __cdecl  SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkTimeMs in_iPosition, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  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 __cdecl  SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkReal32 in_fPercent, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  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 __cdecl  CancelEventCallbackCookie (void *in_pCookie)
 
AKSOUNDENGINE_API void __cdecl  CancelEventCallbackGameObject (AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API void __cdecl  CancelEventCallback (AkPlayingID in_playingID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  GetSourcePlayPosition (AkPlayingID in_PlayingID, AkTimeMs *out_puPosition, bool in_bExtrapolate=true)
 
AKSOUNDENGINE_API AKRESULT __cdecl  GetSourcePlayPositions (AkPlayingID in_PlayingID, AkSourcePosition *out_puPositions, AkUInt32 *io_pcPositions, bool in_bExtrapolate=true)
 
AKSOUNDENGINE_API AKRESULT __cdecl  GetSourceStreamBuffering (AkPlayingID in_PlayingID, AkTimeMs &out_buffering, bool &out_bIsBuffering)
 
AKSOUNDENGINE_API void __cdecl  StopAll (AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
 
AKSOUNDENGINE_API void __cdecl  StopPlayingID (AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
 
AKSOUNDENGINE_API void __cdecl  ExecuteActionOnPlayingID (AkActionOnEventType in_ActionType, AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
 
AKSOUNDENGINE_API void __cdecl  SetRandomSeed (AkUInt32 in_uSeed)
 
AKSOUNDENGINE_API void __cdecl  MuteBackgroundMusic (bool in_bMute)
 
AKSOUNDENGINE_API bool __cdecl  GetBackgroundMusicMute ()
 
AKSOUNDENGINE_API AKRESULT __cdecl  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 __cdecl  ClearBanks ()
 
AKSOUNDENGINE_API AKRESULT __cdecl  SetBankLoadIOSettings (AkReal32 in_fThroughput, AkPriority in_priority)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBank (const char *in_pszString, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBank (AkBankID in_bankID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBankMemoryView (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBankMemoryCopy (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  DecodeBank (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkMemPoolId in_uPoolForDecodedBank, void *&out_pDecodedBankPtr, AkUInt32 &out_uDecodedBankSize)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBank (const char *in_pszString, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBank (AkBankID in_bankID, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBankMemoryView (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  LoadBankMemoryCopy (const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AkBankID &out_bankID)
 
AKSOUNDENGINE_API AKRESULT __cdecl  UnloadBank (const char *in_pszString, const void *in_pInMemoryBankPtr)
 
AKSOUNDENGINE_API AKRESULT __cdecl  UnloadBank (AkBankID in_bankID, const void *in_pInMemoryBankPtr)
 
AKSOUNDENGINE_API AKRESULT __cdecl  UnloadBank (const char *in_pszString, const void *in_pInMemoryBankPtr, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT __cdecl  UnloadBank (AkBankID in_bankID, const void *in_pInMemoryBankPtr, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API void __cdecl  CancelBankCallbackCookie (void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, const char *in_pszString, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, AkBankID in_bankID, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All)
 
AKSOUNDENGINE_API 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)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareBank (AK::SoundEngine::PreparationType in_PreparationType, AkBankID in_bankID, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All)
 
AKSOUNDENGINE_API AKRESULT __cdecl  ClearPreparedEvents ()
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, AkUniqueID *in_pEventID, AkUInt32 in_uNumEvent)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareEvent (PreparationType in_PreparationType, AkUniqueID *in_pEventID, AkUInt32 in_uNumEvent, AkBankCallbackFunc in_pfnBankCallback, void *in_pCookie)
 
AKSOUNDENGINE_API AKRESULT __cdecl  SetMedia (AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
 
AKSOUNDENGINE_API AKRESULT __cdecl  UnsetMedia (AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, const char *in_pszGroupName, const char **in_ppszGameSyncName, AkUInt32 in_uNumGameSyncs)
 
AKSOUNDENGINE_API AKRESULT __cdecl  PrepareGameSyncs (PreparationType in_PreparationType, AkGroupType in_eGameSyncType, AkUInt32 in_GroupID, AkUInt32 *in_paGameSyncID, AkUInt32 in_uNumGameSyncs)
 
AKSOUNDENGINE_API 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)
 
AKSOUNDENGINE_API 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.