Skip to Content
DocumentationAPI ReferenceStrømmende live-innstillinger

Live Streams API

The Live Streams API provides endpoints for discovering and retrieving information about your live events. This allows you to build “Live Now” directories and embed live players into your applications.

Få Aktive Live Streams

Dette er den primære endpointen for å oppdage strømmene som er aktivt på lufta. Den returnerer en liste med bare de strømmer som aktivt mottar signal fra en encoder.

GET /live-streams/active

Parametre

Denne endpointet tar ikke noen parametre. Det vil returnere alle aktive strømmer for din konto.

Eksempel på forespørsel

GET /api/client/v1/live-streams/active
Host: https://din-app.com
Autorisasjon: Bearer sk-din-api-nøkkel-here

Respons: GET /live-streams/active

Hvis strømmene er aktivt, vil du motta en liste med LiveStream-objekter. Den status vil være aktiv og et manifest-objekt vil være til stede.

Respons: 200 OK (Strømmer Aktiv)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Ukevis Q&A-sesjon",
      "beskrivelse": "Svarer på dine spørsmål live.",
      "status": "aktiv",
      "manifest": {
        "hls_url": "https://din-app.com/lagring/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/anpassende/master.m3u8"
      },
      "metadata": {
        "kategori": "Teknisk diskusjon",
        "vert": "Jane Doe"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    }
  ]
}

Hvis ingen strømmer er aktivt nå, vil API returnere en tom liste.

Respons: 200 OK (Ingen Strømmer Aktiv)
{
  "data": []
}

Få Alle Live Streams

Denne endpointet gir en paginert katalog over alle live strømmene konfigurert i din konto, uavhengig av deres nåværende status (aktiv eller inaktiv). Dette er nyttig for å bygge en kalender eller en fullstendig liste med tilgjengelige kanaler.

GET /live-streams

Parametre

NavnTypeObligatoriskBeskrivelse
per_pageintegerValgfrittAntall strømmer å returnere per side. Standard: 15, Maksimum: 100.

Eksempel på forespørsel

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

Respons: GET /live-streams

Responsen er en standard paginert liste. Den status vil være aktiv eller inaktiv, og det manifest-objektet vil bare være til stede for aktive strømmer.

Respons: 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Ukevis Q&A-sesjon",
      "beskrivelse": "Svarer på dine spørsmål live.",
      "status": "aktiv",
      "manifest": {
        "hls_url": "https://din-app.com/lagring/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/anpassende/master.m3u8"
      },
      "metadata": {
        "kategori": "Teknisk diskusjon"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Kommande Produktlansering",
      "beskrivelse": "Slutt deg til for den store avsløringen.",
      "status": "inaktiv",
      "metadata": {
        "kategori": "Produkt"
      },
      "tags": ["lansering", "arrangement"],
      "created_at": "2024-07-25T15:00:00Z"
    }
  ],
  "links": {
    "first": "https://din-app.com/api/client/v1/live-streams?page=1",
    "last": "https://din-app.com/api/client/v1/live-streams?page=3",
    "prev": null,
    "next": "https://din-app.com/api/client/v1/live-streams?page=2"
  },
  "meta": {
    "nåværende side": 1,
    "fra": 1,
    "siste side": 3,
    "path": "https://din-app.com/api/client/v1/live-streams",
    "per_page": 2,
    "til": 2,
    "total": 6
  }
}

Få en Enkelt Live Strøm

Henter full detaljinformasjon for én spesifik live strøm ved hjelp av dens ID. Dette er endpointet du ville kalle hvis du ønsker å få nødvendig informasjon til å laste inn en strøm i en spillere.

GET /live-streams/{streamId}

Sti Parametre

NavnTypeBeskrivelse
streamIduuidObligatorisk. Den unike identifieren til live strømmen.

Eksempel på forespørsel

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

Respons: GET /live-streams/{streamId}

Responsen er et enkelt LiveStream-objekt. Det manifest vil være inkludert hvis strømmen er aktiv.

Respons: 200 OK (Strømmer Aktiv)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Ukevis Q&A-sesjon",
    "beskrivelse": "Svarer på dine spørsmål live.",
    "status": "aktiv",
    "manifest": {
      "hls_url": "https://din-app.com/lagring/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/anpassende/master.m3u8"
    },
    "metadata": {
      "kategori": "Teknisk diskusjon",
      "vert": "Jane Doe"
    },
    "tags": ["live", "q&a"],
    "created_at": "2024-08-01T10:00:00Z"
  }
}
VideofilmerVideoupload