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 endpoint for at opdage strømme, der er aktivt på luften. Den returnerer en liste med kun de strømme, der aktivt modtager signal fra en encoder.
GET /live-streams/active
Parametre
Denne endpoint tager ikke nogen parametre. Det vil returnere alle aktive strømme for din konto.
Eksempel anmodning
GET /api/client/v1/live-streams/active
Host: https://din-app.com
Authorization: Bearer sk-din-api-nøgle-hereSvar: GET /live-streams/active
Hvis strømme er aktive, vil du modtage en array af LiveStream objekter. Den status vil være active og et manifest objekt vil være til stede.
{
"data": [
{
"id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
"title": "Ugentlige Q&A Session",
"beskrivelse": "Svarer på dine spørgsmål live.",
"status": "active",
"manifest": {
"hls_url": "https://din-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
},
"metadata": {
"kategori": "Teknisk Tale",
"vært": "Jane Doe"
},
"tags": ["live", "q&a"],
"created_at": "2024-08-01T10:00:00Z"
}
]
}Hvis der ikke er nogen strømme, der er aktivt på luften, vil API returnere en tom data array.
{
"data": []
}Få alle live streams
Denne endpoint tilbyder en pagineret katalog over alle live streams, der er konfigureret i din konto, uanset deres nuværende status (aktiv eller inaktiv). Dette er nyttigt for at bygge en kalender eller en fuldstændig liste over tilgængelige kanaler.
GET /live-streams
Parametre
| Navn | Type | Kræves | Beskrivelse |
|---|---|---|---|
per_page | integer | Optional | Antallet af strømme, der skal returneres per side. Standard: 15, Max: 100. |
Eksempel anmodning
GET /api/client/v1/live-streams?per_page=2Svar: GET /live-streams
Svaret er en standard pagineret liste. Den status vil være active eller inactive, og det manifest objekt vil kun være til stede for aktive strømme.
{
"data": [
{
"id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
"title": "Ugentlige Q&A Session",
"beskrivelse": "Svarer på dine spørgsmål live.",
"status": "active",
"manifest": {
"hls_url": "https://din-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
},
"metadata": {
"kategori": "Teknisk Tale"
},
"tags": ["live", "q&a"],
"created_at": "2024-08-01T10:00:00Z"
},
{
"id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
"title": "Fremtidig Produkt Lancer",
"beskrivelse": "Del med os på den store aften.",
"status": "inactive",
"metadata": {
"kategori": "Produkt"
},
"tags": ["launch", "event"],
"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": {
"current_page": 1,
"from": 1,
"last_page": 3,
"path": "https://din-app.com/api/client/v1/live-streams",
"per_page": 2,
"to": 2,
"total": 6
}
}Få en enkelt live stream
Henter fuldstemt detaljer for én bestemt live stream ved hjælp af dens ID. Dette er endpointen, du ville kalde til at få de nødvendige oplysninger til at laste en strøm ind i en spiller.
GET /live-streams/{streamId}
Sti Parametre
| Navn | Type | Beskrivelse |
|---|---|---|
streamId | uuid | Kræves. Den unikke identifier for live stream. |
Eksempel anmodning
GET /api/client/v1/live-streams/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8fSvar: GET /live-streams/{streamId}
Svaret er et enkelt LiveStream objekt. Det manifest vil være inkluderet, hvis strømmen er aktiv.
{
"data": {
"id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
"title": "Ugentlige Q&A Session",
"beskrivelse": "Svarer på dine spørgsmål live.",
"status": "active",
"manifest": {
"hls_url": "https://din-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
},
"metadata": {
"kategori": "Teknisk Tale",
"vært": "Jane Doe"
},
"tags": ["live", "q&a"],
"created_at": "2024-08-01T10:00:00Z"
}
}