fmod_errors.js

const {
  e
} = require('./api');

e.FMOD_ErrorString = function(errcode) {
  switch (errcode) {
    case e.FMOD_OK:
      return 'No errors.';
    case e.FMOD_ERR_BADCOMMAND:
      return 'Tried to call a function on a data type that does not allow this type of functionality (ie calling Sound::lock on a streaming sound).';
    case e.FMOD_ERR_CHANNEL_ALLOC:
      return 'Error trying to allocate a channel.';
    case e.FMOD_ERR_CHANNEL_STOLEN:
      return 'The specified channel has been reused to play another sound.';
    case e.FMOD_ERR_DMA:
      return 'DMA Failure.  See debug output for more information.';
    case e.FMOD_ERR_DSP_CONNECTION:
      return 'DSP connection error.  Connection possibly caused a cyclic dependency or connected dsps with incompatible buffer counts.';
    case e.FMOD_ERR_DSP_DONTPROCESS:
      return 'DSP return code from a DSP process query callback.  Tells mixer not to call the process callback and therefore not consume CPU.  Use this to optimize the DSP graph.';
    case e.FMOD_ERR_DSP_FORMAT:
      return 'DSP Format error.  A DSP unit may have attempted to connect to this network with the wrong format, or a matrix may have been set with the wrong size if the target unit has a specified channel map.';
    case e.FMOD_ERR_DSP_INUSE:
      return 'DSP is already in the mixer\'s DSP network. It must be removed before being reinserted or released.';
    case e.FMOD_ERR_DSP_NOTFOUND:
      return 'DSP connection error.  Couldn\'t find the DSP unit specified.';
    case e.FMOD_ERR_DSP_RESERVED:
      return 'DSP operation error.  Cannot perform operation on this DSP as it is reserved by the system.';
    case e.FMOD_ERR_DSP_SILENCE:
      return 'DSP return code from a DSP process query callback.  Tells mixer silence would be produced from read, so go idle and not consume CPU.  Use this to optimize the DSP graph.';
    case e.FMOD_ERR_DSP_TYPE:
      return 'DSP operation cannot be performed on a DSP of this type.';
    case e.FMOD_ERR_FILE_BAD:
      return 'Error loading file.';
    case e.FMOD_ERR_FILE_COULDNOTSEEK:
      return 'Couldn\'t perform seek operation.  This is a limitation of the medium (ie netstreams) or the file format.';
    case e.FMOD_ERR_FILE_DISKEJECTED:
      return 'Media was ejected while reading.';
    case e.FMOD_ERR_FILE_EOF:
      return 'End of file unexpectedly reached while trying to read essential data (truncated?).';
    case e.FMOD_ERR_FILE_ENDOFDATA:
      return 'End of current chunk reached while trying to read data.';
    case e.FMOD_ERR_FILE_NOTFOUND:
      return 'File not found.';
    case e.FMOD_ERR_FORMAT:
      return 'Unsupported file or audio format.';
    case e.FMOD_ERR_HEADER_MISMATCH:
      return 'There is a version mismatch between the FMOD header and either the FMOD Studio library or the FMOD Low Level library.';
    case e.FMOD_ERR_HTTP:
      return 'A HTTP error occurred. This is a catch-all for HTTP errors not listed elsewhere.';
    case e.FMOD_ERR_HTTP_ACCESS:
      return 'The specified resource requires authentication or is forbidden.';
    case e.FMOD_ERR_HTTP_PROXY_AUTH:
      return 'Proxy authentication is required to access the specified resource.';
    case e.FMOD_ERR_HTTP_SERVER_ERROR:
      return 'A HTTP server error occurred.';
    case e.FMOD_ERR_HTTP_TIMEOUT:
      return 'The HTTP request timed out.';
    case e.FMOD_ERR_INITIALIZATION:
      return 'FMOD was not initialized correctly to support this function.';
    case e.FMOD_ERR_INITIALIZED:
      return 'Cannot call this command after System::init.';
    case e.FMOD_ERR_INTERNAL:
      return 'An error occurred that wasn\'t supposed to.  Contact support.';
    case e.FMOD_ERR_INVALID_FLOAT:
      return 'Value passed in was a NaN, Inf or denormalized float.';
    case e.FMOD_ERR_INVALID_HANDLE:
      return 'An invalid object handle was used.';
    case e.FMOD_ERR_INVALID_PARAM:
      return 'An invalid parameter was passed to this function.';
    case e.FMOD_ERR_INVALID_POSITION:
      return 'An invalid seek position was passed to this function.';
    case e.FMOD_ERR_INVALID_SPEAKER:
      return 'An invalid speaker was passed to this function based on the current speaker mode.';
    case e.FMOD_ERR_INVALID_SYNCPOINT:
      return 'The syncpoint did not come from this sound handle.';
    case e.FMOD_ERR_INVALID_THREAD:
      return 'Tried to call a function on a thread that is not supported.';
    case e.FMOD_ERR_INVALID_VECTOR:
      return 'The vectors passed in are not unit length, or perpendicular.';
    case e.FMOD_ERR_MAXAUDIBLE:
      return 'Reached maximum audible playback count for this sound\'s soundgroup.';
    case e.FMOD_ERR_MEMORY:
      return 'Not enough memory or resources.';
    case e.FMOD_ERR_MEMORY_CANTPOINT:
      return 'Can\'t use FMOD_OPENMEMORY_POINT on non PCM source data, or non mp3/xma/adpcm data if FMOD_CREATECOMPRESSEDSAMPLE was used.';
    case e.FMOD_ERR_NEEDS3D:
      return 'Tried to call a command on a 2d sound when the command was meant for 3d sound.';
    case e.FMOD_ERR_NEEDSHARDWARE:
      return 'Tried to use a feature that requires hardware support.';
    case e.FMOD_ERR_NET_CONNECT:
      return 'Couldn\'t connect to the specified host.';
    case e.FMOD_ERR_NET_SOCKET_ERROR:
      return 'A socket error occurred.  This is a catch-all for socket-related errors not listed elsewhere.';
    case e.FMOD_ERR_NET_URL:
      return 'The specified URL couldn\'t be resolved.';
    case e.FMOD_ERR_NET_WOULD_BLOCK:
      return 'Operation on a non-blocking socket could not complete immediately.';
    case e.FMOD_ERR_NOTREADY:
      return 'Operation could not be performed because specified sound/DSP connection is not ready.';
    case e.FMOD_ERR_OUTPUT_ALLOCATED:
      return 'Error initializing output device, but more specifically, the output device is already in use and cannot be reused.';
    case e.FMOD_ERR_OUTPUT_CREATEBUFFER:
      return 'Error creating hardware sound buffer.';
    case e.FMOD_ERR_OUTPUT_DRIVERCALL:
      return 'A call to a standard soundcard driver failed, which could possibly mean a bug in the driver or resources were missing or exhausted.';
    case e.FMOD_ERR_OUTPUT_FORMAT:
      return 'Soundcard does not support the specified format.';
    case e.FMOD_ERR_OUTPUT_INIT:
      return 'Error initializing output device.';
    case e.FMOD_ERR_OUTPUT_NODRIVERS:
      return 'The output device has no drivers installed.  If pre-init, FMOD_OUTPUT_NOSOUND is selected as the output mode.  If post-init, the function just fails.';
    case e.FMOD_ERR_PLUGIN:
      return 'An unspecified error has been returned from a plugin.';
    case e.FMOD_ERR_PLUGIN_MISSING:
      return 'A requested output, dsp unit type or codec was not available.';
    case e.FMOD_ERR_PLUGIN_RESOURCE:
      return 'A resource that the plugin requires cannot be allocated or found. (ie the DLS file for MIDI playback)';
    case e.FMOD_ERR_PLUGIN_VERSION:
      return 'A plugin was built with an unsupported SDK version.';
    case e.FMOD_ERR_RECORD:
      return 'An error occurred trying to initialize the recording device.';
    case e.FMOD_ERR_REVERB_CHANNELGROUP:
      return 'Reverb properties cannot be set on this channel because a parent channelgroup owns the reverb connection.';
    case e.FMOD_ERR_REVERB_INSTANCE:
      return 'Specified instance in FMOD_REVERB_PROPERTIES couldn\'t be set. Most likely because it is an invalid instance number or the reverb doesn\'t exist.';
    case e.FMOD_ERR_SUBSOUNDS:
      return 'The error occurred because the sound referenced contains subsounds when it shouldn\'t have, or it doesn\'t contain subsounds when it should have.  The operation may also not be able to be performed on a parent sound.';
    case e.FMOD_ERR_SUBSOUND_ALLOCATED:
      return 'This subsound is already being used by another sound, you cannot have more than one parent to a sound.  Null out the other parent\'s entry first.';
    case e.FMOD_ERR_SUBSOUND_CANTMOVE:
      return 'Shared subsounds cannot be replaced or moved from their parent stream, such as when the parent stream is an FSB file.';
    case e.FMOD_ERR_TAGNOTFOUND:
      return 'The specified tag could not be found or there are no tags.';
    case e.FMOD_ERR_TOOMANYCHANNELS:
      return 'The sound created exceeds the allowable input channel count.  This can be increased using the \'maxinputchannels\' parameter in System::setSoftwareFormat.';
    case e.FMOD_ERR_TRUNCATED:
      return 'The retrieved string is too long to fit in the supplied buffer and has been truncated.';
    case e.FMOD_ERR_UNIMPLEMENTED:
      return 'Something in FMOD hasn\'t been implemented when it should be! contact support!';
    case e.FMOD_ERR_UNINITIALIZED:
      return 'This command failed because System::init or System::setDriver was not called.';
    case e.FMOD_ERR_UNSUPPORTED:
      return 'A command issued was not supported by this object.  Possibly a plugin without certain callbacks specified.';
    case e.FMOD_ERR_VERSION:
      return 'The version number of this file format is not supported.';
    case e.FMOD_ERR_EVENT_ALREADY_LOADED:
      return 'The specified bank has already been loaded.';
    case e.FMOD_ERR_EVENT_LIVEUPDATE_BUSY:
      return 'The live update connection failed due to the game already being connected.';
    case e.FMOD_ERR_EVENT_LIVEUPDATE_MISMATCH:
      return 'The live update connection failed due to the game data being out of sync with the tool.';
    case e.FMOD_ERR_EVENT_LIVEUPDATE_TIMEOUT:
      return 'The live update connection timed out.';
    case e.FMOD_ERR_EVENT_NOTFOUND:
      return 'The requested event, parameter, bus or vca could not be found.';
    case e.FMOD_ERR_STUDIO_UNINITIALIZED:
      return 'The Studio::System object is not yet initialized.';
    case e.FMOD_ERR_STUDIO_NOT_LOADED:
      return 'The specified resource is not loaded, so it can\'t be unloaded.';
    case e.FMOD_ERR_INVALID_STRING:
      return 'An invalid string was passed to this function.';
    case e.FMOD_ERR_ALREADY_LOCKED:
      return 'The specified resource is already locked.';
    case e.FMOD_ERR_NOT_LOCKED:
      return 'The specified resource is not locked, so it can\'t be unlocked.';
    case e.FMOD_ERR_RECORD_DISCONNECTED:
      return 'The specified recording driver has been disconnected.';
    case e.FMOD_ERR_TOOMANYSAMPLES:
      return 'The length provided exceeds the allowable limit.';
    default:
      return 'Unknown error.';
  };
}