FMODUnity.Settings Class Reference

Classes
struct	PlatformTemplate

Public Member Functions
void	SetPlatformParent (Platform platform, Platform newParent)

Public Attributes
bool	HasSourceProject = true
bool	HasPlatforms = true
int	BankRefreshCooldown = 5
bool	ShowBankRefreshWindow = true
bool	AutomaticEventLoading
BankLoadType	BankLoadType
bool	AutomaticSampleLoading
string	EncryptionKey
ImportType	ImportType
string	TargetAssetPath = "FMODBanks"
string	TargetBankFolder = ""
EventLinkage	EventLinkage = EventLinkage.Path
FMOD.DEBUG_FLAGS	LoggingLevel = FMOD.DEBUG_FLAGS.WARNING
List< string >	MasterBanks
List< string >	Banks
List< string >	BanksToLoad
ushort	LiveUpdatePort = 9264
bool	EnableMemoryTracking
bool	AndroidUseOBB = false
bool	AndroidPatchBuild = false
MeterChannelOrderingType	MeterChannelOrdering
bool	StopEventsOutsideMaxDistance = false
bool	EnableErrorCallback = false
bool	HideSetupWizard
List< Platform >	Platforms = new List<Platform>()
Platform	DefaultPlatform
Platform	PlayInEditorPlatform

Package Types
enum	SharedLibraryUpdateStages { Start = 0 , DisableExistingLibraries , RestartUnity , CopyNewLibraries }

Package Functions
Platform	FindPlatform (string identifier)
bool	PlatformExists (string identifier)
void	AddPlatform (Platform platform)
void	RemovePlatform (string identifier)
void	LinkPlatform (Platform platform)
void	DeclareRuntimePlatform (RuntimePlatform runtimePlatform, Platform platform)
Platform	FindCurrentPlatform ()
void	AddPlatformProperties (Platform platform)
void	OnEnable ()

Static Package Functions
static void	Initialize ()
static bool	IsInitialized ()
static void	AddPlatformTemplate< T > (string identifier)

Package Attributes
List< Legacy.PlatformIntSetting >	SpeakerModeSettings
List< Legacy.PlatformIntSetting >	SampleRateSettings
List< Legacy.PlatformBoolSetting >	LiveUpdateSettings
List< Legacy.PlatformBoolSetting >	OverlaySettings
List< Legacy.PlatformStringSetting >	BankDirectorySettings
List< Legacy.PlatformIntSetting >	VirtualChannelSettings
List< Legacy.PlatformIntSetting >	RealChannelSettings
List< string >	Plugins = new List<string>()
bool	BoltUnitOptionsBuildPending = false
SharedLibraryUpdateStages	SharedLibraryUpdateStage = SharedLibraryUpdateStages.Start
double	SharedLibraryTimeSinceStart = 0.0
int	CurrentVersion
int	LastEventReferenceScanVersion
Dictionary< RuntimePlatform, List< Platform > >	PlatformForRuntimePlatform = new Dictionary<RuntimePlatform, List<Platform>>()

Static Package Attributes
const string	SettingsAssetName = "FMODStudioSettings"
const int	BankRefreshPrompt = -1
const int	BankRefreshManual = -2
static List< PlatformTemplate >	PlatformTemplates = new List<PlatformTemplate>()

Properties
static Settings	Instance [get]
static IEditorSettings	EditorSettings [get, set]
string	SourceProjectPath [get, set]
string	SourceBankPath [get, set]
string	TargetPath [get]
string	TargetSubFolder [get, set]

Private Member Functions
void	LinkPlatformToParent (Platform platform)
	Settings ()
void	PopulatePlatformsFromAsset ()

Static Private Member Functions
static Platform	CreatePlatformInstance< T > (string identifier)

Private Attributes
string	sourceProjectPath
string	sourceBankPath
string	sourceBankPathUnformatted
bool	hasLoaded = false

Static Private Attributes
static Settings	instance = null
static IEditorSettings	editorSettings = null
static bool	isInitializing = false

Member Enumeration Documentation

SharedLibraryUpdateStages

enum FMODUnity.Settings.SharedLibraryUpdateStages

package

Enumerator
Start
DisableExistingLibraries
RestartUnity
CopyNewLibraries

Constructor & Destructor Documentation

Settings()

FMODUnity.Settings.Settings ( )

private

Member Function Documentation

AddPlatform()

void FMODUnity.Settings.AddPlatform ( Platform platform )

package

AddPlatformProperties()

void FMODUnity.Settings.AddPlatformProperties ( Platform platform )

package

AddPlatformTemplate< T >()

static void FMODUnity.Settings.AddPlatformTemplate< T > ( string identifier )

staticpackage

Type Constraints

T

:

Platform

CreatePlatformInstance< T >()

static Platform FMODUnity.Settings.CreatePlatformInstance< T > ( string identifier )

staticprivate

Type Constraints

T

:

Platform

DeclareRuntimePlatform()

void FMODUnity.Settings.DeclareRuntimePlatform ( RuntimePlatform runtimePlatform, Platform platform )

package

FindCurrentPlatform()

Platform FMODUnity.Settings.FindCurrentPlatform ( )

package

FindPlatform()

Platform FMODUnity.Settings.FindPlatform ( string identifier )

package

Initialize()

static void FMODUnity.Settings.Initialize ( )

staticpackage

IsInitialized()

static bool FMODUnity.Settings.IsInitialized ( )

staticpackage

LinkPlatform()

void FMODUnity.Settings.LinkPlatform ( Platform platform )

package

LinkPlatformToParent()

void FMODUnity.Settings.LinkPlatformToParent ( Platform platform )

private

OnEnable()

void FMODUnity.Settings.OnEnable ( )

package

PlatformExists()

bool FMODUnity.Settings.PlatformExists ( string identifier )

package

PopulatePlatformsFromAsset()

void FMODUnity.Settings.PopulatePlatformsFromAsset ( )

private

RemovePlatform()

void FMODUnity.Settings.RemovePlatform ( string identifier )

package

SetPlatformParent()

void FMODUnity.Settings.SetPlatformParent	(	Platform	platform,
		Platform	newParent )

Member Data Documentation

AndroidPatchBuild

bool FMODUnity.Settings.AndroidPatchBuild = false

AndroidUseOBB

bool FMODUnity.Settings.AndroidUseOBB = false

AutomaticEventLoading

bool FMODUnity.Settings.AutomaticEventLoading

AutomaticSampleLoading

bool FMODUnity.Settings.AutomaticSampleLoading

BankDirectorySettings

List<Legacy.PlatformStringSetting> FMODUnity.Settings.BankDirectorySettings

package

BankLoadType

BankLoadType FMODUnity.Settings.BankLoadType

BankRefreshCooldown

int FMODUnity.Settings.BankRefreshCooldown = 5

BankRefreshManual

const int FMODUnity.Settings.BankRefreshManual = -2

staticpackage

BankRefreshPrompt

const int FMODUnity.Settings.BankRefreshPrompt = -1

staticpackage

Banks

List<string> FMODUnity.Settings.Banks

BanksToLoad

List<string> FMODUnity.Settings.BanksToLoad

BoltUnitOptionsBuildPending

bool FMODUnity.Settings.BoltUnitOptionsBuildPending = false

package

CurrentVersion

int FMODUnity.Settings.CurrentVersion

package

DefaultPlatform

Platform FMODUnity.Settings.DefaultPlatform

editorSettings

IEditorSettings FMODUnity.Settings.editorSettings = null

staticprivate

EnableErrorCallback

bool FMODUnity.Settings.EnableErrorCallback = false

EnableMemoryTracking

bool FMODUnity.Settings.EnableMemoryTracking

EncryptionKey

string FMODUnity.Settings.EncryptionKey

EventLinkage

EventLinkage FMODUnity.Settings.EventLinkage = EventLinkage.Path

hasLoaded

bool FMODUnity.Settings.hasLoaded = false

private

HasPlatforms

bool FMODUnity.Settings.HasPlatforms = true

HasSourceProject

bool FMODUnity.Settings.HasSourceProject = true

HideSetupWizard

bool FMODUnity.Settings.HideSetupWizard

ImportType

ImportType FMODUnity.Settings.ImportType

instance

Settings FMODUnity.Settings.instance = null

staticprivate

isInitializing

bool FMODUnity.Settings.isInitializing = false

staticprivate

LastEventReferenceScanVersion

int FMODUnity.Settings.LastEventReferenceScanVersion

package

LiveUpdatePort

ushort FMODUnity.Settings.LiveUpdatePort = 9264

LiveUpdateSettings

List<Legacy.PlatformBoolSetting> FMODUnity.Settings.LiveUpdateSettings

package

LoggingLevel

FMOD.DEBUG_FLAGS FMODUnity.Settings.LoggingLevel = FMOD.DEBUG_FLAGS.WARNING

MasterBanks

List<string> FMODUnity.Settings.MasterBanks

MeterChannelOrdering

MeterChannelOrderingType FMODUnity.Settings.MeterChannelOrdering

OverlaySettings

List<Legacy.PlatformBoolSetting> FMODUnity.Settings.OverlaySettings

package

PlatformForRuntimePlatform

Dictionary<RuntimePlatform, List<Platform> > FMODUnity.Settings.PlatformForRuntimePlatform = new Dictionary<RuntimePlatform, List<Platform>>()

package

Platforms

List<Platform> FMODUnity.Settings.Platforms = new List<Platform>()

PlatformTemplates

List<PlatformTemplate> FMODUnity.Settings.PlatformTemplates = new List<PlatformTemplate>()

staticpackage

PlayInEditorPlatform

Platform FMODUnity.Settings.PlayInEditorPlatform

Plugins

List<string> FMODUnity.Settings.Plugins = new List<string>()

package

RealChannelSettings

List<Legacy.PlatformIntSetting> FMODUnity.Settings.RealChannelSettings

package

SampleRateSettings

List<Legacy.PlatformIntSetting> FMODUnity.Settings.SampleRateSettings

package

SettingsAssetName

const string FMODUnity.Settings.SettingsAssetName = "FMODStudioSettings"

staticpackage

SharedLibraryTimeSinceStart

double FMODUnity.Settings.SharedLibraryTimeSinceStart = 0.0

package

SharedLibraryUpdateStage

SharedLibraryUpdateStages FMODUnity.Settings.SharedLibraryUpdateStage = SharedLibraryUpdateStages.Start

package

ShowBankRefreshWindow

bool FMODUnity.Settings.ShowBankRefreshWindow = true

sourceBankPath

string FMODUnity.Settings.sourceBankPath

private

sourceBankPathUnformatted

string FMODUnity.Settings.sourceBankPathUnformatted

private

sourceProjectPath

string FMODUnity.Settings.sourceProjectPath

private

SpeakerModeSettings

List<Legacy.PlatformIntSetting> FMODUnity.Settings.SpeakerModeSettings

package

StopEventsOutsideMaxDistance

bool FMODUnity.Settings.StopEventsOutsideMaxDistance = false

TargetAssetPath

string FMODUnity.Settings.TargetAssetPath = "FMODBanks"

TargetBankFolder

string FMODUnity.Settings.TargetBankFolder = ""

VirtualChannelSettings

List<Legacy.PlatformIntSetting> FMODUnity.Settings.VirtualChannelSettings

package

Property Documentation

EditorSettings

IEditorSettings FMODUnity.Settings.EditorSettings

staticgetsetpackage

Instance

Settings FMODUnity.Settings.Instance

staticget

SourceBankPath

string FMODUnity.Settings.SourceBankPath

getset

SourceProjectPath

string FMODUnity.Settings.SourceProjectPath

getset

TargetPath

string FMODUnity.Settings.TargetPath

getpackage

TargetSubFolder

string FMODUnity.Settings.TargetSubFolder

getset

---

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

• Assets/Plugins/FMOD/src/Settings.cs