Table of Contents

AKRESULT __cdecl AK::SoundEngine::RegisterCodec ( AkUInt32  in_ulCompanyID,
AkUInt32  in_ulCodecID,
AkCreateFileSourceCallback  in_pFileCreateFunc,
AkCreateBankSourceCallback  in_pBankCreateFunc  
)

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

Note.gif
Note: This function is deprecated. Registration is now automatic if you link plugins statically. If plugins are dynamic libraries (such as DLLs or SOs), use RegisterPluginDLL.
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 the plug-in description XML file)
in_ulCodecID  Codec identifier (as declared in the plug-in description XML file)
in_pFileCreateFunc  Pointer to the codec's file source node creation function
in_pBankCreateFunc  Pointer to the codec's bank source node creation function