studio_vca

VCA

FMOD Object: Studio::VCA

This module holds functionality related to global mixer VCAs.

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.

• fmod_studio_vca_set_volume
• fmod_studio_vca_get_volume
• fmod_studio_vca_get_id
• fmod_studio_vca_get_path
• fmod_studio_vca_is_valid

---

Back To Top

fmod_studio_vca_set_volume

FMOD Function: Studio::VCA::setVolume

This function sets the volume level.

The VCA volume level is used to linearly modulate the levels of the buses and VCAs which it controls.

Syntax:

fmod_studio_vca_set_volume(vca_ref, volume)

Argument	Type	Description
vca_ref	Real	A reference to a vca.
volume	Real	Volume level. Negative level inverts the signal. Range: [-inf, inf], Default: 1

Returns:

N/A

---

Back To Top

fmod_studio_vca_get_volume

FMOD Function: Studio::VCA::getVolume

This function retrieves the volume level set by fmod_studio_vca_set_volume.

Syntax:

fmod_studio_vca_get_volume(vca_ref)

Argument	Type	Description
vca_ref	Real	A reference to a vca.

Returns:

Real

---

Back To Top

fmod_studio_vca_get_id

FMOD Function: Studio::VCA::getID

This function retrieves the GUID of the given VCA.

Syntax:

fmod_studio_vca_get_id(vca_ref)

Argument	Type	Description
vca_ref	Real	A reference to a vca.

Returns:

String

---

Back To Top

fmod_studio_vca_get_path

FMOD Function: Studio::VCA::getPath

This function retrieves the path.

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

Syntax:

fmod_studio_vca_get_path(vca_ref)

Argument	Type	Description
vca_ref	Real	A reference to a vca.

Returns:

String

---

Back To Top

fmod_studio_vca_is_valid

FMOD Function: Studio::VCA::isValid

This function checks that the VCA reference is valid.

Syntax:

fmod_studio_vca_is_valid(vca_ref)

Argument	Type	Description
vca_ref	Real	A reference to a vca.

Returns:

Real