Skip to Content
DocumentationAPI ReferenceSuorat lähetykset

Live Streams API

The Live Streams API tarjoaa pisteitä löytämään ja hankkimaan tietoa siitä, mitä elävää sisältöä on käynnissä. Tämä mahdollistaa rakentamisen “Elävässä nyt”-luetteloihin sekä elävän sisällön sijoittamisen sovelluksiin.

Aktiivisten Elävien Sisältöjen Haku

Tämä on pääpiste, joka tarjoaa tietoa siitä, mitä sisältöjä on käynnissä. Se palauttaa listan vain niistä sisällöistä, jotka ovat aktiivisesti vastaanottamassa signaalia kooderista.

GET /live-streams/active

Parametrit

Tämä piste ei ole tarvitse parametreja. Se palauttaa kaikki käynnissä olevat sisällöt tilillesi.

Esimerkkiyhteys

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

Vastaus: GET /live-streams/active

Jos sisällöt ovat käynnissä, saat vastauksena taulukon LiveStream -objekteja. status on active ja manifest -olio on olemassa.

Vastaus: 200 OK (Sisällöt ovat käynnissä)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Viikoittainen kysymyksiin vastaus",
      "description": "Vastaa kysymyksiisi elävänä.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "category": "Tekninen keskustelu",
        "host": "Jane Doe"
      },
      "tags": ["elävä", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    }
  ]
}

Jos ei ole sisältöjä käynnissä, API palauttaa tyhjän taulukon.

Vastaus: 200 OK (Ei sisällöitä)
{
  "data": []
}

Kaikki Elävät Sisällöt

Tämä piste tarjoaa sivutettynä luettelona kaikkia eläviä sisältöjä, jotka on konfiguroitu tilillesi. Tämä on hyödyllistä rakentamiseen aikataulua tai kokonaisuutta sisällön kautta.

GET /live-streams

Parametrit

NimiTyyppiVaaditaanKuvaus
per_pageintegerVaihtoehtoinenPalautettavien sisältöjen lukumäärä sivulla. Oletus: 15, Maksimi: 100.

Esimerkkiyhteys

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

Vastaus: GET /live-streams

Vastauksena on sivutettynä luettelona. status on active tai inactive, ja manifest -olio on olemassa vain aktiivisille sisällöille.

Vastaus: 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Viikoittainen kysymyksiin vastaus",
      "description": "Vastaa kysymyksiisi elävänä.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "category": "Tekninen keskustelu"
      },
      "tags": ["elävä", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Tuleva tuotejulkaisu",
      "description": "Liity suurin piirtein palveluun.",
      "status": "inactive",
      "metadata": {
        "category": "Tuote"
      },
      "tags": ["julkistus", "tapahtuma"],
      "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": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "path": "https://your-app.com/api/client/v1/live-streams",
    "per_page": 2,
    "to": 2,
    "total": 6
  }
}

Yksittäinen Elävä Sisältö

Hakee täydelliset tiedot yhden tietyn elävän sisällön ID:stä. Tämä on piste, jota kutsut sitten tarvitsemaan tietoja lataamaan sisältöä sovellukseen.

GET /live-streams/{streamId}

Polkuparametrit

NimiTyyppiKuvaus
streamIduuidVaaditaan. Elävän sisällön yksilöllinen tunniste.

Esimerkkiyhteys

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

Vastaus: GET /live-streams/{streamId}

Vastauksena on yksittäinen LiveStream -olio. manifest on olemassa, jos sisältö on aktiivinen.

Vastaus: 200 OK (Sisältö on aktiivinen)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Viikoittainen kysymyksiin vastaus",
    "description": "Vastaa kysymyksiisi elävänä.",
    "status": "active",
    "manifest": {
      "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
    },
    "metadata": {
      "category": "Tekninen keskustelu",
      "host": "Jane Doe"
    },
    "tags": ["elävä", "q&a"],
    "created_at": "2024-08-01T10:00:00Z"
  }
}
VideotVideoiden lataaminen