Callaba Engine-Dokumentation
Mit der Callaba Engine API automatisieren Sie Live-Video-Workflows durchgängig: SRT- oder RTMP-Feeds empfangen, routen oder transcodieren, aufzeichnen und für die Browser-Wiedergabe bereitstellen. Wählen Sie den Abschnitt, der zu Ihrer Aufgabe passt.
Geeignet, wennSie kennen das gewünschte Videoergebnis, aber noch nicht die dafür benötigte Callaba-Ressource.
Anderes Modul verwenden, wennÖffnen Sie ein Modul direkt, wenn Sie bereits wissen, welche Ressource den Job ausführt.
Wählen Sie ein Modul nach Ergebnis
| Ziel | Beginnen Sie mit | Danach hinzufügen | Anderes Modul wählen, wenn |
|---|---|---|---|
| OBS oder einen anderen RTMP-Publisher empfangen | RTMP-Server | Aufzeichnung, Restream oder Webplayer | Die Quelle sendet SRT anstelle von RTMP |
| Einen ausfallsicheren SRT-Contribution-Stream empfangen | SRT-Server | Multiview, Aufzeichnung oder Restream | Sie benötigen nur unveränderte SRT-Weiterleitung |
| Senden Sie eine Live-Quelle an Plattformen oder ein anderes Protokoll | Restreams | Webplayer oder Aufzeichnung | Die Übergabe bleibt bei SRT und benötigt keine Verarbeitung |
| Mehrere Live-Feeds gemeinsam überwachen | Multiview | SRT-Failover oder Aufzeichnung | Die Ausgabe ist für Zuschauer statt für Operatoren bestimmt |
| Verwandeln Sie eine Live-Quelle in eine Datei | Aufzeichnungen | Dateien und Speicherziele | Die Medien existieren bereits als Datei |
| Browser-Wiedergabe bereitstellen | Webplayer | Webplayer-Gruppen | Operatoren benötigen stattdessen einen Multiviewer |
| Remote-Gäste in Produktion bringen | Videoanrufe | NDI-Adapter oder Aufzeichnung | Der Contributor sendet über einen Encoder |
Voraussetzungen
- Bereitstellen oder starten Sie eine Callaba Engine-Instanz und notieren Sie sich die Basis-URL.
- Erstellen Sie ein API-Token in Allgemeine Einstellungen.
- Senden Sie das Token im
x-access-token-Header über HTTPS. - Bewahren Sie das Token in einem Backend oder einer anderen vertrauenswürdigen Umgebung auf.
Funktionen
- Ingest: Contribution-Streams über SRT-Server, RTMP-Server, Streams oder Videoanrufe empfangen.
- Routen und verarbeiten: SRT-Routen, Restreams, NDI-Adapter und Aufzeichnungen einsetzen.
- Speichern und ausliefern: Dateien und Speicherziele verwalten und Medien anschließend über Webplayer oder Webplayer-Gruppen bereitstellen.
- Betreiben: Ressourcen starten, stoppen, aktualisieren und entfernen sowie – sofern unterstützt – Laufzeitstatistiken prüfen.
Beispiel-Workflow
- Erstellen Sie einen SRT- oder RTMP-Server für den Contribution-Feed.
- Erstellen Sie eine Aufzeichnung oder einen Restream, der den Server als Eingabe verwendet.
- Erstellen Sie einen Webplayer, wenn die Ausgabe in einem Browser angezeigt werden muss.
- Starten Sie die Ressourcen in Abhängigkeitsreihenfolge und überprüfen Sie deren Laufzeitstatus.
- Stoppen Sie nachgelagerte Jobs, bevor Sie die Ingest-Ressource entfernen.
Typische Anwendungsfälle
- Wiederholbare Contribution-, Aufzeichnungs- und Wiedergabe-Workflows für regelmäßige Veranstaltungen bereitstellen.
- Ein Buchungs-, Kontrollraum- oder Kundenportal mit dem Live-Video-Betrieb verbinden.
- Betreiben Sie mehrere Callaba-Instanzen mit der gleichen Bereitstellungs- und Überwachungslogik.
Einschränkungen und Fehlerbehebung
Prüfen Sie Kennungen, Enum-Werte, Ports und erforderliche verschachtelte Objekte, bevor Sie eine Anfrage senden. Eine gespeicherte Ressource belegt noch nicht, dass der zugehörige Medienprozess einwandfrei läuft; prüfen Sie deshalb nach dem Start die Laufzeitstatistiken. Beachten Sie Abhängigkeiten: Eine Eingabe funktioniert nicht mehr, sobald die vorgelagerte Ressource gestoppt oder entfernt wurde.
Nächste Schritte
Lesen Sie zuerst Installation oder Sofortstart und anschließend Autorisierung. Öffnen Sie danach das Modul für die erste Stufe Ihres Workflows.
Ingest, Monitoring, Aufzeichnung und Ausgabe kombinieren
Bauen Sie eine Produktionssteuerung in Abhängigkeitsreihenfolge: Contribution-Feed empfangen, Operatoren bereitstellen, aufzeichnen und separat beobachtbare Ausgaben pro Ziel erstellen.
- Contribution-Ingest erstellenDefinieren Sie Listener, Latenz, Zugriffsrichtlinie und freigegebene Primär-/Backup-Routing-Hosts.
POST /api/srt-servers/create - Quelle starten und prüfenStellen Sie die Upstream-Grenze fehlerfrei bereit, bevor abhängige Ressourcen starten.
POST /api/srt-servers/start - Operator-Monitoring erstellenFügen Sie die geprüfte Quelle einem authentifizierten Operator-Layout hinzu.
POST /api/multiview/create - Operator-Wand startenPrüfen Sie den Contribution-Feed visuell vor Capture- und Ausgabezweigen.
POST /api/multiview/start - Archiv-Zweig erstellenVerbinden Sie das dokumentierte SRT-Eingabe-Preset mit Aufnahmeformat und Aufbewahrungsrichtlinie.
POST /api/recording/create - Aufzeichnung startenStarten Sie den Archiv-Zweig, nachdem das Operator-Monitoring nutzbare Medien bestätigt.
POST /api/recording/start - Ausgabezweige erstellenErstellen Sie einen Job pro Ziel mit nur dem benötigten Remuxing oder Transcoding.
POST /api/restream/create - Downstream-Ausgabe startenStarten Sie Ausgaben unabhängig, damit ein Ziel die anderen nicht blockiert.
POST /api/restream/start - Jede Ausgabe beobachtenVergleichen Sie Prozessstatus, Bitrate und Bildrate pro Zweig während des Events.
POST /api/restream/getStat
Modul-IDs sind nicht austauschbar. Verwenden Sie das exakte Eingabe-Preset und die source_id der jeweiligen Downstream-Create-Methode, starten Sie Upstream-Abhängigkeiten zuerst und rollen Sie nur den fehlerhaften Zweig zurück.
SRT empfangen, aufzeichnen und im Browser wiedergeben
Kombinieren Sie Ingest, Routing-Steuerung, Aufzeichnung und Browser-Wiedergabe über eine Callaba-API. Bauen Sie in Abhängigkeitsreihenfolge und ergänzen Sie denselben Workflow in Cloud- oder Self-Hosted-Deployments um Storage, Multiview oder Restream.
- SRT-Ingest erstellenKonfigurieren Sie Listener, Latenz, Zugriffsregeln und Quellen-Routing.
POST /api/srt-servers/create - Ingest starten und prüfenStarten Sie den Server, bevor Sie Jobs erstellen, die von seinem Live-Eingang abhängen.
POST /api/srt-servers/start - Archiv-Job erstellenWählen Sie das SRT-Server-Eingabe-Preset und die gewünschte kontinuierliche oder segmentierte Ausgabe.
POST /api/recording/create - Aufzeichnung startenStarten Sie die Aufzeichnung erst, wenn der Contribution-Eingang fehlerfrei arbeitet.
POST /api/recording/start - Browser-Ausgabe erstellenVerwenden Sie das SRT-Server-Eingabe-Preset und konfigurieren Sie anschließend HLS oder DASH sowie den Zuschauerzugriff.
POST /api/vod/create - Wiedergabe starten und testenStarten Sie den Player, prüfen Sie seinen Laufzeitstatus und testen Sie die Zuschauer-URL.
POST /api/vod/start
Jede Create-Antwort liefert die Ressourcen-ID für den zugehörigen Start-Aufruf. Verwenden Sie das Eingabe-Preset des nachgelagerten Moduls und ersetzen Sie es nicht durch die ID eines anderen Ressourcentyps.
Einen Gottesdienst von Ingest zu Multistreaming, Aufzeichnung und Wiedergabe führen
Bauen Sie einen wiederholbaren Gottesdienst-Workflow in Abhängigkeitsreihenfolge auf: Programm-Feed annehmen, Ziele starten, Gottesdienst aufzeichnen und Browser-Wiedergabe veröffentlichen.
- Gottesdienst-Ingest erstellenKonfigurieren Sie den RTMP-Einstiegspunkt für den Encoder der Kirche.
POST /api/rtmp-servers/create - Ingest starten und prüfenStarten Sie den Server vor der Encoder-Verbindung und prüfen Sie den Quellenzustand.
POST /api/rtmp-servers/start - Plattform-Ziele erstellenErstellen Sie pro Plattform einen Restream-Job aus dem geprüften Programm-Eingang.
POST /api/restream/create - Multistream-Ausgabe startenStarten Sie Ziele unabhängig, damit eine Plattform den Zustand einer anderen nicht verdeckt.
POST /api/restream/start - Gottesdienst-Aufzeichnung erstellenBinden Sie einen Aufzeichnungs-Job an dieselbe geprüfte Programmquelle.
POST /api/recording/create - Archiv-Aufzeichnung startenStarten Sie die Aufzeichnung bei stabilem Ingest und behalten Sie die zurückgegebene Recording-ID.
POST /api/recording/start - Wiedergabe für die Kirchenwebsite erstellenKonfigurieren Sie den Browser-Player und den vorgesehenen Zuschauerzugriff.
POST /api/vod/create - Wiedergabe starten und testenStarten Sie den Player und testen Sie die Zuschauer-URL vor der Veröffentlichung.
POST /api/vod/start
Erstellen und starten Sie jede Ressource mit der ID ihres eigenen Moduls. Prüfen Sie den Live-Eingang, bevor Sie Ziele, Aufzeichnung oder Zuschauer-Wiedergabe aktivieren.
Eine Sportveranstaltung von Monitoring zu Paywall und Replay führen
Kombinieren Sie einen Venue-Workflow, der das Programm für Operatoren sichtbar hält, die Veranstaltung aufzeichnet, Browser-Wiedergabe veröffentlicht und kontrollierten Gruppenzugriff startet.
- Venue-Ingest erstellenKonfigurieren Sie den RTMP-Einstiegspunkt für das freigegebene Veranstaltungsprogramm.
POST /api/rtmp-servers/create - Programm-Ingest startenStarten Sie den Server und bestätigen Sie die Contribution vor nachgelagerten Schritten.
POST /api/rtmp-servers/start - Operator-Monitoring erstellenFügen Sie Programm und kritische Ausgänge zu einem Event-Multiview hinzu.
POST /api/multiview/create - Operator-Ansicht startenStarten Sie die Wall und prüfen Sie jede erforderliche Quelle vor der Zugriffsfreigabe.
POST /api/multiview/start - Event-Aufzeichnung erstellenKonfigurieren Sie die Aufzeichnung des freigegebenen Programm-Eingangs.
POST /api/recording/create - Event-Aufzeichnung startenStarten Sie die Aufzeichnung, wenn Contribution und Monitoring fehlerfrei arbeiten.
POST /api/recording/start - Aufzeichnung abschließenStoppen Sie die Aufzeichnung sauber am Ende der Live-Veranstaltung.
POST /api/recording/stop - Replay-Medien lesenLesen Sie recordedFiles aus der abgeschlossenen Aufzeichnung vor dem Replay-Aufbau.
POST /api/recording/getById - Event-Wiedergabe erstellenKonfigurieren Sie den Live- oder Replay-Player mit den vorgesehenen Zugriffseinstellungen.
POST /api/vod/create - Zuschauer-Wiedergabe startenStarten Sie den Player und prüfen Sie Zuschauer-URL und Laufzeitstatus.
POST /api/vod/start - Kontrollierten Zugriff erstellenGruppieren Sie den Event-Player unter der geprüften Paywall- oder Zugriffsrichtlinie.
POST /api/vod-group/create - Zugriffsgruppe startenStarten Sie die Gruppe erst, wenn Wiedergabe und externe Berechtigungsprüfung bereit sind.
POST /api/vod-group/start
Stoppen und lesen Sie die Aufzeichnung, bevor Sie sie als Replay-Medium verwenden. Eine Player-Gruppe steuert den Zugriff auf konfigurierte Player; sie ersetzt keine externe Zahlungs- oder Berechtigungsprüfung.