Zum Hauptinhalt gehen

Verwenden der Vimeo-Live-API

Für diese Funktion ist ein Vimeo Enterprise-Tarif erforderlich.

Dieser Artikel enthält Informationen zum Abrufen von Details über Live-Events mit der Vimeo-Live-API. Weitere Details findest du in der API-Referenz.

In diesem Artikel:

Details für ein wiederkehrendes Event abrufen

Während eines Live-Events empfehlen wir, eher den Event-Container anstelle des zugrunde liegenden einzelnen Clips einzubetten, um sicherzustellen, dass derselbe Einbettungscode auch nach dem Trennen/Wiederherstellen der Verbindung weiterhin funktioniert.

Verwende die API, um den Event-Container über die ID abzurufen:

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

Rufe aus der Antwort anschließend den einbettbaren iFrame-Code von embed:html ab

Is chat enabled? "chat_enabled" true/false

Wenn der Wert „true“ ist, enthält „chat_embed_code“ den einbettbaren iFrame-Code.

Wenn du keine Antwort über die ID erhältst, kann es möglich sein, dass die ID mit einem einmaligen Event verbunden ist. Näheres findest du im Abschnitt „Details für einzelne Videoclips oder einmalige Events abrufen“.

Einige Details des Event-Containers, die du für deine Anwendung wissen solltest:

  • „stream privacy“ spiegelt den Grad der Privatsphäre wider
  • „embed“: „public“, „whitelist“, oder „private“. Mit der Option „private“ ist das Einbetten durch Partner nicht möglich.
  • „stream_password“ gibt das Passwort für den Stream wieder
  • „badges“ enthält Informationen über den Clip, um den Player zu informieren:
    • „live“ gibt an, ob „streaming“:true/false oder archived true/false ist
    • „vod“ gibt an, ob es sich um ein VOD handelt oder nicht.

Eine ausführliche Dokumentation findest du in der API-Referenz.

Nach dem Event – Clips innerhalb wiederkehrender Events

Nach dem Event zeigt die Player-Einbettung eines von drei Dingen an:

  • Den letzten VOD-Clip der vorherigen Sitzung
  • Eine Meldung, dass der (nächste) Stream noch nicht gestartet wurde
  • Ein neues Event, wenn das wiederkehrende Event erneut zum Streamen verwendet wird.

Für eine zuverlässige Anzeige des entsprechenden VOD-Clips muss der einzelne Clip in das Event eingebettet werden. Die ID und die Daten des einzelnen Clips kannst du aus der API-Antwort des Events beziehen.

Das wiederkehrende Event enthält zwei relevante Objekte. Auf welches Objekt du dich beziehen sollst, hängt davon ab, wann du die Daten abrufst.

  • live_clips – (nach dem Stream). Ein Array aller abgeschlossenen Videoclips des Events, welche die Video-ID und den Epochen-Zeitstempel für den Zeitpunkt des Event-Streamings enthält. 
  • streamable_clip – (vor/während des Streams). Dies ist der aktive Clip vor/während eines Streams. Die ID und der Einbettungscode entsprechen dem einzelnen Clip sowohl während des Streams als auch für das zugehörige VOD.

Nachdem ein Stream gestoppt wurde, werden seine Clip-Informationen in das Array „live_clips“ verschoben, und „streamable_clip“ ändert sich und enthält die Informationen für den nächsten zu streamenden Clip.

Abrufen von Details für einzelne Videoclips oder ein einmaliges Event

Du kannst einen Videoclip direkt über die ID erreichen. Diese Methode wird für den Zugriff auf Details für ein einmaliges Event oder ein einzelnes VOD verwendet. Die ID und die Einbettung ändern sich nicht, wenn Live in VOD konvertiert wird.

Details eines einzelnen Videoclips:

https://api.vimeo.com/videos/{video_id}
  • „link“ ist die URL
  • „embed“ enthält die Eigenschaften zum Einbetten für den Clip
  •  „html“ ist die iFrame-Quelle für den Clip
  • „badges“ enthält Informationen über den Clip, um den Player zu informieren:
  • „live“ gibt an, ob „streaming“:true/false oder archived true/false ist
  • „vod“ gibt an, ob es sich um ein VOD handelt oder nicht.
  • „chat_embed_code“ ist der Einbettungscode für den Chat. Er kann bei wiederkehrenden Live-Events (RLE) vererbt werden.
  • „chat_enabled“ ist true/false. Kann bei wiederkehrenden Live-Events (RLE) vererbt werden.
  • „live“ enthält Informationen für das Streaming und ggf. Informationen über den übergeordneten Event-Container.

Details findest du in der API-Referenz.

Verwandte Beiträge

=