Module: FMOD::Core::Result

Defined in:: lib/fmod/core/result.rb

Overview

Result codes returned from every function call to FMOD.

Constant Summary collapse

OK = No errors.

BAD_COMMAND = 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).

CHANNEL_ALLOC = Error trying to allocate a channel.

CHANNEL_STOLEN = The specified channel has been reused to play another sound.

DMA = DMA Failure. See debug output for more information.

DSP_CONNECTION = DSP connection error. Connection possibly caused a cyclic dependency or connected dsps with incompatible buffer counts.

DSP_DONT_PROCESS = 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.

DSP_FORMAT = 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.

DSP_IN_USE = DSP is already in the mixer’s DSP network. It must be removed before being reinserted or released.

DSP_NOT_FOUND = DSP connection error. Couldn’t find the DSP unit specified.

DSP_RESERVED = DSP operation error. Cannot perform operation on this DSP as it is reserved by the system.

DSP_SILENCE = 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.

DSP_TYPE = DSP operation cannot be performed on a DSP of this type.

FILE_BAD = Error loading file.

FILE_COULD__SEEK = Couldn’t perform seek operation. This is a limitation of the medium (ie net-streams) or the file format.

FILE_DISK_EJECTED = Media was ejected while reading.

FILE_EOF = End of file unexpectedly reached while trying to read essential data (truncated?).

FILE_END_OF_DATA = End of current chunk reached while trying to read data.

FILE_NOT_FOUND = File not found.

FORMAT = Unsupported file or audio format.

HEADER_MISMATCH = There is a version mismatch between the FMOD header and either the FMOD Studio library or the FMOD Low Level library.

HTTP = A HTTP error occurred. This is a catch-all for HTTP errors not listed elsewhere.

HTTP_ACCESS = The specified resource requires authentication or is forbidden.

HTTP_PROXY_AUTH = Proxy authentication is required to access the specified resource.

HTTP_SERVER_ERROR = A HTTP server error occurred.

HTTP_TIMEOUT = The HTTP request timed out.

INITIALIZATION = FMOD was not initialized correctly to support this function.

INITIALIZED = Cannot call this command after FMOD::System.create.

INTERNAL = An error occurred that wasn’t supposed to. Contact support.

INVALID_FLOAT = Value passed in was a NaN, Inf or de-normalized float.

INVALID_HANDLE = An invalid object handle was used.

INVALID_PARAM = An invalid parameter was passed to a function.

INVALID_POSITION = An invalid seek position was passed to a function.

INVALID_SPEAKER = An invalid speaker was passed to this function based on the current speaker mode.

INVALID_SYNC_POINT = The syncpoint did not come from this sound handle.

INVALID_THREAD = Tried to call a function on a thread that is not supported.

INVALID_VECTOR = The vectors passed in are not unit length, or perpendicular.

MAX_AUDIBLE = Reached maximum audible playback count for this sound’s sound group.

MEMORY = Not enough memory or resources.

MEMORY_CANT_POINT = Can’t use “open memory point” on non PCM source data, or non mp3/xma/adpcm data if “create compressed sample” was used.

NEEDS_3D = Tried to call a command on a 2d sound when the command was meant for 3D sound.

NEEDS_HARDWARE = Tried to use a feature that requires hardware support.

NET_CONNECT = Couldn’t connect to the specified host.

NET_SOCKET_ERROR = A socket error occurred. This is a catch-all for socket-related errors not listed elsewhere.

NET_URL = The specified URL couldn’t be resolved.

NET_WOULD_BLOCK = Operation on a non-blocking socket could not complete immediately.

NOT_READY = Operation could not be performed because specified sound/DSP connection is not ready.

OUTPUT_ALLOCATED = Error initializing output device, but more specifically, the output device is already in use and cannot be reused.

OUTPUT_CREATE_BUFFER = Error creating hardware sound buffer.

OUTPUT_DRIVER_CALL = A call to a standard soundcard driver failed, which could possibly mean a bug in the driver or resources were missing or exhausted.

OUTPUT_FORMAT = Sound card does not support the specified format.

OUTPUT_INIT = Error initializing output device.

OUTPUT_NO_DRIVERS = The output device has no drivers installed. If pre-init, NO_SOUND is selected as the output mode. If post-init, the function just fails.

PLUGIN = An unspecified error has been returned from a plugin.

PLUGIN_MISSING = A requested output, DSP unit type or codec was not available.

PLUGIN_RESOURCE = A resource that the plugin requires cannot be found. (ie the DLS file for MIDI playback)

PLUGIN_VERSION = A plugin was built with an unsupported SDK version.

RECORD = An error occurred trying to initialize the recording device.

REVERB_CHANNEL_GROUP = Reverb properties cannot be set on this channel because a parent channel group owns the reverb connection.

REVERB_INSTANCE = Specified instance in Reverb couldn’t be set. Most likely because it is an invalid instance number or the reverb doesn’t exist.

SUBSOUNDS = The error occurred because the sound referenced contains sub-sounds when it shouldn’t have, or it doesn’t contain sub-sounds when it should have. The operation may also not be able to be performed on a parent sound.

SUBSOUND_ALLOCATED = 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.

SUBSOUND_CANT_MOVE = Shared subsounds cannot be replaced or moved from their parent stream, such as when the parent stream is an FSB file.

TAG_NOT_FOUND = The specified tag could not be found or there are no tags.

TOO_MANY_CHANNELS = The sound created exceeds the allowable input channel count.

TRUNCATED = The retrieved string is too long to fit in the supplied buffer and has been truncated.

UNIMPLEMENTED = Something in FMOD hasn’t been implemented when it should be! Contact support!

UNINITIALIZED = This command failed because System.create or System.output was not called.

UNSUPPORTED = A command issued was not supported by this object. Possibly a plugin without certain callbacks specified.

VERSION = The version number of this file format is not supported.

EVENT_ALREADY_LOADED = The specified bank has already been loaded.

EVENT_LIVE_UPDATE_BUSY = The live update connection failed due to the game already being connected.

EVENT_LIVE_UPDATE_MISMATCH = The live update connection failed due to the game data being out of sync with the tool.

EVENT_LIVE_UPDATE_TIMEOUT = The live update connection timed out.

EVENT_NOT_FOUND = The requested event, bus or vca could not be found.

STUDIO_UNINITIALIZED = The Studio::System object is not yet initialized.

STUDIO_NOT_LOADED = The specified resource is not loaded, so it can’t be unloaded.

INVALID_STRING = An invalid string was passed to this function.

ALREADY_LOCKED = The specified resource is already locked.

NOT_LOCKED = The specified resource is not locked, so it can’t be unlocked.

RECORD_DISCONNECTED = The specified recording driver has been disconnected.

TOO_MANY_SAMPLES = The length provided exceeds the allowable limit.