Simple Audio Manager  1.0.1
 All Classes Files Functions Enumerations Enumerator Properties Events Pages
Public Member Functions | Properties | Events | List of all members
Track Class Reference

It is a track that can be played. More...

Public Member Functions

 Track (AudioSystem audioSystem, AudioSource audioSource, AudioOption option, Transform followTarget, AudioClip clip)
 This method used Audio System. If need use AudioSystem.CreateTrack(); More...
 
void Play (AudioOption option)
 Play sound the specified option. More...
 
void Play ()
 Play sound. More...
 
void Pause ()
 Pause sound. More...
 
void Stop ()
 Stop sound. More...
 
AudioSystem GetBindAudioSystem ()
 Gets the binding AudioSystem. More...
 
virtual bool IsDestroyAndUpdate ()
 This method use AudioSystem. More...
 

Properties

float volume [get, set]
 Gets or sets the volume. More...
 
AudioOption option [get, set]
 Gets or sets the option. More...
 
AudioClip clip [get, set]
 Gets or sets the audio clip. More...
 
AudioSource audioSource [get, set]
 Gets or sets the audioSource. More...
 
Transform transform [get]
 Gets the AudioSource transform. More...
 
bool isPause [get, set]
 Is pause track. More...
 
bool isStop [get]
 Is stop track. More...
 
bool isPlay [get]
 Is play track. More...
 
bool isNull [get]
 is clip null More...
 

Events

Action< Trackcomplete
 Complete play track. More...
 

Detailed Description

It is a track that can be played.

Exceptions
System.ArgumentExceptionIs thrown when an argument passed to a method is invalid.

Constructor & Destructor Documentation

Track.Track ( AudioSystem  audioSystem,
AudioSource  audioSource,
AudioOption  option,
Transform  followTarget,
AudioClip  clip 
)

This method used Audio System. If need use AudioSystem.CreateTrack();

Member Function Documentation

AudioSystem Track.GetBindAudioSystem ( )

Gets the binding AudioSystem.

Returns
The the binding AudioSystem.
virtual bool Track.IsDestroyAndUpdate ( )
virtual

This method use AudioSystem.

void Track.Pause ( )

Pause sound.

void Track.Play ( AudioOption  option)

Play sound the specified option.

Parameters
optionPlay option.
void Track.Play ( )

Play sound.

void Track.Stop ( )

Stop sound.

Property Documentation

AudioSource Track.audioSource
getset

Gets or sets the audioSource.

The AudioSource.

AudioClip Track.clip
getset

Gets or sets the audio clip.

The clip.

bool Track.isNull
get

is clip null

true if clip is null; otherwise, false.

bool Track.isPause
getset

Is pause track.

true if is play; otherwise, false.

bool Track.isPlay
get

Is play track.

true if is play; otherwise, false.

bool Track.isStop
get

Is stop track.

true if is play; otherwise, false.

AudioOption Track.option
getset

Gets or sets the option.

The option.

Exceptions
System.ArgumentExceptionIs thrown when an argument passed to a method is invalid.
Transform Track.transform
get

Gets the AudioSource transform.

The transform of AudioSource.

float Track.volume
getset

Gets or sets the volume.

The volume.

Event Documentation

Action<Track> Track.complete

Complete play track.


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