Action de requête de partie de jour
L'action Requête de partie de jour permet aux scripts tiers de décider si le lecteur se trouve actuellement dans une période d'ouverture de partie de jour active.
Les opérateurs de réseau trouveront l'action de requête de partie de jour utile pour la surveillance externe.
La requête de partie de jour utilise l'action in_day_part.
Appelez l'action in_day_part en utilisant l'une des options suivantes :
Serveur WebSocket :
-
JSON – Vous pouvez transmettre des paramètres depuis votre fichier HTML5 à l’aide de JSON.
Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».
Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.
Port 2324 :
- remote_action – Une application fournie avec Broadsign Control Player qui utilise la ligne de commande.
- XML – Si vous souhaitez développer vos propres applications, vous pouvez communiquer directement avec Broadsign Control Player API en utilisant XML.
Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».
Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.
Note : L'action Déclencheurs est la seule exception à cette règle. Elle utilise le port 2325. Voir Action Triggers.
Vous pouvez appeler cette action sur Windows et Ubuntu Linux, et la trouver via les chemins suivants :
- Windows (64 bits) :
- Ubuntu Linux :
/opt/broadsign/suite/bsp/bin/
C:\Program Files\BroadSign\bsp\bin
Avec l'outil remote_action en ligne de commande, le nom d'action in_day_part doit être utilisé. L'exécutable peut être trouvé dans le répertoire d'installation bin de Broadsign Control Player. Pour interroger le lecteur :
remote_action in_day_part
La requête de partie de jour renvoie du XML qui indique si des parties de jour sont actives dans une période d'heure d'ouverture.
Lorsqu'une partie de la journée est active :
<in_day_part status=”1”/>
Lorsqu'aucune partie de jour n'est active :
<in_day_part status=”0”/>
Votre application peut soumettre une requête XML à l'API du lecteur en envoyant un message XML au port monitor_remote (2324) :
<rc version="1" id="1" action="in_day_part" />\r\n\r\n
Note : Vous devez terminer la requête avec \r\n\r\n.
Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.
La requête de partie de jour renvoie du XML qui indique si des parties de jour sont actives dans une période d'heure d'ouverture.
Lorsqu'une partie de la journée est active :
<in_day_part status=”1”/>
Lorsqu'aucune partie de jour n'est active :
<in_day_part status=”0”/>
Requête de partie de jour - Paramètres XML
Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.
| Paramètre | Description |
|---|---|
| version | La version est toujours « 1 ». |
| id | Contient l'identifiant de la requête. |
| action | Le type d'action à entreprendre; toujours in_day_part. |
| status | Le statut est « 1 » lorsqu'une partie de jour est active et Broadsign Control Player est actuellement dans une période d'heure d'ouverture. Dans tous les autres cas, y compris lorsque Broadsign Control Player a une partie de jour active mais est en dehors des périodes d'ouverture, le statut renvoyé sera « 0 ». |
Votre application interactive peut soumettre des données JSON au lecteur via le serveur WebSocket de monitor_remote (port 2326). Vous devrez activer le serveur WebSocket. Pour plus d'informations, voir L'onglet «Remote Control».
{
"rc": {
"version": "1",
"id": "1",
"action": "in_day_part"
}
}
Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.
La requête de partie de jour renvoie une chaîne JSON qui indique si des parties de jour sont actives dans une période d'heure d'ouverture.
Lorsqu'une partie de jour est active :
{
"rc": {
"id": "1",
"version": "1",
"status": "1",
"action": "in_day_part",
"in_day_part": { "status": "1" }
}
}
Lorsqu'aucune partie de jour n'est active :
{
"rc": {
"id": "1",
"version": "1",
"status": "1",
"action": "in_day_part",
"in_day_part": { "status": "0" }
}
}
Requête de partie de jour - Paramètres JSON
Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.
| Paramètre | Description |
|---|---|
| version | La version est toujours « 1 ». |
| id | Contient l'identifiant de la requête. |
| action | Le type d'action à entreprendre; toujours in_day_part. |
| status | Le statut est « 1 » lorsqu'une partie de jour est active et Broadsign Control Player est actuellement dans une période d'heure d'ouverture. Dans tous les autres cas, y compris lorsque Broadsign Control Player a une partie de jour active mais est en dehors des périodes d'ouverture, le statut renvoyé sera « 0 ». |
