Firelight Technologies FMOD Studio API

Studio::Bank::getVCAList

Retrieves the VCAs in the bank.

C++ Syntax

FMOD_RESULT Studio::Bank::getVCAList(
  Studio::VCA **array,
  int capacity,
  int *count
);

C Syntax

FMOD_RESULT FMOD_Studio_Bank_GetVCAList(
  FMOD_STUDIO_BANK *bank,
  FMOD_STUDIO_VCA **array,
  int capacity,
  int *count
);

C# Syntax

RESULT Studio.Bank.getVCAList(
  out VCA[] array
);

JavaScript Syntax

Bank.getVCAList(
  array,                           // writes value to array.val
  capacity,                        
  count                            // writes value to count.val
);

Parameters

array

An array of memory allocated by the user.

capacity

The capacity of the array passed in as the first parameter

count

Address of a variable to receive the number of VCAs written to the array

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Used in conjunction with Studio::Bank::getVCACount to enumerate the VCAs.

See Also

• Studio::Bank::getVCACount

Version 1.10.03 Built on Feb 1, 2018