getComponent

ビデオビューアの JavaScript API リファレンス

getComponent(componentId)

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

パラメータ

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

コンポーネント ID

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

parameterManager

s7sdk.ParameterManager

コンテナ

s7sdk.common.Container

mediaSet

s7sdk.set.MediaSet

videoPlayer

s7sdk.video.VideoPlayer

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

emailShare

s7sdk.share.EmailShare

embedShare

s7sdk.share.EmbedShare

SDK API を操作する場合は、「 Viewer SDK の名前空間.

特定のコンポーネントについて詳しくは、 Viewer SDK API のドキュメントを参照してください。

戻り値

{Object} Viewer SDK コンポーネントへのリファレンス。 メソッドはを返します。 null ( componentId はサポートされていないビューアコンポーネントです。または、ビューアのロジックによってコンポーネントがまだ作成されていない場合も同様です。

例

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

このページ