fm.teal.feed.play

teal.fm

Documentation

main record

No description available.

Record Key tid Timestamp-based ID

Properties

artistMbIds array of string Optional

DEPRECATED: USE 'artists' INSTEAD. Array of Musicbrainz artist IDs.

artistNames array of string Optional

DEPRECATED: USE 'artists' INSTEAD. Array of artist names in order of original appearance.

duration integer Optional

The length of the track in seconds

isrc string Optional

The ISRC code associated with the recording

musicServiceUri string uri Optional

The canonical URI identifying the listening surface or music service.

originUri string uri Optional

The exact URI where the listening event originated.

playedTime string datetime Optional

The datetime at which playback began.

recordingMbId string uri Optional

The MusicBrainz recording ID URI of the track, formatted as mbid:<uuid>

releaseDiscriminant string Optional

Distinguishing information for release variants (e.g. 'Deluxe Edition', 'Remastered', '2023 Remaster', 'Special Edition'). Used to differentiate between different versions of the same base release while maintaining grouping capabilities.

maxLength: 128 bytesmaxGraphemes: 1280 graphemes
releaseMbId string uri Optional

The MusicBrainz release ID URI, formatted as mbid:<uuid>

releaseName string Optional

The name of the release/album

maxLength: 256 bytesmaxGraphemes: 2560 graphemes
submissionClientAgent string Optional

A metadata string specifying the user agent where the format is `<app-identifier>/<version> (<kernel/OS-base>; <platform/OS-version>; <device-model>)`. If string is provided, only `app-identifier` and `version` are required. `app-identifier` is recommended to be in reverse dns format. Defaults to 'manual/unknown' if unavailable or not provided.

maxLength: 256 bytesmaxGraphemes: 2560 graphemes
trackDiscriminant string Optional

Distinguishing information for track variants (e.g. 'Acoustic Version', 'Live at Wembley', 'Radio Edit', 'Demo'). Used to differentiate between different versions of the same base track while maintaining grouping capabilities.

maxLength: 128 bytesmaxGraphemes: 1280 graphemes
trackMbId string uri Optional

The MusicBrainz ID URI of the track, formatted as mbid:<uuid>

trackName string Required

The name of the track

maxLength: 256 bytesminLength: 1 bytesmaxGraphemes: 2560 graphemes
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "trackName"
    ],
    "properties": {
      "isrc": {
        "type": "string",
        "description": "The ISRC code associated with the recording"
      },
      "artists": {
        "type": "array",
        "items": {
          "ref": "fm.teal.feed.defs#artist",
          "type": "ref"
        },
        "description": "Array of artists in order of original appearance."
      },
      "duration": {
        "type": "integer",
        "description": "The length of the track in seconds"
      },
      "originUri": {
        "type": "string",
        "format": "uri",
        "description": "The exact URI where the listening event originated."
      },
      "trackMbId": {
        "type": "string",
        "format": "uri",
        "description": "The MusicBrainz ID URI of the track, formatted as mbid:<uuid>"
      },
      "trackName": {
        "type": "string",
        "maxLength": 256,
        "minLength": 1,
        "description": "The name of the track",
        "maxGraphemes": 2560
      },
      "playedTime": {
        "type": "string",
        "format": "datetime",
        "description": "The datetime at which playback began."
      },
      "artistMbIds": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "DEPRECATED: USE 'artists' INSTEAD. Array of Musicbrainz artist IDs."
      },
      "artistNames": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 256,
          "minLength": 1,
          "maxGraphemes": 2560
        },
        "description": "DEPRECATED: USE 'artists' INSTEAD. Array of artist names in order of original appearance."
      },
      "releaseMbId": {
        "type": "string",
        "format": "uri",
        "description": "The MusicBrainz release ID URI, formatted as mbid:<uuid>"
      },
      "releaseName": {
        "type": "string",
        "maxLength": 256,
        "description": "The name of the release/album",
        "maxGraphemes": 2560
      },
      "recordingMbId": {
        "type": "string",
        "format": "uri",
        "description": "The MusicBrainz recording ID URI of the track, formatted as mbid:<uuid>"
      },
      "musicServiceUri": {
        "type": "string",
        "format": "uri",
        "description": "The canonical URI identifying the listening surface or music service."
      },
      "trackDiscriminant": {
        "type": "string",
        "maxLength": 128,
        "description": "Distinguishing information for track variants (e.g. 'Acoustic Version', 'Live at Wembley', 'Radio Edit', 'Demo'). Used to differentiate between different versions of the same base track while maintaining grouping capabilities.",
        "maxGraphemes": 1280
      },
      "releaseDiscriminant": {
        "type": "string",
        "maxLength": 128,
        "description": "Distinguishing information for release variants (e.g. 'Deluxe Edition', 'Remastered', '2023 Remaster', 'Special Edition'). Used to differentiate between different versions of the same base release while maintaining grouping capabilities.",
        "maxGraphemes": 1280
      },
      "submissionClientAgent": {
        "type": "string",
        "maxLength": 256,
        "description": "A metadata string specifying the user agent where the format is `<app-identifier>/<version> (<kernel/OS-base>; <platform/OS-version>; <device-model>)`. If string is provided, only `app-identifier` and `version` are required. `app-identifier` is recommended to be in reverse dns format. Defaults to 'manual/unknown' if unavailable or not provided.",
        "maxGraphemes": 2560
      }
    }
  }
}

Lexicon Garden

@