FlatRoom

Summary

Different to the Room Model, this model is used as a representation of a room’s current state in a search entry. It’s basically a flattened model of the Room Model, hence the name.

Model

{
   "cid": "",
   "dj": "",
   "favorite": false,
   "format": -1,
   "guests": -1,
   "host": "",
   "id": -1,
   "image": "",
   "media": "",
   "name": "",
   "nsfw": false,
   "capacity": 5000,
   "population": -1,
   "private": false,
   "slug": ""
}

Detail

cid

Originating site’s media ID.

Type: String
Default Value: ""

dj

Name of the DJ.

Type: String
Default Value: ""

favorite

Shows if this room is in your favorites.

Type: Boolean
Default Value: false

format

Media format. Plug’s internal indicator from which site the media originates.

Type: Number
Default Value: -1

guests

Amount of guests connected.

Type: Number
Default Value: -1

host

Name of the host.

Type: String
Default Value: ""

id

Host’s ID.

Type: Number
Default Value: -1

image

Preview image of the media currently played.

Type: String
Default Value: ""

media

Title and Author of the media currently played.

Type: String
Default Value: ""

name

Name of the room.

Type: String
Default Value: ""

nsfw

Shows if this room is marked as not safe for work.

Type: Boolean
Default Value: false

capacity

Maximum amount of user slots available. -1 means infinite.

Type: Number
Default Value: 5000

population

Current amount of users, guests are counted seperately.

Type: Number
Default Value: -1

private

Whether the room is private, as in, not listed.

Type: Boolean
Default Value: false

slug

URL conform representation of the username. Used for the profile link.

Type: String
Default Value: ""