Enum rfmod::Status

#[repr(C)]
pub enum Status {
    Ok,
    AlreadyLocked,
    BadCommand,
    CDDADrivers,
    CDDAInit,
    CDDAInvalidDevice,
    CDDANoAudio,
    CDDANoDevices,
    CDDANoDisc,
    CDDARead,
    ChannelAlloc,
    ChannelStolen,
    COM,
    DMA,
    DSPConnection,
    DSPFormat,
    DSPNotFound,
    DSPRunning,
    DSPTooManyConnections,
    FileBad,
    FileCouldNotSeek,
    FileDiskEjected,
    FileEOF,
    FileNotFound,
    FileUnwanted,
    Format,
    HTTP,
    HTTPAccess,
    HTTPProxyAuth,
    HTTPServerError,
    HTTPTimeout,
    Initialization,
    Initialized,
    Internal,
    InvalidAddress,
    InvalidFloat,
    InvalidHandle,
    InvalidParam,
    InvalidPosition,
    InvalidSpeaker,
    InvalidSyncPoint,
    InvalidVector,
    MaxAudible,
    Memory,
    MemoryCantPoint,
    MemorySRAM,
    Needs2D,
    Needs3D,
    NeedsHardware,
    NeedsSoftware,
    NetConnect,
    NetSocketError,
    NetURL,
    NetWouldBlock,
    NotReady,
    OutputAllocated,
    OutputCreateBuffer,
    OutputDriverCall,
    OutputEnumeration,
    OutputFormat,
    OutputInit,
    OutputNoHardware,
    OutputNoSoftware,
    Pan,
    Plugin,
    PluginInstances,
    PluginMissing,
    PluginResource,
    Preloaded,
    ProgrammerSound,
    Record,
    ReverbInstance,
    SubsoundAllocated,
    SubsoundCantMove,
    SubsoundMode,
    Subsounds,
    TagNotFound,
    TooManyChannels,
    Unimplemented,
    Uninitialized,
    Unsupported,
    Update,
    Version,
    EventFailed,
    EventInfoOnly,
    EventInternal,
    EventMaxStreams,
    EventMismatch,
    EventNameConflict,
    EventNotFound,
    EventNeedsSimple,
    EventGuidConflict,
    EventAlreadyLoaded,
    MusicUninitialized,
    MusicNotFound,
    MusicNoCallback,
    StatusForceInt,
}

Error codes. Returned from every function.

Variants

Ok

No errors.

AlreadyLocked

Tried to call lock a second time before unlock was called.

BadCommand

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

CDDADrivers

Neither NTSCSI nor ASPI could be initialised.

CDDAInit

An error occurred while initialising the CDDA subsystem.

CDDAInvalidDevice

Couldn’t find the specified device.

CDDANoAudio

No audio tracks on the specified disc.

CDDANoDevices

No CD/DVD devices were found.

CDDANoDisc

No disc present in the specified drive.

CDDARead

A CDDA read error occurred.

ChannelAlloc

Error trying to allocate a channel.

ChannelStolen

The specified channel has been reused to play another sound.

COM

A Win32 COM related error occured. COM failed to initialize or a QueryInterface failed meaning a Windows codec or driver was not installed properly.

DMA

DMA Failure. See debug output for more information.

DSPConnection

DSP connection error. Connection possibly caused a cyclic dependancy. Or tried to connect a tree too many units deep (more than 128).

DSPFormat

DSP Format error. A DSP unit may have attempted to connect to this network with the wrong format.

DSPNotFound

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

DSPRunning

DSP error. Cannot perform this operation while the network is in the middle of running. This will most likely happen if a connection or disconnection is attempted in a DSP callback.

DSPTooManyConnections

DSP connection error. The unit being connected to or disconnected should only have 1 input or output.

FileBad

Error loading file.

FileCouldNotSeek

Couldn’t perform seek operation. This is a limitation of the medium (ie netstreams) or the file format.

FileDiskEjected

Media was ejected while reading.

FileEOF

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

FileNotFound

File not found.

FileUnwanted

Unwanted file access occured.

Format

Unsupported file or audio format.

HTTP

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

HTTPAccess

The specified resource requires authentication or is forbidden.

HTTPProxyAuth

Proxy authentication is required to access the specified resource.

HTTPServerError

A HTTP server error occurred.

HTTPTimeout

The HTTP request timed out.

Initialization

FMOD was not initialized correctly to support this function.

Initialized

Cannot call this command after System::init.

Internal

An error occured that wasn’t supposed to. Contact support.

InvalidAddress

On Xbox 360, this memory address passed to FMOD must be physical, (ie allocated with XPhysicalAlloc.)

InvalidFloat

Value passed in was a NaN, Inf or denormalized float.

InvalidHandle

An invalid object handle was used.

InvalidParam

An invalid parameter was passed to this function.

InvalidPosition

An invalid seek position was passed to this function.

InvalidSpeaker

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

InvalidSyncPoint

The syncpoint did not come from this sound handle.

InvalidVector

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

MaxAudible

Reached maximum audible playback count for this sound’s soundgroup.

Memory

Not enough memory or resources.

MemoryCantPoint

Can’t use FMOD_OPENMEMORY_POINT on non PCM source data, or non mp3/xma/adpcm data if FMOD_CREATECOMPRESSEDSAMPLE was used.

MemorySRAM

Not enough memory or resources on console sound ram.

Needs2D

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

Needs3D

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

NeedsHardware

Tried to use a feature that requires hardware support. (ie trying to play a GCADPCM compressed sound in software on Wii).

NeedsSoftware

Tried to use a feature that requires the software engine. Software engine has either been turned off, or command was executed on a hardware channel which does not support this feature.

NetConnect

Couldn’t connect to the specified host.

NetSocketError

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

NetURL

The specified URL couldn’t be resolved.

NetWouldBlock

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

NotReady

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

OutputAllocated

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

OutputCreateBuffer

Error creating hardware sound buffer.

OutputDriverCall

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

OutputEnumeration

Error enumerating the available driver list. List may be inconsistent due to a recent device addition or removal.

OutputFormat

Soundcard does not support the minimum features needed for this soundsystem (16bit stereo output).

OutputInit

Error initializing output device.

OutputNoHardware

FMOD_HARDWARE was specified but the sound card does not have the resources necessary to play it.

OutputNoSoftware

Attempted to create a software sound but no software channels were specified in System::init.

Pan

Panning only works with mono or stereo sound sources.

Plugin

An unspecified error has been returned from a 3rd party plugin.

PluginInstances

The number of allowed instances of a plugin has been exceeded.

PluginMissing

A requested output, dsp unit type or codec was not available.

PluginResource

A resource that the plugin requires cannot be found. (ie the DLS file for MIDI playback or other DLLs that it needs to load)

Preloaded

The specified sound is still in use by the event system, call EventSystem::unloadFSB before trying to release it.

ProgrammerSound

The specified sound is still in use by the event system, wait for the event which is using it finish with it.

Record

An error occured trying to initialize the recording device.

ReverbInstance

Specified instance in FMOD_REVERB_PROPERTIES couldn’t be set. Most likely because it is an invalid instance number or the reverb doesnt exist.

SubsoundAllocated

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.

SubsoundCantMove

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

SubsoundMode

The subsound’s mode bits do not match with the parent sound’s mode bits. See documentation for function that it was called with.

Subsounds

The error occured 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, or a parent sound was played without setting up a sentence first.

TagNotFound

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

TooManyChannels

The sound created exceeds the allowable input channel count. This can be increased using the maxinputchannels parameter in System::setSoftwareFormat.

Unimplemented

Something in FMOD hasn’t been implemented when it should be ! contact support !

Uninitialized

This command failed because System::init or System::setDriver was not called.

Unsupported

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

Update

An error caused by System::update occured.

Version

The version number of this file format is not supported.

EventFailed

An Event failed to be retrieved, most likely due to ‘just fail’ being specified as the max playbacks behavior.

EventInfoOnly

Can’t execute this command on an EVENT_INFOONLY event.

EventInternal

An error occured that wasn’t supposed to. See debug log for reason.

EventMaxStreams

Event failed because ‘Max streams’ was hit when FMOD_EVENT_INIT_FAIL_ON_MAXSTREAMS was specified.

EventMismatch

FSB mismatches the FEV it was compiled with, the stream/sample mode it was meant to be created with was different, or the FEV was built for a different platform.

EventNameConflict

A category with the same name already exists.

EventNotFound

The requested event, event group, event category or event property could not be found.

EventNeedsSimple

Tried to call a function on a complex event that’s only supported by simple events.

EventGuidConflict

An event with the same GUID already exists.

EventAlreadyLoaded

The specified project or bank has already been loaded. Having multiple copies of the same project loaded simultaneously is forbidden.

MusicUninitialized

Music system is not initialized probably because no music data is loaded.

MusicNotFound

The requested music entity could not be found.

MusicNoCallback

The music callback is required, but it has not been set.

StatusForceInt

Makes sure this enum is signed 32bit.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Status

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Status> for Status

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Status> for Status

fn partial_cmp(&self, other: &Status) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Status

impl StructuralPartialEq for Status