Version

    Other Documentation

menu_open
Wwise SDK 2019.1.11
AK::IAkMixerPluginContext Class Referenceabstract

Interface to retrieve contextual information for a mixer. More...

Inheritance diagram for AK::IAkMixerPluginContext:
AK::IAkPluginContextBase

Public Member Functions

virtual AkUniqueID  GetBusID ()=0
 
virtual AkUInt32  GetBusType ()=0
 
virtual AKRESULT  GetSpeakerAngles (AkReal32 *io_pfSpeakerAngles, AkUInt32 &io_uNumAngles, AkReal32 &out_fHeightAngle)=0
 
Services.
virtual AKRESULT  ComputeSpeakerVolumesDirect (AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AkReal32 in_fCenterPerc, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
  Compute a direct speaker assignment volume matrix with proper downmixing rules between two channel configurations. More...
 
virtual AKRESULT  ComputeSpeakerVolumesPanner (const AkVector &in_position, AkReal32 in_fCenterPct, AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
  Compute a volume matrix given the position of the panner (Wwise 2D panner). More...
 
virtual AKRESULT  ComputePlanarVBAPGains (AkReal32 in_fAngle, AkChannelConfig in_outputConfig, AkReal32 in_fCenterPerc, AK::SpeakerVolumes::VectorPtr out_vVolumes)=0
 
virtual AKRESULT  InitSphericalVBAP (AK::IAkPluginMemAlloc *in_pAllocator, const AkSphericalCoord *in_SphericalPositions, const AkUInt32 in_NbPoints, void *&out_pPannerData)=0
 
virtual AKRESULT  ComputeSphericalVBAPGains (void *in_pPannerData, AkReal32 in_fAzimuth, AkReal32 in_fElevation, AkUInt32 in_uNumChannels, AK::SpeakerVolumes::VectorPtr out_vVolumes)=0
 
virtual AKRESULT  TermSphericalVBAP (AK::IAkPluginMemAlloc *in_pAllocator, void *in_pPannerData)=0
 
virtual AKRESULT  Compute3DPositioning (AkReal32 in_fAngle, AkReal32 in_fElevation, AkReal32 in_fSpread, AkReal32 in_fFocus, AkChannelConfig in_inputConfig, AkChannelMask in_uInputChanSel, AkChannelConfig in_outputConfig, AkReal32 in_fCenterPerc, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
 
virtual AKRESULT  Compute3DPositioning (const AkTransform &in_emitter, const AkTransform &in_listener, AkReal32 in_fCenterPerc, AkReal32 in_fSpread, AkReal32 in_fFocus, AkChannelConfig in_inputConfig, AkChannelMask in_uInputChanSel, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
 
Metering.
virtual void  EnableMetering (AkMeteringFlags in_eFlags)=0
 
- Public Member Functions inherited from AK::IAkPluginContextBase
virtual IAkGlobalPluginContext GlobalContext () const =0
 
virtual IAkGameObjectPluginInfo GetGameObjectInfo ()=0
 
virtual AKRESULT  GetOutputID (AkUInt32 &out_uOutputID, AkPluginID &out_uDevicePlugin) const =0
 
virtual void  GetPluginMedia (AkUInt32 in_dataIndex, AkUInt8 *&out_rpData, AkUInt32 &out_rDataSize)=0
 
virtual void  GetPluginCustomGameData (void *&out_rpData, AkUInt32 &out_rDataSize)=0
 
virtual AKRESULT  PostMonitorData (void *in_pData, AkUInt32 in_uDataSize)=0
 
virtual bool  CanPostMonitorData ()=0
 
virtual AKRESULT  PostMonitorMessage (const char *in_pszError, AK::Monitor::ErrorLevel in_eErrorLevel)=0
 
virtual AkReal32  GetDownstreamGain ()=0
 
virtual AKRESULT  GetParentChannelConfig (AkChannelConfig &out_channelConfig) const =0
 

Protected Member Functions

virtual  ~IAkMixerPluginContext ()
  Virtual destructor on interface to avoid warnings. More...
 
- Protected Member Functions inherited from AK::IAkPluginContextBase
virtual  ~IAkPluginContextBase ()
  Virtual destructor on interface to avoid warnings. More...
 

Detailed Description

Interface to retrieve contextual information for a mixer.

Definition at line 392 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