インタラクティブビデオビューアのJavaScript APIリファレンス。
getComponent(componentId)
ビューアで使用されているビューアSDKコンポーネントへの参照を返します。 Webページでは、このメソッドを使用して、標準搭載のビューアの動作を拡張またはカスタマイズできます。 このメソッドは、initComplete
ビューアのコールバックを実行した後でのみ呼び出してください。呼び出さないと、ビューアのロジックによってコンポーネントがまだ作成されていない場合があります。
*
componentID*
— ビューア {String}
が使用するビューアSDKコンポーネントのID。このビューアでは、次のコンポーネントIDがサポートされています。
コンポーネントID |
ビューアSDKコンポーネントのクラス名 |
---|---|
parameterManager |
s7sdk.ParameterManager |
コンテナ |
s7sdk.common.コンテナ |
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 |
コントロール |
s7sdk.common.ControlBar |
socialShare |
s7sdk.share.SocialShare |
twitterShare |
s7sdk.share.TwitterShare |
facebookShare |
s7sdk.share.FacebookShare |
linkShare |
s7sdk.share.LinkShare |
SDK APIを使用する場合、ビューアSDKの名前空間で説明されているとおり、正しい完全修飾SDK名前空間を使用することが重要です。
特定のコンポーネントについて詳しくは、ビューアSDK APIのドキュメントを参照してください。
{Object}
ビューアSDKコンポーネントへのリファレンス。componentId
がサポートされているビューアコンポーネントでない場合、またはビューアのロジックによってコンポーネントがまだ作成されていない場合は、null
が返されます。
<instance>.setHandlers({
"initComplete":function() {
var videoPlayer = <instance>.getComponent("videoPlayer");
}
})