# \#studio-scripting-api

**URL:** https://qa.fmod.com/tag/studio-scripting-api/35.md

[Latest](https://qa.fmod.com/latest.md) · [Categories](https://qa.fmod.com/categories.md) · [Tags](https://qa.fmod.com/tags.md)

---

## [Scripting API: Checking if an audioFile object is valid](https://qa.fmod.com/t/scripting-api-checking-if-an-audiofile-object-is-valid/23901)

<div class="topic-metadata">

**Author:** [@CaioMJ](https://qa.fmod.com/u/CaioMJ)\
**Replies:** 3\
**Last updated:** [February 6, 2026, 2:37am UTC](https://qa.fmod.com/t/scripting-api-checking-if-an-audiofile-object-is-valid/23901 "2026-02-06T02:37:38Z")

</div>

Hello, I’m writing some automation with JavaScript using the Scripting API. One of the things I’m doing is iterating through all events in my FMOD project and getting a list of all audio assets referenced by an event, h…

---

## [Can you have scripts that are 'per project'?](https://qa.fmod.com/t/can-you-have-scripts-that-are-per-project/23692)

<div class="topic-metadata">

**Author:** [@tom-bossa](https://qa.fmod.com/u/tom-bossa)\
**Replies:** 6\
**Last updated:** [December 15, 2025, 11:42pm UTC](https://qa.fmod.com/t/can-you-have-scripts-that-are-per-project/23692 "2025-12-15T23:42:23Z")

</div>

I’m currently using fmod scripting api but for user scripts to show up it seems they must go in %localappdata% on a per machine level. When using source control and multiple develolpers it would be much nicer to have a s…

---

## [Project independent path for Studio API scripts osx](https://qa.fmod.com/t/project-independent-path-for-studio-api-scripts-osx/23768)

<div class="topic-metadata">

**Author:** [@dada\_da](https://qa.fmod.com/u/dada_da)\
**Replies:** 1\
**Last updated:** [December 7, 2025, 11:34pm UTC](https://qa.fmod.com/t/project-independent-path-for-studio-api-scripts-osx/23768 "2025-12-07T23:34:01Z")

</div>

I got my script to work if I put it into the projectfolder of the FMOD project by creating a /Scripts subdirectory. Placing the exact same script in Users/XX/Application Support/FMOD Studio/Scripts folder does not work…

---

## [Custom script not appearing in menu](https://qa.fmod.com/t/custom-script-not-appearing-in-menu/23766)

<div class="topic-metadata">

**Author:** [@dada\_da](https://qa.fmod.com/u/dada_da)\
**Replies:** 2\
**Last updated:** [December 5, 2025, 8:35am UTC](https://qa.fmod.com/t/custom-script-not-appearing-in-menu/23766 "2025-12-05T08:35:33Z")

</div>

Hi, Script newbie question: I added a .js script in the Application Support/FMOD Studio/Scripts folder on OSX. It does not show up in my scripts menu in FMOD Studio. How do I call it or at least see it in the menu? I tr…

---

## [Unofficial FMOD Entity Model Documentation](https://qa.fmod.com/t/unofficial-fmod-entity-model-documentation/23731)

<div class="topic-metadata">

**Author:** [@tRoshan](https://qa.fmod.com/u/tRoshan)\
**Replies:** 1\
**Last updated:** [November 30, 2025, 9:31pm UTC](https://qa.fmod.com/t/unofficial-fmod-entity-model-documentation/23731 "2025-11-30T21:31:48Z")

</div>

Hi all, For years I have worked with FMOD Scripting API and felt I had to rely on object.dump to query all the properties each for objects on a project that heavily relied on fmod scripting. I recently made something t…

---

## [JS Scripting API: checking if event has a multi-instrument](https://qa.fmod.com/t/js-scripting-api-checking-if-event-has-a-multi-instrument/23506)

<div class="topic-metadata">

**Author:** [@CaioMJ](https://qa.fmod.com/u/CaioMJ)\
**Replies:** 3\
**Last updated:** [October 29, 2025, 4:30am UTC](https://qa.fmod.com/t/js-scripting-api-checking-if-event-has-a-multi-instrument/23506 "2025-10-29T04:30:06Z")

</div>

Hello, I’m writing a script with JS and writing a function that returns true if an event has a multi instrument on any parameter sheet. This is my current code: function HasVariations( event ) { var eventSheets = even…

---

## [\[Completed\] studio.project.create('Folder') fails, but create('Event') works](https://qa.fmod.com/t/completed-studio-project-create-folder-fails-but-create-event-works/23367)

<div class="topic-metadata">

**Author:** [@LittleAdventurer](https://qa.fmod.com/u/LittleAdventurer)\
**Replies:** 2\
**Last updated:** [September 17, 2025, 6:40am UTC](https://qa.fmod.com/t/completed-studio-project-create-folder-fails-but-create-event-works/23367 "2025-09-17T06:40:40Z")

</div>

Hello, I’m having a script issue. I can create an ‘Event’ using studio.project.create('Event'), but I cannot create a ‘Folder’ using studio.project.create('Folder'). The function seems to return null and fails. I have al…

---

## [FMOD Scripting API Changes Overview](https://qa.fmod.com/t/fmod-scripting-api-changes-overview/23284)

<div class="topic-metadata">

**Author:** [@michaelhartung](https://qa.fmod.com/u/michaelhartung)\
**Replies:** 1\
**Last updated:** [September 1, 2025, 11:27pm UTC](https://qa.fmod.com/t/fmod-scripting-api-changes-overview/23284 "2025-09-01T23:27:11Z")

</div>

I notice there have been some changes to the scripting API with FMOD 2.03.xxx recently. Like sudio.project.buildEndedConnect etc. I can’t seem to find an overview of what changed. Would it be possible to get a changelis…

---

## [Adding pitch shift automation curve through script](https://qa.fmod.com/t/adding-pitch-shift-automation-curve-through-script/23016)

<div class="topic-metadata">

**Author:** [@norbertweiher](https://qa.fmod.com/u/norbertweiher)\
**Replies:** 3\
**Last updated:** [June 12, 2025, 10:53pm UTC](https://qa.fmod.com/t/adding-pitch-shift-automation-curve-through-script/23016 "2025-06-12T22:53:21Z")

</div>

Hello FMOD community! My current workflow requires auto-creating a lot of similar events. I wrote a script which automates most parts (instrument creation, bank / folder assignment, adding of preset FX, routing). For t…

---

## [Is there a way to copy or change the type of instruments in the FMOD Studio scripting API?](https://qa.fmod.com/t/is-there-a-way-to-copy-or-change-the-type-of-instruments-in-the-fmod-studio-scripting-api/22894)

<div class="topic-metadata">

**Author:** [@rhys-L](https://qa.fmod.com/u/rhys-L)\
**Replies:** 3\
**Last updated:** [May 15, 2025, 6:40am UTC](https://qa.fmod.com/t/is-there-a-way-to-copy-or-change-the-type-of-instruments-in-the-fmod-studio-scripting-api/22894 "2025-05-15T06:40:30Z")

</div>

Hi, I’m trying to write a script that converts every SingleSound instance in an event into a ProgrammerSound that uses the SingleSound’s audioFIle as a placeholder. So far I can select every SingleSound in an event, but…

---

## [Script to add values to a User:Labeled parameter?](https://qa.fmod.com/t/script-to-add-values-to-a-user-labeled-parameter/22744)

<div class="topic-metadata">

**Author:** [@getman.josh](https://qa.fmod.com/u/getman.josh)\
**Replies:** 14\
**Last updated:** [April 22, 2025, 10:36pm UTC](https://qa.fmod.com/t/script-to-add-values-to-a-user-labeled-parameter/22744 "2025-04-22T22:36:39Z")

</div>

Hi everyone! I’ve got a very long list of values in a spreadsheet that I’d like to be able to make into values in a user:labeled parameter and I’m wondering if it can be done with a script. I’ve tried reading through th…

---

## [Scripting UI Limitations](https://qa.fmod.com/t/scripting-ui-limitations/22719)

<div class="topic-metadata">

**Author:** [@leppadeer](https://qa.fmod.com/u/leppadeer)\
**Replies:** 4\
**Last updated:** [April 14, 2025, 7:28am UTC](https://qa.fmod.com/t/scripting-ui-limitations/22719 "2025-04-14T07:28:38Z")

</div>

I’ve been experimenting with the studio scripting system for making custom UIs, particularly a simple Git UI, and I’ve run into a some annoying limitations. My current working version is here, and here’s what it looks li…

---

## [Scripting: Loop through content of effect chain](https://qa.fmod.com/t/scripting-loop-through-content-of-effect-chain/22737)

<div class="topic-metadata">

**Author:** [@deHaan](https://qa.fmod.com/u/deHaan)\
**Replies:** 4\
**Last updated:** [March 28, 2025, 9:52am UTC](https://qa.fmod.com/t/scripting-loop-through-content-of-effect-chain/22737 "2025-03-28T09:52:09Z")

</div>

Hi, Is it possible to loop through all the content of effect chains when scripting for FMOD? Haven’t been able to do this yet. Sorry about all my scripting questions, but your responses are super helpful! Cheers, Nik…

---

## [Scripting: Check for automation on master track?](https://qa.fmod.com/t/scripting-check-for-automation-on-master-track/22733)

<div class="topic-metadata">

**Author:** [@deHaan](https://qa.fmod.com/u/deHaan)\
**Replies:** 4\
**Last updated:** [March 28, 2025, 12:49am UTC](https://qa.fmod.com/t/scripting-check-for-automation-on-master-track/22733 "2025-03-28T00:49:34Z")

</div>

Very specific question to the project I am working on: With FMOD scripting, is it possible to figure out if a parameter is used for automation on any events on the master track of an event? I basically need to check if…

---

## [Delete User Property from script?](https://qa.fmod.com/t/delete-user-property-from-script/22732)

<div class="topic-metadata">

**Author:** [@deHaan](https://qa.fmod.com/u/deHaan)\
**Replies:** 2\
**Last updated:** [March 26, 2025, 10:37am UTC](https://qa.fmod.com/t/delete-user-property-from-script/22732 "2025-03-26T10:37:49Z")

</div>

I am working on a script that adds a User Property to all events that contains a specific Effect Chain on their master track, and have a script that works for this. However, I cannot figure out how to make the script rem…

---

## [Cache Issues with Duplicate Event Detection After Copy/Paste](https://qa.fmod.com/t/cache-issues-with-duplicate-event-detection-after-copy-paste/22653)

<div class="topic-metadata">

**Author:** [@lucafusi](https://qa.fmod.com/u/lucafusi)\
**Replies:** 7\
**Last updated:** [March 17, 2025, 2:38am UTC](https://qa.fmod.com/t/cache-issues-with-duplicate-event-detection-after-copy-paste/22653 "2025-03-17T02:38:49Z")

</div>

We validate event names to check for dupe paths before path-stripping our events and creating a header file for our game to use. The script correctly identifies actual duplicates, but sometimes in a session after event c…

---

## [Official/Unofficial Comprehensive FMOD Studio Scripting API Reference?](https://qa.fmod.com/t/official-unofficial-comprehensive-fmod-studio-scripting-api-reference/22672)

<div class="topic-metadata">

**Author:** [@Bradgentle](https://qa.fmod.com/u/Bradgentle)\
**Replies:** 1\
**Last updated:** [March 13, 2025, 2:58am UTC](https://qa.fmod.com/t/official-unofficial-comprehensive-fmod-studio-scripting-api-reference/22672 "2025-03-13T02:58:34Z")

</div>

Hey there, I’m working on some custom FMOD Studio scripts to streamline my workflow, but I’m finding it hard to locate a comprehensive reference for all the available functions, especially around file handling and proje…

---

## [Scripting API - Event/Browser selection changed callback?](https://qa.fmod.com/t/scripting-api-event-browser-selection-changed-callback/22636)

<div class="topic-metadata">

**Author:** [@lucafusi](https://qa.fmod.com/u/lucafusi)\
**Replies:** 2\
**Last updated:** [February 27, 2025, 5:35pm UTC](https://qa.fmod.com/t/scripting-api-event-browser-selection-changed-callback/22636 "2025-02-27T17:35:40Z")

</div>

Hi there, writing a small utility to mirror selection between the event browser and event editor, to make working through batches of “Find Reference” type modifications easier. I imagine it’d be something like the built…

---

## [Hello. I would like to ask how to change the MetaData file name in Studio](https://qa.fmod.com/t/hello-i-would-like-to-ask-how-to-change-the-metadata-file-name-in-studio/22431)

<div class="topic-metadata">

**Author:** [@berserk77](https://qa.fmod.com/u/berserk77)\
**Replies:** 4\
**Last updated:** [December 31, 2024, 12:52am UTC](https://qa.fmod.com/t/hello-i-would-like-to-ask-how-to-change-the-metadata-file-name-in-studio/22431 "2024-12-31T00:52:32Z")

</div>

I want to save the MetaData file name in Studio as custom. Is there a function supported in the script? The file name is saved as a guid, making it difficult to recognize.

---

## [Scripting: Creating a Parameter event with an instrument per slot](https://qa.fmod.com/t/scripting-creating-a-parameter-event-with-an-instrument-per-slot/22112)

<div class="topic-metadata">

**Author:** [@Geoff1](https://qa.fmod.com/u/Geoff1)\
**Replies:** 1\
**Last updated:** [September 25, 2024, 4:24am UTC](https://qa.fmod.com/t/scripting-creating-a-parameter-event-with-an-instrument-per-slot/22112 "2024-09-25T04:24:06Z")

</div>

Hi, I’d like to speed up event creation with a script that will make a parameter sheet event, and load samples into single instruments inside each slot of a single parameter, so it will look something like this (I create…

---

## [Studio API - Get NamedMarkers in the order thay are in the logic track](https://qa.fmod.com/t/studio-api-get-namedmarkers-in-the-order-thay-are-in-the-logic-track/21978)

<div class="topic-metadata">

**Author:** [@RGLD\_O](https://qa.fmod.com/u/RGLD_O)\
**Replies:** 3\
**Last updated:** [August 13, 2024, 6:49am UTC](https://qa.fmod.com/t/studio-api-get-namedmarkers-in-the-order-thay-are-in-the-logic-track/21978 "2024-08-13T06:49:24Z")

</div>

Hello! I have the following code to extract the name of NamedMarkers in a specific logic track: Blockquote allEvents.forEach(function (event) { var markerTrack = event.markerTracks\[2\]; var destinationMarkerNames = ;…

---

## [Scripting: Is there a way to call the "New Loop Region" method from the scripting API?](https://qa.fmod.com/t/scripting-is-there-a-way-to-call-the-new-loop-region-method-from-the-scripting-api/21891)

<div class="topic-metadata">

**Author:** [@jon-nbg](https://qa.fmod.com/u/jon-nbg)\
**Replies:** 4\
**Last updated:** [July 22, 2024, 8:43am UTC](https://qa.fmod.com/t/scripting-is-there-a-way-to-call-the-new-loop-region-method-from-the-scripting-api/21891 "2024-07-22T08:43:37Z")

</div>

I am on Studio v2.02.20 and i have been trying to find out if there is an easy way to add a new loop region for the selected instrument. I can add a new loop region through code just fine, but it would be quite handy if …

---

## [studio.system.getFile API sometimes cannot load from relative path](https://qa.fmod.com/t/studio-system-getfile-api-sometimes-cannot-load-from-relative-path/21865)

<div class="topic-metadata">

**Author:** [@victor647](https://qa.fmod.com/u/victor647)\
**Replies:** 1\
**Last updated:** [July 16, 2024, 6:44am UTC](https://qa.fmod.com/t/studio-system-getfile-api-sometimes-cannot-load-from-relative-path/21865 "2024-07-16T06:44:44Z")

</div>

I have a script that loads a json file from a custom defined folder within my FMOD project directory. I am writing my script as var data = studio.system.getFile("New Folder/MyText.txt") Sometimes the script runs withou…

---

## [Script to extract loop length](https://qa.fmod.com/t/script-to-extract-loop-length/21747)

<div class="topic-metadata">

**Author:** [@RGLD\_O](https://qa.fmod.com/u/RGLD_O)\
**Replies:** 1\
**Last updated:** [June 12, 2024, 2:02am UTC](https://qa.fmod.com/t/script-to-extract-loop-length/21747 "2024-06-12T02:02:03Z")

</div>

I wonder if there is a way to obtain the length of a loop region and then store it as a rounded-up int value in the user properties. I have a javascript script that helps me handle accessing and creating user properties …

---

## [Script to place assets](https://qa.fmod.com/t/script-to-place-assets/21689)

<div class="topic-metadata">

**Author:** [@dada\_da](https://qa.fmod.com/u/dada_da)\
**Replies:** 3\
**Last updated:** [June 10, 2024, 2:55pm UTC](https://qa.fmod.com/t/script-to-place-assets/21689 "2024-06-10T14:55:59Z")

</div>

Hi, For a project I am trying to place around 100 assets (already imported to project) on a discrete parameter sheet and match the filename with the value of the parameter. Very similar to the Unity Piano FMOD example. …

---

## [Typescript Definition for Studio Scripting API](https://qa.fmod.com/t/typescript-definition-for-studio-scripting-api/21655)

<div class="topic-metadata">

**Author:** [@michaelhartung](https://qa.fmod.com/u/michaelhartung)\
**Replies:** 2\
**Last updated:** [May 24, 2024, 7:56am UTC](https://qa.fmod.com/t/typescript-definition-for-studio-scripting-api/21655 "2024-05-24T07:56:43Z")

</div>

Hi, I just released a first version of Typescript Definitions for the FMOD Studio Scripting API and a small starter project to get things going. The hope was to make for a better developer experience while creating…
