Metadata rádií

Pro předání informací o aktuálně hraných skladbách (nebo pořadech) můžete využít některý z následujících formátů. Ve všech variantách můžete vyplnit (až na uvedené výjimky povinných položek) položky podle potřeby. Pokud zvolíte variantu pluginu, musíte nám tento způsob použití (typ pluginu) oznámit, abychom data správně načítali. Pokud si nejste jistí výběrem, doporučujeme plugin songtext nebo jednu z variant přehledu dat. U varianty, která neobsahuje položky pro pořad a moderátora, můžete k tomuto účelu využít položky pro interpreta a skladbu.

Data pro rádia přístupná přes Play.cz umíme zpracovat automaticky (pokud mají data přes Play.cz vystavena) a není třeba mít výdej samostatně.

1. Plugin typu "songtext"

Informace o právě přehrávané skladbě nebo pořadu můžete vystavit formou jednoduchého řetězce na vlastním api, které je volně přístupné přes URL. Načtení pak probíhá prostřednictvím metody GET, protokolu HTTP/1.1. Z praktických důvodů uvažujeme jen prvních 150 znaků řetězce a ostatní znaky se ignorují. Interpreta (případně jméno moderátora) doporučujeme uvést velkými písmeny.

INTERPRET - Název skladby

2. Plugin typu "rozhlas"

Předávaná data načítáme podle statusu, který mají nastavený. Status je povinná položka. Časové údaje jsou dle uvedeného formátu (viz RFC 3339).

{
    "data": {
        "status": "quiet",                    // povinná hodnota v případě, že nic nehraje
        "since": "2021-01-29T10:59:56+01:00"  // čas od kdy nic nehraje (RFC 3339)
    }
}

{
    "data": {
        "status": "onair",
        "interpret": "Interpret",
        "track": "Název skladby",
        "since": "2021-01-29T11:05:53+01:00",  // čas začátku přehrávání skladby (RFC 3339)
    }
}

3) Přehled dat

Přehled dat je třetí možnou variantou, která nemá dohodnutý žádný plugin, kterým rozlišujeme jak data zpracovat. Data mohou být strukturovaná nebo nestrukturovaná, což rozlišujeme podle nastavené hodnoty statusu. Status určuje, zda jsou data strukturovaná nebo ne. Pozor na to, že názvy některých položek dat nemusí být u obou variant stejné.

{
    "status": "ok",                      // musí být vyplněno (např. "ok")
    "title": "Název skladby",
    "artist": "Interpret",
    "album": "Album",
    "starttime": 1598439601,             // čas (timestamp) začátku přehrávání skladby
    "moderatorName": "Jméno moderátora",
    "showName": "Název pořadu",
}

{
    "song": {
        "artist": "Interpret",
        "title": "Název skladby",
        "played_on": {
            "timestamp": 1611915950     // čas (timestamp) začátku přehrávání skladby
        }
    },
    "programme": {
        "title": "Název pořadu"
    },
    "speaker": {
        "title": "Jméno moderátora"
    }
}