System::registerOutput

FMOD Studio API

Firelight Technologies FMOD Studio API

System::registerOutput

Register a user-defined output mode for use with the System. This function allows you to register statically-linked output modes. Once registered, you can use the output mode with System::setOutputByPlugin.

C++ Syntax

FMOD_RESULT System::registerOutput(
  const FMOD_OUTPUT_DESCRIPTION *description,
  unsigned int *handle
);

C Syntax

FMOD_RESULT FMOD_System_RegisterOutput(
  FMOD_SYSTEM *system,
  const FMOD_OUTPUT_DESCRIPTION *description,
  unsigned int *handle
);

C# Syntax

RESULT System.registerOutput(
  ref OUTPUT_DESCRIPTION description,
  out uint handle
);

JavaScript Syntax

System.registerOutput(
  description,                     
  handle                           
);

Parameters

description
Address of an FMOD_OUTPUT_DESCRIPTION structure, containing information about the output mode.
handle
Address of a variable to receive the plugin handle of the newly-registered output mode.

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