HTMLMediaElement

Propriétés d'instance

Cette interface hérite également des propriétés de ses ancêtres HTMLElement, Element, Node et EventTarget.

HTMLMediaElement.audioTracks Lecture seule

Un objet AudioTrackList qui liste les objets AudioTrack contenus dans l'élément.

HTMLMediaElement.autoplay

Un booléen qui reflète l'attribut HTML autoplay, indiquant si la lecture doit commencer automatiquement dès qu'assez de média est disponible pour le faire sans interruption.

Note : Lancer automatiquement la lecture audio sans que l'utilisateur·ice ne s'y attende ou ne le souhaite est une mauvaise expérience et doit être évité dans la plupart des cas, sauf exception. Voir le guide de lecture automatique pour les médias et les API Web Audio pour plus d'informations. Gardez à l'esprit que les navigateurs peuvent ignorer les demandes de lecture automatique, donc votre code ne doit pas dépendre du bon fonctionnement de cette fonctionnalité.

HTMLMediaElement.buffered Lecture seule

Retourne un objet TimeRanges qui indique les plages de la source média que le navigateur a mises en mémoire tampon (le cas échéant) au moment où la propriété buffered est consultée.

HTMLMediaElement.controls

Un booléen qui reflète l'attribut HTML controls, indiquant si les éléments d'interface utilisateur pour contrôler la ressource doivent être affichés.

HTMLMediaElement.controlsList

Retourne un objet DOMTokenList qui aide l'agent utilisateur à choisir quels contrôles afficher sur l'élément média lorsque l'agent utilisateur affiche son propre ensemble de contrôles. Le DOMTokenList prend une ou plusieurs des trois valeurs possibles : nodownload, nofullscreen et noremoteplayback.

HTMLMediaElement.crossOrigin

Une chaîne de caractères indiquant le paramètre CORS pour cet élément média.

HTMLMediaElement.currentSrc Lecture seule

Retourne une chaîne de caractères contenant l'URL absolue de la ressource média choisie.

HTMLMediaElement.currentTime

Une valeur à virgule flottante en double précision indiquant le temps de lecture actuel en secondes ; si le média n'a pas commencé à être lu et n'a pas été déplacé, cette valeur correspond au temps de lecture initial du média. Définir cette valeur déplace la lecture à ce nouveau temps. Le temps est défini par rapport à la chronologie du média.

HTMLMediaElement.defaultMuted

Un booléen qui reflète l'attribut HTML muted, qui indique si la sortie audio de l'élément média doit être coupée par défaut.

HTMLMediaElement.defaultPlaybackRate

Un double indiquant la vitesse de lecture par défaut du média.

HTMLMediaElement.disableRemotePlayback

Un booléen qui définit ou retourne l'état de lecture à distance, indiquant si l'élément média est autorisé à avoir une interface de lecture à distance.

HTMLMediaElement.duration Lecture seule

Une valeur à virgule flottante en double précision en lecture seule indiquant la durée totale du média en secondes. Si aucune donnée média n'est disponible, la valeur retournée est NaN. Si le média est de longueur indéfinie (comme un flux en direct, un média d'appel WebRTC ou similaire), la valeur est Infinity.

HTMLMediaElement.ended Lecture seule

Retourne un booléen qui indique si l'élément média a terminé la lecture.

HTMLMediaElement.error Lecture seule

Retourne un objet MediaError pour la dernière erreur rencontrée, ou null s'il n'y a pas eu d'erreur.

HTMLMediaElement.loop

Un booléen qui reflète l'attribut HTML loop, qui indique si l'élément média doit recommencer la lecture lorsqu'il arrive à la fin.

HTMLMediaElement.mediaKeys Lecture seule Contexte sécurisé

Retourne un objet MediaKeys, c'est un ensemble de clés que l'élément peut utiliser pour le déchiffrement des données média lors de la lecture. Si aucune clé n'est disponible, la valeur peut être null.

HTMLMediaElement.muted

Un booléen qui détermine si l'audio est coupé. true si l'audio est coupé, false sinon.

HTMLMediaElement.networkState Lecture seule

Retourne un unsigned short (énumération) indiquant l'état actuel de la récupération du média sur le réseau.

HTMLMediaElement.paused Lecture seule

Retourne un booléen qui indique si l'élément média est en pause.

HTMLMediaElement.playbackRate

Un double qui indique la vitesse à laquelle le média est lu.

HTMLMediaElement.played Lecture seule

Retourne un objet TimeRanges qui contient les plages de la source média que le navigateur a lues, le cas échéant.

HTMLMediaElement.preload

Une chaîne de caractères qui reflète l'attribut HTML preload, indiquant quelles données doivent être préchargées, le cas échéant. Les valeurs possibles sont : none, metadata, auto.

HTMLMediaElement.preservesPitch

Une valeur booléenne qui détermine si la hauteur du son sera préservée. Si elle est définie à false, la hauteur s'ajustera à la vitesse de l'audio.

HTMLMediaElement.readyState Lecture seule

Retourne un unsigned short (énumération) indiquant l'état de préparation du média.

HTMLMediaElement.remote Lecture seule

Retourne une instance d'objet RemotePlayback associée à l'élément média.

HTMLMediaElement.seekable Lecture seule

Retourne un objet TimeRanges qui contient les plages temporelles auxquelles l'utilisateur·ice peut accéder, le cas échéant.

HTMLMediaElement.seeking Lecture seule

Retourne un booléen qui indique si le média est en cours de déplacement vers une nouvelle position.

HTMLMediaElement.sinkId Lecture seule Contexte sécurisé

Retourne une chaîne de caractères qui est l'identifiant unique du périphérique audio délivrant la sortie, ou une chaîne vide si le périphérique audio par défaut de l'agent utilisateur est utilisé.

HTMLMediaElement.src

Une chaîne de caractères qui reflète l'attribut HTML src, qui contient l'URL d'une ressource média à utiliser.

HTMLMediaElement.srcObject

Un objet qui sert de source au média associé à HTMLMediaElement, ou null si non attribué.

HTMLMediaElement.textTracks Lecture seule

Retourne un objet TextTrackList contenant la liste des objets TextTrack contenus dans l'élément.

HTMLMediaElement.videoTracks Lecture seule

Retourne un objet VideoTrackList contenant la liste des objets VideoTrack contenus dans l'élément.

HTMLMediaElement.volume

Un double indiquant le volume audio, de 0.0 (silencieux) à 1.0 (le plus fort).

Propriétés obsolètes

Ces propriétés sont obsolètes et ne doivent pas être utilisées, même si un navigateur les prend encore en charge.

HTMLMediaElement.controller Obsolète Non standard

Un objet MediaController qui représente le contrôleur média assigné à l'élément, ou null si aucun n'est assigné.

HTMLMediaElement.mediaGroup Obsolète Non standard

Une chaîne de caractères qui reflète l'attribut HTML mediagroup, qui indique le nom du groupe d'éléments auquel il appartient. Un groupe d'éléments média partage un même MediaController.

HTMLMediaElement.mozAudioCaptured Lecture seule Non standard Obsolète

Retourne un booléen. Lié à la capture de flux audio.

HTMLMediaElement.mozFragmentEnd Non standard Obsolète

Un double qui donne accès à la fin du fragment si l'élément média possède un URI de fragment pour currentSrc, sinon il est égal à la durée du média.

Méthodes d'instance

Cette interface hérite également des méthodes de ses ancêtres HTMLElement, Element, Node et EventTarget.

HTMLMediaElement.addTextTrack()

Ajoute un nouvel objet TextTrack (comme une piste de sous-titres) à un élément média. Ceci est une interface uniquement programmatique et n'affecte pas le DOM.

HTMLMediaElement.captureStream()

Retourne MediaStream, capture un flux du contenu média.

HTMLMediaElement.canPlayType()

Étant donné une chaîne de caractères définissant un type MIME de média (éventuellement avec le paramètre codecs inclus), canPlayType() retourne la chaîne de caractères probably si le média doit pouvoir être lu, maybe s'il n'y a pas assez d'informations pour déterminer si le média sera lu ou non, ou une chaîne vide si le média ne peut pas être lu.

HTMLMediaElement.fastSeek()

Effectue rapidement un déplacement à l'instant donné avec une faible précision.

HTMLMediaElement.load()

Réinitialise le média au début et sélectionne la meilleure source disponible parmi celles fournies à l'aide de l'attribut src ou de l'élément HTML <source>.

HTMLMediaElement.pause()

Met en pause la lecture du média.

HTMLMediaElement.play()

Démarre la lecture du média.

HTMLMediaElement.seekToNextFrame() Obsolète Non standard

Atteint l'image suivante dans le média. Cette méthode non standard et expérimentale permet de piloter manuellement la lecture et le rendu du média à une vitesse personnalisée, ou de parcourir le média image par image pour effectuer des filtrages ou d'autres opérations.

HTMLMediaElement.setMediaKeys() Contexte sécurisé

Retourne un objet Promise. Définit les clés MediaKeys à utiliser lors du déchiffrement du média pendant la lecture.

HTMLMediaElement.setSinkId() Contexte sécurisé

Définit l'identifiant du périphérique audio à utiliser pour la sortie et retourne un objet Promise. Ceci ne fonctionne que lorsque l'application est autorisée à utiliser le périphérique spécifié.

Méthodes obsolètes

Ces méthodes sont obsolètes et ne doivent pas être utilisées, même si un navigateur les prend encore en charge.

HTMLMediaElement.mozCaptureStream() Non standard

Équivalent préfixé Firefox de HTMLMediaElement.captureStream(). Voir sa compatibilité des navigateurs pour plus de détails.

HTMLMediaElement.mozCaptureStreamUntilEnded() Non standard Obsolète

Aucune description disponible.

HTMLMediaElement.mozGetMetadata() Non standard Obsolète

Retourne Object, qui contient des propriétés représentant les métadonnées de la ressource média en cours de lecture sous forme de paires {clé: valeur}. Une copie distincte des données est retournée à chaque appel de la méthode. Cette méthode doit être appelée après le déclenchement de l'évènement loadedmetadata.

Évènements

Hérite des évènements de son parent, HTMLElement.

Écoutez ces évènements en utilisant addEventListener() ou en assignant un gestionnaire d'évènements à la propriété oneventname de cette interface.

abort

Déclenché lorsque la ressource n'a pas été entièrement chargée, mais pas à la suite d'une erreur.

canplay

Déclenché lorsque l'agent utilisateur peut lire le média, mais estime que pas assez de données ont été chargées pour lire le média jusqu'à la fin sans devoir s'arrêter pour mettre en mémoire tampon du contenu supplémentaire.

canplaythrough

Déclenché lorsque l'agent utilisateur peut lire le média et estime que suffisamment de données ont été chargées pour lire le média jusqu'à la fin sans avoir à s'arrêter pour mettre en mémoire tampon du contenu supplémentaire.

durationchange

Déclenché lorsque la propriété de durée a été mise à jour.

emptied

Déclenché lorsque le média est devenu vide ; par exemple, lorsque le média a déjà été chargé (ou partiellement chargé), et que la méthode HTMLMediaElement.load() est appelée pour le recharger.

encrypted

Déclenché lorsque des données d'initialisation sont trouvées dans le média, indiquant que le média est chiffré.

ended

Déclenché lorsque la lecture s'arrête à la fin du média (<audio> ou <video>) ou parce qu'aucune donnée supplémentaire n'est disponible.

error

Déclenché lorsque la ressource n'a pas pu être chargée en raison d'une erreur.

loadeddata

Déclenché lorsque la première image du média a fini de se charger.

loadedmetadata

Déclenché lorsque les métadonnées ont été chargées.

loadstart

Déclenché lorsque le navigateur a commencé à charger une ressource.

pause

Déclenché lorsqu'une demande de mise en pause est traitée et que l'activité est passée à l'état de pause, le plus souvent lorsque la méthode HTMLMediaElement.pause() du média est appelée.

play

Déclenché lorsque la propriété paused passe de true à false, à la suite de l'appel à la méthode HTMLMediaElement.play() ou de l'attribut autoplay.

playing

Déclenché lorsque la lecture est prête à démarrer après avoir été mise en pause ou retardée en raison d'un manque de données.

progress

Déclenché périodiquement pendant que le navigateur charge une ressource.

ratechange

Déclenché lorsque la vitesse de lecture a changé.

seeked

Déclenché lorsqu'une opération de déplacement est terminée.

seeking

Déclenché lorsqu'une opération de déplacement commence.

stalled

Déclenché lorsque l'agent utilisateur tente de récupérer des données média, mais que les données n'arrivent pas comme prévu.

suspend

Déclenché lorsque le chargement des données média a été suspendu.

timeupdate

Déclenché lorsque la propriété currentTime a été mise à jour.

volumechange

Déclenché lorsque le volume a changé.

waiting

Déclenché lorsque la lecture s'est arrêtée en raison d'un manque temporaire de données.

waitingforkey

Déclenché lorsque la lecture est d'abord bloquée en attente d'une clé.

Spécifications

Compatibilité des navigateurs

Voir aussi

• Les éléments HTML <video> et <audio>.
• Les interfaces HTMLVideoElement et HTMLAudioElement, dérivées de HTMLMediaElement.
• Technologies des médias web
• Domaine d'apprentissage : Audio et vidéo HTML
• Guide des types et formats de médias
• Gérer les problèmes de prise en charge des médias dans le contenu web