Global - Documentation

Définition des types

ErrorStatus

Dans cette API, un ErrorStatus est retourné lorsqu'une promesse est rejetée.

Propriétés

Nom	Type	Description
`code`	number	Le code d'erreur.
`message`	string	Un message humainement lisible correspondant à l'erreur.

IdalControlInterfaces

Un objet IdalControlInterfaces contient les interfaces de contrôle du système.

Propriétés

Nom	Type	Description
`printer`	Printer	L'interface de contrôle de l'imprimante.
`player`	Player	L'interface de contrôle du lecteur vidéo.
`logger`	Logger	L'interface de contrôle des fichiers de journalisation.
`contact`	Contact	L'interface de contrôle des contacts d'entrée et de sortie.
`serial`	Serial	L'interface de contrôle de la liaison série.

Événements

SystemReadyEvent

L'événement SystemReadyEvent peut être utilisé pour obtenir les interfaces de contrôle du système.

Propriétés

Nom	Type	Description
`type`	'idal-system-ready'	Le type correspondant à SystemReadyEvent.
`detail`	IdalControlInterfaces	L'ensemble des interfaces de contrôle du système.

Cet événement doit être enregistré en utilisant l'API window.addEventListener() définie par la spécification DOM.

Il est envoyé une seule fois lorsque la page HTML est chargée.
Il n'est pas reçu par les pages chargées dans des <iframe>, par conséquent de telles pages ne peuvent prendre le contrôle du lecteur.
Il est nécessaire d'enregistrer cet événement à l'intérieur d'une balise <script> de la page HTML.

Il est vivement recommandé d'utiliser IDAL.getControlInterfaces() pour obtenir les interfaces de contrôle au lieu de manipuler directement cet événement.

Type

external:CustomEvent

Exemple

Obtention des interfaces de contrôle du système a l'aide de l'événement 'idal-system-ready'.

<script>
// Cet exemple illustre l'utilisation de l'événement 'idal-system-ready'
// pour obtenir les interfaces de contrôle du lecteur vidéo.
//
// Il est cependant fortement conseillé d’utiliser le SDK JavaScript ID-AL qui
// offre une meilleure alternative pour obtenir un résultat similaire.
// De plus, le SDK peut vous permettre d'utiliser des interfaces de contrôle distantes.
// Veuillez vous référer à IDAL.getControlInterfaces() et IDAL.getRemoteControlInterfaces()

// Variable globale contenant les interfaces de contrôle
var ControlInterfaces;
window.addEventListener('idal-system-ready', function(e) {
     // Sauvegarde de la référence sur les interfaces de contrôle.
     ControlInterfaces = e.detail;

     // Il est maintenant possible de contrôler la lecture vidéo
     ControlInterfaces.player.getAllFolders()
         .then(function(folders) {
             // Do something useful with the folders array...
         })
         .catch(function() {
             // ...
         });

     // Ou d'autres functionnalités du lecteur en utilisant les méthodes de:
     //      - ControlInterfaces.serial
     //      - ControlInterfaces.logger
     //      - ControlInterfaces.printer
     //      - ControlInterfaces.contact
});
</script>