StationPlaylist

object

idintegerrequiredread only

namestring

Example

Test Playlist

descriptionstring | null

Example

A playlist containing my favorite songs

typePlaylistTypesdefaultonce_per_x_songsonce_per_x_minutesonce_per_hourcustom

sourcePlaylistSourcessongsplaylistsremote_urlrequests

orderPlaylistOrdersrandomshufflesequential

remote_urlstring | null

Example

https://remote-url.example.com/stream.mp3

remote_typePlaylistRemoteTypes | null

Show child attributes

One of

PlaylistRemoteTypesstreamplaylistother

Example

stream

remote_bufferinteger

The total time (in seconds) that Liquidsoap should buffer remote URL streams.

Example

is_enabledboolean

Example

true

is_jingleboolean

If yes, do not send jingle metadata to AutoDJ or trigger web hooks.

Example

false

play_per_songsinteger

Example

play_per_minutesinteger

Example

play_per_hour_minuteinteger

Example

weightinteger

The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights.

Example

include_in_requestsboolean

Example

true

include_in_on_demandboolean

Whether this playlist’s media is included in ‘on demand’ download/streaming if enabled.

Example

true

backend_optionsArray<string>

Example

interrupt,loop_once,single_track,merge

avoid_duplicatesboolean

Example

true

preserve_queue_on_restartboolean

Don’t reset this playlist’s queue when the station is restarted or its configuration is rewritten.

Example

false

schedule_itemsArray<any>

podcastsArray<any>

playlistsArray<any>

Example

{
  "id": 0,
  "name": "Test Playlist",
  "description": "A playlist containing my favorite songs",
  "type": "default",
  "source": "songs",
  "order": "random",
  "remote_url": "https://remote-url.example.com/stream.mp3",
  "remote_type": "stream",
  "remote_buffer": 0,
  "is_enabled": true,
  "is_jingle": false,
  "play_per_songs": 5,
  "play_per_minutes": 120,
  "play_per_hour_minute": 15,
  "weight": 3,
  "include_in_requests": true,
  "include_in_on_demand": true,
  "backend_options": "interrupt,loop_once,single_track,merge",
  "avoid_duplicates": true,
  "preserve_queue_on_restart": false,
  "schedule_items": [],
  "podcasts": [],
  "playlists": []
}

Docs by Sourcey