Music Player
FreakLib.Music.Playlist Class Reference

This class implements a Playlist for the MusicPlayer. More...

Public Member Functions

 Playlist ()
 Initializes a new instance of the FreakLib.Jukebox.Playlist class. More...
 
 Playlist (string aName)
 Initializes a new instance of the FreakLib.Music.Playlist class. More...
 
 Playlist (string aName, List< Track > theTracks, bool shouldShuffle=false)
 Initializes a new instance of the FreakLib.Music.Playlist class. More...
 

Public Attributes

string name = ""
 The name of the Playlist. More...
 
List< Tracktracks = new List<Track>()
 The list of FreakLib.Music.Tracks in this Playlist. More...
 
bool shuffle = false
 Should the Playlist be shuffeled during play? More...
 
bool foldout = false
 If this Playlist should be expanded in the inspector. More...
 

Properties

List< int > EnabledTrackIndices [get]
 Returns a list of indices to the tracks in this Playlist that are currently enabled. More...
 

Detailed Description

This class implements a Playlist for the MusicPlayer.

A Playlist is a group of FreakLib.Music.Tracks that the MusicPlayer can play in order, or randomly shuffled.

Constructor & Destructor Documentation

FreakLib.Music.Playlist.Playlist ( )

Initializes a new instance of the FreakLib.Jukebox.Playlist class.

FreakLib.Music.Playlist.Playlist ( string  aName)

Initializes a new instance of the FreakLib.Music.Playlist class.

Parameters
aNameThe Playlist name.
FreakLib.Music.Playlist.Playlist ( string  aName,
List< Track theTracks,
bool  shouldShuffle = false 
)

Initializes a new instance of the FreakLib.Music.Playlist class.

Parameters
aNameThe Playlist name.
theTracksA list of tracks for this Playlist.
shouldShuffleIf set to true the Playlist will shuffle.

Member Data Documentation

bool FreakLib.Music.Playlist.foldout = false

If this Playlist should be expanded in the inspector.

string FreakLib.Music.Playlist.name = ""

The name of the Playlist.

bool FreakLib.Music.Playlist.shuffle = false

Should the Playlist be shuffeled during play?

List<Track> FreakLib.Music.Playlist.tracks = new List<Track>()

The list of FreakLib.Music.Tracks in this Playlist.

Property Documentation

List<int> FreakLib.Music.Playlist.EnabledTrackIndices
get

Returns a list of indices to the tracks in this Playlist that are currently enabled.

The enabled track indices.


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