Base class for all record sets. More...

Inheritance diagram for Crosstales.DJ.Set.BaseSet:

Public Member Functions
abstract void	Load ()
	Loads all audio records from this set. More...

System.Collections.Generic.List< Record >	GetRecords (bool random=false, RecordFilter _filter=null)
	Get all Record for a given RecordFilter. More...

int	CountRecords (RecordFilter _filter=null)
	Count all Record for a given RecordFilter. More...

double	PlaytimeRecords (RecordFilter _filter=null)
	Get the total playtime of all Record for a given RecordFilter. More...

long	SizeRecords (RecordFilter _filter=null)
	Get the total size of all Record for a given RecordFilter. More...

System.Collections.Generic.List< Record >	RecordsByFilePath (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by file path. More...

System.Collections.Generic.List< Record >	RecordsByName (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by name. More...

System.Collections.Generic.List< Record >	RecordsByTitle (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by title. More...

System.Collections.Generic.List< Record >	RecordsByArtist (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by artist. More...

System.Collections.Generic.List< Record >	RecordsByAlbum (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by album. More...

System.Collections.Generic.List< Record >	RecordsByGenre (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by genre. More...

System.Collections.Generic.List< Record >	RecordsByRating (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by rating. More...

System.Collections.Generic.List< Record >	RecordsByYear (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by year. More...

System.Collections.Generic.List< Record >	RecordsByDuration (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by duration. More...

System.Collections.Generic.List< Record >	RecordsByFileSize (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by year. More...

System.Collections.Generic.List< Record >	RecordsByFormat (bool desc=false, RecordFilter _filter=null)
	Returns all audio records of this set ordered by audio format. More...

Record	RecordFromIndex (bool random=false, int index=-1, RecordFilter _filter=null)
	Record from a given index (normal/random) from this set. More...

Record	RecordFromHashCode (int hashCode)
	Record from a hashcode from this set. More...

Record	Next (bool random=false, RecordFilter _filter=null)
	Next (normal/random) record from this set. More...

Record	Previous (bool random=false, RecordFilter _filter=null)
	Previous (normal/random) record from this set. More...

void	RandomizeRecords (bool resetIndex=true)
	Randomize all audio records. More...

Protected Member Functions
void	clearFilters (bool clearLastFilter=true, bool clearLastRandomFilter=true)

void	resetFilterLists ()

virtual void	onFilterChange ()

virtual void	onRecordsChange ()

virtual void	onProvider ()

virtual void	onErrorProvider (string info)

Protected Attributes
System.Collections.Generic.List< Record >	randomRecords = new System.Collections.Generic.List<Record>()

System.Collections.Generic.List< Record >	allRecords = new System.Collections.Generic.List<Record>()

Properties
RecordFilter	Filter `[get, set]`
	Global RecordFilter (active if no explicit filter is given). More...

abstract Crosstales.DJ.RecordsChangeEvent	onRecordsChanged `[get]`

abstract Crosstales.DJ.ProviderReadyEvent	onProviderReady `[get]`

abstract Crosstales.DJ.FilterChangeEvent	onFilterChanged `[get]`

abstract Crosstales.DJ.ErrorProviderEvent	onErrorProviderInfo `[get]`

abstract System.Collections.Generic.List< Record >	Records `[get]`

abstract System.Collections.Generic.List< Record >	RandomRecords `[get]`

abstract bool	isReady `[get]`

double	TotalPlaytime `[get]`

long	TotalSize `[get]`

int	CurrentRecordIndex `[get, set]`

int	CurrentRandomRecordIndex `[get, set]`

Properties inherited from Crosstales.DJ.Set.ISet
System.Collections.Generic.List< Record >	Records `[get]`
	Returns the list of all audio records from this set. More...

System.Collections.Generic.List< Record >	RandomRecords `[get]`
	Returns the list of all randomized audio records from this set. More...

bool	isReady `[get]`
	Checks if the set is ready to work. More...

double	TotalPlaytime `[get]`
	The total playtime of the set. More...

long	TotalSize `[get]`
	The total size in bytes of the set. More...

int	CurrentRecordIndex `[get, set]`
	Current record index. More...

int	CurrentRandomRecordIndex `[get, set]`
	Current random record index. More...

Events
Crosstales.DJ.FilterChange	OnFilterChange
	An event triggered whenever the filter changes. More...

Crosstales.DJ.RecordsChange	OnRecordsChange
	An event triggered whenever the records change. More...

ProviderReady	OnProviderReady
	An event triggered whenever all providers are ready. More...

Crosstales.DJ.ErrorProvider	OnErrorProvider
	An event triggered whenever an error occurs. More...

Detailed Description

Base class for all record sets.

Member Function Documentation

◆ CountRecords()

int Crosstales.DJ.Set.BaseSet.CountRecords ( RecordFilter filter = null )

Count all Record for a given RecordFilter.

Parameters

filter Filter (default: null, optional)

Returns: Number of all Record for a given RecordFilter.

Implements Crosstales.DJ.Set.ISet.

◆ GetRecords()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.GetRecords	(	bool	random = `false`,
		RecordFilter	filter = `null`
	)

Get all Record for a given RecordFilter.

Parameters

random	Return random Record (default: false, optional)
filter	Filter (default: null, optional)

Returns: All Record for a given RecordFilter.

Implements Crosstales.DJ.Set.ISet.

◆ Load()

abstract void Crosstales.DJ.Set.BaseSet.Load ( )

pure virtual

Loads all audio records from this set.

Implements Crosstales.DJ.Set.ISet.

Implemented in Crosstales.DJ.Set.DJSet, and Crosstales.DJ.Set.RecordSet.

◆ Next()

Record Crosstales.DJ.Set.BaseSet.Next	(	bool	random = `false`,
		RecordFilter	filter = `null`
	)

Next (normal/random) record from this set.

Parameters

random	Return a random record (default: false, optional)
filter	Filter for the records (default: null, optional)

Returns: Next record.

Implements Crosstales.DJ.Set.ISet.

◆ PlaytimeRecords()

double Crosstales.DJ.Set.BaseSet.PlaytimeRecords ( RecordFilter filter = null )

Get the total playtime of all Record for a given RecordFilter.

Parameters

filter Filter (default: null, optional)

Returns: Total playtime of all Record for a given RecordFilter.

Implements Crosstales.DJ.Set.ISet.

◆ Previous()

Record Crosstales.DJ.Set.BaseSet.Previous	(	bool	random = `false`,
		RecordFilter	filter = `null`
	)

Previous (normal/random) record from this set.

Parameters

random	Return a random record (default: false, optional)
filter	Filter for the records (default: null, optional)

Returns: Previous record.

Implements Crosstales.DJ.Set.ISet.

◆ RandomizeRecords()

void Crosstales.DJ.Set.BaseSet.RandomizeRecords ( bool resetIndex = true )

Randomize all audio records.

Parameters

resetIndex Reset the index of the random records (default: true, optional)

Implements Crosstales.DJ.Set.ISet.

◆ RecordFromHashCode()

Record Crosstales.DJ.Set.BaseSet.RecordFromHashCode ( int hashCode )

Record from a hashcode from this set.

Parameters

hashCode Hashcode of the record

Returns: Record from hashcode.

Implements Crosstales.DJ.Set.ISet.

◆ RecordFromIndex()

Record Crosstales.DJ.Set.BaseSet.RecordFromIndex	(	bool	random = `false`,
		int	index = `-1`,
		RecordFilter	filter = `null`
	)

Record from a given index (normal/random) from this set.

Parameters

random	Return a random record (default: false, optional)
index	Index of the record (default: -1, optional)
filter	Filter for the records (default: null, optional)

Returns: Record from index.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByAlbum()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByAlbum	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by album.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by album.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByArtist()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByArtist	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by artist.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by artist.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByDuration()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByDuration	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by duration.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by duration.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByFilePath()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByFilePath	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by file path.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by file path.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByFileSize()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByFileSize	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by year.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by year.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByFormat()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByFormat	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by audio format.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by audio format.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByGenre()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByGenre	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by genre.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by genre.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByName()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByName	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by name.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by name.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByRating()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByRating	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by rating.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by rating.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByTitle()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByTitle	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by title.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by title.

Implements Crosstales.DJ.Set.ISet.

◆ RecordsByYear()

System.Collections.Generic.List<Record> Crosstales.DJ.Set.BaseSet.RecordsByYear	(	bool	desc = `false`,
		RecordFilter	filter = `null`
	)

Returns all audio records of this set ordered by year.

Parameters

desc	Descending order (default: false, optional)
filter	Filter (default: null, optional)

Returns: All audio records of this set ordered by year.

Implements Crosstales.DJ.Set.ISet.

◆ SizeRecords()

long Crosstales.DJ.Set.BaseSet.SizeRecords ( RecordFilter filter = null )

Get the total size of all Record for a given RecordFilter.

Parameters

filter Filter (default: null, optional)

Returns: Total size of all Record for a given RecordFilter.

Implements Crosstales.DJ.Set.ISet.

Property Documentation

◆ Filter

RecordFilter Crosstales.DJ.Set.BaseSet.Filter

getset

Global RecordFilter (active if no explicit filter is given).

Event Documentation

◆ OnErrorProvider

Crosstales.DJ.ErrorProvider Crosstales.DJ.Set.BaseSet.OnErrorProvider

An event triggered whenever an error occurs.

◆ OnFilterChange

Crosstales.DJ.FilterChange Crosstales.DJ.Set.BaseSet.OnFilterChange

An event triggered whenever the filter changes.

◆ OnProviderReady

ProviderReady Crosstales.DJ.Set.BaseSet.OnProviderReady

An event triggered whenever all providers are ready.

◆ OnRecordsChange

Crosstales.DJ.RecordsChange Crosstales.DJ.Set.BaseSet.OnRecordsChange

An event triggered whenever the records change.

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

C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/DJ/Scripts/Set/BaseSet.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ CountRecords()

◆ GetRecords()

◆ Load()

◆ Next()

◆ PlaytimeRecords()

◆ Previous()

◆ RandomizeRecords()

◆ RecordFromHashCode()

◆ RecordFromIndex()

◆ RecordsByAlbum()

◆ RecordsByArtist()

◆ RecordsByDuration()

◆ RecordsByFilePath()

◆ RecordsByFileSize()

◆ RecordsByFormat()

◆ RecordsByGenre()

◆ RecordsByName()

◆ RecordsByRating()

◆ RecordsByTitle()

◆ RecordsByYear()

◆ SizeRecords()

Property Documentation

◆ Filter

Event Documentation

◆ OnErrorProvider

◆ OnFilterChange

◆ OnProviderReady

◆ OnRecordsChange