bobthenameless / fmod-studio-docs

fmod-studio-docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This is a project to strip the FMOD Studio API out of the .chm file and into md files. Currently very messy. FMOD can be downloaded/purchased at http://www.fmod.org/ and the .chm file can be found in API_INSTALL_DIRECTORY/docs.

This API specifically from FMOD Studio API version 1.03.06

#FSBank API

#Studio API

#Low Level API

##FSBank API

###Callbacks

###Defines

###Enumerations

###Functions

###Structures

##Low Level API

###C++ interfaces

###Structures

###Callbacks

###Channel

####Functions

###ChannelControl

The base class for both Channels and Channel Groups.

####Functions

###ChannelGroup

####Functions

###Defines

###DSP

####Functions

###DSPConnection

####Functions

####Enumerations

###Functions

###Geometry

####Functions

###Reverb3D

####Functions

###Sound

####Functions

###SoundGroup

####Functions

###System

The main object for the FMOD Low Level System.

####Functions

Remarks ------

When using FMOD Studio, this system object will be automatically instantiated as part of Studio::System::initialize.

See Also -------

##Studio API

###C++ interfaces

###Functions

###Structures

###Defines

###Enumerations

###Callbacks

###Studio::Bank

A bank contains FMOD Studio Event data as well as the actual sound data for all events in that bank.

####Functions

See Also --------

###Studio::CueInstance

A trigger for an FMOD Studio Event.

####Functions Studio::CueInstance::trigger Remarks -------

Cues can be set into events to pause the timeline at a certain point until the game activates the cue. Currently there is only a single cue type supported, with a name "keyOff".

See Also --------

###Studio::EventDescription

The description for a FMOD Studio Event.

####Functions

Event Descriptions belong to banks and can be queried after the relevant bank has been loaded. Event Descriptions can be found either by looking up by GUID or by querying all descriptions as part of a bank.

See Also --------

###Studio::EventInstance

An instance of an FMOD Studio Event.

####Functions

###Studio::MixerStrip

Represents either a VCA or a bus.

####Functions

Firelight Technologies FMOD Studio API

###Studio::ParameterInstance

A parameter instance for an FMOD Studio Event.

####Functions

###Studio::System

The main system object for FMOD Studio.

####Functions

Initializing the FMOD Studio System object will also initialise the low level System object.

See Also

About

fmod-studio-docs