Crosstales.DJ.Provider.IRecordProvider Interface Reference

Interface for all record providers. More...

Inheritance diagram for Crosstales.DJ.Provider.IRecordProvider:

Public Member Functions
void	Load (bool forceReload=false)
	Loads all audio records for this provider. More...

Properties
bool	LoadTag [get, set]
	Load the tag of every Record in the constructor. This is a time-costly operation and can lead to stuttering. More...
bool	ReadFileSize [get, set]
	Read the file size of every Record in the constructor. This is a time-costly operation and can lead to stuttering. More...
bool	AutoUpdate [get, set]
	Auto-update the record list. More...
bool	isReady [get, set]
	Checks if the provider is ready to work. More...
System.Collections.Generic.List< Crosstales.DJ.Model.Record >	Records [get]
	Returns the list of all audio records from this provider. More...
double	TotalPlaytime [get]
	Returns the total playtime in seconds from the provider. More...
long	TotalSize [get]
	Returns the total size in bytes from the provider. More...

Detailed Description

Interface for all record providers.

Member Function Documentation

Load()

void Crosstales.DJ.Provider.IRecordProvider.Load

(

bool

forceReload = false

)

Loads all audio records for this provider.

Parameters

forceReload

Force reloading the records (optional).

Implemented in Crosstales.DJ.Provider.RecordProviderPath, Crosstales.DJ.Provider.BaseRecordProvider, and Crosstales.DJ.Provider.BaseRecordProviderDB.

Property Documentation

AutoUpdate

bool Crosstales.DJ.Provider.IRecordProvider.AutoUpdate

getset

Auto-update the record list.

isReady

bool Crosstales.DJ.Provider.IRecordProvider.isReady

getset

Checks if the provider is ready to work.

Returns

True if the provider is ready to work.

LoadTag

bool Crosstales.DJ.Provider.IRecordProvider.LoadTag

getset

Load the tag of every Record in the constructor. This is a time-costly operation and can lead to stuttering.

ReadFileSize

bool Crosstales.DJ.Provider.IRecordProvider.ReadFileSize

getset

Read the file size of every Record in the constructor. This is a time-costly operation and can lead to stuttering.

Records

System.Collections.Generic.List<Crosstales.DJ.Model.Record> Crosstales.DJ.Provider.IRecordProvider.Records

get

Returns the list of all audio records from this provider.

Returns

The list of all audio records from this provider.

TotalPlaytime

double Crosstales.DJ.Provider.IRecordProvider.TotalPlaytime

get

Returns the total playtime in seconds from the provider.

Returns

The total playtime in seconds from the provider.

TotalSize

long Crosstales.DJ.Provider.IRecordProvider.TotalSize

get

Returns the total size in bytes from the provider.

Returns

The total size in bytes from the provider.

---

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

• C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/DJ/Scripts/Provider/IRecordProvider.cs