Table of Contents

Wwise SDK 2021.1.2
AK::IAkGlobalPluginContext Class Referenceabstract

#include <IAkPlugin.h>

Public Member Functions

virtual IAkStreamMgr GetStreamMgr () const =0
  Retrieve the streaming manager access interface. More...
 
virtual AkUInt16  GetMaxBufferLength () const =0
 
virtual bool  IsRenderingOffline () const =0
 
virtual AkUInt32  GetSampleRate () const =0
 
virtual AKRESULT  PostMonitorMessage (const char *in_pszError, AK::Monitor::ErrorLevel in_eErrorLevel)=0
 
virtual AKRESULT  RegisterPlugin (AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreatePluginCallback in_pCreateFunc, AkCreateParamCallback in_pCreateParamFunc)=0
 
virtual AKRESULT  RegisterCodec (AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreateFileSourceCallback in_pFileCreateFunc, AkCreateBankSourceCallback in_pBankCreateFunc)=0
 
virtual AKRESULT  RegisterGlobalCallback (AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender, void *in_pCookie=NULL)=0
 
virtual AKRESULT  UnregisterGlobalCallback (AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender)=0
 
virtual AK::IAkPluginMemAlloc GetAllocator ()=0
  Get the default allocator for plugins. This is useful for performing global initialization tasks shared across multiple plugin instances. More...
 
virtual 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)=0
 
virtual AKRESULT  SendPluginCustomGameData (AkUniqueID in_busID, AkGameObjectID in_busObjectID, AkPluginType in_eType, AkUInt32 in_uCompanyID, AkUInt32 in_uPluginID, const void *in_pData, AkUInt32 in_uSizeInBytes)=0
 
virtual void  ComputeAmbisonicsEncoding (AkReal32 in_fAzimuth, AkReal32 in_fElevation, AkChannelConfig in_cfgAmbisonics, AK::SpeakerVolumes::VectorPtr out_vVolumes)=0
 
virtual AKRESULT  ComputeWeightedAmbisonicsDecodingFromSampledSphere (const AkVector in_samples[], AkUInt32 in_uNumSamples, AkChannelConfig in_cfgAmbisonics, AK::SpeakerVolumes::MatrixPtr out_mxVolume)=0
 
virtual const AkAcousticTexture GetAcousticTexture (AkAcousticTextureID in_AcousticTextureID)=0
 
virtual AKRESULT  ComputeSphericalCoordinates (const AkEmitterListenerPair &in_pair, AkReal32 &out_fAzimuth, AkReal32 &out_fElevation) const =0
 
virtual const AkPlatformInitSettings GetPlatformInitSettings () const =0
 
virtual const AkInitSettings GetInitSettings () const =0
 
virtual AKRESULT  GetAudioSettings (AkAudioSettings &out_audioSettings) const =0
 
virtual AkUInt32  GetIDFromString (const char *in_pszString) const =0
 
virtual AkPlayingID  PostEventSync (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)=0
 
virtual AkPlayingID  PostMIDIOnEventSync (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)=0
 
virtual AKRESULT  StopMIDIOnEventSync (AkUniqueID in_eventID=AK_INVALID_UNIQUE_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)=0
 
virtual IAkPlatformContext GetPlatformContext () const =0
 
virtual IAkPluginService GetPluginService (AkPluginServiceType in_pluginService) const =0
 
virtual AkUInt32  GetBufferTick () const =0
 

Protected Member Functions

virtual  ~IAkGlobalPluginContext ()
  Virtual destructor on interface to avoid warnings. More...
 

Detailed Description

Global plug-in context used for plug-in registration/initialization. Games query this interface from the sound engine, via AK::SoundEngine::GetGlobalPluginContext. Plug-ins query it via IAkPluginContextBase::GlobalContext.

Definition at line 1343 of file IAkPlugin.h.