Pause-API#

Bei Sonderprogrammen kann es wünschenswert sein, dass der Replacer eine Zeitlang nicht ersetzt und keine Titel tauscht. Etwa bei einem Hit-Countdown. Der Replacer kann dazu in den Pause-Modus versetzt werden. In dieser Zeit wird das Simulcast-Signal einfach weitergeleitet. Die Pause gilt für alle Kanäle auf dem Replacer. Es kann also nicht nur für einen einzelnen Kanal pausiert werden.

Der Pause-Modus wird durch den Aufruf einer URL der Replacer-API ausgelöst. Zwei Parameter müssen übermittelt werden:

  • sleep_duration: Der Pause-Zeitraum in Minuten. Etwa 60 für eine Stunde Pause.

  • api_key: Der Zugangs-Schlüssel zur API.

Aufbau der Pause URL#

replacer-<station_key>.radio-creator.com:5008/api/pause?sleep_duration=<sleep_duration>&api_key=<api_key>

Beispiel:

replacer-ffh.radio-creator.com:5008/api/pause?sleep_duration=60&api_key=12345678-1234-5678-1234-123456789012

Pause beenden: Resume#

Nach der eingestellten Zeit beginnt der Replacer von alleine wieder mit dem Ersetzen. Die Pausezeit kann durch erneutes Aufrufen der Pause-API verlängert oder verkürzt werden. Es gilt immer die Pause-Zeit in Minuten ab dem Aufruf der API. Die Pause kann aber auch sofort mit dem Resume-Befehl beendet werden. Dieser API-Endpoint benötigt nur den api_key als Parameter:

replacer-<station_key>.radio-creator.com:5008/api/resume?api_key=<api_key>