getComponent

Última atualização em 2023-05-20
  • Criado para:
  • Developer
    User

Referência da API JavaScript para o Visualizador de vídeo interativo.

getComponent(componentId)

Retorna uma referência ao componente de SDK do Visualizador usado pelo visualizador. A página da Web pode usar esse método para estender ou personalizar o comportamento do visualizador pronto para uso. Chame esse método somente após o initComplete o retorno de chamada do visualizador foi executado, caso contrário, o componente pode não ter sido criado ainda pela lógica do visualizador.

Parâmetros

*componentID* - {String} uma ID do componente do Visualizador SDK usada pelo visualizador. Esse visualizador é compatível com as seguintes IDs de componente:

ID do componente

Nome da classe do componente do visualizador do SDK

parameterManager

s7sdk.ParameterManager

container

s7sdk.common.Container

mediaSet

s7sdk.set.MediaSet

videoPlayer

s7sdk.video.VideoPlayer

interativeSwatches

s7sdk.set.InterativeSwatches

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

controles

s7sdk.common.ControlBar

socialShare

s7sdk.share.SocialShare

twitterShare

s7sdk.share.TwitterShare

facebookShare

s7sdk.share.FacebookShare

linkShare

s7sdk.share.LinkShare

Ao trabalhar com APIs de SDK, é importante usar um namespace de SDK correto e totalmente qualificado, conforme descrito em Namespace do visualizador do SDK.

Consulte a Visualizador da API do SDK para obter mais informações sobre um componente específico.

Devoluções

{Object} Uma referência ao componente do Visualizador SDK. O método retorna null se a variável componentId não é um componente de visualizador compatível ou se o componente ainda não foi criado pela lógica do visualizador.

Exemplo

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

Nesta página