PlayQueue
The PlayQueue
class represents a queue of tracks to be played, including the current position, owner, and access permissions.
Properties
Property | Type | Description |
---|---|---|
_id |
string |
Unique identifier for the play queue. |
Name |
string |
Name of the queue. |
CurPosition |
int |
Current position in the queue. |
Owner |
string |
UserId of the queue owner. |
Editors |
List<string> |
Usernames who can edit the queue. |
Viewers |
List<string> |
Usernames who can view the queue. |
PublicViewing |
bool |
Indicates if the queue is publicly viewable. (not including the owner, who can always view) |
PublicEditing |
bool |
Indicates if the queue is publicly editable. (not including the owner, who can always edit) |
TrackCount |
int |
Number of tracks in the queue. |
Favorite |
bool |
Indicates if the queue is marked as favorite. |
LastListen |
DateTime |
Timestamp of the last time the queue was accessed. |
Tracks |
List<DbLink> |
Tracks in the queue. |
OriginalTrackOrder |
List<string> |
Original order of track IDs in the queue. |
ResponseQueue
The ResponseQueue
class is used for HTTP responses, providing a trimmed version of the queue data suitable for client consumption.
Properties
Property | Type | Description |
---|---|---|
_id |
string |
Unique identifier for the queue. |
CurPosition |
int |
Current position in the queue. |
Name |
string |
Name of the queue. |
Owner |
string |
UserId of the queue owner. |
TrackCount |
int |
Number of tracks in the queue. |
Favorite |
bool |
Indicates if the queue is marked as favorite. |
Editors |
List<string> |
UserIds of who can edit the queue. (not including the owner, who can always edit) |
Viewers |
List<string> |
UserIds of who can view the queue. (not including the owner, who can always view) |
PublicViewing |
bool |
Indicates if the queue is publicly viewable. |
PublicEditing |
bool |
Indicates if the queue is publicly editable. |