Version

    Other Documentation

menu_open
Wwise SDK 2018.1.11
AK::IAkGlobalPluginContext Class Referenceabstract

Global plugin context used for plugin registration/initialization. Games query this interface from the sound engine. More...

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  MixNinNChannels (AkAudioBuffer *in_pInputBuffer, AkAudioBuffer *in_pMixBuffer, AkReal32 in_fPrevGain, AkReal32 in_fNextGain, AK::SpeakerVolumes::ConstMatrixPtr in_mxPrevVolumes, AK::SpeakerVolumes::ConstMatrixPtr in_mxNextVolumes)=0
  N to N channels mix. More...
 
virtual void  Mix1inNChannels (AkReal32 *AK_RESTRICT in_pInChannel, AkAudioBuffer *in_pMixBuffer, AkReal32 in_fPrevGain, AkReal32 in_fNextGain, AK::SpeakerVolumes::ConstVectorPtr in_vPrevVolumes, AK::SpeakerVolumes::ConstVectorPtr in_vNextVolumes)=0
  1 to N channels mix More...
 
virtual void  MixChannel (AkReal32 *AK_RESTRICT in_pInBuffer, AkReal32 *AK_RESTRICT in_pOutBuffer, AkReal32 in_fPrevGain, AkReal32 in_fNextGain, AkUInt16 in_uNumFrames)=0
  Single channel mix. More...
 
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 AKRESULT  PostMIDIOnEventSync (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkMIDIPost *in_pPosts, AkUInt16 in_uNumPosts)=0
 
virtual AKRESULT  StopMIDIOnEventSync (AkUniqueID in_eventID=AK_INVALID_UNIQUE_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)=0
 

Protected Member Functions

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

Detailed Description

Global plugin context used for plugin registration/initialization. Games query this interface from the sound engine.

Definition at line 1116 of file IAkPlugin.h.


The documentation for this class was generated from the following file:

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