En plus du lecteur Web, CloudRadio offre un widget JavaScript qui affiche les renseignements de votre flux en direct sur votre site, un widget de programmation pour vos émissions à venir, un widget de sondage pour vos sondages en ondes et des liens d'écoute téléchargeables pour les lecteurs multimédias d'ordinateur. Des extraits de code prêts à copier vous attendent à la page Widgets et liens de votre radio, dans Studio.
Widget JavaScript
Le widget JavaScript met à jour des éléments HTML de votre page avec les métadonnées du flux en direct. Il n'affiche pas d'interface de lecteur : vous construisez donc votre propre affichage et lui donnez le style que vous voulez.
Obtenir le code
- Ouvrez votre station ou votre radio dans Studio
- Allez à Widgets et liens dans la barre latérale
- Pour une station AutoDJ, ouvrez l'onglet « Website Widgets » et copiez la balise de script de l'étape 1, Ajoutez ce script une seule fois à votre site Web. Pour une radio hébergée, copiez la balise de script qui se trouve en haut de la page.
La balise de script ressemble à ceci :
<script src="https://public.cloudrad.io/your-subdomain/streaminfo.js"></script>
Votre sous-domaine y est déjà inscrit. Il ne vous reste qu'à la coller dans le code HTML de votre site Web.
Ajoutez ensuite des éléments portant les ID ci-dessous aux endroits où les données doivent apparaître. À la page Widgets et liens, la carte de chaque widget présente un aperçu en direct et un bouton pour copier l'extrait HTML correspondant.
| ID de l'élément | Données affichées |
|---|---|
stream_info_song | Titre et artiste de la chanson en cours |
stream_info_title | Nom de la station |
stream_info_bitrate | Débit du flux |
stream_info_listeners | Nombre d'auditeurs à l'écoute |
stream_info_status | On Air ou Off Air |
stream_info_live_source | Studio, Guest DJ ou DJ pendant qu'un DJ est en ondes, vide le reste du temps (CloudRadio One seulement) |
stream_info_songhistory | Historique des dernières chansons |
Les éléments de texte ci-dessus reçoivent du texte brut : ils prennent donc les polices et les couleurs de votre page. L'historique des dernières chansons fait exception : il s'affiche sous forme de liste mise en forme, avec les pochettes.
Mettre en forme l'état en ondes
L'élément d'état reçoit aussi un attribut data-state, qui vaut on ou off. Servez-vous-en pour mettre en forme chaque état dans votre propre feuille de style :
#stream_info_status[data-state="on"] {
color: #16a34a;
font-weight: 600;
}
#stream_info_status[data-state="on"]::before {
content: "";
display: inline-block;
width: .5em;
height: .5em;
margin-right: .45em;
border-radius: 50%;
background: currentColor;
}
Un élément plus ancien,
stream_info_source, affiche plutôt l'état brut de la connexion. Il fonctionne toujours, et les pages existantes continuent donc de fonctionner, mais son libellé varie selon le type de station. Dans vos nouvelles pages, utilisezstream_info_status.
Direct ou automatisé
Les stations CloudRadio One indiquent aussi quelle entrée est en ondes. Vous pouvez donc afficher un indicateur de direct seulement pendant qu'un DJ diffuse. L'élément d'état reçoit un attribut data-source (live, relay ou automated) et, pendant qu'un DJ est en ondes, un attribut data-source-name (studio, guest ou dj). Un élément stream_info_live_source affiche le nom de l'entrée sous forme de texte. Consultez Indicateur de source en direct pour les attributs, des exemples de CSS et les champs correspondants de l'API.
Exemple
<p>Now playing: <span id="stream_info_song">Loading...</span></p>
<p>Listeners: <span id="stream_info_listeners"></span></p>
Le widget vérifie s'il y a du nouveau toutes les 10 secondes. Vous n'avez à inclure que les éléments qui vous intéressent : les ID absents sont ignorés.
Historique des chansons
Dans l'application, il s'appelle le Widget des titres récents. Pour l'élément d'historique des chansons, ajoutez un attribut data-count afin de fixer le nombre d'entrées à afficher :
<div id="stream_info_songhistory" data-count="5"></div>
Les valeurs de 1 à 100 sont acceptées. Sans cet attribut, c'est le nombre par défaut qui s'applique.
Widget de programmation
Le widget de programmation présente les émissions et les DJ à venir de votre station sur votre propre site Web. C'est une petite page que vous placez avec un <iframe>. Elle lit les mêmes événements que votre page Programmation et change donc dès que vous modifiez votre programmation. Il est offert aux stations CloudRadio One.
Ajouter la programmation à votre site Web
- Ouvrez votre station dans Studio
- Allez à Widgets et liens dans la barre latérale, puis ouvrez l'onglet « Website Widgets »
- Sous Widget de programmation, choisissez vos options. L'Aperçu en direct montre le vrai widget avec votre programmation et change à mesure que vous choisissez
- Cliquez sur Copier sous Code d'intégration
- Collez le code dans le HTML de votre site Web, là où la programmation doit apparaître
Le code ressemble à ceci :
<iframe
src="https://embed.clrd.net/schedule/your-station-slug?theme=dark"
title="Your Station schedule"
width="100%" height="600" style="border:0;max-width:100%" loading="lazy"
></iframe>
Le widget de programmation n'a pas besoin de la balise de script du widget JavaScript. Vos options sont enregistrées dans le code lui-même, et non dans Studio : pour changer le style plus tard, choisissez les nouvelles options et collez le nouveau code à la place de l'ancien.
Options du widget
| Option | Ce qu'elle fait |
|---|---|
| Thème | Clair, ou Sombre pour les sites Web foncés |
| Coins | Arrondis, Arrondis en haut (coins du bas carrés, pour un widget posé au-dessus d'un autre contenu) ou Carrés |
| Afficher les images | Un carré à côté de chaque émission : l'image de la liste de lecture pour une émission tirée d'une liste (voyez Ajouter une image à la liste de lecture), sinon une icône selon le type d'émission : musique, DJ en direct ou relais |
| Couleur d'accent | La couleur de la barre d'en-tête, du jour sélectionné et de la ligne en ondes. Par défaut, c'est le bleu CloudRadio |
| Afficher l'en-tête | La barre d'en-tête, tout en haut. Désactivez-la si votre page nomme déjà votre station |
| Texte de l'en-tête | Le texte à droite de l'en-tête, 40 caractères au maximum. S'il est vide, l'en-tête affiche « Schedule ». Sur un widget étroit, un texte long est raccourci pour tenir dans l'espace |
| Afficher le nom de la station et Afficher le logo de la station | Le nom et le logo de votre station, à gauche de l'en-tête. Le logo est celui de la page Profil et marque |
| Couleur automatique du texte de l'en-tête | Activée, le texte de l'en-tête est blanc ou noir, selon ce qui se lit le mieux sur la couleur d'accent. Désactivée, vous choisissez votre propre Couleur du texte de l'en-tête |
| Largeur | Auto (100 %) remplit l'espace offert sur votre page et rétrécit avec elle sur les téléphones. Fixe établit une largeur en pixels, de 240 à 1600 |
| Hauteur (px) | La hauteur du cadre, de 240 à 2000 pixels. Une journée plus longue défile à l'intérieur du cadre, sous l'en-tête et les onglets des jours |
Ce que la programmation affiche
- Une barre d'en-tête avec le logo et le nom de votre station, et votre texte d'en-tête
- Une rangée d'onglets pour les 7 prochains jours (par exemple « Mon » au-dessus de « 9 Nov », ou « 9 » seul sur un widget de moins de 360 pixels de large), à partir d'aujourd'hui, avec un point sur le jour même. Le widget s'ouvre sur aujourd'hui. L'auditeur clique sur un onglet pour voir les émissions de ce jour-là, et un jour sans rien au programme affiche « Nothing scheduled »
- Le nom du jour et le fuseau horaire de votre station (par exemple « Toronto time »). Les heures de début et de fin suivent le réglage Fuseau horaire de la page Paramètres
- Le nom de l'événement, en gras. Un événement sans nom affiche le nom de sa liste de lecture ou de son relais, et un événement DJ en direct sans nom affiche le nom d'antenne du DJ (ou le nom de son compte, sinon son nom d'utilisateur). Donnez donc un nom à tout événement que vous ne voulez pas voir affiché de cette façon
- Sous un événement DJ en direct qui porte un nom, le nom du DJ en texte plus pâle. Un DJ qui ne fait plus partie de votre station n'est jamais nommé
- L'émission programmée en ce moment est mise en évidence par un point « On air » qui clignote, et la suivante porte la mention « Up next ». Ce repère suit votre programmation, et non ce que votre flux diffuse réellement. Le point ne clignote pas pour les visiteurs qui ont désactivé les animations sur leur appareil
Les événements en pause et la programmation de fond n'y figurent pas. Les émissions déjà terminées aujourd'hui disparaissent de la liste. La page s'actualise toutes les 5 minutes et reste sur le jour choisi par l'auditeur : le repère « On air » se déplace donc sans qu'il faille recharger votre site Web.
Anciens codes d'intégration
Les codes d'intégration copiés avant l'arrivée du formulaire d'options fonctionnent toujours. Leurs options ?theme=dark, ?accent= et ?header=0 correspondent à Thème, à Couleur d'accent et à Afficher l'en-tête, et le widget présente la nouvelle mise en page. Ils gardent la hauteur qu'ils avaient au moment de la copie (480 pixels) jusqu'à ce que vous colliez un nouveau code.
Widget de sondage
Le widget de sondage place votre sondage en ondes sur votre propre site Web : vos auditeurs peuvent voter sans ouvrir de lecteur. Il affiche le sondage que vous lancez à partir de DJ en direct > Sondages, avec la même question, les mêmes réponses et les mêmes résultats que dans vos lecteurs et sur la page de la station. Il est offert aux stations CloudRadio One.
Ajouter le sondage à votre site Web
- Ouvrez votre station dans Studio
- Allez à Widgets et liens dans la barre latérale, puis ouvrez l'onglet « Website Widgets » (ou cliquez sur Ajouter le sondage à votre site Web dans l'onglet Sondages de DJ en direct)
- Sous Widget de sondage, choisissez un Thème (Clair ou Sombre) et une Couleur d'accent. La couleur d'accent s'applique à la réponse sélectionnée, au bouton « Vote » et au résultat de l'auditeur
- Cliquez sur Copier sous Code d'intégration
- Collez le code dans le HTML de votre site Web, là où le sondage doit apparaître, par exemple sous votre lecteur ou dans une barre latérale
Le code tient en une seule balise de script :
<script src="https://public.cloudrad.io/embed/poll/your-station-slug/widget.js?theme=dark" async></script>
Il n'a pas besoin de la balise de script du widget JavaScript. Comme pour le widget de programmation, vos options sont enregistrées dans le code lui-même : pour les changer, collez le nouveau code à la place de l'ancien.
Quand le sondage s'affiche
- Aucun sondage actif : le widget n'affiche rien et n'occupe aucun espace sur votre page.
- Un sondage s'ouvre : il apparaît en 30 secondes environ, à la taille du sondage. Les auditeurs qui ont déjà le sondage sous les yeux voient les votes entrer en direct.
- Le sondage se ferme : les résultats finaux restent affichés 10 minutes, puis le widget se masque de nouveau.
Dans Studio, l'Aperçu en direct montre le vrai widget pendant qu'un sondage est actif. Quand il n'y en a aucun, il présente un sondage type pour que vous puissiez choisir le thème et la couleur d'accent à tout moment : passez de Sondage ouvert à Fermé avec résultats pour voir les deux états. Vous êtes la seule personne à voir ce sondage type, et votre site continue de ne rien afficher. Le vote est désactivé dans l'aperçu : aucun risque de voter par accident.
Le vote
Les auditeurs votent directement sur votre page, à raison d'un vote par auditeur et par sondage, selon les mêmes règles que dans vos lecteurs et sur la page de la station : le nombre de votes reste masqué tant qu'il y en a moins de 5, et un sondage réglé pour masquer les résultats ne les montre qu'une fois fermé. Dans le rapport du sondage et dans l'export CSV, ces votes sont comptés sous Widget pour site Web.
Demandes de chansons
Tant que les demandes de chansons sont activées, l'onglet « Website Widgets » comporte une section Demandes de chansons. Elle est offerte aux stations CloudRadio One et Personnalisé.
- Page de demandes est un lien vers une page de demandes que nous hébergeons pour vous, conçue pour les téléphones. Cliquez sur le bouton de copie et partagez le lien où vous voulez. L'onglet Paramètres de Demandes de chansons présente le même lien.
- Widget pour site Web place la même boîte de demandes sur votre propre site Web. Choisissez un Thème (Clair ou Sombre) et une Couleur d'accent, vérifiez l'Aperçu, puis cliquez sur Copier sous Code d'intégration et collez le code là où la boîte doit apparaître. Il n'a pas besoin de la balise de script du widget JavaScript.
Quand les demandes sont désactivées, la section est masquée, et le widget se masque lui-même sur votre site Web. Consultez Partager la page de demandes pour les détails.
Widget de dédicaces
L'onglet « Website Widgets » comporte aussi une section Widget de dédicaces, avec le code d'un widget où les auditeurs enregistrent un message vocal pour votre station : voyez Dédicaces.
Liens d'écoute
CloudRadio génère des fichiers de liste de lecture qui ouvrent votre flux dans les lecteurs multimédias d'ordinateur comme Winamp, VLC ou Windows Media Player. Tous les liens offerts, avec leur bouton de copie, se trouvent à la page Widgets et liens de votre radio, sous Liens d'écoute directs.
Le format de l'URL est le suivant :
https://embed.clrd.net/api/your-subdomain/listen.pls
Formats pris en charge
| Format | Fichier | Utilisé par |
|---|---|---|
| PLS | listen.pls | Winamp, foobar2000, VLC |
| M3U | listen.m3u | VLC et la plupart des lecteurs multimédias |
| ASX | listen.asx | Windows Media Player (hébergement classique seulement) |
| RAM | listen.ram | RealPlayer (hébergement classique seulement) |
| QTL | listen.qtl | QuickTime (hébergement classique seulement) |
Les navigateurs ne lisent pas ces fichiers de liste de lecture directement. Ils les téléchargent et les confient au lecteur multimédia du système. Pour l'écoute dans le navigateur, utilisez le lecteur Web.
Lien vers un point de montage précis
Si votre radio a plusieurs points de montage, précisez le point de montage dans l'URL :
https://embed.clrd.net/api/your-subdomain/mountname/listen.pls
Liens d'écoute AutoDJ
Pour les stations CloudRadio One, Liens d'écoute directs commence par une carte Flux ICY : l'adresse même du flux de la station, en HTTPS et en HTTP, avec des boutons de copie. Elle ne change pas quand vous renommez la station. Utilisez-la dans les applications, les haut-parleurs intelligents et les annuaires qui demandent une URL de flux plutôt qu'un fichier de liste de lecture, et dans tout lecteur qui a besoin des titres des chansons dans le flux (métadonnées ICY). Réservez l'adresse HTTP aux appareils plus anciens qui ne peuvent pas lire le HTTPS.
Les fichiers de liste de lecture utilisent l'identifiant (slug) de la station et sont offerts en PLS et en M3U :
https://embed.clrd.net/api/your-station-slug/listen.pls
https://embed.clrd.net/api/your-station-slug/listen.m3u
Ajouter à votre site Web
Copiez le lien d'écoute à la page Widgets et liens de votre radio et utilisez-le comme lien de téléchargement :
<a href="https://embed.clrd.net/api/your-subdomain/listen.pls">
Open in media player
</a>
API d'information sur le flux
Pour les intégrations avancées, vous pouvez interroger directement les métadonnées du flux en JSON :
GET https://embed.clrd.net/api/your-subdomain/info.json
La réponse contient le titre de la chanson en cours, l'artiste, le nombre d'auditeurs, le débit et l'historique des chansons.
Paramètres facultatifs
| Paramètre | Description |
|---|---|
history_format=json | Renvoie un historique structuré avec les URL des pochettes |
history_count=10 | Nombre d'entrées de l'historique (de 1 à 100) |
Exemple :
https://embed.clrd.net/api/your-subdomain/info.json?history_format=json&history_count=10
L'API prend en charge le CORS et peut être appelée à partir de n'importe quel domaine. Les réponses sont mises en cache pendant 5 secondes.