Browser¶
Imports¶
In Protobuf files:
import "melo/api/Browser.proto";
In C++ files:
#include <melo/api/Browser.pb.h>
Descriptor¶
This message describe a Browser node.
Field |
Type |
Label |
Description |
|---|---|---|---|
name |
string |
Name of the browser
|
|
description |
string |
Description of the browser
|
|
icon |
string |
Icon ID of the browser
|
Entry¶
This message describe one entry in a Browser path.
Field |
Type |
Label |
Description |
|---|---|---|---|
id |
string |
ID of the media (used in path)
|
|
type |
Entry.Type |
Type of the entry
|
|
name |
string |
Displayed name
|
|
media |
melo.api.media.Media |
Media when entry is media type
|
Event¶
This message is used as payload for Browser Event messages.
Request¶
This message is used as payload for Browser Request messages.
Field |
Type |
Label |
Description |
|---|---|---|---|
list |
Request.List |
List entries for a specific path
|
|
queue |
Request.Queue |
Queue an entry to player
|
Request.List¶
Message to list entries
Field |
Type |
Label |
Description |
|---|---|---|---|
path |
string |
Path to list
|
Request.Queue¶
Message to queue an entry
Field |
Type |
Label |
Description |
|---|---|---|---|
path |
string |
Path to the entry to queue
|
|
play |
bool |
Queue and play immediately
|
Response¶
This message is used as payload for Browser 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
|
|
token |
string |
Optional token to fetch more entries
|
|
entries |
Entry |
repeated |
List of entries
|
Entry.Type¶
Type of entry
Name |
Number |
Description |
|---|---|---|
ENTRY_TYPE_MEDIA |
0 |
Entry is a media
|
ENTRY_TYPE_FOLDER |
1 |
Entry is a folder
|