Player

Player

L'interface de contrôle Player permet d'interagir avec le lecteur vidéo.

Cette API est asynchrone et utilise Promise.
Pour utiliser cette API, vous devez dans un premier temps obtenir l'interface de contrôle Player à l'aide de IDAL.getControlInterfaces() ou IDAL.getRemoteControlInterfaces().

Méthodes

addListener(listener): Promise.<boolean>

Attacher un gestionnaire d'événements à l'interface de contrôle Player.

Depuis :
  • micrologiciel v1.08 / SDK version 1.1.0

Cette methode est apparue avec le micrologiciel v1.08 pour rendre possible l'execution d'un même code aussi bien sur le lecteur vidéo que sur un navigateur distant par l'utilisation de IDAL.getRemoteControlInterfaces().
Lorsque l'exécution se fait sur le lecteur vidéo, cette méthode equivaut à l'appel window.addEventListener('idal-player-event', function(e) {}).

Exemple
var player = ... // Obtention de l'interface Player
player.addListener(function(event) {
      // Ici la valeur de event.type est toujours 'idal-player-event'
      switch (event.detail.type) {
          case 'folder-enter':
              console.log("Entrée dans le dossier : " + event.detail.folder.name);
              break;

          case 'file-start':
              console.log("Début du fichier : " + event.detail.filename);
              break;

          // etc...
      }
});
Paramètres
Nom Type Description
listener Listener

Fonction à exécuter lorsqu'un événement survient au niveau du moteur de lecture.
Valeur de retour

Une promesse résolue avec une valeur de type boolean.

Type
Promise.<boolean>

getAllFolders(): Promise.<Array.<FolderInfo>> | Promise.<ErrorStatus>

Obtenir la liste de tous les dossiers médias disponibles sur le stockage actuel.

Valeur de retour

getDuration(): Promise.<number> | Promise.<ErrorStatus>

Obtenir la durée du fichier audio / vidéo courant.

La valeur renvoyée est null lorsque la lecture n'est pas démarrée.

Valeur de retour

  • Une promesse résolue avec la durée totale exprimée en secondes (nombre décimal).

    Type
    Promise.<number>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getFileName(): Promise.<string> | Promise.<ErrorStatus>

Obtenir le nom du fichier en cours de lecture.

Valeur de retour

  • Une promesse résolue avec le nom de fichier.

    Type
    Promise.<string>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getFolderName(): Promise.<string> | Promise.<ErrorStatus>

Obtenir le nom du dossier courant.

Valeur de retour

  • Une promesse résolue avec le nom de dossier.

    Type
    Promise.<string>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getFolderNumber(): Promise.<number> | Promise.<ErrorStatus>

Obtenir le numéro (identifiant) du dossier courant.

Valeur de retour

  • Une promesse résolue avec le numéro de dossier courant (-1 s'il n'y a pas de dossier courant).

    Type
    Promise.<number>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getMute(): Promise.<boolean> | Promise.<ErrorStatus>

Obtenir l'état de la sourdine.

Valeur de retour

  • Une promesse résolue avec l'état de la sourdine, vrai lorsque la sourdine est activée.

    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getPosition(): Promise.<number> | Promise.<ErrorStatus>

Obtenir la position courante de lecture.

La position renvoyée est 0 lorsque la lecture n'est pas lancée.

Valeur de retour

  • Une promesse résolue avec la position courante de lecture exprimée en secondes (nombre décimal).

    Type
    Promise.<number>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getRemainingTime(): Promise.<number> | Promise.<ErrorStatus>

Obtenir le temps de lecture restant.

La valeur renvoyée est null lorsque la lecture n'est pas démarrée.

Valeur de retour

  • Une promesse résolue avec le temps de lecture restant exprimé en secondes (nombre décimal).

    Type
    Promise.<number>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getState(): Promise.<('stopped'|'paused'|'playing'|'maintenance')> | Promise.<ErrorStatus>

Obtenir l'état du lecteur vidéo.

Valeur de retour

  • Une promesse résolue avec une chaîne de caractère donnant l'état du lecteur.

    Type
    Promise.<('stopped'|'paused'|'playing'|'maintenance')>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getStorageDevice(): Promise.<string> | Promise.<ErrorStatus>

Obtenir le nom du périphérique de stockage actuel.

Valeur de retour

  • ne promesse résolue avec le nom périphérique de stockage actuel.

    Type
    Promise.<string>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

getSubtitles(): Promise.<SubtitleInfo> | Promise.<ErrorStatus>

Obtenir des information concernant la sélection des sous-titres:

  • la liste des pistes de sous-titres contenues dans le fichier vidéo en cours de lecture,
  • la piste de sous-titres actuellement sélectionnée,
  • les paramètres courants de sélection de sous-titres.

Depuis :
  • firmware v1.08
Valeur de retour

getVolume(): Promise.<number> | Promise.<ErrorStatus>

Obtenir le niveau du volume audio.

Valeur de retour

  • Une promesse résolue avec le niveau du volume audio (entier entre 0 et 100).

    Type
    Promise.<number>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

mute(): Promise.<boolean> | Promise.<ErrorStatus>

Activer la sourdine.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans le cas suivant :

    • L'opération n'est pas permise.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

nextFile(): Promise.<boolean> | Promise.<ErrorStatus>

Lire le fichier suivant.

Le fichier suivant est le fichier qui suit le fichier courant en prenant en compte les balises présentes sur les fichiers et les dossiers ([Jxxx], [LOOP]...). Le fichier suivant peut donc être située dans un autre dossier que le dossier courant.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Il n'y a pas de fichier suivant.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

nextFolder(): Promise.<boolean> | Promise.<ErrorStatus>

Lire le dossier suivant.

Le dossier suivant est le dossier dont le numéro est supérieur au numéro de dossier actuel.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Il n'y a pas de dossier suivant.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

pause(): Promise.<boolean> | Promise.<ErrorStatus>

Mettre en pause la lecture.

Cette méthode n'est pertinente que lorsque le lecteur est en pause.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Le lecteur n'est pas dans l'état playing.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

play(): Promise.<boolean> | Promise.<ErrorStatus>

Démarrer la lecture.

La lecture est démarrée dans le dossier courant. Cette commande doit être utilisée suite à un appel à stop() ou après une commande de pause.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Il n'y a pas de fichier audio ou vidéo à redémarrer (stop() n'a pas été appelé précédemment).
    • Le lecteur n'est pas dans l'état paused.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

playFolder(folder): Promise.<boolean> | Promise.<ErrorStatus>

Démarrer la lecture d'un dossier donné.

Paramètres
Nom Type Description
folder number

Le numéro du dossier.
Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Le dossier demandé n'existe pas.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

playPause(): Promise.<boolean> | Promise.<ErrorStatus>

Mettre en pause, reprendre ou démarrer la lecture.

Si le lecteur est à l'arrêt, la lecture commence comme le ferait play().
Si le lecteur est en pause, la lecture reprend comme le ferait resume().
Si le lecteur est en cours de lecture, la lecture est suspendue comme le ferait pause().

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • L'état courant du lecteur n'est pas valide (rien à démarrer ou mettre en pause).
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

previousFile(): Promise.<boolean> | Promise.<ErrorStatus>

Lire le fichier précédent.

Le fichier précédent est le fichier qui précède le fichier courant au sein du dossier courant.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Il n'y a pas de fichier précédent.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

previousFolder(): Promise.<boolean> | Promise.<ErrorStatus>

Lire le dossier précédent.

Le dossier précédent est le dossier ayant un numéro d'identification inférieur au dossier actuel.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Il n'y a pas de dossier précédent.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

removeListener(listener): Promise.<boolean>

Détacher un gestionnaire d'événements précédemment attaché à l'interface Player.

Depuis :
  • micrologiciel v1.08 / SDK version 1.1.0
Paramètres
Nom Type Description
listener Listener

Fonction précédemment attachée avec addListener()
Valeur de retour

Une promesse résolue avec une valeur de type boolean.

Type
Promise.<boolean>

resume(): Promise.<boolean> | Promise.<ErrorStatus>

Reprendre la lecture.

Cette méthode n'est pertinente que lorsque le lecteur est en pause.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Le lecteur n'est pas dans l'état paused.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

seek(position, relativeopt): Promise.<boolean> | Promise.<ErrorStatus>

Se déplacer temporellement dans le fichier audio / vidéo courant.

Paramètres
Nom Type Attributs Par défaut Description
position number

Le nombre de millisecondes à appliquer au déplacement (peut être négatif dans le cas d'un déplacement relatif, positif autrement)
relative boolean <optionnel>
 false

Est vrai lorsque la position est relative à la position courante de lecture, faux lorsque le déplacement est absolu.
Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Les paramètres ne sont pas valides (position absolue non valide)
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

selectSubtitle(settings): Promise.<SubtitleInfo> | Promise.<ErrorStatus>

Changer le mode de sélection des sous-titres.

Depuis :
  • firmware v1.08

Par défaut, le lecteur sélectionne les pistes de sous-titres en tenant compte des paramètres système (langue préférée et type de piste).
Cette méthode permet d'outrepasser les paramètres système pour sélectionner explicitement une piste ou bien pour désactiver totalement le sous-titrage.
Il est bien entendu possible de revenir au mode de sélection par défault.

Lorsqu'une piste est sélectionnée, sa langue sera utilisée comme référence pour la sélection des sous-titres lors de la lecture des fichiers suivants.

À propos de la sélection de piste suivante et précédente:

  • s'il n'y a pas de piste actuellement sélectionnée, la première piste est sélectionnée.
  • il est possible de sauter de la première piste à la dernière piste (et vice versa).
Exemples

Sélection de sous-titres en français

var player = ... // Récupération de l'interface Player
player.selectSubtitle({
    selection: "language",
    language: "fra"
});

Sélection de la seconde piste de sous-titres

var player = ... // Récupération de l'interface Player
player.selectSubtitle({
    selection: "index",
    index: 1
});

Sélection de la piste de sous-titres suivante avec bouclage

var player = ... // Récupération de l'interface Player
player.selectSubtitle({
    selection: "next",
    wrap: true
});

Désactivation des sous-titres

var player = ... // Récupération de l'interface Player
player.selectSubtitle({
    selection: "none",
});
Paramètres
Nom Type Description
settings Object

Paramètres de sélection.

Propriétés
Nom Type Attributs Par défaut Description
selection 'automatic' | 'none' | 'language' | 'index' | 'id' | 'next' | 'previous'

Méthode de sélection à exécuter.

Doit prendre pour valeur :

  • 'automatic' pour laisser le lecteur sélectionner les pistes en fonction des paramètres système ;
  • 'none' pour désactiver totalement l'affichage des sous-titres ;
  • 'language' pour sélectionner une piste ayant une langue donnée (le paramètre language doit être renseigné) ;
  • 'index' pour sélectionner dans la liste des pistes une piste à une position donnée (le paramètre index doit être renseigné) ;
  • 'id' pour sélectionner dans la liste des pistes la piste ayant l'identifiant donné (le paramètre id doit être renseigné) ;
  • 'next' pour sélectionner la piste suivante (le paramètre wrap peut être renseigné) ;
  • 'previous' pour sélectionner la piste précédente (le paramètre wrap peut être renseigné),
language string <optionnel>

Code ISO 639-1, 639-2 or 639-3 définissant la langue à sélectionner.

Paramètre obligatoire quand selection à pour valeur 'language'.

Le lecteur sélectionnera une piste appropriée dans la langue donnée.
Dans le cas où le fichier vidéo en cours de lecture ne possède pas de piste dans cette langue, aucun sous-titre ne sera affiché. Les sous-titres pourront cependant être affichés plus tard lors de la lecture de fichiers ayant une piste en cette langue...
Il est possible d'appeler cette méthode lorsque le lecteur est à l'arret.
id string <optionnel>

Identifiant de piste.

Paramètre obligatoire quand selection à pour valeur 'id'.

Le lecteur sélectionnera dans le fichier vidéo courant la piste ayant pour identifiant la valeur de id. Le lecteur doit donc être en cours de lecture pour appeler cette méthode.
Chaque piste de sous-titre à son propre identifiant avec sa propre syntaxe. N'essayer pas de "construire" vous même un identifiant ou de les utiliser en dur dans votre code !
Pour plus d'informations à propos de la récupération des identifiants, reportez vous à Player.getSubtitles().
index number <optionnel>

Index de piste basé sur zéro.

Paramètre obligatoire quand selection à pour valeur 'index'.

Le lecteur sélectionnera la piste à l'index donné dans la liste des pistes. Le lecteur doit donc donc être en cours de lecture pour appeler cette méthode.
Pour plus d'informations à propos de la récupération de la liste des pistes, reportez vous à Player.getSubtitles().
wrap boolean <optionnel>
 false

Doit avoir la valeur true pour boucler.

Peut être utilisé lorque la valeur de selection est 'next' ou 'previous'.
Valeur de retour

  • Une promesse résolue avec une valeur de type boolean.

    Type
    Promise.<SubtitleInfo>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

setVolume(volume, relativeopt): Promise.<boolean> | Promise.<ErrorStatus>

Régler le volume audio de manière absolue ou relative.

Lorsque le volume audio est réglé, la sourdine audio est automatiquement désactivée.

Paramètres
Nom Type Attributs Par défaut Description
volume number

Le niveau du volume (entier entre 0 et 100 pour un volume absolu et entre -100 and 100 pour un volume relatif).
relative boolean <optionnel>
 false

Indique si le niveau de volume est relatif au volume actuel (augmenter ou diminuer le volume).
Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Le volume est déjà au minimum et une diminution à été demandée.
    • Le volume est déjà au maximum et une augmentation à été demandée.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

stop(): Promise.<boolean> | Promise.<ErrorStatus>

Arrête la lecture.

Cette méthode n'est pertinente que lorsque le lecteur est en lecture ou en pause. Le fichier et le dossier actuel sont mémorisés pour rendre possible la reprise de lecture via play() ou playPause().

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Le lecteur n'est pas dans l'état paused ou playing.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

toggleMute(): Promise.<boolean> | Promise.<ErrorStatus>

Activer ou désactiver la sourdine.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

togglePause(): Promise.<boolean> | Promise.<ErrorStatus>

Mettre en pause ou reprendre la lecture.

Cette méthode n'est pertinente que lorsque le lecteur est en pause ou en cours de lecture.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    • Le lecteur n'est pas dans l'état paused ou playing.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

unmute(): Promise.<boolean> | Promise.<ErrorStatus>

Désactiver la sourdine.

Valeur de retour

  • Une promesse résolue avec une valeur de type boolean qui peut être false dans les cas suivants :

    • L'opération n'est pas permise.
    Type
    Promise.<boolean>

  • Une promesse rejetée avec une valeur de type ErrorStatus.

    Type
    Promise.<ErrorStatus>

Définition des types

FolderInfo

Un objet FolderInfo contient les informations détaillées d'un dossier.

Propriétés
Nom Type Description
number number

Le numéro de dossier (identifiant).
name string

Le nom du dossier.

SubtitleInfo

Un SubtitleInfo contient des informations relatives à la sélection des sous-titres.

Propriétés
Nom Type Description
tracks Array.<Object>

Pistes de sous-titres disponibles.

Propriétés
Nom Type Attributs Par défaut Description
language string

Code de langue ISO 639.
id string

Identifiant de la piste.
default boolean <optionnel>
 false

A pour valeur true lorsque la piste est une piste par défaut.
forced boolean <optionnel>
 false

A pour valeur true lorsque la piste est une piste forcée.
current number

Index de la piste actuellement sélectionnée ou -1 si aucune piste n'est actuellement sélectionnée.
override Object

Paramêtres de sélection manuelle.

Propriétés
Nom Type Description
enabled boolean

A pour valeur true lorsque les paramètres système de sélection de piste sont outrepassés (la sélection automatique est désactivée au profit d'une sélection manuelle).
language string

Le code ISO 639 de la langue sélectionnée, peut être null lorsque les sous-titres sont explicitement désactivés.

Il est possible d'obtenir un SubtitleInfo par la méthode Player.getSubtitles().

Exemple

La sélection manuelle de sous-titres en français à été demandée, la piste à l'index 1 est donc sélectionnée.

{
    "override": {
        "enabled": true,
        "language": "fra"
    },
    "current": 1,
    "tracks": [
        {
            "id": "id-0",
            "language": "eng",
            "default": true
        },
        {
            "id": "id-1",
            "language": "fra"
        }
    ]
}

Événements

FileEndEvent

Cet événement est envoyé lorsque le lecteur vidéo achève la lecture d'un fichier.

Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'file-end'

Le type correspondant à FileEndEvent.
filename string

Le nom du fichier.
folder FolderInfo

Le dossier contenant le fichier.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'file-end') {
          // Do something useful...
          console.log("File end: " + e.detail.filename);
      }
});

FileStartEvent

Cet événement est envoyé lorsque le lecteur vidéo démarre la lecture d'un fichier.

Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'file-start'

Le type correspondant à FileStartEvent.
filename string

Le nom du fichier.
folder FolderInfo

Le dossier contenant le fichier.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'file-start') {
          // Do something useful...
          console.log("File start: " + e.detail.filename);
      }
});

FolderEnterEvent

Cet événement est envoyé lorsque le lecteur vidéo démarre la lecture d'un dossier.

Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'folder-enter'

Le type correspondant à FolderEnterEvent.
folder FolderInfo

Le dossier concerné.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'folder-enter') {
          // Do something useful...
          console.log("Enter folder: " + e.detail.folder.name);
      }
});

FolderLeaveEvent

Cet événement est envoyé lorsque le lecteur vidéo quite un dossier.

Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'folder-leave'

Le type correspondant à FolderLeaveEvent.
folder FolderInfo

Le dossier concerné.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'folder-leave') {
          // Do something useful...
          console.log("Leave folder: " + e.detail.folder.name);
      }
});

MuteChangeEvent

Cet événement est envoyé lorsque la sourdine audio est modifiée.

Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'mute-change'

Le type correspondant à MuteChangeEvent.
mute boolean

Indique si la sourdine est activée.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'mute-change') {
          // Do something useful...
          console.log("Mute: " + e.detail.mute);
      }
});

StateChangeEvent

Cet événement est envoyé lorsque le moteur de lecture change d'état.

Depuis :
  • micrologiciel v1.08
Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'state-change'

Le type correspondant à StateChangeEvent.
state 'playing' | 'paused' | 'stopped' | 'maintenance'

État du moteur de lecture.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'state-change') {
          console.log("Nouvel état: " + e.detail.state);
      }
});

TimeUpdateEvent

Cet événement est envoyé périodiquement pour indiquer la position de lecture.

Depuis :
  • micrologiciel v1.08
Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'time-update'

Le type correspondant à TimeUpdateEvent.
position number

Position de lecture dans le fichier courant (secondes).
duration number

Durée du fichier (secondes).

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'time-update') {
          console.log("Position: " + e.detail.position + " / " + e.detail.duration);
      }
});

TrackSelectionEvent

Cet événement est envoyé lorsque le lecteur vidéo sélectionne les pistes audio, video ou sous-titres.
Cela se produit au début de la lecture d'un fichier ou lorsqu'une piste est explicitement sélectionnée, par example, lors du changement de la langue des sous-titres.

Pour le moment, cet événement contient uniquement les informations relatives aux sous-titres.

Depuis :
  • micrologiciel v1.08
Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Attributs Description
type 'track-selection'

Le type correspondant à TrackSelectionEvent.
subtitle Object <optionnel>

Informations concernant la piste de sous-titres sélectionnée. Peut prendre la valeur null.

Propriétés
Nom Type Attributs Par défaut Description
id string

Identifiant de la piste.
language string

Code de langue ISO 639-1, 639-2 or 639-3.
default boolean <optionnel>
 false

A pour valeur true lorsque la piste est une piste par défaut.
forced boolean <optionnel>
 false

A pour valeur true lorsque la piste est une piste forcée.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'track-selection') {
          console.log("Subtitle: " + JSON.stringify(e.detail.subtitle));
      }
});

VolumeChangeEvent

Cet événement est envoyé lorsque le niveau du volume audio est modifié.

Tutoriels :
Propriétés
Nom Type Description
type 'idal-player-event'

Type correspondant à l'ensemble des événements relatifs au lecteur vidéo.
detail Object
Propriétés
Nom Type Description
type 'volume-change'

Le type correspondant à VolumeChangeEvent.
volume number

Le niveau du volume audio.

Cet événement doit être enregistré en utilisant Player.addListener().
Il peut aussi être enregistré via window.addEventListener('idal-player-event', callback) définie par la spécification DOM.
Si vous prévoyez d'utiliser une interface de contrôle à distance, cette dernière méthode doit absolument être évitée.

Type
Exemple
// Methode préférée: utilisation de Player.addListener()
var player = ... // Obtention de l'interface Player
player.addListener(function(e) {
      if (e.detail.type == 'volume-change') {
          // Do something useful...
          console.log("Volume: " + e.detail.volume);
      }
});