Skip to Content
DocumentationAPI ReferenceLive Streams

Live Streams API

De Live Streams API bieden endpoints voor het ontdekken en ophalen van informatie over uw live-evenementen. Dit maakt het mogelijk om “Live Now”-directories te bouwen en live-spelers in uw toepassingen op te nemen.

Actieve Live Streams Halen

Dit is de primaire endpoint voor het ontdekken van streams die momenteel “in beeld” zijn. Het retourneert een lijst met alleen de streams die actief ontvangen signalen van een encoder.

GET /live-streams/active

Parameters

Deze endpoint neemt geen parameters aan. Hij zal alle actieve streams voor uw account retourneren.

Voorbeeldverzoek

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

Antwoord: GET /live-streams/active

Als streams actief zijn, ontvangt u een array van LiveStream-objecten. De status zal active zijn en een manifest-object zal aanwezig zijn.

Antwoord: 200 OK (Streams Actief)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Wekelijkse Q&A-sessie",
      "description": "Antwoorden op uw vragen live.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "categorie": "Tech Talk",
        "host": "Jane Doe"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    }
  ]
}

Als er geen streams actief zijn, zal het API een lege data-array retourneren.

Antwoord: 200 OK (Geen Streams Actief)
{
  "data": []
}

Alle Live Streams Halen

Deze endpoint biedt een geplaatste directory van alle live streams die zijn geconfigureerd in uw account, ongeacht hun huidige status (actief of niet-actief). Dit is handig voor het bouwen van een schema of een complete lijst beschikbare kanalen.

GET /live-streams

Parameters

NaamTypeVereistBeschrijving
per_pageintegerOptioneelHet aantal streams dat per pagina wordt geretourneerd. Standaard: 15, Max: 100.

Voorbeeldverzoek

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

Antwoord: GET /live-streams

Het antwoord is een standaard geplaatste lijst. De status zal active of inactive zijn, en het manifest-object zal alleen aanwezig zijn voor actieve streams.

Antwoord: 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Wekelijkse Q&A-sessie",
      "description": "Antwoorden op uw vragen live.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "categorie": "Tech Talk"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Komende productpresentatie",
      "description": "Sluit u aan bij de grote onthulling.",
      "status": "inactive",
      "metadata": {
        "categorie": "Product"
      },
      "tags": ["launch", "event"],
      "created_at": "2024-07-25T15:00:00Z"
    }
  ],
  "links": {
    "first": "https://your-app.com/api/client/v1/live-streams?page=1",
    "last": "https://your-app.com/api/client/v1/live-streams?page=3",
    "prev": null,
    "next": "https://your-app.com/api/client/v1/live-streams?page=2"
  },
  "meta": {
    "huidige pagina": 1,
    "vanaf": 1,
    "laatste pagina": 3,
    "pad": "https://your-app.com/api/client/v1/live-streams",
    "per_page": 2,
    "tot": 2,
    "totaal": 6
  }
}

Een Enkelvoudige Live Stream Halen

Retourneert de volledige details voor één specifieke live stream op basis van zijn ID. Dit is de endpoint die u zou aanroepen om de benodigde informatie te krijgen om een stream in een speler te laden.

GET /live-streams/{streamId}

Padparameters

NaamTypeBeschrijving
streamIduuidVereist. De unieke identifier van de live stream.

Voorbeeldverzoek

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

Antwoord: GET /live-streams/{streamId}

Het antwoord is een enkelvoudig LiveStream-object. Het manifest zal aanwezig zijn als de stream actief is.

Antwoord: 200 OK (Stream Actief)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Wekelijkse Q&A-sessie",
    "description": "Antwoorden op uw vragen live.",
    "status": "active",
    "manifest": {
      "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
    },
    "metadata": {
      "categorie": "Tech Talk",
      "host": "Jane Doe"
    },
    "tags": ["live", "q&a"],
    "created_at": "2024-08-01T10:00:00Z"
  }
}
Video'sVideo's uploaden