Aller au contenu principal

Utiliser l'API Vimeo Live

Cette fonctionnalité est disponible avec un abonnement Vimeo Enterprise.

Cet article contient des informations sur la récupération des détails des événements en direct à l'aide de l'API Vimeo Live. Plus de détails sont disponibles sous Référence API.

Sommaire de l'article :

Récupérer les détails d'un événement récurrent

Lors d'un événement en direct, nous conseillons d'intégrer un conteneur d'événements plutôt qu'un clip individuel, afin de garantir que le même code d'intégration continue de fonctionner en cas de déconnexion et de reconnexion.

À l'aide de l'API, récupérez le conteneur d'événements par ID :

https://api.vimeo.com/live_events/{event_id}

En fonction de la réponse, récupérez le code iframe intégrable à partir de embed:html.

La discussion est-elle activée ? "chat_enabled" true/false

Si c'est le cas, "chat_embed_code" contient le code iframe intégrable.

Si vous ne recevez pas de réponse en vous basant sur l'ID, ce dernier peut être associé à un événement unique. Consultez la section « Récupérer les détails d'un clip vidéo individuel ou d'un événement unique ».

Voici quelques informations au sujet du conteneur d'événements dont vous aurez peut-être besoin pour votre demande :

  • "stream privacy" reflète le niveau de confidentialité
  • "embed" : "public", "whitelist" ou "private". Les partenaires ne pourront pas intégrer les éléments marqués "private"
  • "stream_password" renvoie au mot de passe du stream
  • "badges" contient des informations sur le clip à destination du player
    • "live" informe sur les données suivantes : "streaming": true/false ou archived: true/false
    • "vod" informe si le contenu est en VOD ou non

Une documentation détaillée est disponible sous Référence API.

Après l'événement - Clips pour les événements récurrents

Après l'événement, l'intégration du player affichera l'un des trois éléments suivants :

  • Le dernier clip VOD de la session précédente
  • Un message indiquant que le (prochain) stream n'a pas encore commencé
  • Un nouvel événement, si l'événement récurrent est utilisé dans le cadre d'un nouveau stream.

Un affichage fiable du clip VOD approprié nécessitera l'intégration du clip individuel et non pas de l'événement. Il vous faudra obtenir l'identifiant et les données du clip individuel à partir de la réponse de l'API de l'événement.

L'événement récurrent contient deux objets pertinents. L'objet à référencer dépend du moment où vous récupérez les données.

  • live_clips - (après le stream). Un tableau contenant tous les clips vidéo réalisés lors de l'événement, contenant l'identifiant de la vidéo et l'horodatage de l'époque à laquelle l'événement a été diffusé. 
  • streamable_clip - (avant/pendant le stream). Il s'agit du clip actif avant/pendant un stream. L'identifiant et le code d'intégration correspondent au clip individuel pendant le flux ainsi qu'à la VOD qui en résulte.

Après l'interruption d'un stream, les informations relatives à son clip sont stockées dans le tableau live_clips. Les données streamable_clip seront modifiées et contiendront les informations relatives au prochain clip à diffuser.

Récupérez les détails d'un clip vidéo individuel ou d'un événement ponctuel

Vous pouvez accéder à un clip vidéo directement depuis l'identifiant. Cette méthode est utilisée pour accéder aux détails d'un événement unique ou d'une VOD individuelle. L'identifiant et l'intégration ne changeront pas lorsque les vidéos en direct passeront en VOD.

Détails d'un clip vidéo individuel :

https://api.vimeo.com/videos/{video_id}
  • "link" renvoie à l'url
  • "embed" contient les propriétés d'intégration pour le clip
  • "html" correspond à la source iframe pour le clip
  • "badges" contient des informations sur le clip à destination du player
  • "live" informe sur les données suivantes : "streaming": true/false ou archived: true/false
  • "vod" informe si le contenu est en VOD ou non
  • "chat_embed_code" est le code d'intégration pour le chat. Il peut être hérité s'il s'agit d'un événement récurrent en direct (RLE).
  • "chat_enabled" est true/false. Il peut être hérité s'il s'agit d'un événement récurrent en direct (RLE).
  • "live" contient des informations pour le streaming ainsi que des informations sur le contenant de l'événement parent, le cas échéant

Les détails sont disponibles sous Référence API.

Articles associés