app.rocksky.playlist.defs Documentation (EN)

playlistViewBasic object

Basic view of a playlist, including its metadata

Properties

coverImageUrl string uri Optional

The URL of the cover image for the playlist.

createdAt string datetime Optional

The date and time when the playlist was created.

curatorAvatarUrl string uri Optional

The URL of the avatar image of the curator.

curatorDid string at-identifier Optional

The DID of the curator of the playlist.

curatorHandle string at-identifier Optional

The handle of the curator of the playlist.

curatorName string Optional

The name of the curator of the playlist.

description string Optional

A description of the playlist.

id string Optional

The unique identifier of the playlist.

title string Optional

The title of the playlist.

trackArts array of stringuri Optional

Album-art URLs of up to four of the playlist's tracks, for rendering a cover mosaic when the playlist has no picture of its own.

trackCount integer Optional

The number of tracks in the playlist.

minimum: 0

uri string at-uri Optional

The URI of the playlist.

View raw schema

{
  "description": "Basic view of a playlist, including its metadata",
  "properties": {
    "coverImageUrl": {
      "description": "The URL of the cover image for the playlist.",
      "format": "uri",
      "type": "string"
    },
    "createdAt": {
      "description": "The date and time when the playlist was created.",
      "format": "datetime",
      "type": "string"
    },
    "curatorAvatarUrl": {
      "description": "The URL of the avatar image of the curator.",
      "format": "uri",
      "type": "string"
    },
    "curatorDid": {
      "description": "The DID of the curator of the playlist.",
      "format": "at-identifier",
      "type": "string"
    },
    "curatorHandle": {
      "description": "The handle of the curator of the playlist.",
      "format": "at-identifier",
      "type": "string"
    },
    "curatorName": {
      "description": "The name of the curator of the playlist.",
      "type": "string"
    },
    "description": {
      "description": "A description of the playlist.",
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the playlist.",
      "type": "string"
    },
    "title": {
      "description": "The title of the playlist.",
      "type": "string"
    },
    "trackArts": {
      "description": "Album-art URLs of up to four of the playlist's tracks, for rendering a cover mosaic when the playlist has no picture of its own.",
      "items": {
        "format": "uri",
        "type": "string"
      },
      "type": "array"
    },
    "trackCount": {
      "description": "The number of tracks in the playlist.",
      "minimum": 0,
      "type": "integer"
    },
    "uri": {
      "description": "The URI of the playlist.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "type": "object"
}

playlistViewDetailed object

Detailed view of a playlist, including its tracks and metadata