Version
menu_open
Wwise SDK 2021.1.14
Classes | Namespaces | Macros | Typedefs | Enumerations
AkSoundEngine.h File Reference
#include <AK/SoundEngine/Common/AkSoundEngineExport.h>
#include <AK/SoundEngine/Common/AkTypes.h>
#include <AK/SoundEngine/Common/IAkPlugin.h>
#include <AK/SoundEngine/Common/AkCallback.h>
#include <AK/SoundEngine/Platforms/Windows/AkWinSoundEngine.h>
#include <AK/SoundEngine/Platforms/Windows/AkPlatformContext.h>

Go to the source code of this file.

Classes

struct   AkOutputSettings
  Platform-independent initialization settings of output devices. More...
 
struct   AkTaskContext
  The execution context for a task. More...
 
struct   AkTaskSchedulerDesc
  Description of the client task scheduler. More...
 
struct   AkInitSettings
 
struct   AkSourceSettings
  Necessary settings for setting externally-loaded sources. More...
 
struct   AkSourcePosition
  Return values for GetSourcePlayPositions. More...
 

Namespaces

namespace   AK
  Audiokinetic namespace.
 
  AK::SoundEngine
 

Macros

#define  AK_ASSERT_HOOK
 

Typedefs

typedef void(*  AkAssertHook) (const char *in_pszExpression, const char *in_pszFileName, int in_lineNumber)
 
typedef AKRESULT(*  AkBackgroundMusicChangeCallbackFunc) (bool in_bBackgroundMusicMuted, void *in_pCookie)
 
typedef void(*  AkParallelForFunc) (void *in_pData, AkUInt32 in_uIdxBegin, AkUInt32 in_uIdxEnd, AkTaskContext in_ctx, void *in_pUserData)
  Task function: process the [in_uIdxBegin,in_uIdxEnd[ range of items in the in_pData array. More...
 

Enumerations

enum   AkFloorPlane { AkFloorPlane_XZ = 0, AkFloorPlane_XY, AkFloorPlane_YZ, AkFloorPlane_Default = AkFloorPlane_XZ }
  Possible values for the floor plane axis used in the Game Object 3D Viewer in Wwise. More...
 

Functions

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

Event Management

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

Detailed Description

The main sound engine interface.

Definition in file AkSoundEngine.h.

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise