getComponent

Last update: December 6, 2021

CREATED FOR:

  • Developer
  • User

JavaScript API reference for Smart Crop Video Viewer.

getComponent(componentId)

Returns a reference to the Viewer SDK component that is used by the viewer. The web page can use this method to extend or customize the behavior of the out-of-box viewer. Call this method only after the initComplete viewer callback has run, otherwise the component may not be created yet by the viewer logic.

Parameters

*componentID* - {String} an ID of the Viewer SDK component used by the viewer. This viewer supports the following component IDs:

Component IDViewer SDK component class name
parameterManagers7sdk.ParameterManager
containers7sdk.common.Container
mediaSets7sdk.set.MediaSet
smartCropVideoPlayers7sdk.video.SmartCropVideoPlayer
fullScreenButtons7sdk.common.FullScreenButton
mutableVolumes7sdk.video.MutableVolume
playPauseButtons7sdk.common.PlayPauseButton
videoScrubbers7sdk.video.VideoScrubber
videoTimes7sdk.video.VideoTime
closedCaptionButtons7sdk.common.ClosedCaptionButton
controlss7sdk.common.ControlBar
socialShares7sdk.share.SocialShare
twitterShares7sdk.share.TwitterShare
facebookShares7sdk.share.FacebookShare
linkShares7sdk.share.LinkShare
emailShares7sdk.share.EmailShare
embedShares7sdk.share.EmbedShare

When working with SDK APIs, it is important to use correct fully qualified SDK namespace as described in [Viewer SDK namespace]
(https://experienceleague.adobe.com/c-html5-aem-asset-viewers/c-html5-aem-smartcropvideo/r-html5-aem-smartcropvideo-viewer-namespace.html?lang=en#concept-679bfabb3e3e4c12a285c4e9c4144153).

Refer to the Viewer SDK API documentation for more information about a particular component.

Returns

{Object} A reference to Viewer SDK component. The method returns null if the componentId is not a supported viewer component or if the component was not yet created by the viewer logic.

Example 

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

Experience Manager