AudioSystem Class Reference

Class play audio clip. More...

Inherits MonoBehaviour.

Inherited by AudioStreamSystem.

Public Member Functions
Track	CreateTrack ()
	Creates the track. Binding to this AudioSystem More...
Track	Play (AudioClip clip)
	Play sound the specified clip. More...
Track	Play (AudioClip clip, AudioOption option)
	Play sound the specified clip and option. More...
Track	Play (AudioClip clip, Transform target, AudioOption option)
	Play sound the specified clip, target and option. More...
Track	Play (Track track, AudioOption option)
	Play sound the specified track and option. More...
Track	Play (Track track)
	Play the specified track. More...
void	Stop (Track track)
	Stop the sound track. More...
void	Pause (Track track)
	Pause sound track. More...
bool	IsPlay (Track track)
	Determines whether this instance is play the specified track. More...
List< Track >	GetTracks ()
	Gets all playing or paused tracks. More...
AudioGroupDetail	GetLocal (AudioOption auidoOption)
	Gets the group setting of sound. More...
AudioGroupDetail	GetGlobal (AudioOption auidoOption)
	Gets the multiplied groups setting of sound. More...
virtual void	StopAll ()
	Stop all sounds. More...

Properties
AudioGroupDetail	this[AudioOption option] [get]
	Gets the local with global group setting of sound More...
int	limitCount [get]
	Gets the count spawn sound with option LIMIT. More...
int	poolCapacity [get]
	Gets the pool capacity More...
bool	isSpawnMode [get, set]
	Gets a value indicating whether this AudioSystem is spawn mode. More...

Detailed Description

Class play audio clip.

Member Function Documentation

Track AudioSystem.CreateTrack

(

)

Creates the track. Binding to this AudioSystem

Returns

The track.

AudioGroupDetail AudioSystem.GetGlobal

(

AudioOption

auidoOption)

Gets the multiplied groups setting of sound.

Returns

Audio setting

Parameters

auidoOption

Auido group setting.

AudioGroupDetail AudioSystem.GetLocal

(

AudioOption

auidoOption)

Gets the group setting of sound.

Returns

Audio setting

Parameters

auidoOption

Auido group setting.

List<Track> AudioSystem.GetTracks

(

)

Gets all playing or paused tracks.

Returns

The tracks.

bool AudioSystem.IsPlay

(

Track

track)

Determines whether this instance is play the specified track.

Returns

true if this instance is play the specified track; otherwise, false.

Parameters

track

Sound track.

void AudioSystem.Pause

(

Track

track)

Pause sound track.

Parameters

track

Sound track.

Track AudioSystem.Play

(

AudioClip

clip)

Play sound the specified clip.

Parameters

clip	Audio clip.

Track AudioSystem.Play	(	AudioClip	clip,
		AudioOption	option
	)

Play sound the specified clip and option.

Parameters

clip	Audio clip.
option	Play option.

Track AudioSystem.Play	(	AudioClip	clip,
		Transform	target,
		AudioOption	option
	)

Play sound the specified clip, target and option.

Parameters

clip	Audio clip.
target	Aim to follow
option	Play option.

Exceptions

System.ArgumentException

Is thrown when clip == null

Track AudioSystem.Play	(	Track	track,
		AudioOption	option
	)

Play sound the specified track and option.

Parameters

track	Sound track.
option	Play option.

Track AudioSystem.Play

(

Track

track)

Play the specified track.

Parameters

track

Sound track.

void AudioSystem.Stop

(

Track

track)

Stop the sound track.

Parameters

track

Sound track.

virtual void AudioSystem.StopAll ( )

virtual

Stop all sounds.

Reimplemented in AudioStreamSystem.

Property Documentation

bool AudioSystem.isSpawnMode

getset

Gets a value indicating whether this AudioSystem is spawn mode.

true if use spawn pool; otherwise, false.

int AudioSystem.limitCount

get

Gets the count spawn sound with option LIMIT.

The count.

int AudioSystem.poolCapacity

get

Gets the pool capacity

The count.

AudioGroupDetail AudioSystem.this[AudioOption option]

get

Gets the local with global group setting of sound

Parameters

option

Auido group setting.

---

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

• SimpleAudioManager/Scripts/AudioSystem.cs