Functions

FMOD System Functions

fmod_create

Arguments	Argument Type
None

Creates the FMOD System. Required to be executed at least once for the extension to work.

fmod_init

Arguments	Argument Type
numberofchannels	Double
studioInitFlags	Double

Initializes the FMOD system. Required to be executed at least once for the extension to work.

fmod_update

Arguments	Argument Type
None

Updates the FMOD System. Required to be executed every frame for the the extension to work.

fmod_loadBank

Arguments	Argument Type
path	String

Loads the specified *.bank file.

fmod_bank_loadSampleData

Arguments	Argument Type
bank_handle	Double

Loads Sample data from the specified *.bank file.

Event Functions

fmod_createEventInstance

Arguments	Argument Type
event_path	String

Creates an event instance. Meant to be ran once.

fmod_event_play

Arguments	Argument Type
event_handle	Double

Plays an event instance.

fmod_event_setParameter

Arguments	Argument Type
handle	Double
parameter_name	String
value	Double
ignoreseekspeed	Double

Sets the specified local parameter to the given value.

fmod_event_getParameter

Arguments	Argument Type
handle	Double
parameter_name	String

Gets the value the specified local parameter is set to.

Bus Functions

fmod_getBus

Arguments	Argument Type
bus_path	String

Gets the ID of the given bus.

fmod_bus_getVolume

Arguments	Argument Type
bus_handle	Double

Gets the buses volume.

fmod_bus_setVolume

Arguments	Argument Type
bus_handle	Double
volume	Double

Sets the buses volume.

fmod_bus_getMute

Arguments	Argument Type
bus_handle	String

Gets if the specified bus is muted.

fmod_bus_setMute

Arguments	Argument Type
bus_handle	String
mute	Double

Mutes or unmutes the specified bus.

Helper Scripts

event_play_oneshot

Arguments	Argument Type
event_path	String

Plays an event. Only for one-and-done events.

event_isplaying

Arguments	Argument Type
event_path	String

Check if any instance of the event is playing.