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

Keeps tracks that you can play at a time More...

Public Member Functions

 TrackStream (AudioStreamSystem audioSystem)
 This method used AudioStreamSystem. If need use AudioStreamSystem.CreateTrackStream(). More...
 
void Play ()
 Play current track. More...
 
void Stop ()
 Stop current track. More...
 
void Pause ()
 Pause current track. More...
 
void Add (AudioClip clip, AudioOption option, Transform followTarget)
 Add clip to stream. More...
 
void Add (AudioClip clip, AudioOption option)
 Add clip to stream. More...
 
void Add (AudioClip clip)
 Add clip to stream. More...
 
void Add (Track track)
 Add track to stream. More...
 
void Remove (int index)
 Remove track by index. More...
 
Track Get (int index)
 Get track by index. More...
 
bool IsRange (int index)
 Whether the index is valid More...
 
void Next ()
 Play next track. More...
 
AudioStreamSystem GetBindAudioStreamSystem ()
 Gets the binding AudioStreamSystem. More...
 

Properties

int Count [get]
 tracks count. More...
 
Track this[int index] [get]
 Get track by index. More...
 
bool isPlay [get]
 Is play current track More...
 
bool isPause [get]
 Is pause current track More...
 
bool isStop [get]
 Is stop current track More...
 
bool isNext [get]
 Can be played next More...
 
AudioStreamOption option [get, set]
 Gets or sets the TrackStream option. More...
 
AudioOption globalOption [get, set]
 Gets or sets the global option (Additive to new track) More...
 
int nTrack [get, set]
 Gets or sets the index current track. More...
 
Track selectTrack [get]
 Gets the select track. More...
 

Events

Action< TrackStreamcompleteTrack
 Complete play track. More...
 
Action< TrackStreamcompleteStream
 Complete play all track. More...
 

Detailed Description

Keeps tracks that you can play at a time

Constructor & Destructor Documentation

TrackStream.TrackStream ( AudioStreamSystem  audioSystem)

Member Function Documentation

void TrackStream.Add ( AudioClip  clip,
AudioOption  option,
Transform  followTarget 
)

Add clip to stream.

void TrackStream.Add ( AudioClip  clip,
AudioOption  option 
)

Add clip to stream.

void TrackStream.Add ( AudioClip  clip)

Add clip to stream.

void TrackStream.Add ( Track  track)

Add track to stream.

Track TrackStream.Get ( int  index)

Get track by index.

Parameters
indexIndex.
AudioStreamSystem TrackStream.GetBindAudioStreamSystem ( )

Gets the binding AudioStreamSystem.

Returns
The the binding AudioStreamSystem.
bool TrackStream.IsRange ( int  index)

Whether the index is valid

Returns
true is valid; otherwise, false.
Parameters
indexIndex.
void TrackStream.Next ( )

Play next track.

void TrackStream.Pause ( )

Pause current track.

void TrackStream.Play ( )

Play current track.

void TrackStream.Remove ( int  index)

Remove track by index.

Parameters
indexIndex.
void TrackStream.Stop ( )

Stop current track.

Property Documentation

int TrackStream.Count
get

tracks count.

AudioOption TrackStream.globalOption
getset

Gets or sets the global option (Additive to new track)

The global option.

bool TrackStream.isNext
get

Can be played next

true if can play; otherwise, false.

bool TrackStream.isPause
get

Is pause current track

true if is pause; otherwise, false.

bool TrackStream.isPlay
get

Is play current track

true if is play; otherwise, false.

bool TrackStream.isStop
get

Is stop current track

true if is stop; otherwise, false.

int TrackStream.nTrack
getset

Gets or sets the index current track.

The current track index.

AudioStreamOption TrackStream.option
getset

Gets or sets the TrackStream option.

The option.

Track TrackStream.selectTrack
get

Gets the select track.

The select track.

Track TrackStream.this[int index]
get

Get track by index.

Parameters
indexIndex.

Event Documentation

Action<TrackStream> TrackStream.completeStream

Complete play all track.

Action<TrackStream> TrackStream.completeTrack

Complete play track.


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