This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Plugins::FMOD::Bank Class

Header: #include <plugins/Unigine/FMOD/UnigineFMOD.h>
Notice
This set of functions is available when the FMOD plugin is loaded.

FMOD Studio banks contain the metadata and audio sample data required for runtime mixing and playback. Audio sample data may be packed into the same bank as the events which reference it, or it may be packed into separate banks.

Bank Class

Members


bool isUnloading ( ) const#

Returns a value indicating if the bank is unloading.

Return value

true if the bank is unloading, otherwise, false.

bool isUnloaded ( ) const#

Returns a value indicating if the bank is unloaded.

Return value

true if the bank is unloaded, otherwise, false.

bool isLoading ( ) const#

Returns a value indicating if the bank is loading.

Return value

true if the bank is loading, otherwise, false.

bool isLoaded ( ) const#

Returns a value indicating if the bank is loaded.

Return value

true if the bank is loaded, otherwise, false.

bool isError ( ) const#

Returns a value indicating if an error has occurred.

Return value

true if an error has occurred, otherwise, false.

EventDescription * getEventDescription ( int index ) #

Returns the event description for the given index. Auxiliary function, should not be used.

Arguments

  • int index - Index of the event.

Return value

Event description for the given index.

Bus * getBus ( int index ) #

Returns a bus by its index. Auxiliary function, should not be used.

Arguments

  • int index - Index of the bus.

Return value

Bus object.

VCA * getVCA ( int index ) #

Returns a VCA by its index. Auxiliary function, should not be used.

Arguments

  • int index - Index of the VCA.

Return value

VCA object.

int getEventDescriptionCount ( ) #

Returns the number of event descriptions.

Return value

Number of event descriptions.

int getBusCount ( ) #

Returns the number of buses.

Return value

Number of buses.

int getVCACount ( ) #

Returns the number of VCAs.

Return value

Number of VCAs.

void loadSampleData ( ) #

Loads non-streaming sample data for all events in the bank.

void unloadSampleData ( ) #

Unloads non-streaming sample data for all events in the bank.

void release ( ) #

Cleans up used resources.

String getPath ( ) const#

Returns the object's path.

Return value

Object's path.

bool isValid ( ) const#

Returns a value indicating if the bank reference is valid.

Return value

true if the bank reference is valid, otherwise, false.
Last update: 2023-03-15
Build: ()