Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / HTML

oncanplay — gerir a disponibilidade de conteúdos multimédia para reprodução

O atributo oncanplay contém JavaScript executado quando ocorre o evento canplay. Para áudio e vídeo, indica que a reprodução pode começar ou ser retomada, mas não garante que todo o recurso possa ser reproduzido sem interrupções para armazenamento em memória intermédia.

Versão: WHATWG HTML Living Standard; index snapshot date recorded separately

Sintaxe

<audio oncanplay="handler(event)"></audio>
<video oncanplay="handler(event)"></video>

oncanplay é um atributo de conteúdo de tratamento de eventos para canplay. O seu valor é código JavaScript; o tratador tem acesso ao objeto event. O atributo é permitido em todos os elementos HTML, mas é normalmente usado para responder à disponibilidade dos elementos audio e video.

O navegador dispara canplay quando o estado de disponibilidade do conteúdo multimédia passa de um nível inferior para HAVE_FUTURE_DATA ou superior. Existem então dados disponíveis para continuar a reprodução, mas não necessariamente em quantidade suficiente para reproduzir todo o recurso sem armazenamento em memória intermédia. Em contrapartida, canplaythrough indica uma estimativa de que é possível reproduzir o conteúdo até ao fim sem parar para armazenar dados em memória intermédia. Por si só, canplay não significa que a reprodução já esteja a decorrer.

Em HTML, use oncanplay="handler(event)"; em JavaScript, atribua uma função a media.oncanplay ou chame media.addEventListener('canplay', handler). O nome do evento não inclui o prefixo on. O exemplo dispara um evento sintético: verifica a ligação entre o atributo e o respetivo tratador, não a disponibilidade real do conteúdo multimédia.

Exemplos

<!doctype html>
<meta charset="utf-8">
<title>oncanplay demo</title>
<audio id="media" oncanplay="document.getElementById('result').textContent = event.type"></audio>
<pre id="result">waiting</pre>
<script>
  const media = document.getElementById('media');
  media.dispatchEvent(new Event('canplay'));
</script>

Resultado

canplay

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes