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
);
C# Syntax
RESULT System.registerCodec(
ref CODEC_DESCRIPTION description,
out uint handle,
uint priority
);
JavaScript Syntax
System.registerCodec(
description,
handle,
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
Version 1.10.03 Built on Feb 1, 2018