getComponent

JavaScript API reference for Interactive 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 ID

Viewer SDK component class name

parameterManager

s7sdk.ParameterManager

container

s7sdk.common.Container

mediaSet

s7sdk.set.MediaSet

videoPlayer

s7sdk.video.VideoPlayer

interactiveSwatches

s7sdk.set.InteractiveSwatches

callToAction

s7sdk.set.CallToAction

fullScreenButton

s7sdk.common.FullScreenButton

mutableVolume

s7sdk.video.MutableVolume

playPauseButton

s7sdk.common.PlayPauseButton

videoScrubber

s7sdk.video.VideoScrubber

videoTime

s7sdk.video.VideoTime

closedCaptionButton

s7sdk.common.ClosedCaptionButton

controls

s7sdk.common.ControlBar

socialShare

s7sdk.share.SocialShare

twitterShare

s7sdk.share.TwitterShare

facebookShare

s7sdk.share.FacebookShare

linkShare

s7sdk.share.LinkShare

When working with SDK APIs it is important to use correct fully qualified SDK namespace as described in Viewer SDK namespace.

See 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 videoPlayer = <instance>.getComponent("videoPlayer"); 
} 
})

On this page