Callaba
PreiseAnmeldenCallaba auf AWS bereitstellenEmpfohlene Region: Frankfurt.
API-DokumentationÜbersicht
Aufzeichnungen
Dateien
Webplayer
Webplayer-Gruppen
Dokumentationsnavigation ein- oder ausblenden
Callaba-Startseite

Webplayer

Verwenden Sie Webplayer, um Live- oder aufgezeichnete Medien für die Browserwiedergabe mit Zugriffskontrolle, adaptiver Bereitstellung, Einbettungen und zuschauerorientierten URLs zu veröffentlichen.

FunktionBrowser-Wiedergabe bereitstellen

Geeignet, wennEine Live- oder aufgezeichnete Quelle benötigt eine HLS- oder DASH-URL beziehungsweise Einbettung mit Zugriffskontrolle oder Pay-per-View.

Anderes Modul verwenden, wennVerwenden Sie Multiview für Operatoren oder Webplayer-Gruppen, wenn Zuschauer zwischen mehreren Playern wählen sollen.

1Stream auswählen2Player erstellen3Wiedergabe einbetten
POST /api/vod/create
9 Endpunkte

Voraussetzungen

Alle Verwaltungsmethoden erfordern einen gültigen x-access-token. Bereiten Sie zuerst die Eingaberessource vor und entscheiden Sie, ob die Wiedergabe öffentlich, passwortgeschützt, gruppiert oder mit Pay-per-View verknüpft sein soll.

Funktionen

  • create und update konfigurieren Eingabe, Wiedergabetyp, Verpackung, adaptive Bitrate, Zugriff, Gruppierung und Pay-per-View-Einstellungen.
  • getAll, getCount und getById inspizieren Player.
  • start und stop steuern die Wiedergabeverfügbarkeit.
  • getStat meldet die verfügbare Eingabebitrate und Kadenz des Player-Prozesses.
  • remove löscht einen Player.

Beispiel-Workflow

  1. Erstellen Sie einen Player von einem SRT-Server, einem RTMP-Server oder einem unterstützten Medieneingang.
  2. Wählen Sie HLS- oder DASH-Wiedergabe und stimmen Sie die Segmentdauer und die adaptive Bitrate für die erforderliche Latenz und Belastbarkeit ab.
  3. Wenden Sie die gewünschten Einstellungen für öffentlichen, Passwort-, Gruppen- oder Pay-per-View-Zugriff an.
  4. Starten Sie den Player und überprüfen Sie getStat, bevor Sie die Viewer-URL testen.
  5. Validieren Sie die Wiedergabe und das Einbetten in repräsentative Browser und Netzwerke.

Typische Anwendungsfälle

  • Veröffentlichung eines SRT- oder RTMP-Beitrags als eingebettete Live-Wiedergabe.
  • Schützen Sie einen Review-Stream für Partner mit Zugangsdaten für Zuschauer.
  • Liefern Sie eine kostenpflichtige Veranstaltung über einen konfigurierten Pay-per-View-Zugriff.
  • Erstellen Sie Sprachvarianten, die zu einer Webplayer-Gruppe gehören.

Einschränkungen und Fehlerbehebung

Eine erreichbare Player-Seite belegt nicht, dass der vorgelagerte Medienprozess einwandfrei läuft; prüfen Sie getStat. Kürzere Segmente können die Latenz verringern, erhöhen jedoch den Request-Overhead und die Empfindlichkeit gegenüber Netzwerkschwankungen. Testen Sie vor der Veröffentlichung Autorisierung, Zahlung, Einbettungsrichtlinie, Codecs und adaptive Varianten.

Nächste Schritte

Öffnen Sie den Player in einem Browser und prüfen Sie Zugriff und Wiedergabe. Verwenden Sie anschließend Webplayer-Gruppen, wenn Zuschauer zwischen mehreren Feeds wählen sollen.

REST-Lösungsrezept

Einen Live-Eingang erstellen und im Browser wiedergeben

Erstellen und starten Sie eine SRT-Ingest-Ressource, verwenden Sie die geprüfte Quelle anschließend in einem Webplayer und testen Sie die erzeugte Zuschauer-URL in einem echten Browser.

  1. SRT-Ingest erstellenKonfigurieren Sie Listener, Latenz, Zugriffsrichtlinie und Quellen-Routing und behalten Sie Ressourcen-ID und Publisher-Daten.POST /api/srt-servers/create
  2. Eingang starten und prüfenStarten Sie den Listener, senden Sie einen echten Stream und prüfen Sie die Verbindung vor der Browser-Ausgabe.POST /api/srt-servers/start
  3. Browser-Wiedergabe erstellenWählen Sie das SRT-Server-Preset und konfigurieren Sie Ausgabeformat, Zugriff und Darstellung.POST /api/vod/create
  4. Wiedergabe starten und testenStarten Sie den Player, prüfen Sie seinen Laufzeitstatus und öffnen Sie die Zuschauer-URL in repräsentativen Browsern.POST /api/vod/start

Eine erfolgreiche API-Antwort bestätigt die Ressource, nicht den Zustand des Live-Mediums. Prüfen Sie Publisher-Verbindung und dekodiertes Video, bevor Sie die Wiedergabe-URL teilen.

Produktseite der Video API öffnen
REST-Lösungsrezept

Eine verwaltete Datei zur Browser-Wiedergabe veröffentlichen

Bereiten Sie die Mediendatei vor, erstellen Sie mit dem passenden Datei-Preset einen Webplayer und validieren Sie die erzeugte HLS- oder DASH-Wiedergabe.

  1. Quelle hochladenErstellen Sie die verwaltete Datei und behalten Sie ihre ID für den Player-Eingang.POST /api/files/uploadFile
  2. VOD-Wiedergabe erstellenWählen Sie Datei-Preset, Ausgabeformat, Zugriffsrichtlinie und Darstellung.POST /api/vod/create
  3. Player starten und testenStarten Sie die Ressource und testen Sie ihre Zuschauer-URL in repräsentativen Browsern.POST /api/vod/start

Der Player ist eine Ausgabe-Ressource; verwalten Sie die Quelldatei separat und prüfen Sie Autorisierung, Codecs und Browser-Wiedergabe vor der Veröffentlichung.

Produktseite für Video on Demand öffnen
POST
/api/vod/create
API-Token erforderlich

Erstellen Sie einen Webplayer über POST /api/vod/create. Senden Sie das im Dashboard erzeugte JWT im x-access-token-Header.

Die Anfrage verbindet einen Live-Eingang mit HLS- oder DASH-Auslieferung, optionaler adaptiver Bitrate, Transcodierung, Overlays, Zuschauerautorisierung, Pay-per-View, Gruppenzuordnung und Darstellungsfeldern.

Anfragebeispiele

Wählen Sie die Voreinstellung für die gewünschte Wiedergabe- und Zugriffsrichtlinie und ergänzen Sie nur die optionalen Felder, die Ihre Zuschaueroberfläche benötigt.

Typische Anwendungsfälle

  • Veröffentlichen Sie einen öffentlichen Event-Stream als browserfähige HLS-Wiedergabe.
  • Betten Sie einen geschützten Review-Player mit Passwort- oder Zuschauerautorisierung ein.
  • Bereiten Sie Sprach-, Kamera- oder Kommentar-Player für eine gruppierte Zuschaueroberfläche vor.

Nachdem Sie einen Live-Player gestartet haben, verwenden Sie die Wiedergabe-URL und überwachen Sie die Anzahl der Viewer, Bitrate und FPS.

Öffentliche Wiedergabe

Verwenden Sie diese Voreinstellung, wenn eine verwaltete SRT-Quelle zu einem öffentlichen Endpunkt für die Browser-Wiedergabe ohne Zugriffsbarriere werden soll.

SRT-Server zum öffentlichen Webplayer

Dies ist das sauberste Live-Player-Setup für die öffentliche Browser-Wiedergabe. Die Player-Ebene übernimmt die Paketierung und Wiedergabe, während die vorgelagerte Quelle verwaltet wird.

SRT-Server zum öffentlichen Webplayer
Code kopieren
curl --request POST \
  --url http://localhost/api/vod/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vod_name": "Main stage player",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "input_module_id": "SRT_SERVER_ID",
    "input_stream_id": "",
    "entity_name": "Main stage player",
    "module_name": "MODULE_VOD"
  },
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "MAX_RESOLUTION_UNSET"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "support_email": "",
  "transcoding": {
    "video_transcoding": "Disabled",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "Disabled",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "DISABLED",
    "channel": "1,2",
    "track": "0"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true
}'
RTMP-Server zum öffentlichen Webplayer

Dies hält den Wiedergabevertrag stabil, auch wenn der Ingest-Transport auf der Quellseite RTMP bleibt.

RTMP-Server zum öffentlichen Webplayer
Code kopieren
curl --request POST \
  --url http://localhost/api/vod/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vod_name": "RTMP browser player",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "input": {
    "input_type": "INPUT_TYPE_RTMP_SOFTWARE",
    "input_module_id": "RTMP_SERVER_ID",
    "input_stream_id": "",
    "entity_name": "RTMP browser player",
    "module_name": "MODULE_VOD"
  },
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "MAX_RESOLUTION_UNSET"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "support_email": "",
  "transcoding": {
    "video_transcoding": "Disabled",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "Disabled",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "DISABLED",
    "channel": "1,2",
    "track": "0"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true
}'
Eingeschränkte Wiedergabe

Verwenden Sie diese Voreinstellung, wenn der Player bereitgestellt werden soll, aber nicht öffentlich zugänglich sein darf. Der Browser-Endpunkt wird immer noch generiert, aber der Zugriff wird durch playerseitige Zugangsdaten gesteuert.

Passwortgeschützter Webplayer

Dies eignet sich hervorragend für Freigaben für Partner, interne Screenings, Premium-Previews oder jeden Fall, in dem die Zugriffskontrolle in die Wiedergabeebene selbst gehört.

Passwortgeschützter Webplayer
Code kopieren
curl --request POST \
  --url http://localhost/api/vod/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vod_name": "Partner review player",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "input_module_id": "SRT_SERVER_ID",
    "input_stream_id": "",
    "entity_name": "Partner review player",
    "module_name": "MODULE_VOD"
  },
  "authorization": {
    "authorization_type": "VOD_PASSWORD_ONLY_MANUALLY",
    "credentials": [
      {
        "email": "[email protected]",
        "password": "guest-password"
      }
    ]
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "MAX_RESOLUTION_UNSET"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "support_email": "",
  "transcoding": {
    "video_transcoding": "Disabled",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "Disabled",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "DISABLED",
    "channel": "1,2",
    "track": "0"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true
}'
Mehrsprachige Live-Wiedergabe

Verwenden Sie diese Voreinstellung, nachdem der Operator die Audiospuren auf dem Quell-SRT-Server angehört und benannt hat.

Eine Sprache aus einem mehrspurigen SRT-Programm

SELECT_AUDIO_TRACK ordnet diesem Player eine produzierte Quellspur zu. Erstellen und testen Sie einen Player pro Sprache und veröffentlichen Sie die geprüften Varianten anschließend über eine LANGUAGE_LIST-Webplayer-Gruppe.

Callaba übersetzt oder erzeugt die Quellaudiospuren nicht.

Eine Sprache aus einem mehrspurigen SRT-Programm
Code kopieren
curl --request POST \
  --url http://localhost/api/vod/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vod_name": "Main stage Spanish",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "input_module_id": "SRT_SERVER_ID",
    "input_stream_id": "",
    "entity_name": "Main stage Spanish",
    "module_name": "MODULE_VOD"
  },
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "MAX_RESOLUTION_UNSET"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "support_email": "",
  "transcoding": {
    "video_transcoding": "Disabled",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "Disabled",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "SELECT_AUDIO_TRACK",
    "channel": "All channels",
    "track": "1"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true,
  "group_settings": {
    "group_id": "LANGUAGE_LIST_GROUP_ID",
    "name": "Spanish",
    "selected": false
  }
}'
Gruppierte Wiedergabe

Verwenden Sie diese Voreinstellung, wenn ein Player einer Gruppe von verwandten Browser-Endpunkten beitreten soll, z. B. verschiedenen Sprachen, Programmen oder alternativen Ereignisansichten.

Gruppierter Varianten-Player

Der gruppierte Player-Ablauf ist nützlich, wenn die Browser-Oberfläche größer als eine einzelne URL ist und der Zuschauer zwischen verwandten Player-Varianten wechseln kann.

Gruppierter Varianten-Player
Code kopieren
curl --request POST \
  --url http://localhost/api/vod/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vod_name": "Main stage EN",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "input_module_id": "SRT_SERVER_ID",
    "input_stream_id": "",
    "entity_name": "Main stage EN",
    "module_name": "MODULE_VOD"
  },
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "MAX_RESOLUTION_UNSET"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "support_email": "",
  "transcoding": {
    "video_transcoding": "Disabled",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "Disabled",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "DISABLED",
    "channel": "1,2",
    "track": "0"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true,
  "group_settings": {
    "group_id": "VOD_GROUP_ID",
    "name": "English",
    "selected": true
  }
}'
Auslieferungsoptimierung

Verwenden Sie diese Voreinstellung, wenn die Browserseite auf eine adaptive Bitratenwiedergabe und nicht auf eine einzelne feste Qualitätsstufe vorbereitet sein soll.

ABR-fähiger Webplayer

Callaba verbindet adaptive Bitraten mit Wiedergabeoptimierung und Transcodierung. Das eignet sich für Anwendungen, in denen ein stabiler Start und die automatische Qualitätsanpassung wichtiger sind als eine feste Qualitätsstufe.

ABR-fähiger Webplayer
Code kopieren
curl --request POST \
  --url http://localhost/api/vod/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vod_name": "ABR main stage player",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "input_module_id": "SRT_SERVER_ID",
    "input_stream_id": "",
    "entity_name": "Main stage player",
    "module_name": "MODULE_VOD"
  },
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "1080"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "support_email": "",
  "transcoding": {
    "video_transcoding": "libx264",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "aac",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "DISABLED",
    "channel": "1,2",
    "track": "0"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true
}'
Parameter im Request-Body
Identität
vod_name
string
Direktlink kopieren

Dashboard-Bezeichnung: Playername.

Lesbarer Name des Wiedergabe-Endpunkts.

vod_type
string
Direktlink kopieren

Der Standard-Live-Workflow verwendet VOD_TYPE_LIVE_STREAM, während das Produkt auch On-Demand-Modi unterstützt.

vod_media_type
string
Direktlink kopieren

Optionaler Medientyp-Deskriptor, der auf dem Player-Objekt gespeichert ist.

Eingabe
input
object
Direktlink kopieren

Dashboard-Bezeichnung: Eingabetyp.

Die Eingabedefinition stammt aus dem gemeinsamen Quellenformular. Unterstützt werden unter anderem SRT-Server, RTMP-Server, SRT-Routen und URL-basierte Live-Quellen.

Wiedergabe und Auslieferung
adaptive_bitrate_settings
object
Direktlink kopieren

Adaptive Bitrateneinstellungen für den Player. Das Produkt verwendet input_resolution als zentrales Kriterium für die Auslieferung und bindet ABR an die Transcoding-Schicht.

hls_fragment_size
integer
Direktlink kopieren

Dashboard-Bezeichnung: HLS-Segmentdauer.

Die UI-Anleitung empfiehlt 3 Sekunden für ein gutes HLS-Erlebnis.

hls_fragment_length
integer
Direktlink kopieren

Dashboard-Bezeichnung: Länge der HLS-Playlist.

Die UI-Anleitung empfiehlt 60 Sekunden.

dash_fragment_size / dash_fragment_length
mixed
Direktlink kopieren

DASH-seitige Fragmentgrößensteuerungen, die mit dem Player-Objekt gespeichert sind.

initial_live_manifest_size
integer
Direktlink kopieren

Dashboard-Bezeichnung: Mindestanzahl der HLS-Segmente.

Steuert, wie viele Fragmente vorgeladen werden, bevor die Wiedergabe beginnt.

live_sync_duration_count
integer
Direktlink kopieren

Dashboard-Bezeichnung: Abstand zur Live-Kante.

Steuert, mit welchem Abstand zum neuesten Segment die Live-Wiedergabe beginnt.

Zugang und Gruppierung
authorization
object
Direktlink kopieren

Playerseitige Autorisierungseinstellungen. Die Benutzeroberfläche verwendet dies, um eine Zuschauer-Autorisierung zu erfordern, bevor der Webplayer geöffnet werden kann.

group_settings
object
Direktlink kopieren

Optionaler Gruppenzuweisungsblock mit group_id, Anzeigename name innerhalb der Gruppe und selected als Standardauswahl.

pay_per_view_settings
object
Direktlink kopieren

Optionaler Monetarisierungsblock: Der deaktivierte Zustand bleibt für die meisten Player der normale Standard.

Darstellung
cover_path / logo_path / useCustomLogo / useCustomBackground
mixed
Direktlink kopieren

Optionale Präsentations- und Branding-Einstellungen für die browserbasierte Playeroberfläche.

event_date / timeZone / eventDateStatus / support_email
mixed
Direktlink kopieren

Optionale Ereignis- und Support-Metadaten, die mit dem Player-Objekt gespeichert sind.

Verarbeitung
transcoding / modify_audio / modify_video / overlay
object
Direktlink kopieren

Optionale Medienverarbeitungsblöcke, die verwendet werden, wenn der Player mehr als reine Paketierung ohne Transcodierung ausführen soll.

Setzen Sie für eine mehrsprachige Quelle modify_audio.type auf SELECT_AUDIO_TRACK, übergeben Sie den nullbasierten Quellindex track als Zeichenfolge und verwenden Sie den geprüften Kanalmodus, zum Beispiel All channels.

Laufzeit
active
boolean
Direktlink kopieren

Dashboard-Bezeichnung: Einmal erstellt aktivieren.

Steuert, ob der Player direkt nach der Bereitstellung aktiv sein soll.

Webplayer erstellen
Code kopieren
curl --request POST \
  --url http://localhost/api/vod/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vod_name": "Main stage player",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "input": {
    "input_type": "INPUT_TYPE_SRT_SOFTWARE",
    "input_module_id": "SRT_SERVER_ID",
    "input_stream_id": "",
    "entity_name": "Main stage player",
    "module_name": "MODULE_VOD"
  },
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "MAX_RESOLUTION_UNSET"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "support_email": "",
  "transcoding": {
    "video_transcoding": "Disabled",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "Disabled",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "DISABLED",
    "channel": "1,2",
    "track": "0"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true
}'
Antwort
Identität
_id
string
Direktlink kopieren

Ressourcen-ID, die beim Erstellen oder Auflisten des Webplayers zurückgegeben wird.

id
string
Direktlink kopieren

Kurzform für _id.

vod_name
string
Direktlink kopieren

Name, der für das Player-Objekt gespeichert ist.

vod_type / vod_media_type
mixed
Direktlink kopieren

Im Objekt gespeicherter Player- und Medientyp.

Wiedergabe und Auslieferung
vod_port
integer
Direktlink kopieren

Generierter interner Port, der vom Auslieferungsprozess des Players verwendet wird.

Eingabe
input[]
array
Direktlink kopieren

Verknüpftes Eingabeobjekt oder verknüpfte Eingabeobjekte, die von der Wiedergabe-Pipeline verwendet werden.

Wiedergabe und Auslieferung
adaptive_bitrate_settings / hls_fragment_* / dash_fragment_*
mixed
Direktlink kopieren

Einstellungen für die Wiedergabebereitstellung, die auf dem Player-Objekt gespeichert sind.

Zugang und Gruppierung
authorization / pay_per_view_settings / group_id / users
mixed
Direktlink kopieren

Im Player gespeicherte Zugriffs-, Monetarisierungs-, Gruppen- und Zuschauerautorisierung.

Darstellung
hidden / support_email / logo / background fields
mixed
Direktlink kopieren

Präsentations- und Sichtbarkeitseinstellungen werden mit dem Player-Objekt zurückgegeben.

Laufzeit
active
boolean
Direktlink kopieren

Aktueller Aktivstatus für den Player.

created / modified
string
Direktlink kopieren

Zeitstempel, die vom Backend verwaltet werden.

Betriebsergebnis
success
boolean
Direktlink kopieren

Bei erfolgreicher Ausführung enthält die Antwort success: true.

Antwort: Webplayer erstellen
JSON
Code kopieren
{
  "_id": "66015d2997300f9385d32c00",
  "id": "66015d2997300f9385d32c00",
  "vod_name": "Main stage player",
  "vod_type": "VOD_TYPE_LIVE_STREAM",
  "vod_media_type": "video",
  "vod_port": 20840,
  "input": [
    {
      "_id": "66015d2997300f9385d32c01",
      "id": "66015d2997300f9385d32c01",
      "input_type": "INPUT_TYPE_SRT_SOFTWARE",
      "input_module_id": "SRT_SERVER_ID",
      "input_stream_id": "",
      "entity_name": "Main stage player",
      "module_name": "MODULE_VOD"
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "adaptive_bitrate_settings": {
    "input_resolution": "MAX_RESOLUTION_UNSET"
  },
  "hls_fragment_size": 3,
  "hls_fragment_length": 60,
  "dash_fragment_size": 3,
  "dash_fragment_length": 60,
  "initial_live_manifest_size": 4,
  "live_sync_duration_count": 5,
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED",
    "client_id": ""
  },
  "group_id": null,
  "users": [],
  "hidden": false,
  "support_email": "",
  "transcoding": {
    "video_transcoding": "Disabled",
    "output_video_bitrate": 6000,
    "preset": "ultrafast",
    "tune": "Disabled",
    "crf": "Disabled",
    "pix_fmt": "Disabled",
    "encoding_rate": "",
    "filter_fps": "",
    "gop": "Disabled",
    "force_key_frames": 2,
    "frame_width": "",
    "frame_height": "",
    "slices": "",
    "cores": "",
    "xlnx_hwdev": "0",
    "audio_transcoding": "Disabled",
    "output_audio_bitrate": 128,
    "sample_rate": 44100
  },
  "modify_audio": {
    "type": "DISABLED",
    "channel": "1,2",
    "track": "0"
  },
  "modify_video": {
    "type": "DISABLED"
  },
  "overlay": {
    "type": "DISABLED",
    "position": {
      "x": 1,
      "y": 1
    }
  },
  "active": true,
  "created": "2026-03-24T14:00:00.000Z",
  "modified": "2026-03-24T14:00:00.000Z",
  "success": true
}
POST
/api/vod/getCount
API-Token erforderlich
POST
/api/vod/getAll
API-Token erforderlich
POST
/api/vod/getById
API-Token erforderlich
POST
/api/vod/update
API-Token erforderlich
POST
/api/vod/start
API-Token erforderlich
POST
/api/vod/stop
API-Token erforderlich
DELETE
/api/vod/remove
API-Token erforderlich
POST
/api/vod/getStat
API-Token erforderlich
Zurück zuDateienWeiter zuWebplayer-Gruppen