Crosstales.DJ.Provider.RecordProviderFile Class Reference

File based record provider. More...

Inheritance diagram for Crosstales.DJ.Provider.RecordProviderFile:
Crosstales.DJ.Provider.BaseRecordProvider Crosstales.DJ.Provider.IRecordProvider

Public Attributes

Crosstales.DJ.RecordsChangeEvent OnRecordsChanged
 
Crosstales.DJ.ProviderReadyEvent OnProviderReadyEvent
 
Crosstales.DJ.ErrorProviderEvent OnErrorProviderInfo
 
- Public Attributes inherited from Crosstales.DJ.Provider.BaseRecordProvider
double TotalPlaytime => Records.Aggregate(0d, (current, record) => current + record.Duration)
 
long TotalSize => Records.Sum(record => record.FileSize)
 

Protected Member Functions

override void load ()
 
override void loadInEditor ()
 
- Protected Member Functions inherited from Crosstales.DJ.Provider.BaseRecordProvider
virtual void Awake ()
 
virtual void Start ()
 
void fillRecords (string[] list)
 
virtual void onRecordsChange ()
 
virtual void onProvider ()
 
virtual void onErrorProvider (string info)
 

Protected Attributes

override Crosstales.DJ.RecordsChangeEvent onRecordsChanged => OnRecordsChanged
 
override Crosstales.DJ.ProviderReadyEvent onProviderReady => OnProviderReadyEvent
 
override Crosstales.DJ.ErrorProviderEvent onErrorProviderInfo => OnErrorProviderInfo
 
- Protected Attributes inherited from Crosstales.DJ.Provider.BaseRecordProvider
System.Collections.Generic.List< Crosstales.DJ.Model.Recordrecords = new System.Collections.Generic.List<Crosstales.DJ.Model.Record>()
 
bool loading
 
string errorMessage
 

Properties

System.Collections.Generic.List< string > Files [get, set]
 Files (records) with full path. More...
 
- Properties inherited from Crosstales.DJ.Provider.BaseRecordProvider
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.RecordRecords [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.RecordRecords [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...
 

Additional Inherited Members

- Public Member Functions inherited from Crosstales.DJ.Provider.BaseRecordProvider
virtual void Load (bool forceReload=false)
 Loads all audio records for this provider. More...
 
- Static Protected Member Functions inherited from Crosstales.DJ.Provider.BaseRecordProvider
static string determineAudioFormatExtension (Crosstales.DJ.Model.Enum.AudioFormat audioFormat=Crosstales.DJ.Model.Enum.AudioFormat.MP3)
 
- Events inherited from Crosstales.DJ.Provider.BaseRecordProvider
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

File based record provider.

Property Documentation

◆ Files

System.Collections.Generic.List<string> Crosstales.DJ.Provider.RecordProviderFile.Files
getset

Files (records) with full path.


The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/DJ/Scripts/Provider/RecordProviderFile.cs