API da ponte JavaScript
Mídia e transmissão
A notificação de mídia na tela de bloqueio controlada pela sua página e como enviar um vídeo para uma TV.
requestPictureInPicture padrão web#
video.requestPictureInPicture() — Picture-in-Picture
Exemplo
A API padrão de Picture-in-Picture: deixa um vídeo flutuando em uma janela pequena enquanto o usuário faz outra coisa. O Chrome no Android tem; o WebView do Android não; no app o vídeo preenche a janela flutuante, como no Chrome.
Retorna: uma Promise de um PictureInPictureWindow (evento width, height, resize). O vídeo recebe enterpictureinpicture, depois leavepictureinpicture quando o usuário fecha ou expande a janela; document.pictureInPictureElement é o vídeo nesse meio tempo. Rejeita NotAllowedError sem um toque, InvalidStateError antes de os metadados do vídeo serem carregados ou quando ele tem disablePictureInPicture. Requer: Picture-in-picture ligado no build (é ligado sozinho quando seu código chama requestPictureInPicture), Android 8 ou mais recente.
<video id="v" src="clip.mp4" controls playsinline></video>
<button id="pip">Pop out</button>
<script>
const v = document.getElementById('v');
const btn = document.getElementById('pip');
btn.hidden = !document.pictureInPictureEnabled;
btn.addEventListener('click', async () => {
try {
if (document.pictureInPictureElement) await document.exitPictureInPicture();
else await v.requestPictureInPicture();
} catch (e) {
console.warn('Picture-in-Picture:', e.name);
}
});
v.addEventListener('enterpictureinpicture', () => { btn.textContent = 'Back to app'; });
v.addEventListener('leavepictureinpicture', () => { btn.textContent = 'Pop out'; });
</script>Abrir a janela flutuante automaticamente quando o usuário sair e avisar quando a compilação não for compatível:
const v = document.getElementById('v');
if (!document.pictureInPictureEnabled || v.disablePictureInPicture) {
document.getElementById('pip').hidden = true; // this build has no picture-in-picture
}
document.addEventListener('visibilitychange', async () => {
if (document.hidden && !v.paused && !document.pictureInPictureElement) {
try { await v.requestPictureInPicture(); }
catch (e) { console.warn(e.name); } // NotAllowedError without a tap
}
});Espere os metadados e redimensione junto com a janela:
async function popOut(video) {
if (video.readyState < 1) await new Promise((r) => video.addEventListener('loadedmetadata', r, { once: true }));
try {
const pipWin = await video.requestPictureInPicture();
pipWin.addEventListener('resize', () => console.log(pipWin.width, pipWin.height));
} catch (e) {
if (e.name === 'InvalidStateError') showMessage('This video cannot float.');
else if (e.name === 'NotAllowedError') showMessage('Tap the button to pop out.');
}
}
document.getElementById('pip').onclick = () => popOut(document.getElementById('v'));Observações: o Android coloca o app inteiro na janela flutuante, então o vídeo é mostrado primeiro sozinho (em tela cheia) e a janela assume o formato do vídeo; ao sair da janela, o vídeo volta para a página. document.exitPictureInPicture() traz o app de volta à tela cheia. Quando a compilação não tem picture-in-picture, document.pictureInPictureEnabled é false, como em um navegador sem o recurso. A mudança de modo chega à página como appmint:pip. Transportes internos: __pipEnter, __pipExit, __pipAvailable, __pipPrepare.
__pipAvailable ponte#
window.WebToApk.__pipAvailable(): Boolean
Se video.requestPictureInPicture() pode funcionar: PiP ativado na compilação, Android 8+.
Exemplo
Documentado junto com WebToApk.__pipEnter - o exemplo de lá mostra este também.
Transporte interno por trás de video.requestPictureInPicture() e document.exitPictureInPicture(). As páginas usam a API padrão; nunca chame estes diretamente, pois os métodos __ podem mudar sem aviso.
Retorna: __pipEnter(width, height) retorna "ok" quando o Android aceitou a janela (com a proporção do vídeo), senão "unsupported" / "failed". A abertura e o fechamento da janela chegam como appmint:pip com {inPip}. __pipAvailable() é verdadeiro quando o build tem picture-in-picture no Android 8+. Requer: picture-in-picture ligado no build.
Use a API pública:
const video = document.querySelector('video');
button.addEventListener('click', () => video.requestPictureInPicture());Verifique o suporte primeiro e informe uma recusa:
async function floatVideo(video) {
if (!document.pictureInPictureEnabled) { showMessage('Picture-in-picture is not on in this app.'); return; }
try {
await video.requestPictureInPicture();
} catch (err) {
showMessage('Could not open the floating window.');
}
}Saia de novo e acompanhe o estado com os eventos padrão:
video.addEventListener('enterpictureinpicture', () => hideControls());
video.addEventListener('leavepictureinpicture', () => showControls());
closeBtn.onclick = () => { if (document.pictureInPictureElement) document.exitPictureInPicture(); };Observações: implementado no shell do app (PictureInPictureShim.kt). __pipPrepare impede o shell de girar a tela para o modo horizontal na etapa de tela cheia ao entrar na janela.
__pipEnter ponte#
window.WebToApk.__pipEnter(width: Int, height: Int): String
Abre a janela PiP com a proporção de um vídeo de [width]×[height]: "ok", ou "unsupported" / "failed". A mudança de modo chega como `appmint:pip`.
Exemplo
Transporte interno por trás de video.requestPictureInPicture() e document.exitPictureInPicture(). As páginas usam a API padrão; nunca chame estes diretamente, pois os métodos __ podem mudar sem aviso.
Retorna: __pipEnter(width, height) retorna "ok" quando o Android aceitou a janela (com a proporção do vídeo), senão "unsupported" / "failed". A abertura e o fechamento da janela chegam como appmint:pip com {inPip}. __pipAvailable() é verdadeiro quando o build tem picture-in-picture no Android 8+. Requer: picture-in-picture ligado no build.
Use a API pública:
const video = document.querySelector('video');
button.addEventListener('click', () => video.requestPictureInPicture());Verifique o suporte primeiro e informe uma recusa:
async function floatVideo(video) {
if (!document.pictureInPictureEnabled) { showMessage('Picture-in-picture is not on in this app.'); return; }
try {
await video.requestPictureInPicture();
} catch (err) {
showMessage('Could not open the floating window.');
}
}Saia de novo e acompanhe o estado com os eventos padrão:
video.addEventListener('enterpictureinpicture', () => hideControls());
video.addEventListener('leavepictureinpicture', () => showControls());
closeBtn.onclick = () => { if (document.pictureInPictureElement) document.exitPictureInPicture(); };Observações: implementado no shell do app (PictureInPictureShim.kt). __pipPrepare impede o shell de girar a tela para o modo horizontal na etapa de tela cheia ao entrar na janela.
__pipExit ponte#
window.WebToApk.__pipExit()
document.exitPictureInPicture(): traz o app de volta para a tela cheia.
Exemplo
Documentado junto com WebToApk.__pipEnter - o exemplo de lá mostra este também.
Transporte interno por trás de video.requestPictureInPicture() e document.exitPictureInPicture(). As páginas usam a API padrão; nunca chame estes diretamente, pois os métodos __ podem mudar sem aviso.
Retorna: __pipEnter(width, height) retorna "ok" quando o Android aceitou a janela (com a proporção do vídeo), senão "unsupported" / "failed". A abertura e o fechamento da janela chegam como appmint:pip com {inPip}. __pipAvailable() é verdadeiro quando o build tem picture-in-picture no Android 8+. Requer: picture-in-picture ligado no build.
Use a API pública:
const video = document.querySelector('video');
button.addEventListener('click', () => video.requestPictureInPicture());Verifique o suporte primeiro e informe uma recusa:
async function floatVideo(video) {
if (!document.pictureInPictureEnabled) { showMessage('Picture-in-picture is not on in this app.'); return; }
try {
await video.requestPictureInPicture();
} catch (err) {
showMessage('Could not open the floating window.');
}
}Saia de novo e acompanhe o estado com os eventos padrão:
video.addEventListener('enterpictureinpicture', () => hideControls());
video.addEventListener('leavepictureinpicture', () => showControls());
closeBtn.onclick = () => { if (document.pictureInPictureElement) document.exitPictureInPicture(); };Observações: implementado no shell do app (PictureInPictureShim.kt). __pipPrepare impede o shell de girar a tela para o modo horizontal na etapa de tela cheia ao entrar na janela.
__pipPrepare ponte#
window.WebToApk.__pipPrepare()
A página está prestes a colocar um vídeo em tela cheia para o PiP: não force o modo paisagem para isso.
Exemplo
Documentado junto com WebToApk.__pipEnter - o exemplo de lá mostra este também.
Transporte interno por trás de video.requestPictureInPicture() e document.exitPictureInPicture(). As páginas usam a API padrão; nunca chame estes diretamente, pois os métodos __ podem mudar sem aviso.
Retorna: __pipEnter(width, height) retorna "ok" quando o Android aceitou a janela (com a proporção do vídeo), senão "unsupported" / "failed". A abertura e o fechamento da janela chegam como appmint:pip com {inPip}. __pipAvailable() é verdadeiro quando o build tem picture-in-picture no Android 8+. Requer: picture-in-picture ligado no build.
Use a API pública:
const video = document.querySelector('video');
button.addEventListener('click', () => video.requestPictureInPicture());Verifique o suporte primeiro e informe uma recusa:
async function floatVideo(video) {
if (!document.pictureInPictureEnabled) { showMessage('Picture-in-picture is not on in this app.'); return; }
try {
await video.requestPictureInPicture();
} catch (err) {
showMessage('Could not open the floating window.');
}
}Saia de novo e acompanhe o estado com os eventos padrão:
video.addEventListener('enterpictureinpicture', () => hideControls());
video.addEventListener('leavepictureinpicture', () => showControls());
closeBtn.onclick = () => { if (document.pictureInPictureElement) document.exitPictureInPicture(); };Observações: implementado no shell do app (PictureInPictureShim.kt). __pipPrepare impede o shell de girar a tela para o modo horizontal na etapa de tela cheia ao entrar na janela.
castMedia ponte#
window.WebToApk.castMedia(mediaUrl: String)
Oferece [mediaUrl] ao que houver neste celular que possa reproduzi-lo em outra tela - Chromecast, um app de Smart TV, um player local - pelo seletor do sistema. O tipo é tirado da URL ([CastMediaType]): um arquivo de áudio (.mp3, .m4a, .aac, .ogg, .opus, .wav, .flac …) ou uma URL `data:` de áudio é oferecido a apps de áudio; qualquer outra coisa - arquivos de vídeo, manifestos de stream, URLs sem extensão - a apps de vídeo. Isto é uma transferência, não uma sessão de transmissão: o app não continua controlando a reprodução e não há callback. Uma página que precise de uma sessão real deve usar o Cast SDK em JavaScript.
Exemplo
Oferece um endereço de vídeo ou áudio aos apps do celular que podem reproduzi-lo em outra tela (um app de Chromecast, um app de Smart TV, um player de vídeo), pelo seletor "Transmitir para..." do Android.
Retorna: nada, e nenhum callback. Requer: nada para ativar. O celular precisa de um app que aceite o link.
function castToTv(url) {
if (window.WebToApk && typeof window.WebToApk.castMedia === 'function') {
window.WebToApk.castMedia(url); // opens the "Cast to..." chooser
} else {
alert('Casting is only available in the app');
}
}
document.getElementById('cast-btn').addEventListener('click', function () {
var video = document.querySelector('video');
var url = video && video.currentSrc ? video.currentSrc : 'https://example.com/movie.mp4';
castToTv(url);
});Envie um episódio de podcast de uma lista para um alto-falante ou app de TV (um link .mp3 é oferecido a apps de áudio):
// <li><button class="cast" data-src="https://example.com/ep12.mp3">Cast</button> Episode 12</li>
document.getElementById('episodes').addEventListener('click', function (e) {
var btn = e.target.closest('button.cast');
if (!btn) return;
var src = btn.getAttribute('data-src') || '';
if (src.indexOf('https://') !== 0) {
alert('This episode cannot be cast'); // files inside the app cannot be handed over
return;
}
if (window.WebToApk && typeof window.WebToApk.castMedia === 'function') {
window.WebToApk.castMedia(src);
}
});Mostre o botão Cast somente dentro do app e pause o player da própria página antes de enviar uma transmissão ao vivo:
var castBtn = document.getElementById('cast-live');
var canCast = !!(window.WebToApk && typeof window.WebToApk.castMedia === 'function');
castBtn.hidden = !canCast;
castBtn.addEventListener('click', function () {
var video = document.getElementById('live');
video.pause(); // avoid playing twice, here and on the TV
window.WebToApk.castMedia('https://example.com/live/stream.m3u8'); // offered to video apps
});Observaçþes:
- Isto é um repasse, não uma sessão de cast: sua página não controla a reprodução depois que o usuário escolhe um app.
- O endereço deve ser um link
https://completo que outros apps possam abrir. Um arquivo dentro do ZIP do seu app, uma URLblob:ou o endereço de uma página web não vai tocar. - O tipo vem do link: um arquivo de áudio (
.mp3,.m4a,.aac,.ogg,.opus,.wav,.flac…) ou uma URLaudio/data:é oferecido a apps de áudio; qualquer outra coisa - arquivos de vídeo, streams.m3u8, links sem extensão de arquivo - a apps de vídeo.
clearMediaNotification ponte#
window.WebToApk.clearMediaNotification()
Permite que o conteúdo web controle a notificação em estilo de mídia do Android e receba callbacks de controle de reprodução (play/pause/next/prev) da tela de bloqueio e da central de notificações. Uso em JavaScript: window.WebToApk.setMediaMetadata('Song Title', 'Artist Name', 'https://…/art.jpg') window.WebToApk.setPlaybackState(true, 30000, 240000) // tocando, posição em ms, duração em ms window.WebToApk.clearMediaNotification() Callback do Android → JS: window.WebToApkOnMediaAction('play'|'pause'|'next'|'prev'|'stop')
Descrito pelo seu grupo, Ponte de notificação de mídia, e não isoladamente.
Exemplo
Remove a notificação de mídia e seus controles da tela de bloqueio, por exemplo quando o usuário fecha seu player.
Retorna: nada. Requer: ative a Notificação de mídia na Etapa 4 (Acesso) ao compilar. Sem isso a chamada não faz nada.
Não há chamada padrão da web para isso, então use a ponte:
function closePlayer() {
var audio = document.getElementById('player');
audio.pause();
audio.currentTime = 0;
if (window.WebToApk && typeof window.WebToApk.clearMediaNotification === 'function') {
window.WebToApk.clearMediaNotification();
}
}
document.getElementById('close-player').addEventListener('click', closePlayer);
// The notification's own Stop button already removes it; just stop your audio:
if ('mediaSession' in navigator) {
navigator.mediaSession.setActionHandler('stop', function () {
var audio = document.getElementById('player');
audio.pause();
audio.currentTime = 0;
});
}Um timer de sono que para o áudio e remove a notificação após o número de minutos escolhido:
var sleepTimer = null;
function setSleepTimer(minutes) {
clearTimeout(sleepTimer);
sleepTimer = setTimeout(function () {
var audio = document.getElementById('player');
audio.pause();
if (window.WebToApk && typeof window.WebToApk.clearMediaNotification === 'function') {
window.WebToApk.clearMediaNotification();
}
}, minutes * 60 * 1000);
}
document.getElementById('sleep-30').addEventListener('click', function () { setSleepTimer(30); });Remova a notificação quando a última faixa de uma playlist terminar, em vez de deixar um botão Reproduzir sem função:
var audio = document.getElementById('player');
var playlist = ['https://example.com/1.mp3', 'https://example.com/2.mp3'];
var current = 0;
audio.addEventListener('ended', function () {
current++;
if (current < playlist.length) {
audio.src = playlist[current];
audio.play();
} else if (window.WebToApk && typeof window.WebToApk.clearMediaNotification === 'function') {
window.WebToApk.clearMediaNotification();
}
});Observações: use isto para "parar", não para "pausar" (para pausar, envie setPlaybackState(false, ...) para o botão Play continuar aparecendo). Definir navigator.mediaSession.metadata = null não remove a notificação. O próximo setMediaMetadata / setPlaybackState (ou novos metadados / estado de navigator.mediaSession) traz de volta a notificação e os controles da tela de bloqueio.
setMediaMetadata ponte#
window.WebToApk.setMediaMetadata(title: String, artist: String, artworkUrl: String)
Permite que o conteúdo web controle a notificação em estilo de mídia do Android e receba callbacks de controle de reprodução (play/pause/next/prev) da tela de bloqueio e da central de notificações. Uso em JavaScript: window.WebToApk.setMediaMetadata('Song Title', 'Artist Name', 'https://…/art.jpg') window.WebToApk.setPlaybackState(true, 30000, 240000) // tocando, posição em ms, duração em ms window.WebToApk.clearMediaNotification() Callback do Android → JS: window.WebToApkOnMediaAction('play'|'pause'|'next'|'prev'|'stop')
Descrito pelo seu grupo, Ponte de notificação de mídia, e não isoladamente.
Exemplo
Define o título, o artista e a imagem de capa da notificação de mídia e do player da tela de bloqueio. Normalmente as páginas definem navigator.mediaSession.metadata, que chama isto por você.
Retorna: nada. Requer: ative a Notificação de mídia na Etapa 4 (Acesso) ao compilar. Sem isso a chamada não faz nada.
A forma pública (use esta):
if ('mediaSession' in navigator && window.MediaMetadata) {
navigator.mediaSession.metadata = new MediaMetadata({
title: 'Episode 12', artist: 'My Podcast',
artwork: [{ src: 'https://example.com/cover.jpg', sizes: '512x512' }]
});
}A chamada direta. Argumentos: title, artist, artworkUrl (use '' para nenhuma imagem):
function showNowPlaying(track) {
if (!(window.WebToApk && typeof window.WebToApk.setMediaMetadata === 'function')) return;
window.WebToApk.setMediaMetadata(track.title, track.artist || '', track.cover || '');
window.WebToApk.setPlaybackState(true, 0, Math.round(track.seconds * 1000));
}
// Buttons in the notification come back through the standard API:
if ('mediaSession' in navigator) {
navigator.mediaSession.setActionHandler('nexttrack', function () { playNext(); });
navigator.mediaSession.setActionHandler('previoustrack', function () { playPrevious(); });
}Mantenha o título da notificação atualizado em uma rádio ao vivo, em que a música muda sem a página carregar um novo arquivo:
var lastSong = '';
function refreshNowPlaying() {
fetch('https://example.com/radio/now-playing.json')
.then(function (r) { return r.json(); })
.then(function (np) { // e.g. { "title": "...", "artist": "...", "cover": "https://..." }
var key = np.title + '|' + np.artist;
if (key === lastSong) return; // only update when the song really changed
lastSong = key;
if (window.WebToApk && typeof window.WebToApk.setMediaMetadata === 'function') {
window.WebToApk.setMediaMetadata(np.title || 'Live radio', np.artist || '', np.cover || '');
}
})
.catch(function () { /* try again on the next tick */ });
}
document.getElementById('radio').addEventListener('play', function () {
refreshNowPlaying();
setInterval(refreshNowPlaying, 30000);
}, { once: true });Observaçþes:
- A notificação aparece (ou é atualizada) com esta chamada. Um título vazio mostra o nome do app.
artworkUrldeve ser um endereçohttps://completo na internet. O app o baixa (limite de 4 segundos); se falhar, o ícone do app é mostrado.- Receba toques em botões com
navigator.mediaSession.setActionHandler(vejanavigator.mediaSession), ou com seu própriowindow.WebToApkOnMediaAction = function (action) { ... }(play,pause,next,prev,stop) - use um dos dois. Depois declearMediaNotification(), a próxima chamada a isto (ou asetPlaybackState) traz de volta a notificação e os controles da tela de bloqueio.
setPlaybackState ponte#
window.WebToApk.setPlaybackState(isPlaying: Boolean, positionMs: Long, durationMs: Long)
Permite que o conteúdo web controle a notificação em estilo de mídia do Android e receba callbacks de controle de reprodução (play/pause/next/prev) da tela de bloqueio e da central de notificações. Uso em JavaScript: window.WebToApk.setMediaMetadata('Song Title', 'Artist Name', 'https://…/art.jpg') window.WebToApk.setPlaybackState(true, 30000, 240000) // tocando, posição em ms, duração em ms window.WebToApk.clearMediaNotification() Callback do Android → JS: window.WebToApkOnMediaAction('play'|'pause'|'next'|'prev'|'stop')
Descrito pelo seu grupo, Ponte de notificação de mídia, e não isoladamente.
Exemplo
Informa à notificação de mídia se você está reproduzindo ou pausado, e em que ponto da faixa está. As páginas normalmente definem navigator.mediaSession.playbackState e chamam setPositionState, que chamam isto por você.
Retorna: nada. Requer: ative a Notificação de mídia na Etapa 4 (Acesso) ao compilar. Sem isso a chamada não faz nada.
A forma pública (use esta):
var audio = document.getElementById('player');
function publish() {
if (!('mediaSession' in navigator)) return;
navigator.mediaSession.playbackState = audio.paused ? 'paused' : 'playing';
if (audio.duration > 0 && navigator.mediaSession.setPositionState) {
navigator.mediaSession.setPositionState({ duration: audio.duration, position: audio.currentTime });
}
}
audio.addEventListener('play', publish);
audio.addEventListener('pause', publish);A chamada direta. Argumentos: isPlaying (true/false), positionMs, durationMs (milissegundos inteiros):
function publishRaw(audio) {
if (!(window.WebToApk && typeof window.WebToApk.setPlaybackState === 'function')) return;
window.WebToApk.setPlaybackState(
!audio.paused,
Math.floor(audio.currentTime * 1000),
Math.floor((audio.duration || 0) * 1000)
);
}Informe a nova posição depois que o usuário buscar e mude a notificação para Reproduzir quando a faixa terminar:
var audio = document.getElementById('player');
function report(playing) {
if (!(window.WebToApk && typeof window.WebToApk.setPlaybackState === 'function')) return;
var durMs = Math.floor((audio.duration || 0) * 1000);
var posMs = Math.floor(audio.currentTime * 1000);
window.WebToApk.setPlaybackState(playing, Math.min(posMs, durMs || posMs), durMs);
}
audio.addEventListener('seeked', function () { report(!audio.paused); });
audio.addEventListener('ended', function () { report(false); }); // Play button, notification can be swiped awayObservações: true mostra o botão Pausar e impede que a notificação seja dispensada com um deslize; false mostra Play. Chame setMediaMetadata primeiro, para a notificação ter um título. Para remover a notificação quando o usuário parar, chame clearMediaNotification().