La documentation Pulse évolue : partagez votre avis en bas de chaque page.

Lecteur vidéo

Piloter la lecture d'une vidéo sur l'appareil : lecture, pause, reprise, arrêt, déplacement et sourdine.

Le lecteur se pilote par un endpoint générique, /player, qui porte l'action à effectuer. Trois raccourcis existent pour les actions les plus courantes.

Endpoint générique

MéthodePOST
Chemin/player

Requête

{
  "id": 51,
  "action": "play",
  "currentTime": 0
}
ChampObligatoireRôle
idouiIdentifiant de la vidéo présente sur l'appareil.
actionouiL'action à effectuer, parmi la liste ci-dessous.
currentTimenonPosition en secondes. Requis uniquement pour seek.

Réponse

{
  "videoId": 51,
  "title": "Mont-Blanc",
  "message": "Lecture de la vidéo",
  "currentTime": 0
}

Actions disponibles

ActionEffet
playDémarre la lecture depuis le début, ou depuis currentTime s'il est fourni.
pauseMet la lecture en pause en conservant la position.
resumeReprend une lecture mise en pause.
stopArrête la lecture et ferme le lecteur.
seekDéplace la lecture à currentTime.
muteCoupe le son de la lecture.
volumeAjuste le volume du lecteur.

Lorsque la vidéo porte une date limite d'utilisation atteinte ou dépassée, seules play et resume sont refusées. pause, seek, stop et mute restent disponibles, afin de garder la main sur une lecture déjà en cours. Voir la date limite d'utilisation.

Pour connaître les vidéos disponibles et leurs identifiants, interrogez /contents.

Arrêter la lecture

Raccourci équivalent à action: "stop" sur l'endpoint générique.

MéthodePOST
Chemin/player/stop

Requête

{
  "id": 51
}

Réponse

{
  "videoId": 51,
  "title": "Mont-Blanc",
  "message": "Arrêt de la vidéo"
}

Déplacer la lecture

MéthodePOST
Chemin/player/seek

Requête

{
  "id": 51,
  "currentTime": 16
}

Réponse

{
  "videoId": 51,
  "title": "Mont-Blanc",
  "message": "Seek de la vidéo",
  "currentTime": 16
}

currentTime est exprimé en secondes depuis le début de la vidéo.

Mettre en sourdine

MéthodeGET
Chemin/player/mute

Réponse

{
  "videoId": 51,
  "title": "Mont-Blanc",
  "message": "Sourdine de la vidéo",
  "currentTime": 16
}

La commande s'applique à la lecture en cours : contrairement aux autres endpoints du lecteur, elle ne prend pas d'identifiant de vidéo.

La sourdine ne concerne que le lecteur vidéo. Pour le volume général de l'appareil, utilisez /volume.

Cette page vous a-t-elle aidé ?

Dernière mise à jour le

Sur cette page