Action de commande Stop
Les applications tierces peuvent invoquer la commande Stop via l'API du lecteur. La commande Stop oblige le lecteur à interrompre la lecture du contenu actuel et à passer à l'élément suivant dans la politique de boucle.
Une application tierce surveillant un événement pourrait vouloir signaler à Broadsign Control Player de passer au fichier suivant. De même, un fichier HTML5 dynamique pourrait devoir être diffusé dans un créneau à durée dynamique. Puis, en fonction d'un événement ou d'une variable, la session se ferme automatiquement.
Vous pouvez réaliser ces cas d'utilisation avec l'action Stop.
Déclenchez l'action Stop en utilisant l'une des méthodes 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
Pour utiliser l'outil remote_action en ligne de commande, recherchez l'exécutable dans le répertoire bin d'installation de Broadsign Control Player. Par exemple, pour envoyer une commande stop, tapez :
remote_action.exe stop -f 1234
Où :
-
stop : Le type d'action.
-
-f : Spécifie l'identifiant du cadre à arrêter.
Avertissement : Omettre l'option -f provoque l'arrêt de la lecture du contenu actuel dans tous les cadres et le lancement de la lecture du contenu suivant.
Une application personnalisée peut utiliser l'action Stop sur Broadsign Control Player en envoyant un message XML au port monitor_remote (2324) :
<rc version="1" id="1" action="stop" frame_id="1234" />\r\n\r\n
Note : Vous devez terminer la requête avec \r\n\r\n.
Le lecteur répondra avec le document suivant :
<!DOCTYPE rc>
<rc id="1" version="1" action="stop" status="1"/>
Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.
Action « Stop » - 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 |
|---|---|
| id | Contient l'identifiant de la requête. |
| version | La version est toujours 1. |
| action | Le type d'action à entreprendre, dans ce cas-ci, stop. |
| status | Un résultat de « 1 » indique que la commande a réussi. |
| frame_id | Facultatif. Il s'agit de l'identifiant du cadre dans lequel le contenu doit être arrêté. Si vous omettez frame_id, le lecteur arrête tous les cadres qui diffusent du contenu. Cela simplifiera la programmation des mises en page plein écran à cadre unique. |
Une application personnalisée peut utiliser l'action Stop en envoyant un message JSON au serveur WebSocket de monitor_remote (port 2326). Vous devrez activer le serveur WebSocket. Pour plus d'informations, consultez L'onglet «Remote Control».
{
"rc": {
"version": "1",
"id": "1",
"action": "stop",
"frame_id": "1234"
}
}
Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.
Le lecteur répondra avec le document suivant :
{
"rc": {
"id": "1",
"version": "1",
"action": "stop",
"status": "1"
}
}
Action « Stop » - 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 |
|---|---|
| id | Contient l'identifiant de la requête. |
| version | La version est toujours 1. |
| action | Le type d'action à entreprendre, dans ce cas-ci, stop. |
| status | Un résultat de « 1 » indique que la commande a réussi. |
| frame_id | Facultatif. Il s'agit de l'identifiant du cadre dans lequel le contenu doit être arrêté. Si vous omettez frame_id, le lecteur arrête tous les cadres qui diffusent du contenu. Cela simplifiera la programmation des mises en page plein écran à cadre unique. |
