getComponent

インタラクティブビデオビューアのJavaScript APIリファレンス。

getComponent(componentId)

ビューアで使用されるビューアSDKコンポーネントへの参照を返します。 Webページでは、この方法を使用して、標準提供ビューアの動作を拡張またはカスタマイズできます。 このメソッドは、initCompleteビューアのコールバックを実行した後にのみ呼び出します。そうしないと、ビューアのロジックによってコンポーネントがまだ作成されていない可能性があります。

パラメータ

*componentID* - {String} ビューアで使用されるビューアSDKコンポーネントのID。このビューアは、次のコンポーネントIDをサポートしています。

コンポーネントID

ビューアSDKコンポーネントのクラス名

parameterManager

s7sdk.ParameterManager

コンテナ

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

コントロール

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"); 
} 
})

このページ