Skip to Content
DocumentationAPI ReferenceLivestreams

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å Aktiva Live Streams

Detta är den primära slutpunkten för att upptäcka strömmar som är “på luftning”. Den returnerar en lista med endast de strömmar som aktivt mottar ett signal från en encoder.

GET /live-streams/active

Parametrar

Den här slutpunkten tar inte några parametrar. Den kommer att returnera alla aktiva strömmar för din konto.

Exempelbegäran

GET /api/client/v1/live-streams/active
Host: https://din-app.com
Authorization: Bearer sk-din-api-nyckel-här

Svar: GET /live-streams/active

Om strömmarna är aktiva kommer du att få tillbaka en array av LiveStream objekt. Den status kommer att vara active och ett manifest objekt kommer att finnas.

Svar: 200 OK (Strömmar Aktiva)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Veckans Q&A-session",
      "description": "Svarar på dina frågor live.",
      "status": "active",
      "manifest": {
        "hls_url": "https://din-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "kategori": "Tekniskt samtal",
        "värd": "Jane Doe"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    }
  ]
}

Om inga strömmar är aktiva kommer API att returnera en tom data-array.

Svar: 200 OK (Inga Strömmar Aktiva)
{
  "data": []
}

Få Alla Live Streams

Den här slutpunkten ger en sidorbetad katalog över alla live-strömmar som är konfigurerade i ditt konto, oavsett deras nuvarande status (aktiv eller inaktiv). Detta är användbart för att bygga en schema eller en komplett lista med tillgängliga kanaler.

GET /live-streams

Parametrar

NamnTypKrävsBeskrivning
per_pageintegerValfrittAntalet strömmar att returnera per sida. Standard: 15, Max: 100.

Exempelbegäran

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

Svar: GET /live-streams

Svaret är en standard sidorbetad lista. Den status kommer att vara active eller inactive, och den manifest objektet kommer endast att finnas för aktiva strömmar.

Svar: 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Veckans Q&A-session",
      "description": "Svarar på dina frågor live.",
      "status": "active",
      "manifest": {
        "hls_url": "https://din-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "kategori": "Tekniskt samtal"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Kommande Produktlansering",
      "description": "Anslut dig till den stora avslöjningen.",
      "status": "inactive",
      "metadata": {
        "kategori": "Produkt"
      },
      "tags": ["lansering", "händelse"],
      "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": {
    "nuvarande_sida": 1,
    "från": 1,
    "senaste_sidan": 3,
    "länk": "https://din-app.com/api/client/v1/live-streams",
    "per_page": 2,
    "till": 2,
    "total": 6
  }
}

Hämta en Enstaka Live Stream

Hämtar fullständiga detaljer för en specifik live-ström genom dess ID. Detta är slutpunkten du skulle kalla för att få den nödvändiga informationen för att ladda upp en ström i ett spelare.

GET /live-streams/{streamId}

Sockelparametrar

NamnTypBeskrivning
streamIduuidKrävs. Den unika identifieraren för den live-strömmen.

Exempelbegäran

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

Svar: GET /live-streams/{streamId}

Svaret är ett enda LiveStream objekt. Den manifest kommer att finnas med om strömmen är aktiv.

Svar: 200 OK (Strömmen är Aktiv)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Veckans Q&A-session",
    "description": "Svarar på dina frågor live.",
    "status": "active",
    "manifest": {
      "hls_url": "https://din-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
    },
    "metadata": {
      "kategori": "Tekniskt samtal",
      "värd": "Jane Doe"
    },
    "tags": ["live", "q&a"],
    "created_at": "2024-08-01T10:00:00Z"
  }
}
VideorVideouppladdningar