getComponent

Senast uppdaterad: 22 juli 2024
  • Ämnen:

Skapat för:

  • Utvecklare
  • Användare

JavaScript API-referens för Interactive Video Viewer.

getComponent(componentId)

Returnerar en referens till SDK-komponenten för visningsprogrammet som används av visningsprogrammet. Webbsidan kan använda den här metoden för att utöka eller anpassa beteendet för visningsprogrammet som inte är installerat. Anropa den här metoden först efter att initComplete-visningsprogrammets återanrop har körts, annars kanske komponenten inte har skapats ännu av visningsprogramlogiken.

Parametrar

*componentID* - {String} ett ID för SDK-komponenten för visningsprogrammet som används av visningsprogrammet. Detta visningsprogram stöder följande komponent-ID:

Komponent-IDNamn på SDK-komponentklass för visningsprogram
parameterManagers7sdk.ParameterManager
containers7sdk.common.Container
mediaSets7sdk.set.MediaSet
videoPlayers7sdk.video.VideoPlayer
interactiveSwatchess7sdk.set.InteractiveSwatches
callToActions7sdk.set.CallToAction
fullScreenButtons7sdk.common.FullScreenButton
mutableVolumes7sdk.video.MutableVolume
playPauseButtons7sdk.common.PlayPauseButton
videoScrubbers7sdk.video.VideoScrubber
videoTimes7sdk.video.VideoTime
closedCaptionButtons7sdk.common.ClosedCaptionButton
kontrollers7sdk.common.ControlBar
socialShares7sdk.share.SocialShare
twitterShares7sdk.share.TwitterShare
facebookShares7sdk.share.FacebookShare
linkShares7sdk.share.LinkShare

När du arbetar med SDK API:er är det viktigt att du använder ett korrekt, fullständigt kvalificerat SDK-namnutrymme enligt beskrivningen i Viewer SDK-namnområdet.

Mer information om en viss komponent finns i dokumentationen för SDK API för visningsprogrammet.

Returnerar

{Object} En referens till SDK-komponenten för visningsprogrammet. Metoden returnerar null om componentId inte är en visningsprogramkomponent som stöds eller om komponenten ännu inte har skapats av visningsprogramlogiken.

Exempel 

<instance>.setHandlers({
 "initComplete":function() {
  var videoPlayer = <instance>.getComponent("videoPlayer");
}
})
Föregående sida
Nästa sida

Experience Manager