1.1.2 • Published 6 months ago

@zeedhi/zd-video-vue v1.1.2

Weekly downloads
-
License
-
Repository
-
Last release
6 months ago

ZdVideo

O componente ZdVideo é usado para renderizer um player de vídeo.

Instalação

O ZdVideo é composto pelos pacotes @zeedhi/zd-video-common e @zeedhi/zd-video-vue. Utilize o comando abaixo para instalar ambos automaticamente:

npm install @zeedhi/zd-video

Ou instale os pacotes separadamente:

npm install @zeedhi/zd-video-vue @zeedhi/zd-video-common

Registro do Componente

Para registrá-lo, adicione o seguinte código ao inicializar a aplicação (por exemplo no arquivo zeedhi.ts)

import Vue from 'vue';
import { ZdPlayer, ZdYoutube, ZdDailymotion, ZdVideo, ZdVimeo  } from '@zeedhi/zd-video'; 
// import { ZdPlayer, ZdYoutube, ZdDailymotion, ZdVideo, ZdVimeo } from '@zeedhi/zd-video-vue'; caso tenha instalado os pacotes separadamente

Vue.component('ZdPlayer', ZdPlayer);
Vue.component('ZdYoutube', ZdYoutube);
Vue.component('ZdDailymotion', ZdDailymotion);
Vue.component('ZdVideo', ZdVideo);
Vue.component('ZdVimeo', ZdVimeo);

Uso Básico

Para utilizá-lo em um Metadata, basta definir a propriedade component como "ZdPlayer" e em seu children desse component definir o "ZdVideo".

{
  "name": "video-basic-usage",
  "component": "ZdPlayer",
  "controlsSettings": {
    "noSettings": true
  },
  "children": [
    {
      "name": "youtube-basic-usage",
      "component": "ZdVideo",
      "poster": "https://media.vimejs.com/poster.png",
      "crossOrigin": true,
      "dataSrc": "https://media.vimejs.com/720p.mp4",
      "type": "video/mp4",
      "subtitlesSrc": "https://media.vimejs.com/subs/english.vtt",
      "srclang": "en",
      "label": "English"
    }
  ]
}

ZdPlayer

NomeTipoPadrãoDescrição
aspectRatiostring16:9A proporção do player expressa como largura:altura (16:9). Isso só é aplicado se o viewType for vídeo e o player não estiver no modo de tela cheia.
autopausebooleanfalseSe o player deve pausar automaticamente quando outro player do Vime iniciar/retomar a reprodução.
autoplaybooleanfalseSe a reprodução deve começar automaticamente quando a mídia estiver pronta para isso. Isso só funcionará se as políticas de reprodução automática dos navegadores forem atendidas.
controlsbooleanfalseIndica se uma interface de usuário deve ser mostrada para controlar o recurso.
currentTimenumber0Um duplo indicando o tempo de reprodução atual em segundos. O padrão é 0 se a mídia não começou a ser reproduzida e não procurou. Definir este valor busca a mídia para o novo tempo.
debugbooleanfalseSe o player está no modo de depuração e deve console.x informações sobre seu estado interno.
languagestringenO idioma atual do player. Isso pode ser qualquer código definido por meio do método extendLanguage ou o padrão en.
loopbooleanfalseSe a mídia deve começar a ser reproduzida automaticamente desde o início toda vez que termina
mutedbooleanfalseSe o áudio está silenciado ou não.
pausedbooleantrueSe a reprodução deve ser pausada. O padrão é true se nenhuma mídia foi carregada ou a reprodução não foi iniciada. Definir como true iniciará/retomará a reprodução.
playingbooleanfalseSe a mídia está sendo reproduzida ativamente. O padrão é false se nenhuma mídia foi carregada ou a reprodução não foi iniciada.
volumenumber50Um int entre 0 (silencioso) e 100 (mais alto) indicando o volume do áudio.
controlsSettingsIControlsSettings{}Define uma interface com os controles do player

ZdDailymotion

O component "Dailymotion" deve ser utilizado como children do component "Player"

NomeTipoPadrãoDescrição
colorstringundefinedAltere a cor de realce padrão usada nos controles (valor hexadecimal sem o # inicial)
posterstringundefinedO URL absoluto de um pôster personalizado a ser usado para o vídeo atual.
shouldAutoplayQueuebooleanfalseSe o próximo vídeo da fila deve ser reproduzido automaticamente.
showDailymotionLogobooleanfalseSe o logotipo do Dailymotion deve ser exibido.
showShareButtonsbooleanfalseSe os botões para compartilhar o vídeo devem ser exibidos.
showUpNextQueuebooleanfalseSe a fila 'Próximo' deve ser exibida.
showVideoInfobooleantrueSe as informações do vídeo (título e proprietário) devem ser exibidas na tela inicial.
syndicationbooleanfalseEncaminha sua chave de distribuição para o player.
videoIdstring | O ID do recurso Dailymotion do vídeo a ser carregado.

ZdVideo

O component "Video" deve ser utilizado como children do component "Player"

NomeTipoPadrãoDescrição
controlsListstringundefinedDetermina quais controles mostrar no elemento de mídia sempre que o navegador mostrar seu próprio conjunto de controles
crossOriginstringundefinedSe o CORS deve ser usado para buscar a imagem relacionada. Consulte MDN para obter mais informações.
mediaTitlestringundefinedO título da mídia atual.
posterstringundefinedUm URL para uma imagem a ser exibida durante o download do vídeo. Se este atributo não for especificado, nada será exibido até que o primeiro quadro esteja disponível, então o primeiro quadro será mostrado como o quadro de pôster.
preloadstringmetadataFornece uma dica ao navegador sobre o que o autor acha que levará à melhor experiência do usuário em relação ao conteúdo carregado antes da reprodução do vídeo. Consulte MDN para obter mais informações.
dataSrcstringundefinedDefinir caminho ou URL do vídeo
typestringundefinedDefina o tipo de vídeo
subtitlesSrcstringundefinedDefinir caminho ou url das legendas
srclangstringundefinedDefinir idioma das legendas
labelstringundefinedDefinir rótulo da legenda

ZdVimeo

O component "Vimeo" deve ser utilizado como children do component "Player"

NomeTipoPadrãoDescrição
bylinebooleantrueSe o nome do proprietário do vídeo deve ser exibido.
colorstringundefinedO valor de cor hexadecimal dos controles de reprodução. As configurações de incorporação do vídeo podem substituir esse valor.
cookiesbooleantrueSe os cookies devem ser ativados na incorporação.
noAutoAspectRatiobooleanfalseO URL absoluto de um pôster personalizado a ser usado para o vídeo atual.
posterstringundefinedSe o retrato do proprietário do vídeo deve ser exibido.
portraitbooleanfalseDesativa a determinação automática da proporção do vídeo atual.
videoIdstring | O ID do recurso do Vimeo do vídeo a ser carregado.

ZdYoutube

O component "Youtube" deve ser utilizado como children do component "Player"

NomeTipoPadrãoDescrição
cookiesbooleanfalseSe os cookies devem ser ativados na incorporação.
posterstringundefinedO URL absoluto de um pôster personalizado a ser usado para o vídeo atual.
showFullscreenControlbooleantrueSe o controle de tela cheia deve ser mostrado.
videoIdstring | O ID do recurso do YouTube do vídeo a ser carregado.

IControlsSettings

NomeTipoPadrãoDescrição
noCaptionsbooleanfalseDefine se o controle da legenda deve aparecer.
noClickToPlaybooleanfalseDefine se botão click to play deve aparecer.
noControlsbooleanfalseDefine se os controle devem aparecer.
noDblClickFullscreenbooleanfalseDefine se o duplo click deve mudar para full screan.
noLoadingScreenbooleanfalseDefine se o loading deve aparecer.
noPosterbooleanfalseDefine se o poster deve aparecer.
noSettingsbooleanfalseDefine se o controle da configurações deve aparecer.
noSpinnerbooleanfalseDefine se o laoder deve aparecer.