ApsaraVideo VOD:Aliplayer API Reference

Name

Type

Description

id

String

ID de l'élément DOM du conteneur externe du lecteur.

source

String

Lorsque vous utilisez la lecture basée sur une URL, spécifiez l'URL de la vidéo avec cette propriété.

vid

String

ID du média pour le service ApsaraVideo Media Processing.

playauth

String

Identifiant de lecture. Pour obtenir un identifiant de lecture, consultez Obtain a Playback Credential.

customVodServer

String

Un domaine personnalisé pour le proxy VOD (pris en charge dans le mode de lecture VidAuth version 2.32.0 et ultérieure). Vous devez déployer un service de proxy de requête dédié. Lorsque le domaine VOD par défaut (*.aliyuncs.com) est inaccessible, le lecteur bascule automatiquement vers votre service de proxy. Cela évite le détournement par les FAI et améliore la stabilité et le taux de réussite de la lecture.

playConfig

JSON

Paramètres personnalisés utilisés lors de la lecture avec Vid (VidAuth ou VidSts). Ces paramètres sont transmis à l'API VOD. Pour connaître les champs pris en charge et la description des paramètres, consultez Custom PlayConfig Settings for Media Playback. Exemple de valeur :

{"PlayDomain":"vod.test_domain","PreviewTime":"20","MtsHlsUriToken":"yqCD7******oVjslp5Q"}

authTimeout

Number

Durée de validité de l'URL de lecture vidéo obtenue via Vid (VidAuth ou VidSts). Unité : secondes. Valeur par défaut : 7200.

Assurez-vous que cette valeur dépasse la durée réelle de la vidéo afin d'éviter l'expiration de l'URL de lecture avant la fin de la diffusion.

height

String

Hauteur du lecteur. Valeurs valides :

• 100%

• 100px

width

String

Largeur du lecteur. Valeurs valides :

• 100%

• 100px

autoSize

Boolean | String

Ajuste automatiquement la taille du lecteur pour l'adapter au contenu vidéo. Valeurs valides : 'height' ou 'width'.

Par exemple, définissez width: '500px' et autoSize: 'height'. Le lecteur conserve une largeur fixe de 500 px et ajuste sa hauteur en fonction du rapport d'aspect de la vidéo.

Ou définissez height: '500px' et autoSize: 'width'. Le lecteur conserve une hauteur fixe de 500 px et ajuste sa largeur en fonction du rapport d'aspect de la vidéo.

Remarque : autoSize: true équivaut à autoSize: 'height'. L'ajustement automatique de la hauteur est la valeur par défaut.

videoWidth

String

Largeur de la vidéo. Pour plus d'informations, consultez Set Display Mode.

videoHeight

String

Hauteur de la vidéo. Pour plus d'informations, consultez Set Display Mode.

preload

Boolean

Le lecteur se charge automatiquement.

cover

String

Image de couverture par défaut du lecteur. Saisissez une URL d'image valide. Ce paramètre ne prend effet que lorsque autoplay est défini sur false.

isLive

Boolean

Indique si le contenu est une diffusion en direct. Lorsqu'elle est activée, les utilisateurs ne peuvent pas faire glisser la barre de progression. Valeur par défaut : false. Définissez sur true pour les diffusions en direct.

autoplay

Boolean

Active la lecture automatique du lecteur. La lecture automatique échoue sur les appareils mobiles. Valeurs valides :

• true (par défaut) : active la lecture automatique.

• false : désactive la lecture automatique.

autoplayPolicy

Object

Le lecteur prend en charge une politique adaptative pour la lecture automatique en sourdine. Cette propriété ne prend effet que lorsque autoplay est défini sur true. Voici un exemple de configuration :

autoplayPolicy: {
      fallbackToMute: true, // Basculer vers la lecture automatique en sourdine si la lecture automatique audible échoue. Par défaut : false.
      showUnmuteBtn: true, // Afficher un grand bouton de réactivation du son lorsque la lecture automatique en sourdine est active. Par défaut : true.
    }

rePlay

Boolean

Active la lecture en boucle automatique.

useH5Prism

Boolean

Utilise le lecteur HTML5.

playsinline

Boolean

Active la lecture intégrée pour HTML5. Certains navigateurs Android ne prennent pas en charge cette fonctionnalité.

skinRes

Url

URL de l'image de l'habillage. Nous ne recommandons pas de modifier ce champ. Pour personnaliser l'habillage, consultez Customize the Player Skin.

skinLayout

Array | Boolean

Configure la disposition des composants de l'interface utilisateur. Omettez cette propriété pour utiliser la disposition par défaut. Définissez sur false pour masquer tous les composants de l'interface utilisateur. Pour plus d'informations, consultez Configure the skinLayout Property.

skinLayoutIgnore

Array

Liste des composants de l'interface utilisateur à masquer. Consultez VOD Component Parameter Reference pour les noms des composants. Exemple de configuration :

skinLayoutIgnore: [
  'bigPlayButton', // Masquer le grand bouton de lecture.
  'controlBar.fullScreenButton' // Masquer le bouton plein écran dans la barre de contrôle (utiliser la notation pointée pour les composants imbriqués).
]

controlBarVisibility

String

Implémentation du panneau de contrôle. Les valeurs valides incluent :

• click : vous pouvez cliquer sur la zone du lecteur.

• hover (par défaut) : afficher lorsque l'utilisateur survole la zone du lecteur.

• always : toujours afficher la barre de contrôle.

• Never : masque tout le panneau de contrôle.

showBarTime

Number

Temps en millisecondes avant que la barre de contrôle ne se masque automatiquement.

enableSystemMenu

Boolean

Active le menu contextuel système. Valeur par défaut : false.

format

String

Spécifiez le format de l'URL de lecture. Valeurs valides :

• mp4

• hls ou m3u8

• flv

• mp3

Par défaut : vide.

mediaType

String

Spécifiez s'il faut renvoyer l'audio ou la vidéo. Pris en charge uniquement lors de l'utilisation de la lecture basée sur vid. Valeur par défaut : video. Valeurs valides :

• video : Vidéo.

• audio : Formats audio uniquement, tels que les fichiers MP4 contenant uniquement de l'audio.

qualitySort

String

Spécifiez l'ordre de tri. Pris en charge uniquement lors de l'utilisation de la lecture Vid + PlayAuth. Valeurs valides :

• desc : Tri décroissant (du plus grand au plus petit).

• asc : Tri croissant (du plus petit au plus grand).

Par défaut : asc.

definition

String

Définissez les définitions vidéo à afficher. Séparez plusieurs définitions par des virgules (,). Exemple : 'FD,LD'. Il s'agit d'un sous-ensemble des définitions disponibles pour le vid spécifié. Valeurs valides :

• FD (basse définition)

• LD (définition standard)

• HD (haute définition)

• HD (ultra-haute définition)

• OD (qualité originale)

• 2K (2K)

• 4K (4K)

defaultDefinition

String

Définissez la définition vidéo par défaut. Celle-ci doit correspondre à l'une des définitions disponibles pour le vid spécifié. Valeurs valides :

• FD (basse définition)

• LD (définition standard)

• SD (Standard Definition)

• HD (ultra-haute définition)

• OD (qualité originale)

• 2K (2K)

• 4K (4K)

autoPlayDelay

Number

Délai avant le début de la lecture. Unité : secondes.

language

String

Définissez la langue pour l'internationalisation. Valeur par défaut : zh-cn. Si omis, la langue du navigateur est utilisée. Valeurs valides :

• zh-cn : chinois

• en-us : anglais

languageTexts

JSON

Texte d'internationalisation personnalisé au format JSON. Les clés doivent correspondre à la valeur de la propriété language. Exemple : {jp:{Play:"Play"}}. Pour la liste complète des clés, consultez JSON Structure.

snapshotWatermark

Object

Configurez les filigranes de capture d'écran pour les lecteurs HTML5.

useHlsPluginForSafari

Boolean

Active le plugin HLS pour les navigateurs Safari, à l'exception de Safari 11. Valeurs valides :

• true : activer.

• false (par défaut) : désactiver.

enableStashBufferForFlv

Boolean

Active la mise en cache de la lecture pour FLV dans les lecteurs HTML5. S'applique uniquement à la diffusion en direct. Valeurs valides :

• true (par défaut) : activer.

• false : désactiver.

stashInitialSizeForFlv

Number

Taille initiale du cache pour FLV dans les lecteurs HTML5. S'applique uniquement à la diffusion en direct. Valeur par défaut : 32 Ko.

Une valeur plus petite améliore la vitesse de démarrage. Toutefois, si elle est trop faible, la lecture peut saccader après un court instant.

loadDataTimeout

Number

Temps en secondes avant d'inviter l'utilisateur à passer à une définition inférieure en raison de la mise en mémoire tampon. Valeur par défaut : 20.

waitingTimeout

Number

Délai maximal de mise en mémoire tampon. Un message d'erreur apparaît si ce délai est dépassé. Unité : secondes. Valeur par défaut : 60.

diagnosisButtonVisible

Boolean

Affiche le bouton de diagnostic. Valeurs valides :

• true (par défaut) : affiche le bouton.

• false : masque le bouton.

disableSeek

Boolean

Désactive la recherche avec la barre de progression. Valeurs valides :

• true : désactiver.

• false (par défaut) : ne pas désactiver.

encryptType

Number

Active le chiffrement vidéo Alibaba Cloud (chiffrement privé). Valeur par défaut : 0. Valeurs valides :

• 0 : lire les vidéos non chiffrées.

• 1 : lire les vidéos chiffrées de manière privée.

progressMarkers

Array

Un tableau d'objets de marqueurs de progression. Pour plus d'informations, consultez Progress Bar Markers.

vodRetry

Number

Nombre de tentatives en cas d'échec de la lecture VOD. Valeur par défaut : 3.

liveRetry

Number

Nombre de tentatives en cas d'échec de la lecture en direct. Valeur par défaut : 5.

hlsFrameChasing

Boolean

Active la poursuite d'images pour la diffusion en direct HLS. Valeurs valides :

• true : activer la poursuite d'images.

• false (par défaut) : désactiver la poursuite d'images.

chasingFirstParagraph

Number

Durée du premier segment de poursuite d'images. Unité : secondes. Valeur par défaut : 20.

chasingSecondParagraph

Number

Durée du deuxième segment de poursuite d'images. Unité : secondes. Valeur par défaut : 40.

chasingFirstSpeed

Number

Vitesse de lecture pour le premier segment de poursuite d'images. Valeur par défaut : 1,1×.

chasingSecondSpeed

Number

Vitesse de lecture pour le deuxième segment de poursuite d'images. Valeur par défaut : 1,2×.

hlsOption.maxLiveSyncPlaybackRate

Number

Définissez la vitesse de lecture pour la poursuite d'images en diffusion en direct HLS. Valeur par défaut : 1 (pas de poursuite d'images).

• Exemple de configuration :

  hlsOption: {
    maxLiveSyncPlaybackRate: 1.5, // Définir la vitesse de lecture de poursuite d'images.
    liveSyncDurationCount: 3 // Définir le nombre de segments qui déclenchent la poursuite d'images.
  }

• Signification de l'exemple : lorsque la latence de la diffusion en direct dépasse la durée de 3 segments, le lecteur lit à une vitesse de 1,5× pour rattraper son retard de 3 segments (car le lecteur a besoin d'un tampon pour gérer les fluctuations du réseau, vous devez modifier la valeur de liveSyncDurationCount avec prudence — définir cette valeur trop basse peut provoquer des saccades).

flvFrameChasing

Boolean

Activez la synchronisation des images pour le streaming en direct FLV. Valeurs valides :

• true : activez la synchronisation des images.

• false : désactivez la synchronisation des images.

Par défaut : false.

keyShortCuts

Boolean

Activez les raccourcis clavier. Valeurs valides :

• true : activez les raccourcis clavier.

• false : désactivez les raccourcis clavier.

Par défaut : false.

keyFastForwardStep

Number

Intervalle de temps pour l'avance et le retour rapides. Unité : secondes. Par défaut : 10.

rtsFallback

Boolean

Lorsque le navigateur ne prend pas en charge RTS ou que l'extraction du flux RTS échoue, le lecteur revient automatiquement au format FLV ou HLS. Il privilégie le format FLV pour une latence plus faible. Si le navigateur ne prend pas en charge FLV, il revient au format HLS.

Cette fonctionnalité est activée par défaut. Pour la désactiver, définissez ce paramètre sur false.

rtsFallbackType

String

Spécifiez le protocole vers lequel revenir depuis RTS. Valeurs valides : HLS ou FLV. Par défaut, le lecteur effectue une sélection automatique, en privilégiant le format FLV pour une latence plus faible. Si le navigateur ne prend pas en charge FLV, il revient au format HLS.

rtsFallbackSource

String

Nous vous recommandons d'utiliser la stratégie de secours par défaut du lecteur. Toutefois, si vous souhaitez spécifier une URL de flux fixe pour le repli, utilisez ce paramètre.

traceId

String

Votre identifiant utilisateur unique. Transmettez cette valeur aux points d'instrumentation publics pour suivre la génération des journaux. Par défaut, le SDK Web Player active la génération des journaux. La transmission de traceId permet d'identifier les utilisateurs. S'il est omis, le SDK Web Player génère et stocke un UUID dans le cache du navigateur.

textTracks

Array

Configurez les sous-titres WebVTT externes. Exemple :

textTracks: [
  { kind: 'subtitles', label: 'Chinese', src: 'caption-url', srclang: 'zh-CN', default: true },
  { kind: 'subtitles', label: 'English (US)', src: 'caption-url', srclang: 'en-US' }
],

ratio

Number

Définissez le lecteur pour qu'il s'adapte selon un rapport d'aspect fixe. Par exemple, pour un rapport d'aspect vidéo de 16:9, définissez les paramètres du lecteur sur width: "100%", ratio: 16/9. Cela permet de maintenir le rapport d'aspect du lecteur cohérent avec le contenu vidéo et de lui permettre de s'adapter proportionnellement lors du redimensionnement de la page.

extLanguageTexts

Object

Le SDK Web Player inclut des textes d'interface utilisateur intégrés en chinois et en anglais. Utilisez cette propriété pour personnaliser le texte d'éléments spécifiques de l'interface utilisateur. Par exemple, pour modifier l'affichage de HD de high definition à 1080p :

extLanguageTexts: {
    'zh-cn': {
      'HD': '1080p'
    }
}

speedLevels

Array

Personnalisez la liste des vitesses de lecture. Chaque objet contient une clé (valeur de vitesse) et un texte (libellé de l'interface utilisateur). S'il est omis, la liste par défaut est utilisée. Exemple :

speedLevels: [
  {"key": 0.25, "text": "0.25"},
  {"key": 0.5, "text": "0.5"},
  {"key": 1, "text": "Normal"},
  {"key": 1.25, "text": "1.25"},
  {"key": 1.5, "text": "1.5"},
  {"key": 2,"text": "2"}
]

logo

Array

Configurez des images de logo personnalisées. Exemple :

    logo: [{
      width: 30,
      position: 'bottom-right',
      origin: 'content',
      src: 'a.png'
    },
    {
      width: 20,
      position: 'bottom-right',
      offsetY: -20,
      origin: 'content',
      src: 'b.png'
    }]

Descriptions des champs :

• src : URL de l'image du logo.

• origin : point de référence pour le positionnement. Valeurs valides :

  • box : conteneur du lecteur

  • content : contenu vidéo

• width/height : dimensions du logo en pourcentage (calculées par rapport à origin). Si une seule dimension est spécifiée, l'autre s'adapte proportionnellement.

• position : position relative au sein de origin. Valeurs valides :

  • top-left : coin supérieur gauche

  • top-right : coin supérieur droit

  • bottom-left : coin inférieur gauche

  • bottom-right : coin inférieur droit

• offsetX/offsetY : décalage par rapport à la position, en pourcentage (calculé par rapport à origin).

license

Object

Pour utiliser des fonctionnalités à valeur ajoutée telles que Surveillance de la qualité de lecture (héritée), Dépannage ponctuel ou Lecture vidéo H.265/H.266, soumettez d'abord le Formulaire de demande de services à valeur ajoutée du SDK Web Player afin d'obtenir une licence. Intégrez ensuite la licence comme suit :

// domain is the domain you entered when applying for the license.
// key is the license key.
license: {
    domain: "example.com",
    key: "example-key"
  }

mute

Boolean

Activez la lecture en sourdine. Configurez ce paramètre pour activer la lecture automatique en sourdine lorsque les navigateurs bloquent la lecture automatique. Pour plus de détails, consultez Fonctionnalités avancées.

clickPause

Boolean

Cliquez sur la zone vidéo pour mettre en pause ou reprendre la lecture.

• true : activez.

• false : désactivez.

Par défaut : true sur ordinateur, false sur mobile. N'utilisez pas ce paramètre avec dbClickSkip pour éviter les conflits d'interaction.

disablePip

Boolean

Masquez le bouton Picture-in-Picture (PiP) natif du navigateur.

env

String

Par défaut, les données de télémétrie du lecteur sont téléchargées vers le centre de données en Chine. Si vous avez des exigences de conformité pour les données hors de Chine, définissez env: 'SEA' pour télécharger les données vers le centre de données de Singapour.

watchStartTime

Number

Utilisez seul pour définir l'heure de début de la lecture.

Utilisez avec watchEndTime pour activer la lecture par plage horaire. Les utilisateurs peuvent uniquement lire et rechercher dans la plage horaire spécifiée.

Unité : secondes

watchEndTime

Number

Utilisez avec watchStartTime pour activer la lecture par plage horaire. Les utilisateurs peuvent uniquement lire et rechercher dans la plage horaire spécifiée.

Si cette valeur est inférieure à watchStartTime, watchStartTime est ignoré.

Unité : secondes

start

Number

Utilisez avec end pour extraire un segment de la vidéo. Par exemple, si la vidéo originale dure 60 secondes et que vous définissez start: 10 et end: 30, le lecteur affiche une vidéo de 20 secondes commençant à la 10e seconde de la vidéo originale.

end

Number

Utilisez avec start pour extraire un segment de la vidéo. Par exemple, si la vidéo originale dure 60 secondes et que vous définissez start: 10 et end: 30, le lecteur affiche une vidéo de 20 secondes commençant à la 10e seconde de la vidéo originale.

dbClickFullscreen

Boolean

Activez le double-clic pour passer en plein écran. Activé par défaut sur ordinateur.

longPressFastForward

Boolean

Activez l'avance rapide par appui long (mobile uniquement). Valeurs valides :

• true (par défaut) : activez.

• false : désactivez.

dbClickSkip

Boolean

Double-cliquez sur le côté gauche pour revenir en arrière, double-cliquez sur le côté droit pour avancer rapidement (mobile uniquement). Valeurs valides :

• true (par défaut) : activez.

• false : désactivez.

N'utilisez pas ce paramètre avec clickPause pour éviter les conflits d'interaction.

enableMockFullscreen

Boolean

Activez le pseudo-plein écran basé sur CSS. Par défaut, le lecteur appelle l'API plein écran du navigateur. Sur iOS et certains navigateurs Android, le lecteur système prend le contrôle du plein écran, ce qui entraîne des problèmes d'interface utilisateur. Activez ce paramètre pour éviter cette prise de contrôle. Par défaut : false.

watermark

Object

Configurez des filigranes dynamiques. Exemple :

watermark: {
  enable: true,
  text: 'Copyright ©2026',
  mode: 'BULLET'
}

Descriptions des champs :

• enable : activez le filigrane dynamique.

• text : texte à afficher en tant que filigrane.

• mode : mode de filigrane. Valeurs valides :

  • BULLET : défilement (par défaut).

  • GHOST : clignotement aléatoire.

• direction : direction du mouvement. Valeurs valides :

  • RTL : de droite à gauche (par défaut).

  • LTR : de gauche à droite.

  • STATIC : stationnaire (valide uniquement pour le mode GHOST).

• speed : vitesse de déplacement. Plage : 0~100. Des valeurs plus élevées signifient un déplacement plus rapide. Par défaut : 50 pour BULLET, 30 pour GHOST.

• interval : temps en millisecondes entre la disparition et la réapparition du filigrane. Par défaut : 3000.

• duration : durée d'affichage pour chaque apparition du filigrane (mode GHOST uniquement). Par défaut : 5000 (millisecondes).

• opacity : transparence du texte du filigrane. Plage : 0~1. Par défaut : 0,5.

• fontSize : taille de police du texte du filigrane. Valeur CSS font-size. Par défaut : 14px.

• fontColor : couleur du texte du filigrane. Toute valeur de couleur CSS valide. Par défaut : #FFFFFF.

• top : distance entre le haut du conteneur et la zone de filigrane. Prend en charge les valeurs en pixels (par exemple, 50) ou les pourcentages (par exemple, '20%').

• bottom : distance entre le bas du conteneur et la zone de filigrane. Prend en charge les valeurs en pixels ou les pourcentages.

• left : distance entre la gauche du conteneur et la zone de filigrane. Prend en charge les valeurs en pixels ou les pourcentages (mode GHOST uniquement).

• right : distance entre la droite du conteneur et la zone de filigrane. Prend en charge les valeurs en pixels ou les pourcentages (mode GHOST uniquement).

memoryPlay

Object

Pour activer la reprise de la lecture, ajoutez l'option memoryPlay à la configuration du lecteur. Exemple :

// Resume playback configuration
    memoryPlay: {
        enable: true, // Enable resume playback.
        autoSeek: false // Automatically jump to the remembered position.
    }

Descriptions des champs :

• enable : activez la reprise de la lecture. Valeurs valides :

  • false (par défaut) : désactivez la reprise de la lecture.

  • true : activez la reprise de la lecture.

• autoSeek : sautez automatiquement à la position mémorisée. Valeurs valides :

  • false (par défaut) : affichez une invite demandant à l'utilisateur s'il souhaite sauter (recommandé).

  • true : sautez à la position mémorisée et affichez une invite après le chargement de la vidéo.

getTimeFunction/saveTimeFunction sont utilisés pour les scénarios nécessitant un contrôle personnalisé de la progression de la lecture (comme la synchronisation multi-appareils). S'ils sont omis, le lecteur stocke par défaut la progression dans localStorage.

• getTimeFunction : récupérez l'heure mémorisée depuis un emplacement de stockage personnalisé. Signature de la fonction : (videoKey) => number｜Promise<number>.

• saveTimeFunction : enregistrez l'heure de lecture actuelle. Signature de la fonction : (videoKey, currentTime) => void.

menuMode

String

Définissez l'emplacement d'affichage des commandes de vitesse de lecture, de définition, de sous-titrage et de piste audio. Valeurs valides :

• fold (par défaut) : placez dans le sous-menu Paramètres.

• expand : affichez dans la barre de contrôle (menu principal).

Nom

Type

Obligatoire

Description

time

number

Oui

Instant cible, exprimé en secondes.

Nom

Type

Obligatoire

Description

volume

number

Oui

Valeur réelle comprise entre 0 et 1. Non pris en charge sur iOS et certains appareils Android.

Nom

Type

Obligatoire

Description

quiet

boolean

Non

Masque l'indicateur de statut muet/activé dans le coin inférieur gauche.

Nom

Type

Obligatoire

Description

quiet

boolean

Non

Indique s'il faut masquer l'invite textuelle dans le coin inférieur gauche lors du rétablissement du son.

Nom

Type

Obligatoire

Description

url

string

Oui

URL de la vidéo cible.

seconds

number

Non

Instant de démarrage de la lecture après le basculement.

autoPlay

boolean

Non

Démarre automatiquement la lecture après le basculement.

Nom

Type

Obligatoire

Description

vid

string

Oui

ID de la vidéo.

playauth

string

Oui

Identifiant de lecture.

Nom

Type

Obligatoire

Description

mediaAuth

string

Oui

Identifiant de lecture.

Nom

Type

Obligatoire

Description

name

string

Oui

Nom du composant intégré (par exemple, fullScreenButton). Consultez la liste des noms de composants dans Configurer la propriété skinLayout. Chaque composant prend en charge les méthodes hide et show.

Nom

Type

Obligatoire

Description

width

string

Oui

Définit la taille du lecteur. Valeurs acceptées :

• 400px

• 60%

height

string

Oui

Nom

Type de paramètre

Obligatoire

Description

speed

number

Oui

Vitesses de lecture prises en charge : de 0,5× à 2×.

Nom

Type

Obligatoire

Description

traceId

string

Oui

Identifiant unique.

Nom

Type

Obligatoire

Description

width

number

Oui

Unités de largeur et hauteur : pixels. Plage de qualité de la capture : 0–1 (valeur par défaut : 1). Pour plus de détails, consultez Captures d'écran vidéo.

height

number

Oui

rate

number

Oui

Nom

Type

Obligatoire

Description

start

string

Oui

Heure de début du flux en direct.

end

string

Oui

Heure de fin du flux en direct.

Nom

Type

Obligatoire

Description

rotate

number

Oui

Les valeurs positives entraînent une rotation dans le sens horaire, les valeurs négatives dans le sens antihoraire. Exemple : setRotate(90). Pour plus d'informations, consultez Définir le mode d'affichage.

Nom

Type

Obligatoire

Description

type

string

Oui

Valeurs acceptées :

• horizon : Retournement horizontal.

• Vertical : Orientation verticale.

Exemple : setImage('horizon'). Pour plus d'informations, consultez Définir le mode d'affichage.

Nom

Type

Obligatoire

Description

coverUrl

string

Oui

URL de la vignette.

Nom

Type

Obligatoire

Description

markers

Array<markers>

Oui

markers : Tableau d'objets marqueur (obligatoire).

marker.time : Instant du marqueur (obligatoire).

marker.text : Libellé textuel du marqueur (obligatoire).

Consultez le paramètre progressMarkers pour plus de détails.

Nom

Type

Obligatoire

Description

time

number

Oui

Unité : secondes. Pour plus d'informations, consultez Aperçu.

Nom

Type

Obligatoire

Description

textTracks

Array<object>

Oui

Exemple :

player.setTextTracks([ { kind: 'subtitles', label: 'Chinese', src: 'caption-url', srclang: 'zh-CN' },{ kind: 'subtitles', label: 'English (US)', src: 'caption-url', srclang: 'en-US' }])

Nom

Type

Obligatoire

Description

logoList

Array<object>

Oui

Exemple :

player.setLogo([{
      width: 30,
      position: 'bottom-right',
      origin: 'content',
      src: 'a.jpg'
    },
    {
      width: 20,
      position: 'bottom-right',
      offsetY: -20,
      origin: 'content',
      src: 'b.jpg'
    }])

Pour la description des champs, consultez la propriété : logo.

Nom

Type

Obligatoire

Description

start

string

Oui

Heure de début.

end

string

Oui

Heure de fin.

Nom

Type

Obligatoire

Description

start

string

Oui

Heure de début.

end

string

Oui

Heure de fin.

Nom

Type

Obligatoire

Description

start

string

Oui

Heure de début.

end

string

Oui

Heure de fin.

Nom

Type

Obligatoire

Description

start

string

Oui

Heure de début.

end

string

Oui

Heure de fin.

Nom

Type

Description

time

string

Instant de la capture.

base64

string

Contenu de la capture encodé en base64.

binary

string

Représentation binaire du contenu de la capture.

error

Error

Détails de l'erreur de capture, le cas échéant.