Živé přenosy API
Živé přenosy API poskytnou koncovky pro objevování a získávání informací o vašich živých událostech. To vám umožňuje stavět “živé nyní” adresáře a vkládat živé hráče do svých aplikací.
Získejte aktivní žijící přenosy
Tato je primární koncovka pro objevování přenosů, které jsou aktuálně “v provozu”. Vrací seznam pouze těch přenosů, které jsou aktivně přijímány signál z encoderu.
GET /live-streams/active
Parametry
Tato koncovka nepotřebuje žádné parametry. Budou vráceny všechny aktivní přenosy pro váš účet.
Příklad požadavku
GET /api/client/v1/live-streams/active
Host: https://vaše-aplikace.cz
Autorizace: Bearer sk-vaše-api-klíč-zde
Odpověď: GET /live-streams/active
Pokud jsou přenosy aktivní, budete obdržet pole LiveStream
objektů. Status bude aktivní
a přítomný bude objekt manifest
.
{
"data": [
{
"id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
"title": "Týdenní Q&A Soutěž",
"description": "Odpovídáme na vaše otázky živě.",
"status": "aktivní",
"manifest": {
"hls_url": "https://vaše-aplikace.cz/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
},
"metadata": {
"kategorie": "Technické diskuse",
"host": "Jane Doe"
},
"značky": ["živý", "q&a"],
"vytvořeno": "2024-08-01T10:00:00Z"
}
]
}
Pokud nejsou žádné přenosy aktuálně aktivní, vrátí API prázdné pole data
.
{
"data": []
}
Získejte všechny žijící přenosy
Tato koncovka poskytuje stránkovatelný adresář všech živých přenosů nakonfigurovaných v vašem účtu, bez ohledu na jejich aktuální stav (aktivní nebo neaktivní). Je to užitečné pro stavbu rozvrhu nebo kompletní seznam dostupných kanálů.
GET /live-streams
Parametry
Název | Typ | Povinné | Popis |
---|---|---|---|
per_page | integer | Volitelné | Počet přenosů vrácených na stránku. Výchozí: 15 , Maximální: 100 . |
Příklad požadavku
GET /api/client/v1/live-streams?per_page=2
Odpověď: GET /live-streams
Odpověď je standardní stránkovatelný seznam. Status bude aktivní
nebo neaktivní
, a objekt manifest
bude přítomen pouze pro aktivní přenosy.
{
"data": [
{
"id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
"title": "Týdenní Q&A Soutěž",
"description": "Odpovídáme na vaše otázky živě.",
"status": "aktivní",
"manifest": {
"hls_url": "https://vaše-aplikace.cz/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
},
"metadata": {
"kategorie": "Technické diskuse"
},
"značky": ["živý", "q&a"],
"vytvořeno": "2024-08-01T10:00:00Z"
},
{
"id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
"title": "Nápadný Produktový Start",
"description": "Připojte se k velkému odhalení.",
"status": "neaktivní",
"metadata": {
"kategorie": "Produkt"
},
"značky": ["start", "událost"],
"vytvořeno": "2024-07-25T15:00:00Z"
}
],
"odkazy": {
"první": "https://vaše-aplikace.cz/api/client/v1/live-streams?page=1",
"poslední": "https://vaše-aplikace.cz/api/client/v1/live-streams?page=3",
"předchozí": null,
"následující": "https://vaše-aplikace.cz/api/client/v1/live-streams?page=2"
},
"meta": {
"současná stránka": 1,
"od": 1,
"poslední stránka": 3,
"cesta": "https://vaše-aplikace.cz/api/client/v1/live-streams",
"počet na stránku": 2,
"do": 2,
"celkový počet": 6
}
}
Získejte jeden žijící přenos
Získává plné podrobnosti o jednom konkrétním živém přenosu podle jeho ID. Je to koncovka, kterou byste volali pro získání potřebných informací k načtení přenosu do hráče.
GET /live-streams/{streamId}
Cestovní parametry
Název | Typ | Popis |
---|---|---|
streamId | uuid | Povinné. Unikátní identifikátor živého přenosu. |
Příklad požadavku
GET /api/client/v1/live-streams/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f
Odpověď: GET /live-streams/{streamId}
Odpověď je jeden objekt LiveStream
. Objekt manifest
bude přítomen, pokud je přenos aktivní.
{
"data": {
"id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
"title": "Týdenní Q&A Soutěž",
"description": "Odpovídáme na vaše otázky živě.",
"status": "aktivní",
"manifest": {
"hls_url": "https://vaše-aplikace.cz/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
},
"metadata": {
"kategorie": "Technické diskuse",
"host": "Jane Doe"
},
"značky": ["živý", "q&a"],
"vytvořeno": "2024-08-01T10:00:00Z"
}
}