Eye of the Nile Docs
Everything you need to know to get started!
•All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Pages
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Package Functions | Package Attributes | Static Package Attributes | Properties | Private Attributes | Static Private Attributes | List of all members
FMODUnity.Platform Class Referenceabstract

Classes

class  Property< T >
 
struct  PropertyAccessor< T >
 
class  PropertyAccessors
 
class  PropertyBool
 
class  PropertyCallbackHandler
 
class  PropertyCodecChannels
 
class  PropertyInt
 
interface  PropertyOverrideControl
 
class  PropertyScreenPosition
 
class  PropertySpeakerMode
 
class  PropertyStorage
 
class  PropertyString
 
class  PropertyStringList
 
class  PropertyThreadAffinityList
 

Public Member Functions

void SetOverlayFontSize (int size)
 

Public Attributes

Platform Parent
 

Protected Member Functions

virtual string GetPluginBasePath ()
 

Protected Attributes

PropertyStorage Properties = new PropertyStorage()
 

Package Functions

void DeclareRuntimePlatforms (Settings settings)
 
virtual void PreSystemCreate (Action< FMOD.RESULT, string > reportResult)
 
virtual void PreInitialize (FMOD.Studio.System studioSystem)
 
virtual string GetBankFolder ()
 
virtual string GetPluginPath (string pluginName)
 
virtual void LoadPlugins (FMOD.System coreSystem, Action< FMOD.RESULT, string > reportResult)
 
virtual void LoadDynamicPlugins (FMOD.System coreSystem, Action< FMOD.RESULT, string > reportResult)
 
virtual void LoadStaticPlugins (FMOD.System coreSystem, Action< FMOD.RESULT, string > reportResult)
 
void AffirmProperties ()
 
void ClearProperties ()
 
virtual void InitializeProperties ()
 
virtual void EnsurePropertiesAreValid ()
 
bool InheritsFrom (Platform platform)
 
FMOD.OUTPUTTYPE GetOutputType ()
 

Package Attributes

string OutputTypeName
 

Static Package Attributes

const float DefaultPriority = 0
 
const string RegisterStaticPluginsClassName = "StaticPluginManager"
 
const string RegisterStaticPluginsFunctionName = "Register"
 

Properties

string Identifier [get, set]
 
string DisplayName [get]
 
virtual float Priority [get]
 
virtual bool MatchesCurrentEnvironment [get]
 
virtual bool IsIntrinsic [get]
 
string ParentIdentifier [get, set]
 
bool IsLiveUpdateEnabled [get]
 
bool IsOverlayEnabled [get]
 
bool Active [get]
 
bool HasAnyOverriddenProperties [get]
 
TriStateBool LiveUpdate [get]
 
int LiveUpdatePort [get]
 
TriStateBool Overlay [get]
 
ScreenPosition OverlayRect [get]
 
int OverlayFontSize [get]
 
TriStateBool Logging [get]
 
int SampleRate [get]
 
string BuildDirectory [get]
 
FMOD.SPEAKERMODE SpeakerMode [get]
 
int VirtualChannelCount [get]
 
int RealChannelCount [get]
 
int DSPBufferLength [get]
 
int DSPBufferCount [get]
 
List< string > Plugins [get]
 
List< string > StaticPlugins [get]
 
PlatformCallbackHandler CallbackHandler [get]
 
virtual List< ThreadAffinityGroup > DefaultThreadAffinities [get]
 
IEnumerable< ThreadAffinityGroup > ThreadAffinities [get]
 
PropertyThreadAffinityList ThreadAffinitiesProperty [get]
 
virtual List< CodecChannelCount > DefaultCodecChannels [get]
 
List< CodecChannelCount > CodecChannels [get]
 
PropertyCodecChannels CodecChannelsProperty [get]
 

Private Attributes

string identifier
 
string parentIdentifier
 
bool active = false
 
PropertyThreadAffinityList threadAffinities = new PropertyThreadAffinityList()
 
PropertyCodecChannels codecChannels = new PropertyCodecChannels()
 

Static Private Attributes

static List< ThreadAffinityGroup > StaticThreadAffinities = new List<ThreadAffinityGroup>()
 
static List< CodecChannelCount > staticCodecChannels
 

Member Function Documentation

◆ AffirmProperties()

void FMODUnity.Platform.AffirmProperties ( )
package

◆ ClearProperties()

void FMODUnity.Platform.ClearProperties ( )
package

◆ DeclareRuntimePlatforms()

void FMODUnity.Platform.DeclareRuntimePlatforms ( Settings settings)
abstractpackage

◆ EnsurePropertiesAreValid()

virtual void FMODUnity.Platform.EnsurePropertiesAreValid ( )
packagevirtual

Reimplemented in FMODUnity.PlatformDefault.

◆ GetBankFolder()

virtual string FMODUnity.Platform.GetBankFolder ( )
packagevirtual

Reimplemented in FMODUnity.PlatformAndroid, and FMODUnity.PlatformPlayInEditor.

◆ GetOutputType()

FMOD.OUTPUTTYPE FMODUnity.Platform.GetOutputType ( )
package

◆ GetPluginBasePath()

virtual string FMODUnity.Platform.GetPluginBasePath ( )
protectedvirtual

◆ GetPluginPath()

virtual string FMODUnity.Platform.GetPluginPath ( string pluginName)
packagevirtual

Reimplemented in FMODUnity.PlatformAndroid, FMODUnity.PlatformLinux, FMODUnity.PlatformMac, FMODUnity.PlatformWebGL, and FMODUnity.PlatformWindows.

◆ InheritsFrom()

bool FMODUnity.Platform.InheritsFrom ( Platform platform)
package

◆ InitializeProperties()

virtual void FMODUnity.Platform.InitializeProperties ( )
packagevirtual

Reimplemented in FMODUnity.PlatformDefault, and FMODUnity.PlatformPlayInEditor.

◆ LoadDynamicPlugins()

virtual void FMODUnity.Platform.LoadDynamicPlugins ( FMOD.System coreSystem,
Action< FMOD.RESULT, string > reportResult )
packagevirtual

◆ LoadPlugins()

virtual void FMODUnity.Platform.LoadPlugins ( FMOD.System coreSystem,
Action< FMOD.RESULT, string > reportResult )
packagevirtual

Reimplemented in FMODUnity.PlatformAppleTV, FMODUnity.PlatformIOS, and FMODUnity.PlatformVisionOS.

◆ LoadStaticPlugins()

virtual void FMODUnity.Platform.LoadStaticPlugins ( FMOD.System coreSystem,
Action< FMOD.RESULT, string > reportResult )
packagevirtual

Reimplemented in FMODUnity.PlatformPlayInEditor.

◆ PreInitialize()

virtual void FMODUnity.Platform.PreInitialize ( FMOD.Studio.System studioSystem)
packagevirtual

◆ PreSystemCreate()

virtual void FMODUnity.Platform.PreSystemCreate ( Action< FMOD.RESULT, string > reportResult)
packagevirtual

◆ SetOverlayFontSize()

void FMODUnity.Platform.SetOverlayFontSize ( int size)

Member Data Documentation

◆ active

bool FMODUnity.Platform.active = false
private

◆ codecChannels

PropertyCodecChannels FMODUnity.Platform.codecChannels = new PropertyCodecChannels()
private

◆ DefaultPriority

const float FMODUnity.Platform.DefaultPriority = 0
staticpackage

◆ identifier

string FMODUnity.Platform.identifier
private

◆ OutputTypeName

string FMODUnity.Platform.OutputTypeName
package

◆ Parent

Platform FMODUnity.Platform.Parent

◆ parentIdentifier

string FMODUnity.Platform.parentIdentifier
private

◆ Properties

PropertyStorage FMODUnity.Platform.Properties = new PropertyStorage()
protected

◆ RegisterStaticPluginsClassName

const string FMODUnity.Platform.RegisterStaticPluginsClassName = "StaticPluginManager"
staticpackage

◆ RegisterStaticPluginsFunctionName

const string FMODUnity.Platform.RegisterStaticPluginsFunctionName = "Register"
staticpackage

◆ staticCodecChannels

List<CodecChannelCount> FMODUnity.Platform.staticCodecChannels
staticprivate
Initial value:
= new List<CodecChannelCount>()
{
new CodecChannelCount { format = CodecType.FADPCM, channels = 32 },
new CodecChannelCount { format = CodecType.Vorbis, channels = 0 },
}
FMODUnity.CodecChannelCount
Definition RuntimeUtils.cs:293
FMODUnity.CodecType
CodecType
Definition RuntimeUtils.cs:260

◆ StaticThreadAffinities

List<ThreadAffinityGroup> FMODUnity.Platform.StaticThreadAffinities = new List<ThreadAffinityGroup>()
staticprivate

◆ threadAffinities

PropertyThreadAffinityList FMODUnity.Platform.threadAffinities = new PropertyThreadAffinityList()
private

Property Documentation

◆ Active

bool FMODUnity.Platform.Active
getpackage

◆ BuildDirectory

string FMODUnity.Platform.BuildDirectory
get

◆ CallbackHandler

PlatformCallbackHandler FMODUnity.Platform.CallbackHandler
get

◆ CodecChannels

List<CodecChannelCount> FMODUnity.Platform.CodecChannels
getpackage

◆ CodecChannelsProperty

PropertyCodecChannels FMODUnity.Platform.CodecChannelsProperty
getpackage

◆ DefaultCodecChannels

virtual List<CodecChannelCount> FMODUnity.Platform.DefaultCodecChannels
getpackage

◆ DefaultThreadAffinities

virtual List<ThreadAffinityGroup> FMODUnity.Platform.DefaultThreadAffinities
getpackage

◆ DisplayName

string FMODUnity.Platform.DisplayName
getabstractpackage

◆ DSPBufferCount

int FMODUnity.Platform.DSPBufferCount
get

◆ DSPBufferLength

int FMODUnity.Platform.DSPBufferLength
get

◆ HasAnyOverriddenProperties

bool FMODUnity.Platform.HasAnyOverriddenProperties
getpackage

◆ Identifier

string FMODUnity.Platform.Identifier
getsetpackage

◆ IsIntrinsic

virtual bool FMODUnity.Platform.IsIntrinsic
getpackage

◆ IsLiveUpdateEnabled

bool FMODUnity.Platform.IsLiveUpdateEnabled
getpackage

◆ IsOverlayEnabled

bool FMODUnity.Platform.IsOverlayEnabled
getpackage

◆ LiveUpdate

TriStateBool FMODUnity.Platform.LiveUpdate
get

◆ LiveUpdatePort

int FMODUnity.Platform.LiveUpdatePort
get

◆ Logging

TriStateBool FMODUnity.Platform.Logging
get

◆ MatchesCurrentEnvironment

virtual bool FMODUnity.Platform.MatchesCurrentEnvironment
getpackage

◆ Overlay

TriStateBool FMODUnity.Platform.Overlay
get

◆ OverlayFontSize

int FMODUnity.Platform.OverlayFontSize
get

◆ OverlayRect

ScreenPosition FMODUnity.Platform.OverlayRect
get

◆ ParentIdentifier

string FMODUnity.Platform.ParentIdentifier
getsetpackage

◆ Plugins

List<string> FMODUnity.Platform.Plugins
get

◆ Priority

virtual float FMODUnity.Platform.Priority
getpackage

◆ RealChannelCount

int FMODUnity.Platform.RealChannelCount
get

◆ SampleRate

int FMODUnity.Platform.SampleRate
get

◆ SpeakerMode

FMOD.SPEAKERMODE FMODUnity.Platform.SpeakerMode
get

◆ StaticPlugins

List<string> FMODUnity.Platform.StaticPlugins
get

◆ ThreadAffinities

IEnumerable<ThreadAffinityGroup> FMODUnity.Platform.ThreadAffinities
get

◆ ThreadAffinitiesProperty

PropertyThreadAffinityList FMODUnity.Platform.ThreadAffinitiesProperty
getpackage

◆ VirtualChannelCount

int FMODUnity.Platform.VirtualChannelCount
get
The documentation for this class was generated from the following file: