Aufzeichnungen
Verwenden Sie Aufzeichnungen, um eine Live-Eingabe als fortlaufende Datei oder als zeitlich begrenzte Segmente für Archivierung, Wiedergabe, Compliance oder Postproduktion zu erfassen.
Geeignet, wennEine Live-Quelle soll als fortlaufende oder segmentierte Datei gespeichert werden.
Anderes Modul verwenden, wennVerwenden Sie Dateien für bereits gespeicherte Medien oder Restreams, wenn die Ausgabe live bleiben soll.
/api/recording/createVoraussetzungen
Alle Methoden erfordern einen gültigen x-access-token. Erstellen oder prüfen Sie zuerst die Eingabe, stellen Sie ausreichenden lokalen Speicherplatz sicher, wählen Sie das Ausgabeformat und legen Sie vor der Veranstaltung die gewünschte Aufbewahrungsregel fest.
Funktionen
createundupdatekonfigurieren Eingabe, Format, Aufnahmemodus, Verarbeitung und Aufbewahrung.getAll,getCountundgetByIdprüfen Jobs und erzeugte Dateien.startundstopsteuern die Aufzeichnung.getStatmeldet verfügbare Bitrate, Frame-Cadence, Codierungsgeschwindigkeit und Ausgabefortschritt.removeFilelöscht eine produzierte Datei, ohne den Job zu entfernen.removelöscht den Aufnahmeauftrag.
Beispiel-Workflow
- Erstellen Sie einen Job von einem SRT-Server, einem RTMP-Server, einer Videoanrufquelle oder einer unterstützten Stream-URL.
- Wählen Sie MP4, HLS oder ein anderes unterstütztes Ausgabeformat sowie einen fortlaufenden oder segmentierten Modus.
- Starten Sie den Job vor dem erforderlichen Erfassungsfenster.
- Verwenden Sie
getStat, um zu bestätigen, dass die Eingabebitrate und die Ausgabezeit weiter voranschreiten. - Stoppen Sie den Job, prüfen Sie die Dateien und kopieren Sie sie in das konfigurierte Speicherziel.
Typische Anwendungsfälle
- Erstellen Sie ein kontinuierliches Programmarchiv für eine Live-Veranstaltung.
- Teilen Sie eine lange Überwachungs- oder Broadcast-Aufzeichnung in planbare Intervalle.
- Zeichnen Sie einen kompatiblen RIST-Contribution-Feed für das Archivieren oder Wiedergeben auf.
- Führen Sie eine Backup-Aufzeichnung mit automatischer altersabhängiger Bereinigung.
Einschränkungen und Fehlerbehebung
Eine Aufzeichnung benötigt eine gesunde Live-Eingabe sowie genügend Festplatten- und Verarbeitungskapazität. Überwachen Sie die Eingabebitrate und den Aufzeichnungsfortschritt während der Ausführung, überprüfen Sie die produzierten Dateien vor der Bereinigung und testen Sie jede RIST-Quelle mit den erforderlichen Profil- und Sicherheitseinstellungen vor dem Ereignis.
Nächste Schritte
Verwenden Sie Dateien, um das Ergebnis zu prüfen oder zu übertragen, und Speicherziele, um eine dauerhafte Aufbewahrung außerhalb der Instanz zu konfigurieren.
Einen Live-Eingang kontinuierlich oder segmentiert aufzeichnen
Erstellen Sie eine Aufzeichnung aus einer fehlerfreien Live-Quelle, wählen Sie kontinuierliche oder zeitgesteuerte Ausgabe, starten und überwachen Sie sie.
- Aufzeichnung erstellenWählen Sie Quelle, Format, Modus, Verarbeitung und Aufbewahrung.
POST /api/recording/create - Aufzeichnung startenStarten Sie erst, wenn Quelle und Speicherpfad bereit sind.
POST /api/recording/start - Fortschritt überwachenBeobachten Sie Bitrate, Bildrate, Encode-Geschwindigkeit und Fortschritt.
POST /api/recording/getStat
Prüfen Sie Speicherplatz und Aufbewahrung vor dem Event. Validieren Sie erzeugte Dateien vor Löschung oder Transfer.
Eine abgeschlossene Live-Aufzeichnung als On-Demand-Wiedergabe veröffentlichen
Zeichnen Sie das Event auf, stoppen Sie die Aufzeichnung sauber, lesen Sie die fertige Datei aus recordedFiles und erstellen und validieren Sie anschließend einen Browser-Player mit dem passenden Managed-File-Preset.
- Live-Aufzeichnung erstellenWählen Sie Live-Eingang, browserkompatibles Archivformat und Aufbewahrungsrichtlinie.
POST /api/recording/create - Event-Aufzeichnung startenStarten Sie die Aufzeichnung bei fehlerfreier Quelle und bestätigter Speicherkapazität.
POST /api/recording/start - Aufzeichnung abschließenStoppen Sie den Worker am Eventende, damit die Ausgabe vor der Wiedergabe finalisiert wird.
POST /api/recording/stop - Fertige Datei ermittelnLaden Sie die Aufzeichnung erneut und wählen Sie einen abgeschlossenen recordedFiles-Eintrag für den Player.
POST /api/recording/getById - On-Demand-Wiedergabe erstellenVerwenden Sie das passende Managed-File-Preset und konfigurieren Sie Zugriff, Ausgabe und Darstellung.
POST /api/vod/create - VOD-Player startenStarten Sie den Player erst, wenn die aufgezeichnete Datei finalisiert und verfügbar ist.
POST /api/vod/start - Browser-Ausgabe validierenPrüfen Sie Prozess und Zuschauer-Ausgabe und testen Sie die erzeugte URL in repräsentativen Browsern.
POST /api/vod/getStat
Veröffentlichen Sie keine Datei, die noch geschrieben wird. Stoppen und laden Sie die Aufzeichnung, wählen Sie einen abgeschlossenen recordedFiles-Eintrag und verwalten Sie die Datei, solange der Player von ihr abhängt.
Eine Live-Quelle aufzeichnen und die fertige Datei in Object Storage kopieren
Registrieren Sie das Storage-Ziel, zeichnen Sie die Live-Quelle auf, finalisieren Sie die Aufzeichnung, ermitteln Sie den recordedFiles-Eintrag und kopieren Sie die verwaltete Datei in das geprüfte Ziel.
- Object Storage registrierenErstellen Sie das geprüfte S3- oder Backblaze-Ziel mit Bucket- und Metadatenkonfiguration.
POST /api/storages/create - Gespeichertes Ziel prüfenBestätigen Sie die nicht geheimen Zielfelder und behalten Sie die ID für den Kopiervorgang.
POST /api/storages/getById - Capture-Job erstellenWählen Sie das geprüfte Live-Eingabe-Preset, Ausgabeformat, Segmentierung und Aufbewahrungsverhalten.
POST /api/recording/create - Aufzeichnung startenStarten Sie erst bei fehlerfreier Upstream-Quelle und geprüfter lokaler Kapazität.
POST /api/recording/start - Recording-Worker überwachenBeobachten Sie Bitrate, FPS, Fortschritt und Prozessstatus während des Schreibens.
POST /api/recording/getStat - Ausgabe finalisierenStoppen Sie die Aufzeichnung sauber, bevor Sie die erzeugte Datei übertragen.
POST /api/recording/stop - recordedFiles ermittelnLaden Sie den Job erneut und wählen Sie die finalisierte Managed-File-ID aus recordedFiles.
POST /api/recording/getById - In das Ziel-Storage kopierenSenden Sie Datei-ID, geprüften Storage-Typ und Storage-ID und verfolgen Sie anschließend den dokumentierten Fortschritt.
POST /api/files/copyTo
Storage-Zugangsdaten sind schreibgeschützte Betriebsgeheimnisse. Stoppen und laden Sie die Aufzeichnung erneut, bevor Sie eine recordedFiles-ID verwenden, und überwachen Sie den Kopierfortschritt, statt eine erfolgreiche Anfrage mit abgeschlossenem Transfer gleichzusetzen.
Erstellen Sie einen verwalteten Aufzeichnungsjob mit Quelle, Ausgabeformat, Segmentierung, optionaler Verarbeitung, Aufbewahrungsregeln und anfänglichem Aktivstatus. Senden Sie das im Dashboard erzeugte JWT im x-access-token-Header.
Als Quellen werden unter anderem SRT- und RTMP-Server, Videoanrufräume oder einzelne Teilnehmer sowie URL-Eingänge wie HLS, MPEG-DASH, RTSP, RTP, UDP und RIST unterstützt. Verwenden Sie für eine RIST-URL INPUT_TYPE_RIST_URL und setzen Sie input_stream_url.
Anfragebeispiele
Wählen Sie die Voreinstellung, die dem gewünschten Archivformat und Erfassungsverhalten entspricht, und fügen Sie dann nur die Verarbeitungsoptionen hinzu, die für die Ausgabe erforderlich sind.
Typische Anwendungsfälle
- Erfassen Sie eine komplette Veranstaltung als MP4 für die Archivierung oder Postproduktion.
- Erstellen Sie zeitlich segmentierte Dateien für lang laufende oder kontinuierliche Eingaben.
- Nehmen Sie die HLS-Ausgabe für einen dateibasierten Wiedergabe-Workflow auf.
Rufen Sie nach dem Start getStat auf, um Bitrate, FPS und Fortschritt zu prüfen. Die erzeugten Dateien finden Sie unter recordedFiles.
Verwenden Sie diese Voreinstellung, wenn das Hauptziel eine stabile Archivdatei aus einem Live-SRT-Contribution-Stream ist.
Dies ist die häufigste Aufzeichnungskonfiguration: Der eingehende Stream wird als fortlaufendes Archiv mit minimaler zusätzlicher Verarbeitung gespeichert.
Verwenden Sie diese Voreinstellung, wenn lange Aufnahmen in vorhersehbare Zeitfenster für die Speicherung, Automatisierung oder Postproduktion geschnitten werden sollen.
Der Aufnahmemodus wechselt von einer kontinuierlichen Datei zu rollenden Segmenten, während der Rest der Aufzeichnungspipeline weitgehend gleich bleibt.
Verwenden Sie diese Voreinstellung, wenn die Ausgabe als HLS-Medien anstelle eines klassischen Archivcontainers geschrieben werden soll.
Dies ist nützlich, wenn das gespeicherte Ausgabeformat für eine spätere Wiedergabe oder nachgelagerte Bereitstellungstools von Bedeutung ist.
Dashboard-Bezeichnung: Name.
Menschlich lesbarer Jobname. Das Dashboard validiert dies als erforderliches Feld und verwendet dieselben Zeichenregeln wie die Benutzeroberfläche: A-Z, a-z, 0-9 und -.
Der aktuelle Aufzeichnungsworkflow verwendet RECORDING_STREAM_TO_FILE.
Die Eingabedefinition basiert auf dem Quellformular. Sie bestimmt, welche Live-Quelle erfasst wird. URL-basierte RIST-Erfassung verwendet INPUT_TYPE_RIST_URL mit input_stream_url über den gemeinsamen I/O-Eingabepfad.
Dashboard-Bezeichnung: Ausgabeformat.
Unterstützte Ausgabeformate sind mp4, avi, flv, mp3, m3u8, mpegts und mkv, abhängig vom ausgewählten Eingabeprotokoll.
Dashboard-Bezeichnung: Automatischer Clip-Modus.
Steuert, ob der Recorder eine kontinuierliche Datei schreibt oder die Ausgabe nach Zeit aufteilt. Die realen Modi sind RECORDING_MODE_INFINITY und RECORDING_MODE_SPLIT_BY_TIME.
Das Dashboard sendet hours, minutes und seconds und stellt dafür eine Zeitsteuerung bereit.
Optionales Transcodierungsprofil für den FFmpeg-Worker. Das Dashboard sendet diesen Block weiterhin, wenn die Transcodierung deaktiviert ist.
Optionale Einstellungen zur Audiobearbeitung. Objekte für den deaktivierten Zustand bleiben Bestandteil des regulären Request-Bodys.
Optionale Videoänderungseinstellungen.
Optionale Overlay-Einstellungen für gebrandete oder mit Einblendungen versehene Aufnahmen.
Dashboard-Bezeichnung: Automatisch löschen nach.
Optionaler Zeitraum für die automatische Löschung in Tagen. 0 deaktiviert die automatische Löschung; auch die Benutzeroberfläche verwendet 0 als Standardwert.
Dashboard-Bezeichnung: Einmal erstellt aktivieren.
Steuert, ob der Aufzeichnungs-Worker nach der Bereitstellung aktiv sein soll.
Ressourcen-ID, die beim Erstellen oder Auflisten des Aufzeichnungsjobs zurückgegeben wird.
Kurzform für _id.
Name, der für den Aufnahmeauftrag gespeichert ist.
Aufzeichnungstyp, der vom Backend zurückgegeben wird.
Verknüpftes Eingabeobjekt oder verknüpfte Eingabeobjekte, die von der Aufzeichnungspipeline verwendet werden.
Gespeichertes Ausgabeformat für die Aufzeichnung.
Aufzeichnungsmodus und alle im Jobobjekt gespeicherten Einstellungen für die zeitbasierte Segmentierung.
Dem Aufnahmeauftrag zugeordnete Verarbeitungseinstellungen.
Bereits mit dem Auftrag verknüpfte Dateien fertiger oder segmentierter Aufnahmen.
Einstellung der automatischen Löschung in Tagen.
Aktueller Aktivstatus für den Aufzeichnungsauftrag.
Zeitstempel, die vom Backend verwaltet werden.
Bei erfolgreicher Ausführung enthält die Antwort success: true.