Codes d'état de montage

Précédent Suivant

Les codes d'état de montage sont utilisés pour informer le lecteur si le flux est disponible et, dans le cas contraire, pourquoi. Chaque point de montage peut avoir son propre code d'état et son propre message. Dans l'API actuelle, un seul montage peut être retourné, mais les versions futures prendront en charge plusieurs requêtes de montage et les clients devront gérer le code d'état et le message de manière appropriée. De plus, lorsque le code d'état est autre que 2xx, le seul champ dont la validité est garantie est le nom du montage (par exemple, la balise <mount> ).  D'autres champs seront présents, mais leurs valeurs pourraient être invalides.

Depuis la version 1.1 de l'API d'approvisionnement du lecteur, le code HTTP renvoyé est toujours 200. Cela permet au lecteur de recevoir le fichier XML avec le code d'état de montage et d'obtenir plus d'informations sur les anomalies. En cas d'erreur de serveur ou de requête erronée, les codes HTTP standard s'appliquent.

Mount status codes (Codes d'état de montage)

CodeMessageDescription

200

OK

Demande acceptée

501

Not implemented        

La version demandée n'existe pas

400

Bad Request

Un paramètre obligatoire est introuvable ou un paramètre invalide a été envoyé

404

Not Found

Le montage n'existe pas

453

Forbidden (Content Access Denied)        

L'accès à ce montage est refusé (par exemple, l'adresse IP du client est géobloquée)

Exemple de réponse XML pour un code d'état non 200 :

<?xml version="1.0" encoding="UTF-8"?standalone="yes"?>
<live_stream_config version="1.9" xmlns="http://provisioning.streamtheworld.com/player/livestream-1.9">
<mountpoints>
  <mountpoint>
    <status>
      <status-code>453</status-code>
      <status-message>Forbidden (Content Access Denied)</status-message>
    </status>
 
    <mount>WXYZFM</mount> 
 
    <!-- Optional Section --> 
    <alternate-content> 
      <url>[URL to alternate content]</url> 
      <!-- OR --> 
      <mount>[Alternate Mount Name]</mount> 
    </alternate-content> 
  </mountpoint> 
</mountpoints> 
</live_stream_config>

Contenu de substitution

Lorsqu'un flux est géobloqué (c'est-à-dire, un code d'état 453 est renvoyé), il est possible qu'un contenu de substitution soit proposé à l'auditeur qui a été bloqué. Comme indiqué ci-dessus, il sera envoyé dans la réponse dans un élément <alternate-content> , lui-même contenant l'un des éléments indiqués dans le tableau ci-dessous.

Éléments de contenu de substitution

BaliseDescription

<url>

URL renvoyant vers un fichier audio (en général) qui doit être lu par l'auditeur.

<mount>

Nom de montage ers lequel l'auditeur doit être réorienté.  Ceci est géré par le lecteur, par le biais d'une autre émission d'un nouvel appel d'approvisionnement au montage de substitution avant d'essayer de se connecter.