Skip to Content
DocumentationAPI ReferenceDiffusions en direct

Diffusion en direct API

La diffusion en direct API fournit des points de terminaison pour découvrir et récupérer des informations sur vos événements en direct. Cela vous permet de construire des répertoires “Diffusion en direct” et d’insérer des lecteurs en direct dans vos applications.

Obtenir les diffusions actives

C’est le point de terminaison principal pour découvrir les flux qui sont actuellement “en diffusion”. Il retourne une liste contenant uniquement les flux qui reçoivent actuellement un signal à partir d’un encodeur.

GET /live-streams/active

Paramètres

Ce point de terminaison ne prend pas de paramètres. Il renverra tous les flux actifs pour votre compte.

Exemple de requête

GET /api/client/v1/live-streams/active
Host: https://votre-app.com
Authorization: Bearer sk-votre-api-clé-ici

Réponse : GET /live-streams/active

Si les flux sont actifs, vous recevrez un tableau de LiveStream objects. Le status sera active et un objet manifest sera présent.

Réponse : 200 OK (Flux Actif)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Séance de questions hebdomadaire",
      "description": "Répondre à vos questions en direct.",
      "status": "active",
      "manifest": {
        "hls_url": "https://votre-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "catégorie" : "Tech Talk",
        "hôte" : "Jane Doe"
      },
      "étiquettes" : ["en direct", "q&a"],
      "created_at" : "2024-08-01T10:00:00Z"
    }
  ]
}

Si aucun flux n’est actuellement en diffusion, le API renverra un tableau vide.

Réponse : 200 OK (Aucun Flux Actif)
{
  "data": []
}

Obtenir toutes les diffusions

Ce point de terminaison fournit un répertoire paginé de toutes les diffusions configurées dans votre compte, quel que soit leur statut actuel (actif ou inactif). Cela est utile pour construire un planning ou une liste complète des canaux disponibles.

GET /live-streams

Paramètres

NomTypeObligatoireDescription
per_pageentierOptionnelLe nombre de flux à retourner par page. Défaut : 15, Max : 100.

Exemple de requête

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

Réponse : GET /live-streams

La réponse est une liste paginée standard. Le status sera active ou inactive, et l’objet manifest ne sera présent que pour les flux actifs.

Réponse : 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Séance de questions hebdomadaire",
      "description": "Répondre à vos questions en direct.",
      "status": "active",
      "manifest": {
        "hls_url": "https://votre-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "catégorie" : "Tech Talk"
      },
      "étiquettes" : ["en direct", "q&a"],
      "created_at" : "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Lancement de produit à venir",
      "description" : "Rejoignez-nous pour la grande révélation.",
      "status" : "inactive",
      "metadata": {
        "catégorie" : "Produit"
      },
      "étiquettes" : ["lancement", "événement"],
      "created_at" : "2024-07-25T15:00:00Z"
    }
  ],
  "liens" : {
    "premier" : "https://votre-app.com/api/client/v1/live-streams?page=1",
    "dernier" : "https://votre-app.com/api/client/v1/live-streams?page=3",
    "précédent" : null,
    "suivant" : "https://votre-app.com/api/client/v1/live-streams?page=2"
  },
  "meta" : {
    "page actuelle" : 1,
    "de" : 1,
    "dernière page" : 3,
    "chemin" : "https://votre-app.com/api/client/v1/live-streams",
    "par page" : 2,
    "à" : 2,
    "total" : 6
  }
}

Obtenir une seule diffusion

Récupère les détails complets pour une diffusion en direct spécifique par son ID. C’est le point de terminaison que vous appelez pour obtenir les informations nécessaires pour charger un flux dans un lecteur.

GET /live-streams/{streamId}

Paramètres de chemin

NomTypeDescription
streamIduuidRequis. L’identifiant unique de la diffusion en direct.

Exemple de requête

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

Réponse : GET /live-streams/{streamId}

La réponse est un objet LiveStream unique. Le manifest sera inclus si le flux est actif.

Réponse : 200 OK (Flux Actif)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Séance de questions hebdomadaire",
    "description": "Répondre à vos questions en direct.",
    "status": "active",
    "manifest": {
      "hls_url": "https://votre-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
    },
    "metadata": {
      "catégorie" : "Tech Talk",
      "hôte" : "Jane Doe"
    },
    "étiquettes" : ["en direct", "q&a"],
    "created_at" : "2024-08-01T10:00:00Z"
  }
}
VidéosTéléchargements de vidéos