collection_full_songs

🟡 Incomplete

This API's output may have additions in the future.


Retrieve an array of every Song object in the current Collection.

The returned array is in incrementing key order, as in:

Song 0,
Song 1,
Song 2,

[... etc ...]

Inputs

None

Outputs

FieldTypeDescription
lenunsigned integerHow many Song's there are
songsarray of Song objectsEvery Song in the Collection

Example Request

festival-cli collection_full_songs
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"collection_full_songs"}'

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "len": 2,
    "songs": [
      {
        "title": "Song Title 1",
        "key": 0,
        "album": 0,
        "runtime": 371,
        "sample_rate": 96000,
        "track": 1,
        "disc": 1,
        "mime": "audio/x-flac",
        "extension": "flac"
      },
      {
        "title": "Song Title 2",
        "key": 1,
        "album": 0,
        "runtime": 348,
        "sample_rate": 96000,
        "track": 2,
        "disc": 1,
        "mime": "audio/x-flac",
        "extension": "flac"
      }
    ]
  },
  "id": 0
}