Base class for all record providers. More...

Inheritance diagram for Crosstales.DJ.Provider.BaseRecordProvider:

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

Public Attributes
double	TotalPlaytime => Records.Aggregate(0d, (current, record) => current + record.Duration)

long	TotalSize => Records.Sum(record => record.FileSize)

Protected Member Functions
virtual void	Awake ()

virtual void	Start ()

abstract void	load ()

abstract void	loadInEditor ()

void	fillRecords (string[] list)

virtual void	onRecordsChange ()

virtual void	onProvider ()

virtual void	onErrorProvider (string info)

Static Protected Member Functions
static string	determineAudioFormatExtension (Crosstales.DJ.Model.Enum.AudioFormat audioFormat=Crosstales.DJ.Model.Enum.AudioFormat.MP3)

Protected Attributes
System.Collections.Generic.List< Crosstales.DJ.Model.Record >	records = new System.Collections.Generic.List<Crosstales.DJ.Model.Record>()

bool	loading

string	errorMessage

Properties
bool	LoadTag `[get, set]`

bool	ReadFileSize `[get, set]`

bool	AutoUpdate `[get, set]`

bool	AutoUpdateInEditor `[get, set]`
	Auto-update the record list in Editor. More...

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

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

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

bool	isLoadTag `[get, set]`

bool	isReadFileSize `[get, set]`

bool	isAutoUpdate `[get, set]`

bool	isReady `[get, set]`

System.Collections.Generic.List< Crosstales.DJ.Model.Record >	Records `[get]`

Properties inherited from Crosstales.DJ.Provider.IRecordProvider
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...

Events
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 providers.

Member Function Documentation

◆ Load()

virtual void Crosstales.DJ.Provider.BaseRecordProvider.Load ( bool forceReload = false )

virtual

Loads all audio records for this provider.

Parameters

forceReload Force reloading the records (optional).

Implements Crosstales.DJ.Provider.IRecordProvider.

Reimplemented in Crosstales.DJ.Provider.RecordProviderPath, and Crosstales.DJ.Provider.BaseRecordProviderDB.

Property Documentation

◆ AutoUpdateInEditor

bool Crosstales.DJ.Provider.BaseRecordProvider.AutoUpdateInEditor

getset

Auto-update the record list in Editor.

Event Documentation

◆ OnErrorProvider

Crosstales.DJ.ErrorProvider Crosstales.DJ.Provider.BaseRecordProvider.OnErrorProvider

An event triggered whenever an error occurs.

◆ OnProviderReady

ProviderReady Crosstales.DJ.Provider.BaseRecordProvider.OnProviderReady

An event triggered whenever all providers are ready.

◆ OnRecordsChange

Crosstales.DJ.RecordsChange Crosstales.DJ.Provider.BaseRecordProvider.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/Provider/BaseRecordProvider.cs

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties

Events