Semi.Audio Class Reference

Inheritance diagram for Semi.Audio:

Public Types
enum	VolumeCategory { VolumeCategory.Sound, VolumeCategory.Music, VolumeCategory.UI }
	Volume category, one value for each bar in settings. More...

Public Member Functions
abstract void	Play ()
	Play this audio track. More...
abstract void	Stop ()
	Stop this audio track. More...
abstract void	Pause ()
	Pause this audio track. More...
abstract void	Resume ()
	Resume this audio track. More...
abstract void	Dispose ()
	Releases all resource used by the Semi.Audio object. More...

Static Public Member Functions
static void	Play (string id, GameObject source=null)
	Plays an audio track with the specified ID. More...

Public Attributes
VolumeCategory	Category
	The volume category of this audio track. More...

Properties
static float	SoundVolume [get, set]
	Volume for Sound set in the settings. More...
static float	MusicVolume [get, set]
	Volume for Music set in the settings. More...
static float	UIVolume [get, set]
	Volume for UI set in the settings. More...
abstract float	Volume [get, set]
	Gets or sets the volume of this track. More...
abstract float	Pitch [get, set]
	Gets or sets the pitch of this track. More...
abstract bool	IsPlaying [get]
	Whether this audio track is currently playing. More...

Member Enumeration Documentation

VolumeCategory

enum Semi.Audio.VolumeCategory

strong

Volume category, one value for each bar in settings.

Enumerator
Sound
Music
UI

Member Function Documentation

Dispose()

abstract void Semi.Audio.Dispose ( )

pure virtual

Releases all resource used by the Semi.Audio object.

Call Dispose when you are finished using the Semi.Audio. The Dispose method leaves the Semi.Audio in an unusable state. After calling Dispose, you must release all references to the Semi.Audio so the garbage collector can reclaim the memory that the Semi.Audio was occupying.

Implemented in Semi.Music, and Semi.Sound.

Pause()

abstract void Semi.Audio.Pause ( )

pure virtual

Pause this audio track.

Implemented in Semi.Music, and Semi.Sound.

Play() [1/2]

abstract void Semi.Audio.Play ( )

pure virtual

Play this audio track.

Implemented in Semi.Music, and Semi.Sound.

Play() [2/2]

static void Semi.Audio.Play ( string  id, GameObject  source = null  )

inlinestatic

Plays an audio track with the specified ID.

Parameters

id	ID of the audio track.
source	Source GameObject.

Resume()

abstract void Semi.Audio.Resume ( )

pure virtual

Resume this audio track.

Implemented in Semi.Music, and Semi.Sound.

Stop()

abstract void Semi.Audio.Stop ( )

pure virtual

Stop this audio track.

Implemented in Semi.Music, and Semi.Sound.

Member Data Documentation

Category

VolumeCategory Semi.Audio.Category

The volume category of this audio track.

Property Documentation

IsPlaying

abstract bool Semi.Audio.IsPlaying

get

Whether this audio track is currently playing.

true if it is playing; otherwise, false.

MusicVolume

float Semi.Audio.MusicVolume

staticgetset

Volume for Music set in the settings.

0f -> 1f

Pitch

abstract float Semi.Audio.Pitch

getset

Gets or sets the pitch of this track.

The pitch.

SoundVolume

float Semi.Audio.SoundVolume

staticgetset

Volume for Sound set in the settings.

0f -> 1f

UIVolume

float Semi.Audio.UIVolume

staticgetset

Volume for UI set in the settings.

0f -> 1f

Volume

abstract float Semi.Audio.Volume

getset

Gets or sets the volume of this track.

The volume.

---

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

• Semi/src/Semi/Audio.cs