Incorporar o Player Samba e utilização de Parâmetros do Player:

Visão Geral

Esta documentação guia o usuário em como incorporar o player Samba em sua aplicação e também como utilizar os parâmetros disponíveis no player incorporado. O player samba pode ser incorporado em uma página web usando a tag iframe. Você também pode incorporar o player em sua página utilizando a API Java Script do player, conforme abordado mais adiante nesta documentação, ou . Adicionando parâmetros ao embed IFrame, é possível customizar o comportamento do player em sua aplicação. Por exemplo, você pode tocar videos automaticamente usando o parâmetro autoStart.

Esta página define todos os parâmetros atualmente suportados pelo player Samba. Dica: Para permitir uma melhor experiência em sua aplicação, as dimensões de largura e altura do player Samba devem ter pelo menos 320px por 168px.

Incorporando o player Samba.

Você pode usar qualquer um dos métodos a seguir para incorporar o player Samba em sua página e especificar os parâmetros do player. Note que as instruções abaixo demonstram como incorporar um player que carrega um único video em uma página web.

Ao definir uma tag iframe em sua página, em que o src URL especifica o conteúdo que o player Samba irá carregar, bem como quaisquer outros parâmetros do player que você deseja adicionar ao src URL. Parâmetros de altura (height) e largura (width) da tag iframe especificam as dimensões de exibição do player Samba.

Se você mesmo estiver criando seu elemento iframe (ao invés de copiar diretamente do Samba Videos), você pode inserir parâmetros do player no final da URL. A URL tem o seguinte formato:

http://fast.player.liquidplatform.com/pApiv2/embed/PLAYER_HASH/MEDIA_ID

Exemplo de uso:

A tag iframe abaixo deve carregar um player com as dimensões 640px x 390px que irá tocar o video de media_Id ‘4226a0781346e04d0002a12fa54c0d19’ do projeto com player_hash ‘5563565fba098a75c00ea9223b4ce69d’ Uma vez que a URL tem o parâmetro autoStart=true adicionado, o video irá tocar automaticamente assim que carregar no browser.

<iframe width="640" height="390" src="http://playerapitest2.liquidplatform.com:7091/embed/5563565fba098a75c00ea9223b4ce69d/4226a0781346e04d0002a12fa54c0d19?autoStart=true" scrolling="no" frameborder="0"></iframe>

Parâmetros Player VOD

Os parâmetros apresentados a seguir são opcionais. A lista mostra aqueles que são suportados também para o player Samba HTML 5. Nota: Para o player Samba ter total compatibilidade com HTML 5 é necessário incorporar os seguintes parâmetros na tag iframe :

Exemplo de uso:

<iframe allowfullscreen webkitallowfullscreen mozallowfullscreen src="http://playerapitest2.liquidplatform.com:7091/embed/ceffa25ef97ffbcd44a44915161ec0cf/cd023ef9950652a81d2c42747b3b960e" width="640" height="360" frameborder="0"></iframe>

autoStart (players suportados: flash)

Valores: true ou false. Padrão é false. Define se o player inicia automaticamente ou não após carregado.

enableControls (players suportados: flash)

Valores: true ou false. Padrão é true. Define se o player exibe ou não a barra de controle.

enableShare (players suportados: flash, HTML5)

Valores: true ou false. Padrão é true. Define se o player exibe ou não as opções de compartilhamento.

hasTwitter (players suportados: flash, HTML5)

Valores: true ou false. Padrão é true. Define se o player exibe ou não o botão de compartilhamento com o twitter nas opções de compartilhamento.

hasFacebook (players suportados: flash, HTML5)

Valores: true ou false. Padrão é true. Define se o player exibe ou não o botão de compartilhamento com o Facebook nas opções de compartilhamento.

hasLink (players suportados: flash)

Valores: true ou false. Padrão é true. Define se o player exibe ou não o botão de compartilhamento para cópia do link do video nas opções de compartilhamento.

hasEmbed (players suportados: flash)

Valores: true ou false. Padrão é true. Define se o player exibe ou não o botão de compartilhamento para cópia do embed do video nas opções de compartilhamento.

startOutput (players suportados: flash, HTML5)

Valores: 240p, 360p, 480p, 720p ou 1080p. Define qual output o player iniciará tocando. Nota: É necessário que o vídeo tenha o output indicado. Caso contrário, será tocado o valor default do projeto.

gaAccount (players suportados: flash, HTML5)

Valores: string: Tracking ID do Google Analtycs, que é uma string tipo ‘UA-000000-01’. Parâmetro utilizado para enviar eventos de tracking: loaded, started, first quartile, mid point, third quartile e completed, para análise de estatísticas de visualização do video com sua conta do Google Analytics. Nota: player HTML5 somente envia os eventos loaded e started.

siteURL (players suportados: flash, HTML5)

Valores: string: URL que se deseja enviar como referring ao Google Analytics. Parâmetro utilizado para definir uma referring URL customizada para envio de estatísticas ao Google Analytics.

title (players suportados: flash, HTML5)

Valores: string: Título da mídia. Parâmetro utilizado para definir um título para a mídia. Útil para ser facilmente buscado no Google Analytics.

volume (players suportados: flash)

Valores: inteiro: 0 .. 100. Parâmetro que permite associar um valor pré-definido ao volume do player antes do vídeo começar a tocar. Nota: Os valores são de 0 a 100.

thumbnailURL (players suportados: flash, HTML5)

Valores: string: URL da imagem a ser inserida como thumbnail da mídia. Parâmetro que permite passar um thumbnail ao vídeo a partir de uma url.

ad_program (players suportados: flash)

Valores: string: URL da VAST tag a ser tocada. Parâmetro que permite tocar qualquer publicidade externa padrão VAST, a partir de uma tag VAST. Se for uma publicidade Pre-roll você deve colocar no final da tag o parâmetro #pre-roll, se a publicidade for Post-roll deve utilizar o parâmetro #post-roll, se for overlay, deve utilizar o parâmetro #overlay.

ad_program (players suportados: flash)

Valores: string: URL da VAST tag a ser tocada. Parâmetro que permite tocar qualquer publicidade externa padrão VAST, a partir de uma tag VAST. Se for uma publicidade Pre-roll você deve colocar no final da tag o parâmetro #pre-roll, se a publicidade for Post-roll deve utilizar o parâmetro #post-roll, se for overlay, deve utilizar o parâmetro #overlay. Veja um exemplo de uso para uma campanha de publicidade Pre-Roll: ad_program=[http://ad3.liverail.com/?LR_PUBLISHER_ID=1331&LR_CAMPAIGN_ID=229&LR_SCHEMA=vast2#pre-roll]

skipAd (players suportados: flash)

Valores: true ou false. Padrão é false. Habilita a opção do usuário pular a publicidade após 5 segundos de exibição. A ação deste evento não gera nenhum registro. Nota: Funciona apenas para publicidade externa no padrão VAST.

html5 (players suportados: flash, HTML5)

Valores: true ou false. Padrão é false. Força o Player Samba a tocar em modo HTML 5 em browsers e dispositivos suportados.

enableLead (players suportados: flash)

Valores: true ou false. Padrão é false. Habilita ou Desativa o coletor de Leads de uma determinada mídia. Nota: Via parâmetro, o coletor de Leads é exibido somente ao fim da exibição do video.

Incorporando o player Samba via Player API

A API do Player Samba permite a você incorporar o player em sua aplicação e controlá-lo utilizando JavaScript.

Usando as funções de JavasScript da API, você pode criar playlist de videos para reprodução; reproduzir, pausar ou parar esses vídeos; ‘pular’ para um determinando ponto do video; ou recuperar informações sobre o vídeo que está sendo tocado, tais como: volume, tempo de bufferStart, tempo atual (em segundos), tempo de bufferEnd, se está mudo, e os possíveis estados do player: carregado, tocando, pausado, resumido ou finalizado. Você também pode adicionar event listeners que serão disparados em resposta a determinados eventos do player, como por exemplo, uma mudança de estado do player.

Dica: O usuário final deve estar usando um browser que suporte o recurso HTML5 postMessage. A maioria dos navegadores modernos suportam postMessage. Browsers suportados: Internet Explorer 8+, Firefox 3+, Safari 4+, Chrome, e Opera 9+. Para incorporar o player Samba pela API JavaScript é necessário chamar em seu código a API: