Class AudioSystem

Namespace

Lime

Assembly

Lime.dll

public static class AudioSystem

Inheritance

object

AudioSystem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

ExclusiveAudioDefaultCrossfadeTime

Default time for fade in and fade out when performing cross fade between exclusive channels. To override for corresponding kind of fade set either FadeTime or FadeInTime to non zero.

public static float ExclusiveAudioDefaultCrossfadeTime

Field Value

float

Properties

Active

public static bool Active { get; set; }

Property Value

bool

Channels

public static IEnumerable<IAudioChannel> Channels { get; }

Property Value

IEnumerable<IAudioChannel>

Methods

GetGroupVolume(AudioChannelGroup)

public static float GetGroupVolume(AudioChannelGroup group)

Parameters

group AudioChannelGroup

Returns

float

Initialize(ApplicationOptions)

public static void Initialize(ApplicationOptions options)

Parameters

options ApplicationOptions

PauseAll()

public static void PauseAll()

PauseGroup(AudioChannelGroup)

public static void PauseGroup(AudioChannelGroup group)

Parameters

group AudioChannelGroup

Play(PlayParameters)

public static Sound Play(PlayParameters parameters)

Parameters

parameters PlayParameters

Returns

Sound

Play(string, AudioChannelGroup, bool, float, float, bool, float, float, float, bool, float)

public static Sound Play(string path, AudioChannelGroup group, bool looping = false, float priority = 0.5, float fadeInTime = 0, bool paused = false, float volume = 1, float pan = 0, float pitch = 1, bool exclusive = false, float fadeOutTime = 0)

Parameters

path string

group AudioChannelGroup

looping bool

priority float

fadeInTime float

paused bool

volume float

pan float

pitch float

exclusive bool

fadeOutTime float

Returns

Sound

PlayEffect(string, bool, float, float, bool, float, float, float)

public static Sound PlayEffect(string path, bool looping = false, float priority = 0.5, float fadeinTime = 0, bool paused = false, float volume = 1, float pan = 0, float pitch = 1)

Parameters

path string

looping bool

priority float

fadeinTime float

paused bool

volume float

pan float

pitch float

Returns

Sound

PlayMusic(string, bool, float, float, bool, float, float, float)

public static Sound PlayMusic(string path, bool looping = true, float priority = 100, float fadeinTime = 0.5, bool paused = false, float volume = 1, float pan = 0, float pitch = 1)

Parameters

path string

looping bool

priority float

fadeinTime float

paused bool

volume float

pan float

pitch float

Returns

Sound

ResumeAll()

public static void ResumeAll()

ResumeGroup(AudioChannelGroup)

public static void ResumeGroup(AudioChannelGroup group)

Parameters

group AudioChannelGroup

SetGroupVolume(AudioChannelGroup, float)

public static float SetGroupVolume(AudioChannelGroup group, float value)

Parameters

group AudioChannelGroup

value float

Returns

float

StopAll()

public static void StopAll()

StopGroup(AudioChannelGroup, float)

public static void StopGroup(AudioChannelGroup group, float fadeoutTime = 0)

Parameters

group AudioChannelGroup

fadeoutTime float

Terminate()

public static void Terminate()

Update()

public static void Update()

Events

AudioMissing

public static event Action<string> AudioMissing

Event Type

Action<string>