Version
menu
Wwise SDK 2024.1.5

◆ RegisterCodec()

AKSOUNDENGINE_API AKRESULT 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: 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
  • AK_InsufficientMemory if there isn't enough memory to register the plug-in
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_ulCompanyIDCompany identifier (as declared in the plug-in description XML file)
in_ulCodecIDCodec identifier (as declared in the plug-in description XML file)
in_pFileCreateFuncPointer to the codec's file source node creation function
in_pBankCreateFuncPointer to the codec's bank source node creation function

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