getComponent

Référence de l’API JavaScript pour la visionneuse de vidéos interactives.

getComponent(componentId)

Renvoie une référence au composant SDK de la visionneuse utilisé par la visionneuse. La page web peut utiliser cette méthode pour étendre ou personnaliser le comportement de la visionneuse prête à l’emploi. Appelez cette méthode uniquement après l’exécution du rappel de la visionneuse initComplete. Sinon, le composant ne peut pas encore être créé par la logique de la visionneuse.

Paramètres

*componentID* : {String} identifiant du composant SDK de visionneuse utilisé par la visionneuse. Cette visionneuse prend en charge les identifiants de composant suivants :

Lorsque vous utilisez des API SDK, il est important que vous utilisiez un espace de noms SDK correct, complet, comme décrit dans la section Espace de noms du SDK de la visionneuse.

Pour plus d’informations sur un composant particulier, voir la documentation API du SDK de visionneuse .

Renvoie

{Object} Référence au composant SDK de visionneuse. La méthode renvoie null si componentId n’est pas un composant de visionneuse pris en charge ou si le composant n’a pas encore été créé par la logique de la visionneuse.

Exemple

<instance>.setHandlers({
 "initComplete":function() {
  var videoPlayer = <instance>.getComponent("videoPlayer");
}
})