Visão Geral da API

Esta seção é destinada a desenvolvedores que precisam de controle programático sobre a Rybená. Se você apenas quer instalar e usar a Rybená, consulte as seções de Instalação e Configuração.

A API Rybená permite controlar programaticamente a solução Rybená, possibilitando integrações com diversos serviços como vídeos, cursos interativos e sistemas que funcionam sem interação direta do usuário.

Quando Usar o Modo API

O modo API é ideal para:

• Integrações com vídeos: Sincronizar tradução com vídeos educacionais
• Cursos interativos: Controlar a tradução baseada em progresso do usuário
• Sistemas automatizados: Traduzir conteúdo sem interação direta do usuário
• Aplicações customizadas: Integrar Rybená em fluxos de trabalho específicos

Padrão da API

A API Rybená segue um padrão singleton simples:

RybenaApi.getInstance().methodName();

Todos os métodos são acessados através da instância singleton da API.

Modo API

Para utilizar a Rybená de forma programática, recomendamos inicializar o script com o parâmetro mode=api. Essa opção automatiza várias funções:

• Abertura da Rybená em background
• Remoção dos textos de apresentação da Rybená

Exemplo de Inicialização

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?mode=api"
></script>

RybenaDOM.getInstance().getRybenaScripts();

RybenaDOM.getInstance().getRybenaScripts("hidden");

Funcionalidades da API

A API Rybená oferece controle sobre:

• Player: Visibilidade, posição, tamanho e modo de exibição
• Tradução: Tradução de texto, controle de reprodução e velocidade
• Idiomas: Alternância entre Português, Espanhol e Inglês
• Eventos: Manipuladores para carregamento e tradução
• Acessibilidade: Recursos visuais, de leitura e navegação

Começando Rápido

Aqui está um exemplo básico de como usar a API:

// Aguarda a Rybená carregar
RybenaApi.getInstance().handleLoaded(() => {
  // Mostra o player
  RybenaApi.getInstance().openPlayer();

  // Traduz um texto
  RybenaApi.getInstance().translate("Olá, bem-vindo à Rybená!");
});

Suporte

Caso tenha alguma dúvida ou sugestão de funcionalidade a ser inserida na API, entre em contato com [email protected]

Navegação

Explore a documentação da API através das seções abaixo: