Voici ci-dessous un exemple de réponse XML pour réussir une requête typique.
<?xml version="1.0" encoding="UTF-8"?>
<live_stream_config version="1.10" xmlns="https://provisioning.streamtheworld.com/player/livestream-1.10">
<mountpoints>
<mountpoint tags="td-lowdelay">
<status>
<status-code>200</status-code>
<status-message>OK</status-message>
</status>
<transports>
<transport>http</transport>
<transport mountSuffix="_SC">shoutcast</transport>
<transport mountSuffix="HLS/playlist.m3u8">hls</transport>
<transport mountSuffix="/HLSTS/playlist.m3u8">hlsts</transport>
</transports>
<metadata>
<shoutcast-v1 enabled="true" mountSuffix="_SC"/>
<shoutcast-v2 enabled="true" mountSuffix="_SC"/>
<sse-sideband enabled="true" mountSuffix="_SBM"/>
</metadata>
<servers>
<server sid="1681">
<ip>1681.live.streamtheworld.com</ip>
<ports>
<port type="http">80</port>
<port type="http">3690</port>
<port type="http">443</port>
</ports>
</server>
<server sid="2310">
<ip>2310.live.streamtheworld.com</ip>
<ports>
<port type="http">80</port>
<port type="http">443</port>
</ports>
</server>
</servers>
<metrics>
<listener-tracking url="https://test-prod.webcastmetrics.com/lt" wcm-station-id="35892" />
<tag name="uuid"/>
</metrics>
<mount>WXYZFM</mount>
<format>FLV</format>
<audio>96000</audio>
<media-format container="flv" cuepoints="stwcue" trackScheme="audio">
<audio index="0" samplerate="44100" codec="heaacv2" bitrate="32000" channels="2" tags="low-bw"/>
</media-format>
<authentication>0</authentication>
<timeout>0</timeout>
<send-page-url>1</send-page-url>
<!-- Optional Section -->
<side-channels>
<station name="WXYZ_SIDECHAN1"/>
<station name="WXYZ_SIDECHAN2"/>
</side-channels>
</mountpoint>
<!-- Other mount points may be present if request was by station name -->
<mountpoint .../>
</mountpoints>
</live_stream_config>
Le schéma XML correspondant est disponible à l'URL suivante :
https://playerservices.streamtheworld.com/schema/livestream-1.10.xsd
Commentaires supplémentaires pour les balises importantes
Name | Valeur |
---|---|
<live_stream_config> | L’attribut version représente la version du format de fichier de configuration. Les versions 1, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9 et 1.10 sont actuellement prises en charge. La valeur de cet attribut correspond au numéro de version transmis lors de la requête initiale. Nous vous recommandons vivement d’utiliser la version la plus récente (1.10). |
<status-code> | L'état de montage, sous la forme d'un nombre entier à trois chiffres. Voir Codes d'état de montage pour plus de détails. |
<status-message> | Une description textuelle de l'état du montage. Le message est toujours en anglais et peut être utilisé en vue d'un affichage à l'utilisateur. Cependant, il est recommandé que l'application cliente implémente son propre dictionnaire de chaînes de caractères pour afficher des messages plus concis pour l'utilisateur, en fonction du code d'état. Dans ce cas, ce message peut être utilisé comme une solution de secours si le client ne connaît pas le code d'état. |
<transport> | Cet élément peut apparaître plusieurs fois et indique quel(s) transport(s) est (sont) pris en charge pour ce montage. L’attribut mountSuffix indique un suffixe qui doit être ajouté au nom du montage lors de la demande du flux. Lorsque la propriété timeshift="true » est ajoutée à un transport HLSRW, cela signifie que l’URL HLS disponible est compatible avec Timeshift Radio. |
<shoutcast-v1> | Spécifie que les métadonnées Shoutcast v1 sont disponibles pour ce montage (enabled="true ») et quel suffixe (via mountSuffix="<suffix> ») à ajouter à l’URL du flux lors de la connexion. Remarque : pour Shoutcast V1, les métadonnées sont multiplexées dans le flux, de sorte que le suffixe de montage est identique au flux lui-même – il n’est pas nécessaire d’établir une deuxième connexion pour obtenir les métadonnées. |
<shoutcast-v2> | Spécifie si les métadonnées Shoutcast v2 sont disponibles pour ce montage (quand enabled="true" et quel suffixe (via mountSuffix="<suffix>") doit être ajouté à l’URL du flux lors de la connexion. Remarque : pour Shoutcast V2, les métadonnées sont multiplexées dans le flux, de sorte que le suffixe de montage est identique au flux lui-même – il n’est pas nécessaire d’établir une deuxième connexion pour obtenir les métadonnées. |
<sse-sideband> | Spécifie si les métadonnées de bande latérale sont disponibles pour ce montage (lorsque enabled="true ») et quel suffixe (via mountSuffix="<suffix> »= est utilisé par les joueurs pour construire l’URL des métadonnées du montage s’ils utilisent SBM. Voir Métadonnées de bande latérale pour plus d'informations. |
<server> | Cet élément peut apparaître plusieurs fois lorsque le flux d'un montage est hébergé sur plusieurs serveurs. L'attribut sid indique l’ID du serveur. |
<ip> | Adresse IP du serveur. |
<port> | Cet élément peut apparaître plusieurs fois. Il indique le(s) port(s) que le serveur écoute. L’attribut type indique, pour chaque port, le type de connexion pris en charge par le port :
|
<metrics> | La balise < métriques > fait partie des informations d’approvisionnement afin d’informer le lecteur de l’URL nécessaire pour appeler l’API Triton Listener Tracking (LT). Pour plus d'informations sur l'API LT et les risques liés à la duplication des mesures, veuillez vous adresser à votre représentant Triton Digital. |
<mount> | Le nom du montage (identique au paramètre de montage dans la requête) |
<format> | Le format du flux. Les formats et codecs actuellement autorisés sont : FLV : Audio : MP3, AAC. Vidéo : On2 VP6, H.264 MP3 : Audio MPEG couche III Déprécié - utilisez l’élément <media-format> à la place. |
<bitrate> | Le débit binaire du flux, en bits par seconde. Déprécié - utilisez l’élément <audio> à la place. |
<media-format> | Définit le format du support de ce montage. Ces attributs sont définis comme suit :
Cet élément contiendra un seul élément <audio> . |
<audio> | Définit le format d'une piste audio contenue dans le flux. Ces attributs sont définis comme suit :
|
<authentication> | Cette fonction est maintenant obsolète et la valeur est toujours fixée à 0. |
<timeout> | Cette fonction est maintenant obsolète et la valeur est toujours fixée à 0. |
<send-page-url> | Booléen (0 ou 1) indiquant si le lecteur doit envoyer l'adresse de la page où il est intégré. Si nécessaire, l’URL de la page doit être encodée en base64 et envoyée en tant que valeur du paramètre de requête pageur. |
<side-channels> | Si la station/le support dispose de canaux latéraux, ils seront listés ici à l’aide d’éléments imbriqués <nom de la station="..."/> . Des appels distincts à l’API d’approvisionnement du lecteur sont nécessaires pour obtenir des informations sur les stations du canal auxiliaire. |