radioplayer

Metadaten an den radioplayer übermitteln

Wir empfehlen Ihnen Metadaten zu Ihren Radio-Streams an uns zu senden, damit die Nutzer des Radioplayers möglichst viele Zusatzinformationen zu Ihren Programmen abrufen können.

Die an uns übermittelten Informationen werden automatisch an die Desktop-Konsolen und Apps verteilt. Radioplayer kann Informationen über die Station selbst, die Sendungen, bis hin zum gerade laufenden Titel verarbeiten. Alle diese Daten werden von unserer Suchmaschine indiziert. Spielen Sie zum Beispiel Rihanna on air und jemand sucht gerade in diesem Moment in der Radioplayer-Suche nach Rihanna, erscheint Ihr Sender in den Suchergebnissen. Ebenso beeinflussen auch in der Vergangenheit gespielte Songs die Suche entsprechend.

Die Grundlagen

Die Radioplayer-Metadaten sind eine Erweiterung der DAB EPG specification. Diese teilen sich in folgende Bereiche auf:

SI (Service Information)

Dies sind die grundlegenden Daten zu Ihrer Station. Sie beinhalten zum Beispiel den Sendernamen, das Logo, die Beschreibung, etc… Sie spezifizieren jedoch noch nicht, welche Sendung gerade on air ist, oder welcher Song läuft.

URL: https://ingest.radioplayer.at/ingestor/metadata/v1/si/

PI (Programme Information)

Sie können Beginn, Ende und Beschreibung einer Sendung an uns übermitteln. Zusätzlich kann zum Beispiel eine URL angegeben werden, unter der die Sendung nach Ausstrahlung als On Demand Inhalt zur Verfügung steht.

URL: https://ingest.radioplayer.at/ingestor/metadata/v1/pi/

OD (On Demand)

In diesem Zusammenhang bezieht sich On Demand nicht auf komplette vergangene Sendungen, sondern auf Inhalte, die in Ergänzung hierzu zur Verfügung gestellt werden sollen. Zum Beispiel Podcasts von Ihrer Comedy, etc..

URL: https://ingest.radioplayer.at/ingestor/metadata/v1/od/

PE (Programme Event)

Programme Events werden genutzt, um Informationen über den aktuellen Song zu übermitteln.

URL: https://ingest.radioplayer.at/ingestor/metadata/v1/pe/

Der Ablauf

Radioplayer stellt die aktuellen XML-Spezifikationen auf dieser Seite zum Download bereit. Die Spezifikationen sind sehr detailliert und beinhalten Links zu den entsprechenden XSDs. Sollten Sie Fragen haben, wenden Sie sich gerne an unser Support-Team.

Im Anschluss müssen Sie Ihre Playout-Systeme so anpassen, dass die benötigten Informationen im passenden Format von Ihnen übermittelt werden können. Gerne können Sie uns vorab Beispiel-XML-Dateien zusenden, damit wir diese überprüfen können.

Die Übermittlung der XML-Metadaten erfolgt mittels HTTP-POST. Unsere Implementation weicht dabei etwas von den üblichen Systemen ab. Dies ist darin begründet, dass unsere Systeme die Daten asynchron verarbeiten. Anstelle einer direkten Rückmeldung erhalten Sie nur eine URL als Rückgabe. Unter dieser URL kann der Verarbeitungs-Status im Anschluss abgefragt werden.

Ein PI-XML-Dokument kann mittels des folgenden Befehls an die Schnittstelle übermittelt werden:

curl -X POST -H „Content-Type:APPLICATION/OCTET-STREAM“ –data-binary @<filename> -u „ingestuser:ingestpassword“ „https://ingest.radioplayer.at/ingestor/metadata/v1/pi“

Eine Sonderstellung nehmen die PE (Programme Events) ein. Diese müssen nicht zwingelnd als XML übermittelt werden, sondern können direkt als HTTP-Aufruf übermittelt werden. Zum Beispiel mittels Curl:

curl -k -v -u „ingestuser:ingestpassword“ -X POST –data „rpId=99&startTime=2014-10-13T10:44:00&duration=600&title=Postcards&artist=James+Blunt“ https://ingest.radioplayer.at/ingestor/metadata/v1/np/

Folgende Parameter müssen dabei übermittelt werden:

  • rpId: ID des jeweiligen Kanals (siehe Konsole)
  • startTime: Start-Zeitpunkt des aktuellen Songs. Hinweis: Die startTime muss in ISO8601 mit der Zeitzone UTC angegeben werden. Empfohlen wird das Format: YYYY-MM-DDThh:mm:ss
  • duration: Die Dauer des aktuellen Songs in Sekunden. Angabe in vollen Sekunden, ohne Nachkommastellen.
  • title: Titel des aktuellen Songs (max. 128 Zeichen)
  • artist: Interpret des aktuellen Songs (max. 128 Zeichen)
  • description (optional): Eine Beschreibung (max. 180 Zeichen)
  • imageUrl(optional): Eine absolute URL zu einem Bild, welches in den Suchergebnissen angezeigt wird. (Das Bild muss eine Größe von 86×48 Pixel aufweisen)

Hierbei ist zu beachten:

  • Die Daten müssen zwingend mittels POST übergeben werden. Für den Falls, dass dies in Ihrer technischen Umgebung nicht möglich ist, haben wir ein kleines PHP-Skript erstellt. Dies nimmt die Daten mittels GET entgegen und leitet sie per POST weiter. Es steht am Ende dieser Seite zum Download bereit.
  • Die Werte der title- und artist-Parameter müssen urlencoded übermittelt werden
  • Kommt es bei Ihren Streamingservern zu einem zeitlichen Delay (z.B. durch Transcoding, Ad-Injection etc…), empfehlen wir, die Startzeit entsprechend um das Delay zu erhöhen. Ansonsten erscheinen die PE nicht mehr synchron zu den Songs in der Konsole und den Apps.

Rückgabewerte auslesen

Nach jeder Anfrage erhalten Sie eine direkte Rückmeldung über den HTTP-Status-Code:

202 Accepted

Die Anfrage / das Dokument wurde erfolgreich entgegengenommen und wird von unseren Systemen nun verarbeitet.

Sie erhalten zudem ein HTTP-Header-Feld „Location“, in welchem die URL zur Abfrage des Verarbeitungsstatus mitgeteilt wird.

< HTTP/1.1 202 Accepted
< Server: Apache
< Set-Cookie: JSESSIONID=625071D14AE4F16E4A8E26466F5E9BD5; Path=/ingestor/; Secure; HttpOnly
< Location: https://ingest.radioplayer.at/ingestor/metadata/v1/946142
< Content-Length: 0
< Connection: close
< Content-Type: text/plain; charset=UTF-8

Unter dieser URL erhalten Sie dann die jeweiligen Informationen im JSON-Format:

{
 „id“:“261702″,
„timestamp“:“30Mar2012 17:17:04 BST“,
„protocol“:“Http“,
„type“:“PI“,
„scope“:“ RpIds:308 startTime:20120120T00:00:00Z, stopTime:20120121T00:00:00Z“,
„downstreamStatuses“:[
{
„downstream“:“solr“,
„status“:“accepted“
}
]
}

503 RetryAfter

Es befinden sich zu viele Anfragen / Dokumente von Ihnen in der Warteschlange. Sollten Sie diesen Fehler sehr oft erhalten, kontaktieren Sie bitte unser Support-Team.

Podcast-Kategorien für XML-API

[müssen noch eingefügt werden]

Weiter

Stay up to date!