Wobbly Life Mod SDK
 
Loading...
Searching...
No Matches
ModWobblyLife.Audio Namespace Reference

Classes

struct  MODATTRIBUTES_3D
 Wrapper for the FMOD api ATTRIBUTES_3D https://fmod.com/docs/2.01/unity/api.html. More...
 
struct  ModEventInstance
 Wrapper for the FMOD api EventInstance https://fmod.com/docs/2.01/unity/api.html. More...
 
class  ModRuntimeManager
 Wrapper for the FMOD api RuntimeManager https://fmod.com/docs/2.01/unity/api.html. More...
 
class  ModRuntimeUtils
 Wrapper for the FMOD api RuntimeUtils https://fmod.com/docs/2.01/unity/api.html.
 
class  ModSoundEmitter
 A basic sound emitter. More...
 
class  ModSurfaceMaterial
 The surface material component, used to determine what sound to play when an impact happens. More...
 
struct  MODVECTOR
 Wrapper for the FMOD api VECTOR https://fmod.com/docs/2.01/unity/api.html. More...
 

Enumerations

enum  MOD_PLAYBACK_STATE : int {
  PLAYING , SUSTAINING , STOPPED , STARTING ,
  STOPPING
}
 Wrapper for the FMOD api PLAYBACK_STATE https://fmod.com/docs/2.01/unity/api.html. More...
 
enum  MOD_STOP_MODE : int { ALLOWFADEOUT , IMMEDIATE }
 Wrapper for the FMOD api STOP_MODE https://fmod.com/docs/2.01/unity/api.html. More...
 
enum  MOD_EVENT_PROPERTY : int {
  CHANNELPRIORITY , SCHEDULE_DELAY , SCHEDULE_LOOKAHEAD , MINIMUM_DISTANCE ,
  MAXIMUM_DISTANCE , COOLDOWN , MAX
}
 Wrapper for the FMOD api EVENT_PROPERTY https://fmod.com/docs/2.01/unity/api.html. More...
 
enum  MODRESULT : int {
  OK , ERR_BADCOMMAND , ERR_CHANNEL_ALLOC , ERR_CHANNEL_STOLEN ,
  ERR_DMA , ERR_DSP_CONNECTION , ERR_DSP_DONTPROCESS , ERR_DSP_FORMAT ,
  ERR_DSP_INUSE , ERR_DSP_NOTFOUND , ERR_DSP_RESERVED , ERR_DSP_SILENCE ,
  ERR_DSP_TYPE , ERR_FILE_BAD , ERR_FILE_COULDNOTSEEK , ERR_FILE_DISKEJECTED ,
  ERR_FILE_EOF , ERR_FILE_ENDOFDATA , ERR_FILE_NOTFOUND , ERR_FORMAT ,
  ERR_HEADER_MISMATCH , ERR_HTTP , ERR_HTTP_ACCESS , ERR_HTTP_PROXY_AUTH ,
  ERR_HTTP_SERVER_ERROR , ERR_HTTP_TIMEOUT , ERR_INITIALIZATION , ERR_INITIALIZED ,
  ERR_INTERNAL , ERR_INVALID_FLOAT , ERR_INVALID_HANDLE , ERR_INVALID_PARAM ,
  ERR_INVALID_POSITION , ERR_INVALID_SPEAKER , ERR_INVALID_SYNCPOINT , ERR_INVALID_THREAD ,
  ERR_INVALID_VECTOR , ERR_MAXAUDIBLE , ERR_MEMORY , ERR_MEMORY_CANTPOINT ,
  ERR_NEEDS3D , ERR_NEEDSHARDWARE , ERR_NET_CONNECT , ERR_NET_SOCKET_ERROR ,
  ERR_NET_URL , ERR_NET_WOULD_BLOCK , ERR_NOTREADY , ERR_OUTPUT_ALLOCATED ,
  ERR_OUTPUT_CREATEBUFFER , ERR_OUTPUT_DRIVERCALL , ERR_OUTPUT_FORMAT , ERR_OUTPUT_INIT ,
  ERR_OUTPUT_NODRIVERS , ERR_PLUGIN , ERR_PLUGIN_MISSING , ERR_PLUGIN_RESOURCE ,
  ERR_PLUGIN_VERSION , ERR_RECORD , ERR_REVERB_CHANNELGROUP , ERR_REVERB_INSTANCE ,
  ERR_SUBSOUNDS , ERR_SUBSOUND_ALLOCATED , ERR_SUBSOUND_CANTMOVE , ERR_TAGNOTFOUND ,
  ERR_TOOMANYCHANNELS , ERR_TRUNCATED , ERR_UNIMPLEMENTED , ERR_UNINITIALIZED ,
  ERR_UNSUPPORTED , ERR_VERSION , ERR_EVENT_ALREADY_LOADED , ERR_EVENT_LIVEUPDATE_BUSY ,
  ERR_EVENT_LIVEUPDATE_MISMATCH , ERR_EVENT_LIVEUPDATE_TIMEOUT , ERR_EVENT_NOTFOUND , ERR_STUDIO_UNINITIALIZED ,
  ERR_STUDIO_NOT_LOADED , ERR_INVALID_STRING , ERR_ALREADY_LOCKED , ERR_NOT_LOCKED ,
  ERR_RECORD_DISCONNECTED , ERR_TOOMANYSAMPLES
}
 Wrapper for the FMOD api RESULT https://fmod.com/docs/2.01/unity/api.html. More...
 
enum  ModEmitterGameEvent : int {
  None , ObjectStart , ObjectDestroy , ObjectEnable ,
  ObjectDisable
}
 When you want the event to execute. More...
 
enum  ModSurface : byte {
  General = 0 , Grass = 1 , Sand = 2 , Snow = 3 ,
  Dirt = 4 , Water = 5 , JungleGrass = 6 , Coins = 7 ,
  Squishy = 8 , None = 9 , Fish = 10 , Jelly = 11 ,
  Ice = 12 , Metal = 13 , Carpet = 14
}
 The surface material, used to determine what sound to play when an impact happens. More...
 

Enumeration Type Documentation

◆ MOD_EVENT_PROPERTY

Wrapper for the FMOD api EVENT_PROPERTY https://fmod.com/docs/2.01/unity/api.html.

Enumerator
CHANNELPRIORITY 

Priority to set on Core API Channels created by this event instance, or -1 for default.

SCHEDULE_DELAY 

FMOD_STUDIO_EVENT_PROPERTY_SCHEDULE_DELAY.

SCHEDULE_LOOKAHEAD 

FMOD_STUDIO_EVENT_PROPERTY_SCHEDULE_LOOKAHEAD.

MINIMUM_DISTANCE 

FMOD_STUDIO_EVENT_PROPERTY_MINIMUM_DISTANCE.

MAXIMUM_DISTANCE 

FMOD_STUDIO_EVENT_PROPERTY_MAXIMUM_DISTANCE.

COOLDOWN 

FMOD_STUDIO_EVENT_PROPERTY_COOLDOWN.

MAX 

FMOD_STUDIO_EVENT_PROPERTY_MAX.

◆ MOD_PLAYBACK_STATE

Wrapper for the FMOD api PLAYBACK_STATE https://fmod.com/docs/2.01/unity/api.html.

Enumerator
PLAYING 

Playing.

SUSTAINING 

The timeline cursor is paused on a sustain point. (Studio::EventInstance only.)

STOPPED 

Stopped.

STARTING 

Preparing to start.

STOPPING 

Preparing to stop.

◆ MOD_STOP_MODE

Wrapper for the FMOD api STOP_MODE https://fmod.com/docs/2.01/unity/api.html.

Enumerator
ALLOWFADEOUT 

Allows AHDSR modulators to complete their release, and DSP effect tails to play out.

IMMEDIATE 

Stops the event instance immediately.

◆ ModEmitterGameEvent

When you want the event to execute.

Enumerator
None 

Do nothing.

ObjectStart 

Execute on start.

ObjectDestroy 

Execute on destroy.

ObjectEnable 

Execute on enable.

ObjectDisable 

Execute on disable.

◆ MODRESULT

Wrapper for the FMOD api RESULT https://fmod.com/docs/2.01/unity/api.html.

Enumerator
OK 

No errors.

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

ERR_CHANNEL_ALLOC 

Error trying to allocate a channel.

ERR_CHANNEL_STOLEN 

The specified channel has been reused to play another sound.

ERR_DMA 

DMA Failure. See debug output for more information.

ERR_DSP_CONNECTION 

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

ERR_DSP_DONTPROCESS 

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.

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

ERR_DSP_INUSE 

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

ERR_DSP_NOTFOUND 

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

ERR_DSP_RESERVED 

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

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

ERR_DSP_TYPE 

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

ERR_FILE_BAD 

Error loading file.

ERR_FILE_COULDNOTSEEK 

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

ERR_FILE_DISKEJECTED 

Media was ejected while reading.

ERR_FILE_EOF 

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

ERR_FILE_ENDOFDATA 

End of current chunk reached while trying to read data.

ERR_FILE_NOTFOUND 

File not found.

ERR_FORMAT 

Unsupported file or audio format.

ERR_HEADER_MISMATCH 

There is a version mismatch between the FMOD header and either the FMOD Studio library or the FMOD Core library.

ERR_HTTP 

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

ERR_HTTP_ACCESS 

The specified resource requires authentication or is forbidden.

ERR_HTTP_PROXY_AUTH 

Proxy authentication is required to access the specified resource.

ERR_HTTP_SERVER_ERROR 

A HTTP server error occurred.

ERR_HTTP_TIMEOUT 

The HTTP request timed out.

ERR_INITIALIZATION 

FMOD was not initialized correctly to support this function.

ERR_INITIALIZED 

Cannot call this command after System::init.

ERR_INTERNAL 

An error occurred that wasn't supposed to. Contact support.

ERR_INVALID_FLOAT 

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

ERR_INVALID_HANDLE 

An invalid object handle was used.

ERR_INVALID_PARAM 

An invalid parameter was passed to this function.

ERR_INVALID_POSITION 

An invalid seek position was passed to this function.

ERR_INVALID_SPEAKER 

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

ERR_INVALID_SYNCPOINT 

The syncpoint did not come from this sound handle.

ERR_INVALID_THREAD 

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

ERR_INVALID_VECTOR 

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

ERR_MAXAUDIBLE 

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

ERR_MEMORY 

Not enough memory or resources.

ERR_MEMORY_CANTPOINT 

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

ERR_NEEDS3D 

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

ERR_NEEDSHARDWARE 

Tried to use a feature that requires hardware support.

ERR_NET_CONNECT 

Couldn't connect to the specified host.

ERR_NET_SOCKET_ERROR 

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

ERR_NET_URL 

The specified URL couldn't be resolved.

ERR_NET_WOULD_BLOCK 

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

ERR_NOTREADY 

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

ERR_OUTPUT_ALLOCATED 

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

ERR_OUTPUT_CREATEBUFFER 

Error creating hardware sound buffer.

ERR_OUTPUT_DRIVERCALL 

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

ERR_OUTPUT_FORMAT 

Soundcard does not support the specified format.

ERR_OUTPUT_INIT 

Error initializing output device.

ERR_OUTPUT_NODRIVERS 

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.

ERR_PLUGIN 

An unspecified error has been returned from a plugin.

ERR_PLUGIN_MISSING 

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

ERR_PLUGIN_RESOURCE 

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

ERR_PLUGIN_VERSION 

A plugin was built with an unsupported SDK version.

ERR_RECORD 

An error occurred trying to initialize the recording device.

ERR_REVERB_CHANNELGROUP 

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

ERR_REVERB_INSTANCE 

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.

ERR_SUBSOUNDS 

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.

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

ERR_SUBSOUND_CANTMOVE 

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

ERR_TAGNOTFOUND 

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

ERR_TOOMANYCHANNELS 

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

ERR_TRUNCATED 

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

ERR_UNIMPLEMENTED 

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

ERR_UNINITIALIZED 

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

ERR_UNSUPPORTED 

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

ERR_VERSION 

The version number of this file format is not supported.

ERR_EVENT_ALREADY_LOADED 

The specified bank has already been loaded.

ERR_EVENT_LIVEUPDATE_BUSY 

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

ERR_EVENT_LIVEUPDATE_MISMATCH 

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

ERR_EVENT_LIVEUPDATE_TIMEOUT 

The live update connection timed out.

ERR_EVENT_NOTFOUND 

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

ERR_STUDIO_UNINITIALIZED 

The Studio::System object is not yet initialized.

ERR_STUDIO_NOT_LOADED 

The specified resource is not loaded, so it can't be unloaded.

ERR_INVALID_STRING 

An invalid string was passed to this function.

ERR_ALREADY_LOCKED 

The specified resource is already locked.

ERR_NOT_LOCKED 

The specified resource is not locked, so it can't be unlocked.

ERR_RECORD_DISCONNECTED 

The specified recording driver has been disconnected.

ERR_TOOMANYSAMPLES 

The length provided exceeds the allowable limit.

◆ ModSurface

The surface material, used to determine what sound to play when an impact happens.

Enumerator
General 

General.

Grass 

Grass.

Sand 

Sand.

Snow 

Snow.

Dirt 

Dirt.

Water 

Water.

JungleGrass 

Jungle Grass.

Coins 

Coins.

Squishy 

Squishy.

None 

None.

Fish 

Fish.

Jelly 

Jelly.

Ice 

Ice.

Metal 

Metal.

Carpet 

Carpet.