API en direct : Points d'entrée statiques

Cette rubrique explique les points d'entrée statiques et comment les implémenter à l'aide de l'API Live.

Introduction

La fonction Static Entry Points (SEP) permet une tâche en direct de longue durée qui peut être activée et désactivée tout en gardant les URL de point d'entrée et les URL de lecture statiques et réutilisables. Cette fonctionnalité permet aux clients de configurer leur encodeur dans leurs installations ou sur le terrain et permet au client de créer sa propre logique de programmation pour les chaînes ou les programmes en direct.

DVR et SEP

La capacité DVR est disponible pour les points d'entrée statiques, mais uniquement lorsque le SEP est activé.

Création d'un point d'entrée statique

Le standard Créer un travail L'opération will est utilisée, mais pour l'ajout de points d'entrée statiques, une propriété devra être ajoutée à la demande de travail :

"static": true

L'URL RTMP de réponse de cette tâche sera statique et pourra ensuite être réutilisée en activant/désactivant la tâche avec les opérations décrites dans les sections ci-dessous. Veuillez lire et comprendre les limitations énumérées à la fin de ce document.

Temps d'attente maximal

Une fois qu'une tâche SEP est activée, elle se désactivera automatiquement après un certain temps si l'encodeur n'est pas démarré. Les règles sont les suivantes :

  • Si la event_length valeur est supérieure à 30 minutes, la tâche se terminera automatiquement dans 30 minutes par défaut. Si vous souhaitez modifier le temps d'attente, vous devez contacter le support. La désactivation automatique ne peut pas être désactivée.
  • Si la event_length valeur est inférieure à reconnect_time, la tâche se terminera dans le délai imparti pour event_length.

Activer la diffusion en direct SEP

Pour activer un flux en direct de point d'entrée statique, envoyez la requête suivante à l'API Live :

Flux SEP actif
Méthode PUT
Point de terminaison
https://api.bcovlive.io/v1/jobs/{jobID}/activate

Aucun corps de requête n'est requis.

Désactiver la diffusion en direct SEP

Pour désactiver un flux en direct de point d'entrée statique, envoyez la requête suivante à l'API Live :

Flux SEP actif
Méthode PUT
Point de terminaison
https://api.bcovlive.io/v1/jobs/{jobID}/deactivate

Aucun corps de requête n'est requis.

Annuler un travail SEP

Pour arrêter définitivement un travail de point d'entrée statique, vous pouvez annuler le travail comme vous le feriez pour n'importe quel travail en direct, en envoyant un PUT demander le point de terminaison /jobs/{job_id}/cancel. Voir le Référence API pour tous les détails.

Contraintes

  • Live to VOD ne peut pas être configuré pour archiver le flux à la fin.

    Solutions de rechange :

    • Utilisation coupure pour archiver l'intégralité de l'événement en direct en tant que VOD. La fenêtre d'écrêtage sera disponible pour la durée standard après un événement ou jusqu'à la prochaine activation du SEP (selon la plus courte des deux).
  • Les paramètres du travail ne peuvent pas être modifiés. Ils sont actuellement liés aux paramètres qui ont initialement créé le SEP.
  • L'activation du flux peut prendre jusqu'à 60 secondes pour que le point d'entrée soit disponible.

    Meilleure pratique :

    Implémentez les notifications de la plate-forme Live pour les changements d'état des tâches afin d'obtenir des mises à jour en temps réel lorsqu'une tâche SEP est réellement prête.

    Solutions de rechange :

    1. Activez le flux au moins 60 secondes avant de démarrer l'encodeur.
    2. Si l'encodeur a une nouvelle tentative intégrée (Wirecast, Elemental, etc.), le flux peut être connecté immédiatement (bien qu'il puisse y avoir quelques erreurs) et les encodeurs se reconnecteront dès que le point d'entrée sera disponible.
  • Reconnect_time est toujours applicable pour les travaux SEP sur les déconnexions de l'encodeur. Si l'heure de reconnexion est atteinte, la tâche SEP sera remise à l'état désactivé.

    Meilleure pratique :

    Désactivez toujours un flux via les API lorsqu'un travail se termine et définissez l'heure de reconnexion sur une fenêtre de temps d'attente acceptable en cas de déconnexion (les coûts d'heure d'entrée sont cumulés pendant cette période d'attente).

  • Chaque compte ne recevra que 3 emplois SEP disponibles par région. Si vous atteignez la limite, vous devrez Annuler l'un de vos travaux SEP avant de pouvoir en créer un nouveau.

    Si vous avez atteint le nombre maximal de tâches SEP et tentez d'en créer une autre, l'erreur suivante sera renvoyée :

    {
      "error": "You've reached the number of static entry points jobs you can create for your account"
    }
  • Si vous tentez d'activer plus de 5 tâches SEP à la fois, une erreur semblable à la suivante s'affiche :
    {
      “message”:“Allocating additional streaming capacity to the region. Please retry your request.: no_streaming_capacity_in_region”,
      “statusCode”:500,
      “name”:“ApiError”,
      “isApiError”:true
    }

    Vous devrez attendre la fin de l'activation de certains travaux avant de réessayer la demande.

Remarques

Coupure des tâches SEP après la désactivation
Les utilisateurs peuvent créer des clips jusqu'à la prochaine activation du flux, ou pendant 7 jours, selon la durée la plus courte. Lorsque le flux est réactivé, les sessions d'enregistrement précédentes sont supprimées du serveur et ne peuvent plus être coupées.
Quelle est la durée du champ stream_start_time lorsqu'un SEP est utilisé ?
Lorsqu'un SEP est activé, cela sera considéré comme l'heure de début.