Skip to Content
DocumentationAPI ReferenceLivestreams

Live Streams API

Die Live Streams API bieten Endpunkte für das Entdecken und Abrufen von Informationen über Ihre Live-Events. Dies ermöglicht Ihnen, “Live Now”-Verzeichnisse zu erstellen und Live-Spieler in Ihren Anwendungen einzubinden.

Aktive Live Streams abrufen

Dies ist der primäre Endpunkt zum Entdecken von Streams, die gerade “online” sind. Er gibt eine Liste nur der Streams zurück, die aktuell ein Signal vom Encoder empfangen.

GET /live-streams/active

Parameter

Dieser Endpunkt nimmt keine Parameter entgegen. Es werden alle aktiven Streams für Ihr Konto zurückgegeben.

Beispielanfrage

GET /api/client/v1/live-streams/active
Host: https://your-app.com
Authorization: Bearer sk-your-api-key-hier

Antwort: GET /live-streams/active

Wenn Streams aktiv sind, erhalten Sie ein Array von LiveStream-Objekten. Der status wird auf active gesetzt und ein manifest-Objekt ist vorhanden.

Antwort: 200 OK (Streams aktiv)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Wöchentliche Q&A-Sitzung",
      "description": "Ihre Fragen live beantworten.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "Kategorie": "Tech Talk",
        "Host": "Jane Doe"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    }
  ]
}

Wenn keine Streams derzeit aktiv sind, gibt die API eine leere Datenarray zurück.

Antwort: 200 OK (Keine Streams aktiv)
{
  "data": []
}

Alle Live Streams abrufen

Dieser Endpunkt bietet ein paginiertes Verzeichnis aller in Ihrem Konto konfigurierten Live-Streams, unabhängig von ihrem aktuellen Status (aktiv oder inaktiv). Dies ist nützlich für die Erstellung eines Zeitplans oder einer vollständigen Liste verfügbarer Kanäle.

GET /live-streams

Parameter

NameTypErforderlichBeschreibung
per_pageintegerOptionalDie Anzahl der Streams, die pro Seite zurückgegeben werden. Standard: 15, Max: 100.

Beispielanfrage

GET /api/client/v1/live-streams?per_page=2

Antwort: GET /live-streams

Die Antwort ist ein standardisiertes paginiertes Verzeichnis. Der status wird auf active oder inactive gesetzt, und das manifest-Objekt ist nur für aktive Streams vorhanden.

Antwort: 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Wöchentliche Q&A-Sitzung",
      "description": "Ihre Fragen live beantworten.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "Kategorie": "Tech Talk"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Kommende Produktvorstellung",
      "description": "Beitreten Sie uns für die große Enthüllung.",
      "status": "inactive",
      "metadata": {
        "Kategorie": "Produkt"
      },
      "tags": ["Launch", "Event"],
      "created_at": "2024-07-25T15:00:00Z"
    }
  ],
  "links": {
    "erste": "https://your-app.com/api/client/v1/live-streams?page=1",
    "letzte": "https://your-app.com/api/client/v1/live-streams?page=3",
    "vorherige": null,
    "nächste": "https://your-app.com/api/client/v1/live-streams?page=2"
  },
  "meta": {
    "aktuelle Seite": 1,
    "von": 1,
    "letzte Seite": 3,
    "Pfad": "https://your-app.com/api/client/v1/live-streams",
    "pro Seite": 2,
    "bis": 2,
    "Gesamt": 6
  }
}

Einzelnes Live-Stream abrufen

Ruft die vollständigen Details für ein bestimmtes Live-Stream nach seiner ID. Dies ist der Endpunkt, den Sie aufrufen würden, um die notwendige Informationen zu laden, um einen Stream in einem Spieler zu laden.

GET /live-streams/{streamId}

Pfadparameter

NameTypBeschreibung
streamIduuidErforderlich. Die eindeutige Identifikationsnummer des Live-Streams.

Beispielanfrage

GET /api/client/v1/live-streams/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f

Antwort: GET /live-streams/{streamId}

Die Antwort ist ein einzelnes LiveStream-Objekt. Das manifest wird nur dann enthalten, wenn der Stream aktiv ist.

Antwort: 200 OK (Stream aktiv)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Wöchentliche Q&A-Sitzung",
    "description": "Ihre Fragen live beantworten.",
    "status": "active",
    "manifest": {
      "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
    },
    "metadata": {
      "Kategorie": "Tech Talk",
      "Host": "Jane Doe"
    },
    "tags": ["live", "q&a"],
    "created_at": "2024-08-01T10:00:00Z"
  }
}
VideoclipsVideodateien hochladen