media server logo
Dokumentationsnavigation ein- oder ausblenden
Callaba-Startseite

Webplayer-Gruppen

Verwenden Sie Webplayer-Gruppen, damit Zuschauer auf einer Seite zwischen freigegebenen Sprachfeeds, Kameraperspektiven oder Replay-Varianten wechseln können.

FunktionZuschauer zwischen Feeds wechseln lassen

Geeignet, wennMehrere vorhandene Player benötigen eine gemeinsame Seite für Sprach-, Kamera- oder Replay-Auswahl.

Anderes Modul verwenden, wennVerwenden Sie zuerst Webplayer, um jeden zugrunde liegenden Wiedergabe-Endpunkt zu erstellen und zu prüfen.

1Player auswählen2Gemeinsamen Zugriff festlegen3Seite veröffentlichen
POST /api/vod-group/create
8 Endpunkte

Voraussetzungen

Alle Verwaltungsmethoden erfordern einen gültigen x-access-token. Erstellen und testen Sie die einzelnen Webplayer, bevor Sie deren Kennungen zu einer Gruppe hinzufügen.

Funktionen

  • create und update definieren Mitgliedschaft, Standardauswahl, Zugriff, Branding und Ereigniseinstellungen.
  • getAll, getCount und getById inspizieren Gruppen.
  • start und stop steuern die Verfügbarkeit der Gruppe.
  • remove löscht die Gruppe, lässt die enthaltenen Webplayer jedoch unverändert.

Beispiel-Workflow

  1. Erstellen und validieren Sie einen Webplayer für jeden Sprachfeed.
  2. Erstellen Sie eine Gruppe, die diese Playeridentifikatoren enthält.
  3. Wählen Sie die primäre Sprache als Standard.
  4. Wenden Sie die gemeinsamen Zugriffs- und Ereigniseinstellungen an.
  5. Starten Sie die Gruppe und veröffentlichen Sie ihre Viewer-URL oder Einbettung.

Typische Anwendungsfälle

  • Bieten Sie parallele Sprach- oder Kommentar-Feeds auf einer Veranstaltungsseite an.
  • Veröffentlichen Sie eine kuratierte Reihe von Wiederholungs- oder Episodenvarianten.
  • Wenden Sie eine gemeinsame Zugriffs- oder Pay-per-View-Richtlinie auf mehrere Player an.

Einschränkungen und Fehlerbehebung

Eine Gruppe ist auf gültige, abspielbare Webplayer angewiesen. Wenn Sie einen enthaltenen Player entfernen oder stoppen, bleibt die entsprechende Auswahl möglicherweise bis zur nächsten Aktualisierung nicht verfügbar. Testen Sie vor der Veröffentlichung die Standardauswahl, den Zugriffsablauf und jeden Player.

Nächste Schritte

Öffnen Sie Webplayer, um jede Quelle vorzubereiten. Betten Sie die getestete Gruppe anschließend in die Zuschaueroberfläche ein oder verlinken Sie sie.

REST-Lösungsrezept

Ein Pay-per-View-Event erstellen

Bereiten Sie zuerst die Player vor, gruppieren Sie die freigegebenen Feeds auf einer Zuschauer-Seite und setzen Sie Pay-per-View- und Zugriffseinstellungen an der Gruppe.

  1. Event-Player erstellenBereiten Sie jeden Live- oder Datei-Feed vor, den Zuschauer kaufen können.POST /api/vod/create
  2. Bezahlte Gruppe erstellenVerbinden Sie Player und konfigurieren Sie pay_per_view_settings, Zugriff, Branding und Eventdaten.POST /api/vod-group/create
  3. Zuschauer-Seite startenStarten Sie die Gruppe erst nach erfolgreichen Kauf- und Wiedergabetests.POST /api/vod-group/start

Eine Zahlungskonfiguration ist kein abgeschlossener Commerce-Test. Prüfen Sie Kauf, Autorisierung, Supportkontakt und Wiedergabe vor dem Event mit einem Testkunden.

POST
/api/vod-group/create
API-Token erforderlich

Verwenden Sie diese Methode, wenn mehrere Player mit gemeinsamer Auswahl, Branding, Veranstaltungsdarstellung oder Zugriffsrichtlinie auf einer Zuschaueroberfläche bereitgestellt werden sollen.

Sie ist der übliche Einrichtungsschritt für Sprach-, Kamera- oder Kommentargruppen, insbesondere wenn Passwort- oder Pay-per-View-Regeln für die gesamte Gruppe gelten. Beispiele für Operator-Automatisierung finden Sie unter vMix Script.

Sprachauswahlgruppe

Verwenden Sie dies, wenn mehrere parallele Webplayer Sprach- oder Kommentarvarianten darstellen und einer standardmäßig ausgewählt werden soll.

Sprachauswahlgruppe
Code kopieren
curl --request POST \
--url http://localhost/api/vod-group/create \
--header 'x-access-token: <your_api_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Main event language selector",
"type": "LANGUAGE_LIST",
"players": [
{
"id": "PLAYER_ID_ENGLISH",
"name": "English",
"selected": true
},
{
"id": "PLAYER_ID_SPANISH",
"name": "Spanish",
"selected": false
}
],
"authorization": {
"authorization_type": "VOD_PASSWORD_DISABLED",
"credentials": []
},
"pay_per_view_settings": {
"type": "PAY_PER_VIEW_DISABLED"
},
"support_email": "[email protected]",
"eventDateStatus": "EVENTS_DATE_DISABLED",
"active": true
}'
Datei-Playlist-Gruppe

Verwenden Sie dies, wenn die gruppierte Browser-Erfahrung zwischen On-Demand-Dateien oder vorbereiteten dateibasierten Playern wechseln soll.

Datei-Playlist-Gruppe
Code kopieren
curl --request POST \
--url http://localhost/api/vod-group/create \
--header 'x-access-token: <your_api_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "On-demand episode selector",
"type": "FILES_LIST",
"players": [
{
"id": "PLAYER_ID_EPISODE_1",
"name": "Episode 1",
"selected": true
},
{
"id": "PLAYER_ID_EPISODE_2",
"name": "Episode 2",
"selected": false
}
],
"authorization": {
"authorization_type": "VOD_PASSWORD_DISABLED",
"credentials": []
},
"pay_per_view_settings": {
"type": "PAY_PER_VIEW_DISABLED"
},
"eventDateStatus": "EVENTS_DATE_DISABLED",
"active": true
}'
Passwortgeschützte Veranstaltungsgruppe

Verwenden Sie dies, wenn die gruppierte Wiedergabe hinter einem gemeinsamen Gästepasswort privat bleiben soll.

Passwortgeschützte Veranstaltungsgruppe
Code kopieren
curl --request POST \
--url http://localhost/api/vod-group/create \
--header 'x-access-token: <your_api_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Private webinar playback group",
"type": "LANGUAGE_LIST",
"players": [
{
"id": "PLAYER_ID_PRIVATE_MAIN",
"name": "Main stream",
"selected": true
}
],
"authorization": {
"authorization_type": "VOD_USE_PASSWORD",
"credentials": [
{
"name": "Guest",
"password": "guest-password"
}
]
},
"pay_per_view_settings": {
"type": "PAY_PER_VIEW_DISABLED"
},
"support_email": "[email protected]",
"eventDateStatus": "EVENTS_DATE_DISABLED",
"active": true
}'
Pay-per-View-Veranstaltungsgruppe

Verwenden Sie dies, wenn eine gebrandete Veranstaltungsseite einen oder mehrere Player mit PayPal-basierten Zahlungs-, Zugriffs- und Zeitplanmetadaten zusammenfassen soll.

Pay-per-View-Veranstaltungsgruppe
Code kopieren
curl --request POST \
--url http://localhost/api/vod-group/create \
--header 'x-access-token: <your_api_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Paid event player group",
"type": "LANGUAGE_LIST",
"players": [
{
"id": "PLAYER_ID_MAIN_STAGE",
"name": "Main stage",
"selected": true
}
],
"authorization": {
"authorization_type": "VOD_PASSWORD_DISABLED",
"credentials": []
},
"pay_per_view_settings": {
"type": "PAY_PER_VIEW_PAYPAL",
"amount": 19,
"client_id": "PAYPAL_CLIENT_ID"
},
"support_email": "[email protected]",
"event_date": "2026-04-01T18:00:00.000Z",
"timeZone": "Europe/Istanbul",
"eventDateStatus": "EVENTS_SET_DATE",
"active": true
}'
Parameter im Request-Body
Identität
name
string
Direktlink kopieren

Dashboard-Bezeichnung: Gruppenname.

Lesbarer Name der gruppierten Wiedergabeoberfläche.

type
string
Direktlink kopieren

Dashboard-Bezeichnung: Typ.

Unterstützte Werte sind LANGUAGE_LIST und FILES_LIST.

Player
players[]
array
Direktlink kopieren

Liste der verknüpften Playereinträge: Jedes Element enthält id, den Anzeigenamen name und das Flag selected, das für die Standardauswahl verwendet wird.

Zugang
authorization
object
Direktlink kopieren

Unterstützte Modi sind VOD_PASSWORD_DISABLED, VOD_USE_PASSWORD und Kombinationen aus E-Mail-Adresse und Passwort.

Monetarisierung
pay_per_view_settings
object
Direktlink kopieren

Optionaler Pay-per-View-Block: Das aktuelle Dashboard zeigt zusätzlich zum deaktivierten Standard einen PayPal-basierten Modus an.

Darstellung
cover_path / logo_path / useCustomLogo / useCustomBackground
mixed
Direktlink kopieren

Optionale Branding-Felder für die gruppierte Wiedergabeseite.

support_email
string
Direktlink kopieren

Optionaler Supportkontakt, der in der veranstaltungsspezifischen Playeroberfläche angezeigt wird.

event_date / timeZone / eventDateStatus
mixed
Direktlink kopieren

Optionale Zeitplanmetadaten der Veranstaltung, die in der Gruppe gespeichert sind.

Laufzeit
active
boolean
Direktlink kopieren

Dashboard-Bezeichnung: Einmal erstellt aktivieren.

Steuert, ob die Gruppe direkt nach der Bereitstellung aktiv sein soll.

Webplayer-Gruppe erstellen
Code kopieren
curl --request POST \
--url http://localhost/api/vod-group/create \
--header 'x-access-token: <your_api_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Main event language selector",
"type": "LANGUAGE_LIST",
"players": [
{
"id": "PLAYER_ID_ENGLISH",
"name": "English",
"selected": true
},
{
"id": "PLAYER_ID_SPANISH",
"name": "Spanish",
"selected": false
}
],
"authorization": {
"authorization_type": "VOD_PASSWORD_DISABLED",
"credentials": []
},
"pay_per_view_settings": {
"type": "PAY_PER_VIEW_DISABLED"
},
"support_email": "[email protected]",
"eventDateStatus": "EVENTS_DATE_DISABLED",
"active": true
}'
Antwort
Identität
_id / id / name / type
mixed
Direktlink kopieren

Kennungen und die Kerngruppenidentitätsfelder.

Player
players[]
array
Direktlink kopieren

Gespeicherte Playereinträge in der Gruppe, einschließlich des Status der Standardauswahl.

Zugang
authorization / users
mixed
Direktlink kopieren

Autorisierungsstatus plus alle verknüpften Zuschauer-Benutzer, die zur Gruppe gehören.

Monetarisierung
pay_per_view_settings
object
Direktlink kopieren

Gespeicherte Pay-per-View-Konfiguration für die Gruppe.

Darstellung
cover_path / logo_path / support_email / event_date / timeZone / eventDateStatus
mixed
Direktlink kopieren

Branding- und Ereignismetadaten, die mit dem Gruppenobjekt zurückgegeben werden.

Laufzeit
active / created / modified
mixed
Direktlink kopieren

Aktueller Aktivstatus und Backend-verwaltete Zeitstempel.

Betriebsergebnis
success
boolean
Direktlink kopieren

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

Antwort: Webplayer-Gruppe erstellen
JSON
Code kopieren
{
"_id": "6a1144aa22bb33cc44dd55ee",
"id": "6a1144aa22bb33cc44dd55ee",
"name": "Main event language selector",
"type": "LANGUAGE_LIST",
"players": [
{
"id": "6a1144aa22bb33cc44dd5601",
"name": "English",
"selected": true
},
{
"id": "6a1144aa22bb33cc44dd5602",
"name": "Spanish",
"selected": false
}
],
"authorization": {
"authorization_type": "VOD_PASSWORD_DISABLED"
},
"pay_per_view_settings": {
"type": "PAY_PER_VIEW_DISABLED"
},
"cover_path": "",
"logo_path": "",
"useCustomLogo": "VOD_DISABLE_LOGO",
"useCustomBackground": "VOD_DISABLE_BACKGROUND",
"support_email": "[email protected]",
"event_date": "2026-04-01T18:00:00.000Z",
"timeZone": "Europe/Istanbul",
"eventDateStatus": "EVENTS_DATE_DISABLED",
"active": true,
"created": "2026-03-24T18:00:00.000Z",
"modified": "2026-03-24T18:00:00.000Z",
"success": true
}
POST
/api/vod-group/getCount
API-Token erforderlich
POST
/api/vod-group/getAll
API-Token erforderlich
POST
/api/vod-group/getById
API-Token erforderlich
POST
/api/vod-group/update
API-Token erforderlich
POST
/api/vod-group/start
API-Token erforderlich
POST
/api/vod-group/stop
API-Token erforderlich
DELETE
/api/vod-group/remove
API-Token erforderlich