Crosstales.DJ.Model.RecordFilter Class Reference

Filter for audio records. More...

Public Member Functions

 RecordFilter ()
 Default-constructor for a RecordFilter. More...
 
 RecordFilter (RecordFilter filter)
 Clone-constructor for a RecordFilter. More...
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
override string ToString ()
 

Public Attributes

string FilePath = string.Empty
 Part of the record file path. More...
 
string Name = string.Empty
 Part of the record names. More...
 
string Title = string.Empty
 Part of the record title. More...
 
string Artist = string.Empty
 Part of the record artist. More...
 
string Album = string.Empty
 Part of the record album. More...
 
string Genres = string.Empty
 Part of the record genres. More...
 
string Format = string.Empty
 Part of the record formats. More...
 
int Limit
 Limit number of results (default: 0 = unlimited). More...
 
bool isFiltering
 Are filter parameters set and active? More...
 

Properties

float RatingMin [get, set]
 Minimal rating (range: 0-4.9). More...
 
float RatingMax [get, set]
 Maximal rating (range: 0.1-5). More...
 
int YearMin [get, set]
 Minimal year of the record (range: 0-9998). More...
 
int YearMax [get, set]
 Maximal year of the record (range: 1-9999). More...
 

Detailed Description

Filter for audio records.

Constructor & Destructor Documentation

◆ RecordFilter() [1/2]

Crosstales.DJ.Model.RecordFilter.RecordFilter ( )

Default-constructor for a RecordFilter.

◆ RecordFilter() [2/2]

Crosstales.DJ.Model.RecordFilter.RecordFilter ( RecordFilter  filter)

Clone-constructor for a RecordFilter.

Member Data Documentation

◆ Album

string Crosstales.DJ.Model.RecordFilter.Album = string.Empty

Part of the record album.

◆ Artist

string Crosstales.DJ.Model.RecordFilter.Artist = string.Empty

Part of the record artist.

◆ FilePath

string Crosstales.DJ.Model.RecordFilter.FilePath = string.Empty

Part of the record file path.

◆ Format

string Crosstales.DJ.Model.RecordFilter.Format = string.Empty

Part of the record formats.

◆ Genres

string Crosstales.DJ.Model.RecordFilter.Genres = string.Empty

Part of the record genres.

◆ isFiltering

bool Crosstales.DJ.Model.RecordFilter.isFiltering
Initial value:
=>
!string.IsNullOrEmpty(FilePath) ||
!string.IsNullOrEmpty(Name) ||
!string.IsNullOrEmpty(Title) ||
!string.IsNullOrEmpty(Artist) ||
!string.IsNullOrEmpty(Album) ||
!string.IsNullOrEmpty(Genres) ||
ratingMin > 0f ||
ratingMax < 5f ||
yearMin > 0 ||
yearMax < 9999 ||
Limit != 0 ||
!string.IsNullOrEmpty(Format)

Are filter parameters set and active?

Returns
True if filter parameters are set and active.

◆ Limit

int Crosstales.DJ.Model.RecordFilter.Limit

Limit number of results (default: 0 = unlimited).

◆ Name

string Crosstales.DJ.Model.RecordFilter.Name = string.Empty

Part of the record names.

◆ Title

string Crosstales.DJ.Model.RecordFilter.Title = string.Empty

Part of the record title.

Property Documentation

◆ RatingMax

float Crosstales.DJ.Model.RecordFilter.RatingMax
getset

Maximal rating (range: 0.1-5).

◆ RatingMin

float Crosstales.DJ.Model.RecordFilter.RatingMin
getset

Minimal rating (range: 0-4.9).

◆ YearMax

int Crosstales.DJ.Model.RecordFilter.YearMax
getset

Maximal year of the record (range: 1-9999).

◆ YearMin

int Crosstales.DJ.Model.RecordFilter.YearMin
getset

Minimal year of the record (range: 0-9998).


The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/DJ/Scripts/Model/RecordFilter.cs
int Limit
Limit number of results (default: 0 = unlimited).
Definition: RecordFilter.cs:70
string FilePath
Part of the record file path.
Definition: RecordFilter.cs:13
string Name
Part of the record names.
Definition: RecordFilter.cs:16
string Genres
Part of the record genres.
Definition: RecordFilter.cs:28
string Album
Part of the record album.
Definition: RecordFilter.cs:25
string Title
Part of the record title.
Definition: RecordFilter.cs:19
string Artist
Part of the record artist.
Definition: RecordFilter.cs:22
string Format
Part of the record formats.
Definition: RecordFilter.cs:61