Component

Description

Properties

Instance

static EventManager Instance [get]

Description:

Returns an instance of the audio event manager singleton, creating one if not already been created.

 

Functions

Play

void Fabric.Component.Play ( GameObject gameObject )

Parameters:

gameObject: Associate an instance with a gameObject

Description:

 

Stop

void Fabric.Component.Stop ( )

void Fabric.Component.Stop ( bool stopInstances )

void Fabric.Component.Stop ( bool stopInstances, bool forceStop )

void Fabric.Component.Stop ( bool stopInstances, bool forceStop, bool ignoreFade )

virtual void Fabric.Component.Stop ( bool stopInstances, bool forceStop, bool ignoreFade, float fadeTime )

Parameters:

stopInstances: Stop all component instances
forceStop: Force stop ignoring fade out
ignoreFade: Ignore fade out properties
fadeTime: Duration of fade out time

 

Description:

Stop function

SetPitch

void Fabric.Component.SetPitch ( float pitch )

Parameters:

pitch: Value of pitch to set (-3 to +3)

Description:

Set components pitch (including all its instances)

SetTime

virtual void Fabric.Component.SetTime ( float time ) [virtual]

Parameters:

time: Value of time to set.

Description:

Set time to all children audio components

SetVolume

void Fabric.Component.SetVolume ( float volume )

Parameters:

volume: Value of volume to set

Description:

Sets components volume (including all instances)

SetMusicTimeSettings

virtual void Fabric.Component.SetMusicTimeSettings ( MusicTimeSittings musicTimeSettings, MusicSyncType musicSyncType ) [virtual]

Parameters:

musicTimeSettings: music time settings to set
musicSyncType: Set MusicSyncType

Description:

Sets components volume (including all instances)

FadeIn

void Fabric.Component.FadeIn ( float targetMS, float curve )

Parameters:

targetMS: Time to fade in into the component volume
curve: Transition curve type ( log < 0.5 > Exp, 0.5 = linear )

Description:

Fade in component (including all instances)

FadeOut

void Fabric.Component.FadeOut ( float targetMS, float curve )

Parameters:

targetMS: Time to fade out component volume
curve: Transition curve type ( log < 0.5 > Exp, 0.5 = linear )

Description:

Fade outs component (including all instances)

GetChildComponents

Component [] Fabric.Component.GetChildComponents ( )

Returns:

array of child components

Description:

Returns a list copy of all children components.

GetLength

virtual float Fabric.Component.GetLength ( ) [virtual]

Returns:

Length of audio component in seconds. Not if more than one audio component in the hierarchy it will return the last audio component.

Description:

 

GetSampleRate

virtual int Fabric.Component.GetSampleRate ( ) [virtual]

Returns:

Sample rate of audio component . Not if more than one audio component in the hierarchy it will return the last audio component.

Description:

 

GetTime

virtual double Fabric.Component.GetTime () [virtual]

Returns:

Time of audio component. Not if more than one audio component in the hierarchy it will return the last audio component.

Description:

 

GetTimeSamples

virtual int Fabric.Component.GetTimeSamples ( ) [virtual]

Returns:

Time in samples of audio component. Not if more than one audio component in the hierarchy it will return the last audio component.

Description:

 

HasReachedEnd

virtual bool Fabric.Component.HasReachedEnd ( ) [virtual]

Returns:

True if the audio component currently playing has reached the end.

Description:

 

IsComponentActive

virtual bool Fabric.Component.IsComponentActive ( ) [virtual]

Returns:

True if the component is active.

Description:

 

IsOneShot

virtual bool Fabric.Component.IsOneShot ( ) [virtual]

Returns:

True if the component is one shot.

Description:

 

IsPlaying

virtual bool Fabric.Component.IsPlaying  () [virtual]

bool Fabric.Component.IsPlaying ( GameObject parentGameObject )

Parameters:

parentGameObject: Check component instance associated with a game object

Returns:

True if the component is playing.

Description:

 

IsVirtualizationActive

bool Fabric.Component.IsVirtualizationActive ( )

Returns:

True if the component's virtualization is active

Description: