Skip to content

studio_system

Jump to bottom
Francisco Dias edited this page Nov 22, 2024 · 5 revisions

FMOD Studio System

FMOD Object: Studio::System


This module holds functionality related to the FMOD Studio system object.

Create an FMOD Studio system object with fmod_studio_system_create.

Note

Initializing the FMOD Studio System object will also initialize the core System object.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.


Back To Top

fmod_studio_system_create

FMOD Function: Studio::System::create


This is the FMOD Studio System creation function.

Call fmod_studio_system_release to free the Studio System.


Syntax:

fmod_studio_system_create()



Returns:

N/A



Back To Top

fmod_studio_system_init

FMOD Function: Studio::System::initialize


This function initializes the Studio System.

The core system used by the studio system is initialized at the same time as the studio system.

The flags parameter is passed to fmod_system_init to initialize the core.

See Getting Started for examples on initialising and updating FMOD systems.


Syntax:

fmod_studio_system_init(max_channels, studio_flags, core_flags)
Argument Type Description
max_channels Real The maximum number of Channels, including both virtual and real, to be used in FMOD.
studio_flags FMOD_STUDIO_INIT Studio system initialization flags.
core_flags FMOD_INIT Core system initialization flags.



Returns:

N/A



Back To Top

fmod_studio_system_release

FMOD Function: Studio::System::release


This function shuts down and frees the Studio System object.

This will free the memory used by the Studio System object and everything created under it.


Syntax:

fmod_studio_system_release()



Returns:

N/A



Back To Top

fmod_studio_system_update

FMOD Function: Studio::System::update


This function updates the FMOD Studio System.

See Getting Started for examples on initialising and updating FMOD systems.


Syntax:

fmod_studio_system_update()



Returns:

N/A



Back To Top

fmod_studio_system_flush_commands

FMOD Function: Studio::System::flushCommands


This function blocks the calling thread until all pending commands have been executed and all non-blocking bank loads have been completed.


Syntax:

fmod_studio_system_flush_commands()



Returns:

N/A



Back To Top

fmod_studio_system_flush_sample_loading

FMOD Function: Studio::System::flushSampleLoading


This function blocks until all sample loading and unloading has completed.


Syntax:

fmod_studio_system_flush_sample_loading()



Returns:

N/A



Back To Top

fmod_studio_system_load_bank_custom

FMOD Function: Studio::System::loadBankCustom


This function loads the metadata of a Studio bank and returns a handle to the Bank.

Sample data must be loaded separately; see Sample Data Loading for details.

If you use FMOD_STUDIO_LOAD_BANK.NONBLOCKING, this function will return a Bank handle which will be usable once it has been loaded asynchronously. This is indicated by the fmod_last_result value after a function call that uses the Bank handle.

If a bank has been split, separating out assets and optionally streams from the metadata bank, all parts must be loaded before any APIs that use the data are called. It is recommended you load each part one after another (order is not important), then proceed with dependent API calls such as fmod_studio_bank_load_sample_data or fmod_studio_system_get_event.


Syntax:

fmod_studio_system_load_bank_custom(flags)
Argument Type Description
flags FMOD_STUDIO_LOAD_BANK Flags to control bank loading.



Returns:

Real



Back To Top

fmod_studio_system_load_bank_file

FMOD Function: Studio::System::loadBankFile


This function loads the metadata of a Studio bank from file, returning a handle to the Bank.

Sample data must be loaded separately; see Sample Data Loading for details.

If you use FMOD_STUDIO_LOAD_BANK.NONBLOCKING, this function will return a Bank handle which will be usable once it has been loaded asynchronously. This is indicated by the fmod_last_result value after a function call that uses the Bank handle.

If a bank has been split, separating out assets and optionally streams from the metadata bank, all parts must be loaded before any APIs that use the data are called. It is recommended you load each part one after another (order is not important), then proceed with dependent API calls such as fmod_studio_bank_load_sample_data or fmod_studio_system_get_event.


Syntax:

fmod_studio_system_load_bank_file(filename, flags)
Argument Type Description
filename String Name of the file on the disk.
flags FMOD_STUDIO_LOAD_BANK Flags to control bank loading.



Returns:

Real



Back To Top

fmod_studio_system_load_bank_memory

FMOD Function: Studio::System::loadBankMemory


This function loads the metadata of a Studio bank from memory, returning a handle to the Bank object.

Sample data must be loaded separately; see Sample Data Loading for details.

When mode is FMOD_STUDIO_LOAD_MEMORY_MODE.MEMORY, FMOD will allocate an internal buffer and copy the data from the passed in buffer before using it. When used in this mode there are no alignment restrictions on buffer and the memory pointed to by buffer may be cleaned up at any time after this function returns.

When mode is FMOD_STUDIO_LOAD_MEMORY_MODE.MEMORY_POINT, FMOD will use the passed memory buffer directly. When using this mode the buffer must be aligned to FMOD_STUDIO_LOAD_MEMORY_ALIGNMENT and the memory must persist until the bank has been fully unloaded, which can be some time after calling fmod_studio_bank_unload to unload the bank. You can ensure the memory is not being freed prematurely by only freeing it after receiving the FMOD_STUDIO_SYSTEM_CALLBACK.BANK_UNLOAD callback (enabled in fmod_studio_system_set_callback).

If you use FMOD_STUDIO_LOAD_BANK.NONBLOCKING, this function will return a Bank handle which will be usable once it has been loaded asynchronously. This is indicated by the fmod_last_result value after a function call that uses the Bank handle.

If a bank has been split, separating out assets and optionally streams from the metadata bank, all parts must be loaded before any APIs that use the data are called. It is recommended you load each part one after another (order is not important), then proceed with dependent API calls such as fmod_studio_bank_load_sample_data or fmod_studio_system_get_event.


Syntax:

fmod_studio_system_load_bank_memory(buff_data, length, mode, flags)
Argument Type Description
buff_data Real Memory buffer.
length Real Length of the memory buffer.
mode FMOD_STUDIO_LOAD_MEMORY_MODE Loading mode to use.
flags FMOD_STUDIO_LOAD_BANK Flags to control bank loading.



Returns:

Real



Back To Top

fmod_studio_system_unload_all

FMOD Function: Studio::System::unloadAll


This function unloads all currently loaded banks.


Syntax:

fmod_studio_system_unload_all()



Returns:

N/A



Back To Top

fmod_studio_system_get_bank

FMOD Function: Studio::System::getBank


This function retrieves a loaded bank.

path may be a path, such as bank:/Weapons or an ID string such as {793cddb6-7fa1-4e06-b805-4c74c0fd625b}.

Note that path lookups will only succeed if the strings bank has been loaded.


Syntax:

fmod_studio_system_get_bank(path)
Argument Type Description
path String The bank path or the ID string that identifies the bank. (UTF-8 string)



Returns:

Real



Back To Top

fmod_studio_system_get_bank_by_id

FMOD Function: Studio::System::getBankByID


This function retrieves a loaded bank by its GUID.


Syntax:

fmod_studio_system_get_bank_by_id(guid_str)
Argument Type Description
guid_str String Bank GUID.



Returns:

Real



Back To Top

fmod_studio_system_get_bank_count

FMOD Function: Studio::System::getBankCount


This function retrieves the number of loaded banks.

May be used in conjunction with fmod_studio_system_get_bank_list to enumerate the loaded banks.


Syntax:

fmod_studio_system_get_bank_count()



Returns:

Real



Back To Top

fmod_studio_system_get_bank_list

FMOD Function: Studio::System::getBankList


This function retrieves an array containing the loaded banks.

May be used in conjunction with fmod_studio_system_get_bank_count to enumerate the loaded banks.


Syntax:

fmod_studio_system_get_bank_list()



Returns:

Array of Real



Back To Top

fmod_studio_system_set_listener_attributes

FMOD Function: Studio::System::setListenerAttributes


This function sets the 3D attributes of the listener.

If you don't pass a value for attenuation, the listener only uses the position in attributes.


Syntax:

fmod_studio_system_set_listener_attributes(listener_index, attributes, attenuation=undefined)
Argument Type Description
listener_index Real Index of listener to set 3D attributes on. Listeners are indexed from 0, to FMOD_MAX_LISTENERS - 1, in a multi-listener environment.
attributes Fmod3DAttributes 3D attributes.
attenuation FmodVector Position used for calculating attenuation.



Returns:

N/A



Back To Top

fmod_studio_system_get_listener_attributes

FMOD Function: Studio::System::getListenerAttributes


This function retrieves listener 3D attributes, containing a struct for the attributes, and a struct for the attenuation position.


Syntax:

fmod_studio_system_get_listener_attributes(listener_index)
Argument Type Description
listener_index Real Index of listener to set 3D attributes on. Listeners are indexed from 0, to FMOD_MAX_LISTENERS - 1, in a multi-listener environment.



Returns:

FmodStudioListenerAttributes



Back To Top

fmod_studio_system_set_listener_weight

FMOD Function: Studio::System::setListenerWeight


This function sets the listener weighting.

Listener weighting is a factor which determines how much the listener influences the mix. It is taken into account for 3D panning, doppler, and the automatic distance event parameter. A listener with a weight of 0 has no effect on the mix.

Listener weighting can be used to fade in and out multiple listeners. For example to do a crossfade, an additional listener can be created with a weighting of 0 that ramps up to 1 while the old listener weight is ramped down to 0. After the crossfade is finished the number of listeners can be reduced to 1 again.

The sum of all the listener weights should add up to at least 1. It is a user error to set all listener weights to 0.


Syntax:

fmod_studio_system_set_listener_weight(listener_index, weight)
Argument Type Description
listener_index Real Listener index.
weight Real Weighting value, Range: [0, 1], Default: 1



Returns:

N/A



Back To Top

fmod_studio_system_get_listener_weight

FMOD Function: Studio::System::getListenerWeight


This function retrieves the weighting value of the listener.


Syntax:

fmod_studio_system_get_listener_weight(listener_index)
Argument Type Description
listener_index Real Listener index.



Returns:

Real



Back To Top

fmod_studio_system_set_num_listeners

FMOD Function: Studio::System::setNumListeners


This function sets the number of listeners in the 3D sound scene.

If the number of listeners is set to more than 1 then FMOD uses a 'closest sound to the listener' method to determine what should be heard.

See the Studio 3D Events white paper for more information.


Syntax:

fmod_studio_system_set_num_listeners(num)
Argument Type Description
num Real Number of listeners, Range: [1, FMOD_MAX_LISTENERS], Default: 1



Returns:

N/A



Back To Top

fmod_studio_system_get_num_listeners

FMOD Function: Studio::System::getNumListeners


This function retrieves the number of listeners.


Syntax:

fmod_studio_system_get_num_listeners()



Returns:

Real



Back To Top

fmod_studio_system_get_bus

FMOD Function: Studio::System::getBus


This function allows you to retrieve a handle for any bus in the global mixer.

path may be a path, such as bus:/SFX/Ambience or an ID string such as {793cddb6-7fa1-4e06-b805-4c74c0fd625b}.

Note that path lookups will only succeed if the strings bank has been loaded.


Syntax:

fmod_studio_system_get_bus(path)
Argument Type Description
path String The bank path or the ID string that identifies the bus. (UTF-8 string)



Returns:

Real



Back To Top

fmod_studio_system_get_bus_by_id

FMOD Function: Studio::System::getBusByID


This function allows you to retrieve a handle for any bus in the global mixer using its GUID.


Syntax:

fmod_studio_system_get_bus_by_id(guid)
Argument Type Description
guid String Bus GUID.



Returns:

Real



Back To Top

fmod_studio_system_get_event

FMOD Function: Studio::System::getEvent


This function allows you to retrieve a handle to any loaded event description.

path may be a path, such as event:/UI/Cancel or an ID string such as {793cddb6-7fa1-4e06-b805-4c74c0fd625b}.

Note that path lookups will only succeed if the strings bank has been loaded.


Syntax:

fmod_studio_system_get_event(path)
Argument Type Description
path String The path or the ID string that identifies the event or snapshot. (UTF-8 string)



Returns:

Real



Back To Top

fmod_studio_system_get_event_by_id

FMOD Function: Studio::System::getEventByID


This function allows you to retrieve a handle to any loaded event description by its GUID.


Syntax:

fmod_studio_system_get_event_by_id(guid_str)
Argument Type Description
guid_str String Event or snapshot GUID.



Returns:

Real



Back To Top

fmod_studio_system_get_parameter_by_id

FMOD Function: Studio::System::getParameterByID


This function retrieves a global parameter value struct by its unique identifier.


Syntax:

fmod_studio_system_get_parameter_by_id(parameter_id)
Argument Type Description
parameter_id FmodStudioParameterId Parameter identifier.



Returns:

FmodStudioParameter



Back To Top

fmod_studio_system_set_parameter_by_id

FMOD Function: Studio::System::setParameterByID


This function sets a global parameter value by unique identifier.


Syntax:

fmod_studio_system_set_parameter_by_id(parameter_id, value, ignore_seek_speed=false)
Argument Type Description
parameter_id FmodStudioParameterId Parameter identifier.
value Real Value for given identifier.
ignore_seek_speed Boolean Specifies whether to ignore the parameter's seek speed and set the value immediately.



Returns:

N/A



Back To Top

fmod_studio_system_set_parameter_by_id_with_label

FMOD Function: Studio::System::setParameterByIDWithLabel


This function sets a global parameter value by unique identifier, looking up the value label.

If the specified label is not found, FMOD_RESULT.ERR_EVENT_NOTFOUND is returned in the next fmod_last_result call. This lookup is case sensitive.


Syntax:

fmod_studio_system_set_parameter_by_id_with_label(parameter_id, label, ignore_seek_speed=false)
Argument Type Description
parameter_id FmodStudioParameterId Parameter identifier.
label String Labeled value for given identifier.
ignore_seek_speed Boolean Specifies whether to ignore the parameter's seek speed and set the value immediately.



Returns:

N/A



Back To Top

fmod_studio_system_get_parameter_by_name

FMOD Function: Studio::System::getParameterByName


This function retrieves a global parameter value struct by name.


Syntax:

fmod_studio_system_get_parameter_by_name(name)
Argument Type Description
name String Parameter name (case-insensitive). (UTF-8 string)



Returns:

FmodStudioParameter



Back To Top

fmod_studio_system_set_parameter_by_name

FMOD Function: Studio::System::setParameterByName


This function sets a global parameter value by name.


Syntax:

fmod_studio_system_set_parameter_by_name(name, value, ignore_seek_speed=false)
Argument Type Description
name String Parameter name (case-insensitive). (UTF-8 string)
value Real Value for given name.
ignore_seek_speed Real Specifies whether to ignore the parameter's seek speed and set the value immediately.



Returns:

N/A



Back To Top

fmod_studio_system_set_parameter_by_name_with_label

FMOD Function: Studio::System::setParameterByNameWithLabel


This function sets a global parameter value by name, looking up the value label.


Syntax:

fmod_studio_system_set_parameter_by_name_with_label(name, label, ignore_seek_speed=false)
Argument Type Description
name String Parameter name (case-insensitive). (UTF-8 string)
label String Labeled value for given name.
ignore_seek_speed Real Specifies whether to ignore the parameter's seek speed and set the value immediately.



Returns:

N/A



Back To Top

fmod_studio_system_get_parameter_description_by_name

FMOD Function: Studio::System::getParameterDescriptionByName


This function retrieves a global parameter by name or path.

name can be the short name (such as 'Wind') or the full path (such as 'parameter:/Ambience/Wind'). Path lookups will only succeed if the strings bank has been loaded.


Syntax:

fmod_studio_system_get_parameter_description_by_name(name)
Argument Type Description
name String Parameter name. (UTF-8 string)



Returns:

FmodStudioParameterDescription



Back To Top

fmod_studio_system_get_parameter_description_by_id

FMOD Function: Studio::System::getParameterDescriptionByID


This function retrieves a global parameter by ID.


Syntax:

fmod_studio_system_get_parameter_description_by_id(parameter_id)
Argument Type Description
parameter_id FmodStudioParameterId Parameter ID.



Returns:

FmodStudioParameterDescription



Back To Top

fmod_studio_system_get_parameter_description_count

FMOD Function: Studio::System::getParameterDescriptionCount


This function retrieves the number of global parameters.


Syntax:

fmod_studio_system_get_parameter_description_count()



Returns:

Real



Back To Top

fmod_studio_system_get_parameter_description_list

FMOD Function: Studio::System::getParameterDescriptionList


This function retrieves an array of global parameters.


Syntax:

fmod_studio_system_get_parameter_description_list()



Returns:

Array of FmodStudioParameterDescription



Back To Top

fmod_studio_system_get_parameter_label_by_name

FMOD Function: Studio::System::getParameterLabelByName


This function retrieves a global parameter label by name or path.

name can be the short name (such as 'Wind') or the full path (such as 'parameter:/Ambience/Wind'). Path lookups will only succeed if the strings bank has been loaded.


Syntax:

fmod_studio_system_get_parameter_label_by_name(name, labelindex)
Argument Type Description
name String Parameter name. (UTF-8 string)
labelindex Real Label index to retrieve.



Returns:

String



Back To Top

fmod_studio_system_get_parameter_label_by_id

FMOD Function: Studio::System::getParameterLabelByID


This function retrieves a global parameter label by ID.


Syntax:

fmod_studio_system_get_parameter_label_by_id(parameter_id, label_index)
Argument Type Description
parameter_id FmodStudioParameterId Parameter ID.
label_index Real Label index to retrieve.



Returns:

String



Back To Top

fmod_studio_system_get_vca

FMOD Function: Studio::System::getVCA


This function allows you to retrieve a handle for any VCA in the global mixer.

path may be a path, such as vca:/MyVCA, or an ID string, such as {d9982c58-a056-4e6c-b8e3-883854b4bffb}.

Note that path lookups will only succeed if the strings bank has been loaded.


Syntax:

fmod_studio_system_get_vca(path)
Argument Type Description
path String The path or the ID string that identifies the VCA. (UTF-8 string)



Returns:

Real



Back To Top

fmod_studio_system_get_vca_by_id

FMOD Function: Studio::System::getVCAByID


This function allows you to retrieve a handle for any VCA in the global mixer by its GUID.


Syntax:

fmod_studio_system_get_vca_by_id(guid_str)
Argument Type Description
guid_str String VCA GUID.



Returns:

Real



Back To Top

fmod_studio_system_set_advanced_settings

FMOD Function: Studio::System::setAdvancedSettings


This function sets advanced settings. This must be called prior to Studio initialization.


Syntax:

fmod_studio_system_set_advanced_settings(settings)
Argument Type Description
settings FmodStudioAdvancedSettings



Returns:

N/A


Example:

var _adv_settings = new FmodStudioAdvancedSettings();
_adv_settings.studio_update_period = 40;
_adv_settings.streaming_schedule_delay = -1;
fmod_studio_system_set_advanced_settings(_adv_settings);


Back To Top

fmod_studio_system_get_advanced_settings

FMOD Function: Studio::System::getAdvancedSettings


This function retrieves advanced settings.


Syntax:

fmod_studio_system_get_advanced_settings()



Returns:

FmodStudioAdvancedSettings



Back To Top

fmod_studio_system_start_command_capture

FMOD Function: Studio::System::startCommandCapture


This function starts recording Studio commands to a file.

The commands generated by the FMOD Studio API can be captured and later replayed for debug and profiling purposes.

Unless the FMOD_STUDIO_COMMANDCAPTURE.SKIP_INITIAL_STATE flag is specified, the command capture will first record the set of all banks and event instances that currently exist.


Syntax:

fmod_studio_system_start_command_capture(filename, flags)
Argument Type Description
filename String The name of the file to which the recorded commands are written. (UTF-8 string)
flags FMOD_STUDIO_COMMANDCAPTURE Flags that control command capturing.



Returns:

N/A



Back To Top

fmod_studio_system_stop_command_capture

FMOD Function: Studio::System::stopCommandCapture


This function stops recording Studio commands.


Syntax:

fmod_studio_system_stop_command_capture()



Returns:

N/A



Back To Top

fmod_studio_system_load_command_replay

FMOD Function: Studio::System::loadCommandReplay


This function loads a command replay and returns its handle.


Syntax:

fmod_studio_system_load_command_replay(filename, flags)
Argument Type Description
filename String The name of the file from which to load the command replay. (UTF-8 string)
flags FMOD_STUDIO_COMMANDCAPTURE Flags that control command capturing.



Returns:

Real



Back To Top

fmod_studio_system_get_buffer_usage

FMOD Function: Studio::System::getBufferUsage


This function retrieves buffer usage information in a struct.

Stall count and time values are cumulative. They can be reset by calling fmod_studio_system_reset_buffer_usage.

Stalls due to the studio command queue overflowing can be avoided by setting a larger command queue size with fmod_studio_system_set_advanced_settings.


Syntax:

fmod_studio_system_get_buffer_usage()



Returns:

FmodStudioBufferUsage



Back To Top

fmod_studio_system_reset_buffer_usage

FMOD Function: Studio::System::resetBufferUsage


This function resets the memory buffer usage statistics tracked by the FMOD Studio System.


Syntax:

fmod_studio_system_reset_buffer_usage()



Returns:

N/A



Back To Top

fmod_studio_system_get_cpu_usage

FMOD Function: Studio::System::getCPUUsage


This function retrieves the amount of CPU used for different parts of the Studio engine.

For readability, the percentage values are smoothed to provide a more stable output.


Syntax:

fmod_studio_system_get_cpu_usage()



Returns:

FmodStudioCPUUsage



Back To Top

fmod_studio_system_get_memory_usage

FMOD Function: Studio::System::getMemoryUsage


This function retrieves memory usage statistics.

The memory usage sample_data value for the system is the total size of non-streaming sample data currently loaded.

Memory usage statistics are only available in logging builds, in release builds the returned struct will contain zero for all values after calling this function.


Syntax:

fmod_studio_system_get_memory_usage()



Returns:

FmodStudioMemoryUsage



Back To Top

fmod_studio_system_set_callback

FMOD Function: Studio::System::setCallback


This function enables a callback for the FMOD Studio System. The callbacks will be received in the Async Social event.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

fmod_studio_system_set_callback(type)
Argument Type Description
type FMOD_STUDIO_SYSTEM_CALLBACK



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String The value "fmod_studio_system_set_callback"
kind FMOD_STUDIO_SYSTEM_CALLBACK The callback type
bank_ref Real Handle of the bank. Only valid when kind=FMOD_STUDIO_SYSTEM_CALLBACK.BANK_UNLOAD


Back To Top

fmod_studio_system_set_user_data

FMOD Function: Studio::System::setUserData


This function allows you to attach a real value to this object.


Syntax:

fmod_studio_system_set_user_data(data)
Argument Type Description
data Real The real value to attach.



Returns:

Real



Back To Top

fmod_studio_system_get_user_data

FMOD Function: Studio::System::getUserData


This function retrieves the real value attached to this object. Returns NaN if no value is attached.


Syntax:

fmod_studio_system_get_user_data()



Returns:

Real



Back To Top

fmod_studio_system_get_sound_info

FMOD Function: Studio::System::getSoundInfo


This function retrieves information for loading a sound from the audio table.

The returned struct contains information to be passed to fmod_system_create_sound (which will create a parent sound), along with a subsound index to be passed to fmod_sound_get_sub_sound once the parent sound is loaded.

The user is expected to call fmod_system_create_sound with the given information. It is up to the user to combine in any desired loading flags, such as FMOD_MODE.CREATESTREAM, FMOD_MODE.CREATECOMPRESSEDSAMPLE or FMOD_MODE.NONBLOCKING with the flags in mode (in the returned struct).

When the banks have been loaded via fmod_studio_system_load_bank_memory, the mode will be returned as FMOD_MODE.OPENMEMORY_POINT. This won't work with the default FMOD_MODE.CREATESAMPLE mode. For memory banks, you should add in the FMOD_MODE.CREATECOMPRESSEDSAMPLE or FMOD_CREATESTREAM flag, or remove FMOD_MODE.OPENMEMORY_POINT and add FMOD_MODE.OPENMEMORY to decompress the sample into a new allocation.


Syntax:

fmod_studio_system_get_sound_info(key)
Argument Type Description
key String The key that identifies the sound. (UTF-8 string)



Returns:

FmodStudioSoundInfo



Back To Top

fmod_studio_system_get_core_system

FMOD Function: Studio::System::getCoreSystem


This function retrieves the Core System.

The Core System object can be retrieved before initializing the Studio System object to call additional core configuration functions.


Syntax:

fmod_studio_system_get_core_system()



Returns:

Real



Back To Top

fmod_studio_system_lookup_id

FMOD Function: Studio::System::lookupID


This function retrieves the GUID for a bank, event, snapshot, bus or VCA.

The strings bank must be loaded prior to calling this function, otherwise FMOD_RESULT.ERR_EVENT_NOTFOUND is returned in the next fmod_last_result call.

The path can be copied to the system clipboard from FMOD Studio using the "Copy Path" context menu command.


Syntax:

fmod_studio_system_lookup_id(path)
Argument Type Description
path String Path. (UTF-8 string)



Returns:

String



Back To Top

fmod_studio_system_lookup_path

FMOD Function: Studio::System::lookupPath


This function retrieves the path for a bank, event, snapshot, bus or VCA.

The strings bank must be loaded prior to calling this function, otherwise FMOD_RESULT.ERR_EVENT_NOTFOUND is returned in the next fmod_last_result call.


Syntax:

fmod_studio_system_lookup_path(str_guid)
Argument Type Description
str_guid String GUID.



Returns:

String



Back To Top

fmod_studio_system_is_valid

FMOD Function: Studio::System::isValid


This function checks that the System reference is valid and has been initialized.


Syntax:

fmod_studio_system_is_valid()



Returns:

Real



YoYoGames 2024

FMOD Extension

Guides

FMOD Core Reference

FMOD Studio Reference

Extras

Clone this wiki locally