Semi.Sound Class Reference

Inheritance diagram for Semi.Sound:

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

Properties
override bool	IsPlaying [get]
override float	Pitch [get, set]
override float	Volume [get, set]
Properties inherited from Semi.Audio
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...

Additional Inherited Members
Public Types inherited from Semi.Audio
enum	VolumeCategory { VolumeCategory.Sound, VolumeCategory.Music, VolumeCategory.UI }
	Volume category, one value for each bar in settings. More...
Static Public Member Functions inherited from Semi.Audio
static void	Play (string id, GameObject source=null)
	Plays an audio track with the specified ID. More...
Public Attributes inherited from Semi.Audio
VolumeCategory	Category
	The volume category of this audio track. More...

Member Function Documentation

Dispose()

override void Semi.Sound.Dispose ( )

inlinevirtual

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.

Implements Semi.Audio.

Pause()

override void Semi.Sound.Pause ( )

inlinevirtual

Pause this audio track.

Implements Semi.Audio.

Play()

override void Semi.Sound.Play ( )

inlinevirtual

Play this audio track.

Implements Semi.Audio.

Resume()

override void Semi.Sound.Resume ( )

inlinevirtual

Resume this audio track.

Implements Semi.Audio.

Stop()

override void Semi.Sound.Stop ( )

inlinevirtual

Stop this audio track.

Implements Semi.Audio.

Property Documentation

IsPlaying

override bool Semi.Sound.IsPlaying

get

Pitch

override float Semi.Sound.Pitch

getset

Volume

override float Semi.Sound.Volume

getset

---

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

• Semi/src/Semi/Audio.cs