label: string

Default value: "Upload with Clipchamp!"

O rótulo no botão inserido. Este é o texto que aparece no botão, que é posicionado no elemento wrapper.

size: string

Default value: "medium"
Allowed values:
tiny small medium large

O tamanho do botão Clipchamp. Escolha entre 4 tamanhos.

title: string

Default value: "Ye' olde video-upload shoppe"

O título de UI que aparece depois de um usuário clicar no botão inserido. O título aparece no topo do popup iframe.

logo: string

Default value: "https://api.clipchamp.com/static/button/images/logo.svg"

O URL do logo da imagem para a IU. Esta é uma imagem que aparece no canto superior esquerdo do iframe.

color: string

Default value: "#303030"

Determina a cor do botão Clipchamp, o background do título da barra de popup, e outros elementos gráficos. Pode ser o nome de uma cor (tal como blue, um código hexa-decimal de uma cor (tal como #3300cc), ou um código RGB de uma cor (tal como rgba(78,24,212,0.5)).

style: object

Default value: undefined

Permite a personalização detalhada da aparência visual da API Clipchamp usando CSS. Uma folha de estilo CSS personalizada pode ser proporcionada como uma propriedade (style.url URL) ou como declarações de sequência CSS (style.text). Em ambos os casos, as declarações de personalização CSS acresCentam mas não substituem o estilo interface padrão do usuário, baseado no estilo padrão Bootstrap 3. Assim sendo, a personalização estilo CSS está disponível no topo dos estilos CSS existentes onde classes CSS existentes podem ser acrescentadas, propriedades CSS podem ser adicionadas ou substituidas. Plano Enterprise.

inline: object

Default value: undefined

Permite um posicionamento na linha da ferramenta API onde o <iframe> que contém a ferramenta Clipchamp é posicionado dentro do elemento wrapper denominado na página embutida. Plano Enterprise.

encoding: object

Default value: undefined

Configurar parâmetros de codificação de saída.

inputs: Array<string>

Default value: ["file", "camera"]
Allowed values:
file camera direct

Fontes que o usuário pode escolher a partir de um vídeo de entrada.camera para a sua webcam file para o sistema de arquivos do seu computador. A direct opção instrui a API Clipchamp a receber o arquivo (s) de vídeo de entrada do arquivo (s) sem qualquer ação por parte do usuário final, diretamente através do pârametro direct.files. Consequentemente, a direct opção de entrada não deverá ser utilizada em combinação com nenhuma das duas opções seguintes (file, camera). Se ambos, direct e file ou camera são dados no inputs, então as opçõesfile e camera serão ignoradas e é esperado que o direct.files pârametro seja uma variedade de instância(s) Blob

output: string

Default value: "dummy"
Allowed values:
dummy blob azure s3 youtube gdrive dropbox

Os destinos onde iremos disponibilizar o vídeo de saída ou uploads. Se “blob” for escolhido, nós fornecemos o vídeo de saída como Blob para o código JavaScript da parte do seu cliente. Se você selecionar “youtube”, “azure” ou “s3”, será preciso autorização de upload do vídeo na conta adequada a partir de configuration page. O “dummy” de saída não prejudica nada, mas estimula um upload usando um simples temporizador e pode ser usado para integrações iniciais e testes sem necessidade de configuração de back-end.

upload: object

Default value: undefined

Configurações que configuram o processo de upload em todos os destinatos de upload suportados.

camera: object

Default value: undefined

Elementos de configuração para personalizar a gravação de câmera.

direct: object

Default value: undefined

Pârametros extras que se aplicam à opção direct dentro dos pârametros de entrada.

enable: Array<string>

Default value: []
Allowed values:
batch fixup-webcam-webm mobile-webcam-format-fallback no-branding no-error-bypass no-hidden-run no-popout no-probe-reject no-thank-you no-user-retry

Habilita um comportamento especial da API Clipchamp:

  • batch – permite o processamento e envio sequencial de vários arquivos sem posterior interação do usuário.
  • fixup-webcam-webm – “fixes” gravações webcam WebM (metadados) que podem estar incorretos ou faltando metadados de duração precisa. Use esta bandeira se você quiser ter certeza de que os passos subsequentes na pipeline de processamento do seu vídeo recebam arquivos WebM onde o metadado do vídeo incorporado está correto e completo. Atualmente, esta bandeira não se aplica a dispositivos móveis (ie., fones Android com a mobile-webcam-format-fallback flag definida). BETA
  • mobile-webcam-format-fallback – habilita a compactação das gravações da webcam em dispositivos móveis mesmo quando o formato destino não está disponível (experimental). Atualmente, esta funcionalidade está restrita ao Chrome no Android onde, com esta bandeira, a API Clipchamp cria arquivos WebM usando codec de vídeo VP8 ou VP9.
  • no-branding – remove as marcas Clipchamp da IU mostrada ao usuário, quando disponibilizado pelo seu plano. Isto não se aplica ao botão de incorporação. Use a opção do Botão da API Personalizada para escolher o estilo do botão de inserção (se estiver disponível no seu plano).
  • no-error-bypass – em caso de falha da transcodificação, por qualquer motivo, normalmente Clipchamp lança mão do arquivo de entrada do jeito que está. Esta bandeira suprimirá o outro comportamento. A causa mais comum de falha de transcodificação são codecs de entrada imcompatíveis.
  • no-hidden-run – desabilita a opção para continuar processando e enviando em segundo plano se o usuário fechar a janela depois de clicar em “enviar”.
  • no-popout – alguns navegadores bloqueiam o uso de certas funcionalidades por códigos de terceiros. Quando isso é detectado, a Clipchamp abre uma nova janela para acessar tais funcionalidades. Escolher no-popout suprimi este comportamento e força a Clipchamp a tentar se contentar com o que existe disponível. Isto pode acarretar aumento dos requisitos de memória, entre outras coisas.
  • no-probe-reject – em caso de impossibilidade de determinar que um arquivo de entrada é um vídeo que normalmente seria rejeitado. Esta opção aceita todos os arquivos de entrada e pula direto para os uploads de arquivos não-vídeos.
  • no-thank-you – desabilita a tela de agradecimento e fecha a janela imediatamente. Se houver algum erro durante o processo, a última tela, ainda assim, é exibida.
  • no-user-retry – desabilita a confirmação do usuário e a opção de tentar novamente depois que uma gravação de webcam é completada e antes do envio do arquivo. A adição desta bandeira inicia o upload imediatamente depois que a gravação da webcam termina. Os usuários não terão a chance de repetir suas gravações de webcam.

experimental: Array<string>

Default value: []
Allowed values:
force-popout overlong-recording h264-hardware-acceleration

Ativa o comportamento experimental da API Clipchamp

  • force-popout – sempre inicia a interface do usuário da API Clipchamp numa “popout” separada da janela do navegador, mesmo que pudesse ser executada dentro de iframe em um DOM de site incorporado. Não deve ser usado em conjunto com o parâmetro da bandeira no-popout (enable).
  • overlong-recording – permite gravações webcam / câmera móvel sem qualquer limitação da duração da gravação (como anteriormente referido pela API Clipchamp). A duração da gravação pode ainda ser deliberadamente limitada atribuíndo um valor numérico (número de segundos) no parâmetro camera.limit. Os clientes têm de se assegurar que só definem a bandeira overlong-recording em navegadores compatíveis (atualmente: Chrome, Opera, e Firefox).
  • h264-hardware-acceleration – permite aceleração-hardware H.264 de código de vídeo em plataformas suportadas (atualmente: dispositivos x86-based ChromeOS/Chromebook). A bandeira aplica-se apenas a web (padrão)preset e ao formato (padrão) mp4. Dependendo do hardware em questão, múltiplas acelerações podem ser atingidas ativando a bandeira h264-hardware-acceleration. Os clientes experimentarão diferentes taxas de compactação para a mesma(subjetiva)qualidade de saída esperada e serão por isso encorajados a ajustar o pârametro de compression para produzir uma compensação entre qualidade / compactação aceitável.

dropbox: object

Default value: undefined

Elementos de configuração quando usar Dropbox como destino de upload.

youtube: object

Default value: undefined

Elementos de configuração ao usar o YouTube como destino de upload.

onWebcamStatusChange(status): function

Esta função callback é invocada para um número de eventos afetando a gravação dos vídeos e da webcam ou da câmera do telefone como tal, ondestatus é uma String refletindo o novo status da webcam ou da gravação:

  • capture_started – a ativação da webcam ou câmera do telefone foi bem sucedida e está capturando (mas ainda não está gravando) um streaming de vídeo
  • capture_ended – a webcam ou câmera do telefone foi desativada e não está mais capturando o streaming de vídeo
  • capture_failed – o acesso à webcam ou câmera do telefone falhou
  • recording_running – a gravação da webcam começou ou recomeçou após ter sido pausada
  • recording_paused – a gravação webcam foi pausada e poderá ser recomeçada posteriormente ou terminada recording_finished – a gravação webcam terminou mas pode ainda estar processando antes de ser enviada ou disponibilizada na callback onVideoCreated
  • recording_cancelled – a gravação webcam foi cancelada

O rastreamento do status da webcam ou da câmera do telefone é suportado nos navegadores desktop (e no Chrome em Android quando a bandeira mobile-webcam-format-fallback está configurada na matriz de parâmetro enable).

onMetadataAvailable(metadata): function

Esta função callback é invocada para todas as gravações webcam e arquivos de vídeo de entrada quando a gravação webcam ou arquivo de vídeo de entrada foram analisados com êxito. O parâmetro metadata é um objeto com as seguintes propriedades:

  • raw – um metadado cru de vídeo como um objeto com as seguintes propriedades:
    • format – informação de formato do contêiner de vídeo
    • streams – matriz de vídeo, áudio, legenda, dados, etc. streamings contidos no vídeo

Repare que quando o usuário escolhe descartar e repetir uma gravação webcam, este callback será invocado várias vezes com a metadado das diferentes gravações. onMetadataAvailable será invocado várias vezes quando for usada a bandeira batch onde o usuário pode selecionar vários vídeos de entrada. BETA

onPreviewAvailable(imageBlob): function

onPreviewAvailable acontece com a imagem de visualização quando há alguma disponível. Repare que o parâmetro é uma instância Blob e não um URL, a imagem não é carregada para o destino de upload indicado junto com o vídeo de saída. Repare também que nem todos os cenários irão produzir uma imagem de visualização, particularmente se o vídeo de entrada estiver corrompido ou conter metadado inválido / incompleto. BETA

onUploadComplete(data): function

Esta função de callback é invocada uma vez quando o vídeo de saída completou o seu upload onde um único objeto data contém meta informação sobre o arquivo enviado. Existem duas propriedades comuns:

  • filename – o nome do arquivo de vídeo original
  • duration – a duração do vídeo. Este campo pode estar ausente em certas situações

Existe também um número de propriedades output -especifícas :

  • Se usando saída “youtube”
    • kind – “youtube”
    • id – o ID do vídeo
    • url – o URL de exibição
    • embedHtml – o snippet HTML fornecido pelo YouTube para inserção do vídeo (se disponibilizado).
  • Caso use saída “azure”
    • kind – “azure”
    • blob – o nome do blob Azure real usado em última instância ao armazenar o upload.
  • No caso de usar saída “s3”
    • kind – “s3”
    • key – o real objeto chave Amazon S3 usado em última instância ao armazenar o upload.
  • Se usando a saída “gdrive”
    • kind – “gdrive”
    • id – o ID do arquivo Google
    • name – o nome do arquivo como armazenado no Google Drive.
    • url – o URL para o arquivo
    • folder – o ID da pasta Google onde o arquivo está, ou “root” se em um nível superior.
  • usando saída “dropbox”
    • kind – “dropbox”
    • id – o ID do arquivo Dropbox
    • name – o nome do arquivo quando armazenado no Dropbox
    • path – o caminho do arquivo no Dropbox
    • link – o link partilhado do arquivo no Dropbox (requer que a opção correspondente para ser incorporada nas configurações API Clipchamp)
  • Usando saída “blob”
    • kind – “blob”
    • data – matriz de qualquer onVideoCreated resultante

onVideoCreated(blob [,done [,fail [,notify]]]): function

onVideoCreated acontece quando a saída é definida para blob e o blob de vídeo de saída será passado como o primeiro pârametro. O blob é válido até que esta função termine o processamento que é determinado usando 1 dos 3 casos:

  1. Se a assinatura da função contém pelo menos um pârametro done ou callback done ou fail é chamado.
  2. Se uma promessa (ou thenable) regressa, espere para que seja resolvida ou rejeitada.
  3. Se a função retorna algo diferente de uma promessa, e não especifica pelo menos um parâmetro done-callback, o processamento será considerado completqado imediatamente no retorno.

Até que a função complete o processamento, o arquivo de saída é considerado como “sendo enviado”. Se uma promessa capaz de reportar o progresso retornar (i.e. onde a função-then aceita um terceiro callback), ou se o callback de notificação for usado, uma progressão numérica será interpretada como um percentual de conclusão do upload e será disponibilízado como tal na tela. Após final do processo (como determinado acima) o blob não poderá mais ser usado de modo confiável já que o repositório de backup pode ter sido removido.

onErrorOccurred(error): function

onErrorOccurred acontece quando um erro foi detectado durante a gravação, processamento ou envio de gravação de vídeo ou webcam / câmera. O parâmetro error é um objeto com um type de propriedade mandatória, que pode ser uma das seguintes:

  • webcam_processing, quando o erro aconteceu durante a gravação de webcam (ou câmera do telefone);
  • video_processing, quando o erro aconteceu enquanto um vídeo de entrada ou gravação de webcam / câmera estava sendo processada (transcodificada/compactada) antes do upload do vídeo;
  • video_uploading, quando o erro aconteceu enquanto o arquivo do vídeo de saída estava sendo enviado para o seu local de armazenamento selecionado;
  • other_unknown, quando a causa do erro é alguma outra coisa ou até mesmo algo desconhecido;

Uma segunda propriedade message (opcional) representa um erro de leitura humano explicativo. Você pode usar o valor da string da propriedade message para mostrar uma mensagem de erro aos seus usuários. Uma propriedade details opcional é uma matriz que contém informações técnicas detalhadas do erro, tais como exceções, eventos de erro e coisas do gênero. Use o valor da propriedade details para comunicar quaisquer problemas ao suporte Clipchamp. O callback onErrorOccurred pode ocasionalmente ocorrer várias vezes pela mesma razão de origem. Por favor, repare que a API Clipchamp tem o hábito de compensar por alguns dos incidentes que venham a ser reportados para o callback onErrorOccurred. Por exemplo, a bandeira no-probe-reject (veja habilitar pârametro) assegurará que o arquivo de vídeo passará pelo mecanismo de transcodificação de vídeo mesmo quando não foi possível extrair metadados técnicos daquele arquivo.

localization: object

Default value: undefined

Uma tabela de strings que está disponível para localização. Use-a para ajustar todos os elemntos visíveis ao usuário da API para aparecer no idioma do seu website se não estiver em Inglês. Você também pode usar estas strings para ocultar snippets de texto que você não quer mostrar aos seus usuários.