Firelight Technologies FMOD Studio API

System::registerCodec

Creates a file format codec to be used by FMOD for opening custom file types.

C++ Syntax

FMOD_RESULT System::registerCodec(
  FMOD_CODEC_DESCRIPTION *description,
  unsigned int *handle,
  unsigned int priority
);

C Syntax

FMOD_RESULT FMOD_System_RegisterCodec(
  FMOD_SYSTEM *system,
  FMOD_CODEC_DESCRIPTION *description,
  unsigned int *handle,
  unsigned int priority
);

Parameters

description

Address of a FMOD_CODEC_DESCRIPTION structure containing information about the codec.

handle

Address of a variable to receive the plugin handle of the newly-registered codec.

priority

Priority of the codec compared to other codecs. 0 = most important, higher numbers = less importance.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

See Also

• FMOD_CODEC_DESCRIPTION
• System::registerDSP

Version 1.03.06 Built on Apr 17, 2014