Table of Contents

virtual AKRESULT AK::IAkGlobalPluginContext::RegisterCodec ( AkUInt32  in_ulCompanyID,
AkUInt32  in_ulPluginID,
AkCreateFileSourceCallback  in_pFileCreateFunc,
AkCreateBankSourceCallback  in_pBankCreateFunc  
) [pure virtual]

Register a codec type with the sound engine and set the callback functions to create the codec's file source and bank source nodes.

See also:
Returns:
AK_Success if successful, AK_InvalidParameter if invalid parameters were provided, or Ak_Fail otherwise. Possible reasons for an AK_Fail result are:
  • Insufficient memory to register the codec
  • Codec ID already registered
Remarks:
Codecs and plug-ins must be registered before loading banks that use them.
Loading a bank referencing an unregistered plug-in or codec will result in a load bank success, but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects, posting the event will fail.
Parameters:
in_ulCompanyID  Company identifier (as declared in XML)
in_ulPluginID  Plugin identifier (as declared in XML)
in_pFileCreateFunc  Factory for streaming sources.
in_pBankCreateFunc  Factory for in-memory sources.