API de la télécommande

Vous pouvez contrôler RadioBOSS à distance en utilisant son API de contrôle à distance.

Activez et configurez cette fonctionnalité via la fenêtre Paramètres: Configure Remote Control API .

HTTP remote control API reference : (Référence de l'API de la télécommande HTTP)

Utilisation de la télécommande HTTP

Demandes :

Note: Lors de la génération d'une chaîne de requête, utilisez l'une des fonctions de codage d'URL pour les paramètres. Par exemple, utilisez "urlencode" (http://www.php.net/manual/en/function.urlencode.php) Pour PHP. Les demandes doivent être envoyées en codage UTF8..

I. Exécution d'une commande : Vous pouvez utiliser les mêmes commandes que dans le planificateur. Voici la liste des commandes disponibles "Commandes du planificateur": Scheduler commands

Syntax:

http://IP:Port/?pass=PASSWORD&cmd=COMMAND

(substitute COMMAND and PASSWORD accordingly) ((Substituer la COMMANDE et le MOT DE PASSE en conséquence)

Example 1: Lire la piste suivante (command: next)

http://127.0.0.1:9001/?pass=WxPe2JXh&cmd=next

Example 2: Lire la première piste de la liste de lecture (command: play 1)

http://127.0.0.1:9001/?pass=WxPe2JXh&cmd=play%201

II. Performing an action

Syntax:

http://IP:Port/?pass=PASSWORD&action=ACTION

(substitute ACTION and PASSWORD accordingly) ((Remplacer ACTION Et MOT DE PASSE En conséquence)

Valeurs ACTION possibles:

playbackinfo

Obtenir des informations sur la lecture

Retourne un XMLContenant l'information de piste actuelle et suivante et la position et l'état de lecture.

Example

http://127.0.0.1:9001/?pass=WxPe2JXh&action=playbackinfo

An example of data returned:

<?xml version="1.0" encoding="utf-8"?>
<Info>
<CurrentTrack>
<TRACK ARTIST="" TITLE="" ALBUM="" YEAR="" GENRE=""

COMMENT="" FILENAME="D:\disko\1\Tehno\08 Title_08.mp3"

DURATION="05:48" PLAYCOUNT="171" LASTPLAYED="2016-08-23 22:21:40"

      INTRO="0.00" OUTRO="0.00" CASTTITLE="08 Title - 08 (%showname)" LISTENERS="0" />
  </CurrentTrack>
  <NextTrack>
    <TRACK ARTIST="" TITLE="" ALBUM="" YEAR="" GENRE=""

COMMENT="" FILENAME="D:\disko\1\Tehno\12 Title_12.mp3"

DURATION="03:26" PLAYCOUNT="220" LASTPLAYED="2016-08-23 04:24:07"

      INTRO="4.66" OUTRO="0.00" CASTTITLE="12 Title - 12" />
  </NextTrack>
  <Playback pos="263849" len="348483" state="play" playlistpos="51" />
  <Options repeat_list="0" shuffle="0" />
</Info>

inserttrack

Insérer une piste dans la liste de lecture

Paramètres

"filename" Nom de fichier local

"pos" Une position dans la liste de lecture où la piste doit être insérée (1 ... N).

Autres valeurs possibles :

-1: Insérer dans la fin de la liste de lecture

-2: Insérer après avoir joué la piste

-3: Insérer après les pistes programmées

"streamingtitle" Définir le titre de diffusion pour l'élément inséré

Example

Insert the track D:\music\track.mp3

http://127.0.0.1:9001/?pass=WxPe2JXh&action=inserttrack&filename=D%3A%5Cmusic%5Ctrack.mp3&pos=-2

library

Télécharger un fichier de bibliothèque musicale (xml)

Paramètres

"filename" Nom de fichier de la bibliothèque musicale

Retourne : Contenu de la bibliothèque musicalets

Example

http://127.0.0.1:9001/?pass=WxPe2JXh&action=library&filename=Base

trackartwork

Télécharge l'illustration de la piste en cours

Renvoie: illustration pour la piste en cours de lecture (ou rien s'il n'y a pas d'illustration)

nexttrackartwork

Télécharge l'illustration pour la piste suivante

Retours: illustration pour la piste suivante (ou rien s'il n'y a pas d'illustration)

setnexttrack

Régler la piste suivante

Paramètres

"pos" La position d'une piste dans la liste de lecture, qui sera sélectionnée en tant que piste suivante (1 ... N)

Example

Définissez la première piste de la liste de lecture à

http://127.0.0.1:9001/?pass=WxPe2JXh&action=setnexttrack&pos=1

delete

Supprimer une piste de la playlist

Paramètres

"pos" La position d'une piste dans la liste de lecture, qui sera supprimée (1 ... N)

Example

Supprimer la deuxième piste de la liste de lecture

http://127.0.0.1:9001/?pass=WxPe2JXh&action=delete&pos=2

move

Déplacer une piste vers une autre position dans la liste de lecture

Paramètres

"pos1" Position originale de la piste

"pos2" Nouvelle position de la piste

mic

Allumer ou éteindre le microphone et demander l'état du microphone

Parameters

"on" - 0 Pour éteindre le microphone, 1 pour le mettre sous tension. Si le paramètre est omis, renvoie l'état du microphone

0 - off

1 - on

Example (Allumez le microphone "on"):

http://127.0.0.1:9001/?pass=WxPe2JXh&action=mic&on=1

Example (query status):

http://127.0.0.1:9001/?pass=WxPe2JXh&action=mic

getplaylist

Obtenir le contenu de la playlist

Renvoie: un XML contenant le contenu de la playlist. Cette fonction lit les informations d'étiquette et peut être lente pour les grandes listes de lecture.

Un exemple de données renvoyées :

<?xml version="1.0" encoding="utf-8"?>
<Playlist>
<TRACK ARTIST="Akira Yamaoka" TITLE="Theme of Laura" ALBUM="Silent Hill 2 Original Soundtracks"

YEAR="2001" GENRE="Soundtrack" COMMENT="" FILENAME="D:\disko\Artist\Akira Yamaoka\01 - Theme Of Laura.mp3"

DURATION="03:24" PLAYCOUNT="118" LASTPLAYED="2016-05-10 08:30:40" INTRO="0.00" OUTRO="0.00" />
<TRACK ARTIST="Akira Yamaoka" TITLE="White Noiz" ALBUM="Silent Hill 2 Original Soundtracks"

YEAR="2001" GENRE="Soundtrack" COMMENT="" FILENAME="D:\disko\Artist\Akira Yamaoka\02 - White Noiz.mp3"

DURATION="01:23" PLAYCOUNT="110" LASTPLAYED="2016-05-07 21:24:30" INTRO="0.00" OUTRO="0.00" />
</Playlist>

getplaylist2

Obtenir le contenu de la playlist (rapide)

Renvoie: un XML contenant le contenu de la playlist. Cette fonction est plus rapide que getplaylist.

Un exemple de données retournées :

<?xml version="1.0" encoding="utf-8"?>

<TRACK STARTTIME="" CASTTITLE="Akira Yamaoka - Overdose Delusion"

DURATION="04:31" FILENAME="D:\disko\Artist\Akira Yamaoka\28 - Overdose Delusion.mp3"

RATING="0" PLAYCOUNT="143" INTRO="" OUTRO="" BPM="" />

<TRACK STARTTIME="" CASTTITLE="Akira Yamaoka - Promise"

DURATION="04:39" FILENAME="D:\disko\Artist\Akira Yamaoka\30 - Promise.mp3"

RATING="0" PLAYCOUNT="156" INTRO="" OUTRO="" BPM="" />

</Playlist>

trackinfo

Obtenir des informations sur la piste

Paramètres

"pos" La position d'une piste dans la liste de lecture

Example

http://127.0.0.1:9001/?pass=WxPe2JXh&action=trackinfo&pos=2

An example of data returned:

<?xml version="1.0" encoding="utf-8"?>
<Info>
<Track>
<TRACK ARTIST="E-Type" TITLE="This Is The Way"

ALBUM="" YEAR="" GENRE="" COMMENT="" FILENAME="D:\disko\1\3.mp3"

DURATION="03:56" PLAYCOUNT="790" LASTPLAYED="2016-08-23 18:31:04"

INTRO="33.53" OUTRO="10.00" />
</Track>
</Info>

songrequest

Ajouter une demande de chanson

Paramètres

"filename" - Nom du fichier d'une chanson demandée (chemin complet)

"message" - Facultatif, message d'un utilisateur ayant demandé une chanson

Pour afficher manuellement la liste des chansons demandées, dans le menu, cliquez sur Interface -->Demandes de chanson. . .

Pour lire automatiquement les chansons playrequestedsong Commandes Planificateur.

songrequestclear

Effacer la liste des morceaux demandés

Efface la liste des morceaux demandés.

encoderstatus

Obtenir le statut des encodeurs de diffusion

Renvoie: un XML contenant des informations sur l'état du codeur.

<?xml version="1.0" encoding="utf-8"?>
<Encoders>
  <Encoder index="0" status="active" />
  <Encoder index="1" status="off" />
  <Encoder index="2" status="idle" />
</Encoders>

streamarchivestatus

Obtenir l'état de l'archive de flux

Retourne l'état des archives de flux Enregistrez votre diffusion

0 - off

1 - on

schedule

Paramètres

"type" - the request type, one of:

olist - list events

odelete - delete an event

orun - run event

oadd - add new event

oupdate - edit event

"event" - XML event data (when type is "update" or "add")

"id" - event ID, you get the event ID when you perform "list" query (used when type is "delete", "run", or "update").