fix: defer PiP visibility refresh on Document Picture-in-Picture enter

[gparant]

WorkAdventure usage

WorkAdventure uses Document Picture-in-Picture via documentPictureInPicture.requestWindow(). After the PiP window is created, it appends a root container (meeting UI + <video> elements) to pipWindow.document.body, then updates app state.

You can test our use case here: WorkAdventure Virtual Office

Issue

For Document Picture-in-Picture, the enter event can be delivered before the host application has finished appending its DOM into documentPictureInPicture.window.document.

If onEnterPiP runs isElementInPiP immediately, pipWin.document.contains(video) may still be false, so adaptive-stream visibility is wrong.

Symptoms we saw: remote video appearing “stuck” or wrong adaptive-stream visibility after ~5s when the tab is hidden, and incorrect visibilityChanged on remote video tracks while Document PiP is active.

Reparenting can also leave the SDK’s observers / attachment state inconsistent until the track is re-attached.

Workaround in our app (until / in addition to SDK fixes): we detach and re-attach the RemoteVideoTrack to the same

// On mount: if PiP is already active, after tick() → detach + attach
if ($activePictureInPictureStore) {
    tick().then(() => refreshTrackAttachmentAfterPictureInPictureMove());
}
// On every transition of activePictureInPictureStore (open/close PiP), after tick() → detach + attach
const unsubscribePictureInPicture = activePictureInPictureStore.subscribe((inPip) => {
    if (inPip === pip) return;
    pip = inPip;
    tick().then(() => refreshTrackAttachmentAfterPictureInPictureMove());
});

Changes

In private onEnterPiP (RemoteVideoTrack.ts), defer isElementInPiP and handleVisibilityChanged using queueMicrotask + requestAnimationFrame, so embedders (including WorkAdventure) can finish mounting content in the PiP document before the SDK evaluates PiP visibility.

[changeset-bot]

🦋 Changeset detected

Latest commit: e832dec

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
livekit-client	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[CLAassistant]

All committers have signed the CLA.