Eye of the Nile Docs
Everything you need to know to get started!
All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Pages
FMODUnity.RuntimeManager Class Reference

Classes

class  AttachedInstance
 
class  GuidComparer
 
struct  LoadedBank
 

Static Public Member Functions

static void AttachInstanceToGameObject (FMOD.Studio.EventInstance instance, GameObject gameObject, bool nonRigidbodyVelocity=false)
 
static void AttachInstanceToGameObject (FMOD.Studio.EventInstance instance, Transform transform, bool nonRigidbodyVelocity=false)
 
static void DetachInstanceFromGameObject (FMOD.Studio.EventInstance instance)
 
static void LoadBank (string bankName, bool loadSamples=false)
 
static void LoadBank (TextAsset asset, bool loadSamples=false)
 
static void UnloadBank (string bankName)
 
static void UnloadBank (TextAsset asset)
 
static bool AnyBankLoading ()
 
static bool AnySampleDataLoading ()
 
static void WaitForAllLoads ()
 
static void WaitForAllSampleLoading ()
 
static FMOD.GUID PathToGUID (string path)
 
static EventReference PathToEventReference (string path)
 
static FMOD.Studio.EventInstance CreateInstance (EventReference eventReference)
 
static FMOD.Studio.EventInstance CreateInstance (string path)
 
static FMOD.Studio.EventInstance CreateInstance (FMOD.GUID guid)
 
static void PlayOneShot (EventReference eventReference, Vector3 position=new Vector3())
 
static void PlayOneShot (string path, Vector3 position=new Vector3())
 
static void PlayOneShot (FMOD.GUID guid, Vector3 position=new Vector3())
 
static void PlayOneShotAttached (EventReference eventReference, GameObject gameObject)
 
static void PlayOneShotAttached (string path, GameObject gameObject)
 
static void PlayOneShotAttached (FMOD.GUID guid, GameObject gameObject)
 
static FMOD.Studio.EventDescription GetEventDescription (EventReference eventReference)
 
static FMOD.Studio.EventDescription GetEventDescription (string path)
 
static FMOD.Studio.EventDescription GetEventDescription (FMOD.GUID guid)
 
static void SetListenerLocation (GameObject gameObject, GameObject attenuationObject=null)
 
static void SetListenerLocation (int listenerIndex, GameObject gameObject, GameObject attenuationObject=null)
 
static FMOD.Studio.Bus GetBus (string path)
 
static FMOD.Studio.VCA GetVCA (string path)
 
static void PauseAllEvents (bool paused)
 
static void MuteAllEvents (bool muted)
 
static bool HasBankLoaded (string loadedBank)
 

Static Public Attributes

const string BankStubPrefix = "bank stub:"
 

Protected Attributes

bool isOverlayEnabled = false
 

Package Functions

void ExecuteOnGUI ()
 

Properties

static bool IsMuted [get]
 
static RuntimeManager Instance [get]
 
static FMOD.Studio.System StudioSystem [get]
 
static FMOD.System CoreSystem [get]
 
static bool IsInitialized [get]
 
static bool HaveAllBanksLoaded [get]
 
static bool HaveMasterBanksLoaded [get]
 

Private Member Functions

void CheckInitResult (FMOD.RESULT result, string cause)
 
void ReleaseStudioSystem ()
 
FMOD.RESULT Initialize ()
 
int GetChannelCountForFormat (CodecType format)
 
void Update ()
 
void Start ()
 
void UpdateDebugText ()
 
void DrawDebugOverlay (int windowID)
 
void OnDestroy ()
 
void OnApplicationPause (bool pauseStatus)
 
void RegisterLoadedBank (LoadedBank loadedBank, string bankPath, string bankName, bool loadSamples, FMOD.RESULT loadResult)
 
void ExecuteSampleLoadRequestsIfReady ()
 
void LoadBanks (Settings fmodSettings)
 
IEnumerable< string > BanksToLoad (Settings fmodSettings)
 
void SetOverlayPosition ()
 

Static Private Member Functions

static RuntimeManager ()
 
static FMOD.RESULT DEBUG_CALLBACK (FMOD.DEBUG_FLAGS flags, IntPtr filePtr, int line, IntPtr funcPtr, IntPtr messagePtr)
 
static FMOD.RESULT ERROR_CALLBACK (IntPtr system, FMOD.SYSTEM_CALLBACK_TYPE type, IntPtr commanddata1, IntPtr commanddata2, IntPtr userdata)
 
static void SetThreadAffinities (Platform platform)
 
static AttachedInstance FindOrAddAttachedInstance (FMOD.Studio.EventInstance instance, Transform transform, FMOD.ATTRIBUTES_3D attributes)
 
static void ReferenceLoadedBank (string bankName, bool loadSamples)
 
static void LoadBank (string bankName, bool loadSamples, string bankId)
 
static void LoadBank (TextAsset asset, bool loadSamples, string bankId)
 
static void ApplyMuteState ()
 

Private Attributes

Platform currentPlatform
 
FMOD.DEBUG_CALLBACK debugCallback
 
FMOD.SYSTEM_CALLBACK errorCallback
 
FMOD.Studio.System studioSystem
 
FMOD.System coreSystem
 
FMOD.DSP mixerHead
 
bool isMuted = false
 
Dictionary< FMOD.GUID, FMOD.Studio.EventDescriptioncachedDescriptions = new Dictionary<FMOD.GUID, FMOD.Studio.EventDescription>(new GuidComparer())
 
Dictionary< string, LoadedBankloadedBanks = new Dictionary<string, LoadedBank>()
 
List< string > sampleLoadRequests = new List<string>()
 
List< AttachedInstanceattachedInstances = new List<AttachedInstance>(128)
 
bool listenerWarningIssued = false
 
FMODRuntimeManagerOnGUIHelper overlayDrawer = null
 
Rect windowRect = new Rect(10, 10, 300, 100)
 
string lastDebugText
 
float lastDebugUpdate = 0
 
int loadingBanksRef = 0
 

Static Private Attributes

static SystemNotInitializedException initException = null
 
static RuntimeManager instance
 
static byte[] masterBusPrefix
 
static byte[] eventSet3DAttributes
 
static byte[] systemGetBus
 

Constructor & Destructor Documentation

◆ RuntimeManager()

static FMODUnity.RuntimeManager.RuntimeManager ( )
staticprivate

Member Function Documentation

◆ AnyBankLoading()

static bool FMODUnity.RuntimeManager.AnyBankLoading ( )
static

◆ AnySampleDataLoading()

static bool FMODUnity.RuntimeManager.AnySampleDataLoading ( )
static

◆ ApplyMuteState()

static void FMODUnity.RuntimeManager.ApplyMuteState ( )
staticprivate

◆ AttachInstanceToGameObject() [1/2]

static void FMODUnity.RuntimeManager.AttachInstanceToGameObject ( FMOD.Studio.EventInstance instance,
GameObject gameObject,
bool nonRigidbodyVelocity = false )
static

◆ AttachInstanceToGameObject() [2/2]

static void FMODUnity.RuntimeManager.AttachInstanceToGameObject ( FMOD.Studio.EventInstance instance,
Transform transform,
bool nonRigidbodyVelocity = false )
static

◆ BanksToLoad()

IEnumerable< string > FMODUnity.RuntimeManager.BanksToLoad ( Settings fmodSettings)
private

◆ CheckInitResult()

void FMODUnity.RuntimeManager.CheckInitResult ( FMOD.RESULT result,
string cause )
private

◆ CreateInstance() [1/3]

static FMOD.Studio.EventInstance FMODUnity.RuntimeManager.CreateInstance ( EventReference eventReference)
static

◆ CreateInstance() [2/3]

static FMOD.Studio.EventInstance FMODUnity.RuntimeManager.CreateInstance ( FMOD.GUID guid)
static

◆ CreateInstance() [3/3]

static FMOD.Studio.EventInstance FMODUnity.RuntimeManager.CreateInstance ( string path)
static

◆ DEBUG_CALLBACK()

static FMOD.RESULT FMODUnity.RuntimeManager.DEBUG_CALLBACK ( FMOD.DEBUG_FLAGS flags,
IntPtr filePtr,
int line,
IntPtr funcPtr,
IntPtr messagePtr )
staticprivate

◆ DetachInstanceFromGameObject()

static void FMODUnity.RuntimeManager.DetachInstanceFromGameObject ( FMOD.Studio.EventInstance instance)
static

◆ DrawDebugOverlay()

void FMODUnity.RuntimeManager.DrawDebugOverlay ( int windowID)
private

◆ ERROR_CALLBACK()

static FMOD.RESULT FMODUnity.RuntimeManager.ERROR_CALLBACK ( IntPtr system,
FMOD.SYSTEM_CALLBACK_TYPE type,
IntPtr commanddata1,
IntPtr commanddata2,
IntPtr userdata )
staticprivate

◆ ExecuteOnGUI()

void FMODUnity.RuntimeManager.ExecuteOnGUI ( )
package

◆ ExecuteSampleLoadRequestsIfReady()

void FMODUnity.RuntimeManager.ExecuteSampleLoadRequestsIfReady ( )
private

◆ FindOrAddAttachedInstance()

static AttachedInstance FMODUnity.RuntimeManager.FindOrAddAttachedInstance ( FMOD.Studio.EventInstance instance,
Transform transform,
FMOD.ATTRIBUTES_3D attributes )
staticprivate

◆ GetBus()

static FMOD.Studio.Bus FMODUnity.RuntimeManager.GetBus ( string path)
static

◆ GetChannelCountForFormat()

int FMODUnity.RuntimeManager.GetChannelCountForFormat ( CodecType format)
private

◆ GetEventDescription() [1/3]

static FMOD.Studio.EventDescription FMODUnity.RuntimeManager.GetEventDescription ( EventReference eventReference)
static

◆ GetEventDescription() [2/3]

static FMOD.Studio.EventDescription FMODUnity.RuntimeManager.GetEventDescription ( FMOD.GUID guid)
static

◆ GetEventDescription() [3/3]

static FMOD.Studio.EventDescription FMODUnity.RuntimeManager.GetEventDescription ( string path)
static

◆ GetVCA()

static FMOD.Studio.VCA FMODUnity.RuntimeManager.GetVCA ( string path)
static

◆ HasBankLoaded()

static bool FMODUnity.RuntimeManager.HasBankLoaded ( string loadedBank)
static

◆ Initialize()

FMOD.RESULT FMODUnity.RuntimeManager.Initialize ( )
private

◆ LoadBank() [1/4]

static void FMODUnity.RuntimeManager.LoadBank ( string bankName,
bool loadSamples,
string bankId )
staticprivate

◆ LoadBank() [2/4]

static void FMODUnity.RuntimeManager.LoadBank ( string bankName,
bool loadSamples = false )
static

◆ LoadBank() [3/4]

static void FMODUnity.RuntimeManager.LoadBank ( TextAsset asset,
bool loadSamples,
string bankId )
staticprivate

◆ LoadBank() [4/4]

static void FMODUnity.RuntimeManager.LoadBank ( TextAsset asset,
bool loadSamples = false )
static

◆ LoadBanks()

void FMODUnity.RuntimeManager.LoadBanks ( Settings fmodSettings)
private

◆ MuteAllEvents()

static void FMODUnity.RuntimeManager.MuteAllEvents ( bool muted)
static

◆ OnApplicationPause()

void FMODUnity.RuntimeManager.OnApplicationPause ( bool pauseStatus)
private

◆ OnDestroy()

void FMODUnity.RuntimeManager.OnDestroy ( )
private

◆ PathToEventReference()

static EventReference FMODUnity.RuntimeManager.PathToEventReference ( string path)
static

◆ PathToGUID()

static FMOD.GUID FMODUnity.RuntimeManager.PathToGUID ( string path)
static

◆ PauseAllEvents()

static void FMODUnity.RuntimeManager.PauseAllEvents ( bool paused)
static

◆ PlayOneShot() [1/3]

static void FMODUnity.RuntimeManager.PlayOneShot ( EventReference eventReference,
Vector3 position = new Vector3() )
static

◆ PlayOneShot() [2/3]

static void FMODUnity.RuntimeManager.PlayOneShot ( FMOD.GUID guid,
Vector3 position = new Vector3() )
static

◆ PlayOneShot() [3/3]

static void FMODUnity.RuntimeManager.PlayOneShot ( string path,
Vector3 position = new Vector3() )
static

◆ PlayOneShotAttached() [1/3]

static void FMODUnity.RuntimeManager.PlayOneShotAttached ( EventReference eventReference,
GameObject gameObject )
static

◆ PlayOneShotAttached() [2/3]

static void FMODUnity.RuntimeManager.PlayOneShotAttached ( FMOD.GUID guid,
GameObject gameObject )
static

◆ PlayOneShotAttached() [3/3]

static void FMODUnity.RuntimeManager.PlayOneShotAttached ( string path,
GameObject gameObject )
static

◆ ReferenceLoadedBank()

static void FMODUnity.RuntimeManager.ReferenceLoadedBank ( string bankName,
bool loadSamples )
staticprivate

◆ RegisterLoadedBank()

void FMODUnity.RuntimeManager.RegisterLoadedBank ( LoadedBank loadedBank,
string bankPath,
string bankName,
bool loadSamples,
FMOD.RESULT loadResult )
private

◆ ReleaseStudioSystem()

void FMODUnity.RuntimeManager.ReleaseStudioSystem ( )
private

◆ SetListenerLocation() [1/2]

static void FMODUnity.RuntimeManager.SetListenerLocation ( GameObject gameObject,
GameObject attenuationObject = null )
static

◆ SetListenerLocation() [2/2]

static void FMODUnity.RuntimeManager.SetListenerLocation ( int listenerIndex,
GameObject gameObject,
GameObject attenuationObject = null )
static

◆ SetOverlayPosition()

void FMODUnity.RuntimeManager.SetOverlayPosition ( )
private

◆ SetThreadAffinities()

static void FMODUnity.RuntimeManager.SetThreadAffinities ( Platform platform)
staticprivate

◆ Start()

void FMODUnity.RuntimeManager.Start ( )
private

◆ UnloadBank() [1/2]

static void FMODUnity.RuntimeManager.UnloadBank ( string bankName)
static

◆ UnloadBank() [2/2]

static void FMODUnity.RuntimeManager.UnloadBank ( TextAsset asset)
static

◆ Update()

void FMODUnity.RuntimeManager.Update ( )
private

◆ UpdateDebugText()

void FMODUnity.RuntimeManager.UpdateDebugText ( )
private

◆ WaitForAllLoads()

static void FMODUnity.RuntimeManager.WaitForAllLoads ( )
static

◆ WaitForAllSampleLoading()

static void FMODUnity.RuntimeManager.WaitForAllSampleLoading ( )
static

Member Data Documentation

◆ attachedInstances

List<AttachedInstance> FMODUnity.RuntimeManager.attachedInstances = new List<AttachedInstance>(128)
private

◆ BankStubPrefix

const string FMODUnity.RuntimeManager.BankStubPrefix = "bank stub:"
static

◆ cachedDescriptions

Dictionary<FMOD.GUID, FMOD.Studio.EventDescription> FMODUnity.RuntimeManager.cachedDescriptions = new Dictionary<FMOD.GUID, FMOD.Studio.EventDescription>(new GuidComparer())
private

◆ coreSystem

FMOD.System FMODUnity.RuntimeManager.coreSystem
private

◆ currentPlatform

Platform FMODUnity.RuntimeManager.currentPlatform
private

◆ debugCallback

FMOD.DEBUG_CALLBACK FMODUnity.RuntimeManager.debugCallback
private

◆ errorCallback

FMOD.SYSTEM_CALLBACK FMODUnity.RuntimeManager.errorCallback
private

◆ eventSet3DAttributes

byte [] FMODUnity.RuntimeManager.eventSet3DAttributes
staticprivate

◆ initException

SystemNotInitializedException FMODUnity.RuntimeManager.initException = null
staticprivate

◆ instance

RuntimeManager FMODUnity.RuntimeManager.instance
staticprivate

◆ isMuted

bool FMODUnity.RuntimeManager.isMuted = false
private

◆ isOverlayEnabled

bool FMODUnity.RuntimeManager.isOverlayEnabled = false
protected

◆ lastDebugText

string FMODUnity.RuntimeManager.lastDebugText
private

◆ lastDebugUpdate

float FMODUnity.RuntimeManager.lastDebugUpdate = 0
private

◆ listenerWarningIssued

bool FMODUnity.RuntimeManager.listenerWarningIssued = false
private

◆ loadedBanks

Dictionary<string, LoadedBank> FMODUnity.RuntimeManager.loadedBanks = new Dictionary<string, LoadedBank>()
private

◆ loadingBanksRef

int FMODUnity.RuntimeManager.loadingBanksRef = 0
private

◆ masterBusPrefix

byte [] FMODUnity.RuntimeManager.masterBusPrefix
staticprivate

◆ mixerHead

FMOD.DSP FMODUnity.RuntimeManager.mixerHead
private

◆ overlayDrawer

FMODRuntimeManagerOnGUIHelper FMODUnity.RuntimeManager.overlayDrawer = null
private

◆ sampleLoadRequests

List<string> FMODUnity.RuntimeManager.sampleLoadRequests = new List<string>()
private

◆ studioSystem

FMOD.Studio.System FMODUnity.RuntimeManager.studioSystem
private

◆ systemGetBus

byte [] FMODUnity.RuntimeManager.systemGetBus
staticprivate

◆ windowRect

Rect FMODUnity.RuntimeManager.windowRect = new Rect(10, 10, 300, 100)
private

Property Documentation

◆ CoreSystem

FMOD.System FMODUnity.RuntimeManager.CoreSystem
staticget

◆ HaveAllBanksLoaded

bool FMODUnity.RuntimeManager.HaveAllBanksLoaded
staticget

◆ HaveMasterBanksLoaded

bool FMODUnity.RuntimeManager.HaveMasterBanksLoaded
staticget

◆ Instance

RuntimeManager FMODUnity.RuntimeManager.Instance
staticgetprivate

◆ IsInitialized

bool FMODUnity.RuntimeManager.IsInitialized
staticget

◆ IsMuted

bool FMODUnity.RuntimeManager.IsMuted
staticget

◆ StudioSystem

FMOD.Studio.System FMODUnity.RuntimeManager.StudioSystem
staticget

The documentation for this class was generated from the following file: