Player Queue¶
Imports¶
In Protobuf files:
import "melo/api/PlayerQueue.proto";
In C++ files:
#include <melo/api/PlayerQueue.pb.h>
Entry¶
This message describe one entry in the PlayerQueue.
Field |
Type |
Label |
Description |
|---|---|---|---|
id |
string |
ID of the media (used in path)
|
|
media |
melo.api.media.Media |
Media when entry is media type
|
Event¶
This message is used as payload for PlayerQueue Event messages.
Field |
Type |
Label |
Description |
|---|---|---|---|
added |
Event.Added |
New entry added
|
Event.Added¶
Message when a new entry is added
Field |
Type |
Label |
Description |
|---|---|---|---|
entry |
Entry |
The newly added entry
|
|
after |
string |
ID of the entry to place after
|
Request¶
This message is used as payload for PlayerQueue Request messages.
Field |
Type |
Label |
Description |
|---|---|---|---|
list |
Request.List |
List entries
|
Request.List¶
Message to list entries
Response¶
This message is used as payload for PlayerQueue Response messages.
Field |
Type |
Label |
Description |
|---|---|---|---|
list |
Response.List |
List of entries
|
Response.List¶
Message with list of entries
Field |
Type |
Label |
Description |
|---|---|---|---|
count |
int32 |
Total count of entries in the path (-1 for undefined)
|
|
offset |
uint32 |
Current offset in the list
|
|
entries |
Entry |
repeated |
List of entries
|