Track
The Track
class represents a track as it appears in the
database after processing.
Properties
Property | Type | Description |
---|---|---|
_id |
string |
Unique identifier for the track. |
Album |
DbLink |
Link to the associated album. |
Position |
int |
Position of the track on the disc. |
Disc |
int |
Disc number the track is on. |
Format |
string |
Audio format of the track. |
Bitrate |
string |
Bitrate of the track. |
SampleRate |
string |
Sample rate of the track. |
Channels |
string |
Number of audio channels. |
BitsPerSample |
string |
Bits per sample of the audio. |
MusicBrainzID |
string |
MusicBrainz ID of the track. |
ISRC |
string |
International Standard Recording Code. |
Year |
string |
Year the track was released. |
Name |
string |
Title of the track. |
Path |
string |
File path to the track. |
Duration |
string |
Duration of the track. |
nextTrack |
string |
ID of the next track, if any. |
PlayCounts |
List<UserStat>
|
Play count statistics. |
SkipCounts |
List<UserStat>
|
Skip count statistics. |
Ratings |
List<UserStat>
|
User ratings for the track. |
TrackArtCount |
int |
Number of artwork images for the track. |
TrackArtDefault |
int |
Default artwork index for the track. |
LyricsPath |
string |
File path to the track's lyrics. |
ServerURL |
string |
Server URL hosting the track's resources. This value is unused. It is planned for use with listening parties in v2. |
LastModified |
DateTime |
Last modified timestamp of the track file. |
DateAdded |
DateTime |
Date when the track was added. |
ReleaseDate |
DateTime |
Release date of the track. |
Chapters |
List<Chapter>
|
Chapters within the track. |
TrackGenres |
List<string> |
Genres associated with the track. |
TrackArtists |
List<DbLink> |
Links to artists associated with the track. |
ResponseTrack
The ResponseTrack
class is a trimmed version of the
Track
class for use in HTTP responses.
Properties
All properties are the same as in the Track class, except the internal
properties Path
and LyricsPath
are excluded.
ProtoTrack Class
The ProtoTrack
class is used during the scanning process.
It represents a track before it is fully processed and saved into the
database.
Properties
Property | Type | Description |
---|---|---|
_id |
string |
Unique identifier for the proto track. |
Album |
Album |
Album associated with the track. |
Position |
int |
Position of the track on the disc. |
Disc |
int |
Disc number the track is on. |
Format |
string |
Audio format of the track. |
Bitrate |
string |
Bitrate of the track. |
SampleRate |
string |
Sample rate of the track. |
Channels |
string |
Number of audio channels. |
BitsPerSample |
string |
Bits per sample of the audio. |
MusicBrainzID |
string |
MusicBrainz ID of the track. |
ISRC |
string |
International Standard Recording Code. |
Year |
string |
Year the track was released. |
Name |
string |
Title of the track. |
Path |
string |
File path to the track. |
Duration |
string |
Duration of the track. |
nextTrack |
string |
ID of the next track, if any. |
PlayCounts |
List<UserStat>
|
Play count statistics. |
SkipCounts |
List<UserStat>
|
Skip count statistics. |
Ratings |
List<UserStat>
|
User ratings for the track. |
TrackArtCount |
int |
Number of artwork images for the track. |
TrackArtDefault |
int |
Default artwork index for the track. |
LyricsPath |
string |
File path to the track's lyrics. |
ServerURL |
string |
Server URL hosting the track's resources. |
LastModified |
DateTime |
Last modified timestamp of the track file. |
DateAdded |
DateTime |
Date when the track was added. |
ReleaseDate |
DateTime |
Release date of the track. |
Chapters |
List<Chapter>
|
Chapters within the track. |
TrackGenres |
List<string> |
Genres associated with the track. |
TrackArtists |
List<Artist> |
Artists associated with the track. |