Tempusxr Français
  1. Docs
  2. Experience Library
  3. Poster with video

Poster with video Image tracking

A video plays on the poster and pauses when you look away.

Open in A-FrameOpen in Three.jsBack to the Experience Library

Code

The code of this experience, split in the files you would keep: HTML, CSS and JavaScript. The live page keeps them in one file; copy each part into its own file and the page works the same.

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
    <title>Tempusxr poster with video</title>
    <!-- Plain HTML, no JavaScript framework: A-Frame, Tempusxr, the image tracker. Needs pnpm build. -->
    <script src="/node_modules/aframe/dist/aframe-v1.8.0.min.js"></script>
    <script src="/packages/sdk-aframe/dist/index.umd.cjs"></script>
    <script src="/packages/sdk-tracker-image/dist/index.umd.cjs"></script>
    <link rel="stylesheet" href="page.css" />
  </head>
  <body>
    <!--
      Open poster.png on a screen (or print it) and point the camera at it: the video plays on the
      poster, and pauses when you look away. The Sound button appears once the poster is seen.
    -->
    <div id="ui" class="tx-overlay">
      <div data-tx-slot="center" data-tx-show="scanning" class="pill">
        Point the camera at the poster
      </div>
      <div data-tx-slot="bottom">
        <button class="tx-cta" type="button" data-tx-show="found" data-tx-action="sound" id="sound">
          Sound on
        </button>
      </div>
    </div>

    <a-scene
      tempusxr="tracker: image; targets: poster.txr; overlay: #ui"
      renderer="alpha: true"
      vr-mode-ui="enabled: false"
    >
      <a-assets>
        <!-- muted and playsinline: phones let a muted video start without a tap -->
        <video
          id="clip"
          src="clip.mp4"
          loop
          muted
          playsinline
          webkit-playsinline
          preload="auto"
        ></video>
      </a-assets>
      <a-camera
        position="0 0 0"
        look-controls="enabled: false"
        wasd-controls="enabled: false"
      ></a-camera>

      <a-entity id="poster" tempusxr-image-target="index: 0">
        <a-video
          tempusxr-image-plane
          src="#clip"
          width="1"
          height="1.33"
          position="0 0 0.01"
        ></a-video>
      </a-entity>
    </a-scene>

    <script src="page.js"></script>
  </body>
</html>
body {
  margin: 0;
}
.pill {
  padding: 8px 18px;
  border-radius: 999px;
  background: rgba(0, 0, 0, 0.55);
  color: #fff;
  font-weight: 700;
}
const clip = document.getElementById('clip');
const poster = document.getElementById('poster');
// Play while the poster is seen, pause when it is lost.
poster.addEventListener('targetFound', () => clip.play());
poster.addEventListener('targetLost', () => clip.pause());

document.getElementById('ui').addEventListener('click', (event) => {
  if (event.target.closest('[data-tx-action="sound"]')) {
    // A tap is what allows sound on a phone.
    clip.muted = !clip.muted;
    document.getElementById('sound').textContent = clip.muted ? 'Sound on' : 'Sound off';
  }
});
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
    <title>Tempusxr poster with video (Three.js)</title>
    <!-- Three.js with the SDK, as a page without a bundler loads it. Needs pnpm build. -->
    <script type="importmap">
      {
        "imports": {
          "three": "/node_modules/three/build/three.module.js",
          "@tempusxr/sdk-core": "/packages/sdk-core/dist/index.js",
          "@tempusxr/sdk-three": "/packages/sdk-three/dist/index.js",
          "@tempusxr/sdk-tracker-image": "/packages/sdk-tracker-image/dist/index.js"
        }
      }
    </script>
    <link rel="stylesheet" href="page.css" />
  </head>
  <body>
    <!--
      Open poster.png on a screen (or print it) and point the camera at it: the video plays on the
      poster, and pauses when you look away. The Sound button appears once the poster is seen.
    -->
    <div id="ui" class="tx-overlay">
      <div data-tx-slot="center" data-tx-show="scanning" class="pill">
        Point the camera at the poster
      </div>
      <div data-tx-slot="bottom">
        <button class="tx-cta" type="button" data-tx-show="found" data-tx-action="sound" id="sound">
          Sound on
        </button>
      </div>
    </div>
    <div id="ar"></div>
    <script type="module" src="page.js"></script>
  </body>
</html>
html,
body {
  margin: 0;
  height: 100%;
  background: #111;
}
.pill {
  padding: 8px 18px;
  border-radius: 999px;
  background: rgba(0, 0, 0, 0.55);
  color: #fff;
  font-weight: 700;
}
import * as THREE from 'three';
import { create } from '@tempusxr/sdk-three';
import '@tempusxr/sdk-tracker-image';
const ar = create({
  container: '#ar',
  overlay: document.getElementById('ui'),
  cameraOptions: { idealWidth: 640, idealHeight: 480 },
});
window.__ar = ar;
const tracker = await ar.use('image', { targets: ['/examples/poster-video/poster.txr'] });
const size = tracker.anchors[0]?.size ?? { width: 1, height: 1.33 };

// muted and playsinline: phones let a muted video start without a tap
const clip = document.createElement('video');
Object.assign(clip, {
  src: '/examples/poster-video/clip.mp4',
  loop: true,
  muted: true,
  playsInline: true,
  preload: 'auto',
});
clip.setAttribute('webkit-playsinline', '');
const texture = new THREE.VideoTexture(clip);
texture.colorSpace = THREE.SRGBColorSpace;

// A plane with the proportions of the poster, a little in front of it.
const video = new THREE.Mesh(
  new THREE.PlaneGeometry(size.width, size.height),
  new THREE.MeshBasicMaterial({ map: texture }),
);
video.position.z = 0.01;
const content = new THREE.Group();
content.add(video);
ar.attach(tracker.anchors[0], content);

// Play while the poster is seen, pause when it is lost.
ar.on('found', () => clip.play());
ar.on('lost', () => clip.pause());
document.getElementById('ui').addEventListener('click', (event) => {
  if (!event.target.closest('[data-tx-action="sound"]')) return;
  // A tap is what allows sound on a phone.
  clip.muted = !clip.muted;
  document.getElementById('sound').textContent = clip.muted ? 'Sound on' : 'Sound off';
});
await ar.start();
{
  "version": 1,
  "id": "poster-video-scene",
  "name": "Poster with video, as a scene file",
  "tracker": {
    "kind": "image",
    "targets": [
      {
        "id": "poster",
        "file": "poster.txr"
      }
    ]
  },
  "assets": [
    {
      "id": "clip",
      "type": "video",
      "src": "clip.mp4",
      "loop": true
    }
  ],
  "nodes": [
    {
      "id": "video",
      "asset": "clip",
      "anchor": "poster",
      "fit": "image",
      "position": [0, 0, 0.01]
    }
  ],
  "behaviors": [
    {
      "on": "found",
      "target": "poster",
      "do": "play",
      "node": "video"
    },
    {
      "on": "lost",
      "target": "poster",
      "do": "pause",
      "node": "video"
    }
  ],
  "meta": {
    "title": "Poster with video",
    "description": "Show poster.png to the camera: the video plays on the poster and pauses when you look away."
  }
}
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
    <title>Tempusxr scene</title>
    <!-- A scene file, opened the way the Viewer opens it. Open ?scene=your.json to try another one. -->
    <script type="importmap">
      {
        "imports": {
          "three": "/node_modules/three/build/three.module.js",
          "three/addons/": "/node_modules/three/examples/jsm/",
          "@tempusxr/scene": "/packages/scene/dist/index.js",
          "@tempusxr/sdk-core": "/packages/sdk-core/dist/index.js",
          "@tempusxr/sdk-three": "/packages/sdk-three/dist/index.js",
          "@tempusxr/sdk-tracker-image": "/packages/sdk-tracker-image/dist/index.js",
          "@tempusxr/sdk-tracker-world": "/packages/sdk-tracker-world/dist/index.js",
          "@tempusxr/sdk-capture": "/packages/sdk-capture/dist/index.js",
          "@tempusxr/ui": "/packages/ui/dist/index.js"
        }
      }
    </script>
    <link rel="stylesheet" href="page.css" />
  </head>
  <body>
    <div id="ar"></div>
    <div id="gate">
      <div id="status">Loading...</div>
      <button id="start" type="button" disabled>Start</button>
      <div id="qr" hidden><span>Scan to open on your phone</span></div>
      <div id="error"></div>
    </div>
    <script type="module" src="page.js"></script>
  </body>
</html>
html,
body {
  margin: 0;
  height: 100%;
  background: #111;
  color: #fff;
  font:
    16px/1.5 system-ui,
    sans-serif;
}
#gate {
  position: fixed;
  inset: 0;
  z-index: 20;
  display: grid;
  place-content: center;
  gap: 14px;
  padding: 24px;
  text-align: center;
  background: #111;
}
#gate[hidden] {
  display: none;
}
#start {
  padding: 14px 32px;
  border: 0;
  border-radius: 999px;
  background: #fecb02;
  color: #1b1b1b;
  font: inherit;
  font-weight: 700;
}
#start:disabled {
  opacity: 0.4;
}
#qr {
  display: grid;
  justify-items: center;
  gap: 6px;
  color: #a49cb1;
  font-size: 14px;
}
#qr[hidden] {
  display: none;
}
#qr svg {
  width: 168px;
  height: 168px;
  border-radius: 10px;
}
#error {
  color: #ff7b6b;
  white-space: pre-wrap;
}
import { loadScene } from '@tempusxr/sdk-three';
import '@tempusxr/sdk-tracker-image';
import '@tempusxr/sdk-tracker-world';
import { qrSvg } from '@tempusxr/ui';
import { addTestToggle } from '/examples/test-mode.js';
import { launchOnIphone } from '/examples/launch-ar.js';

addTestToggle(document.getElementById('gate'));
const status = document.getElementById('status');
const start = document.getElementById('start');
const sceneUrl = new URLSearchParams(location.search).get('scene') || 'scene.json';
const events = (window.__events = []);

// On a computer, show the QR code of this page, so a phone can scan it from the screen.
if (matchMedia('(pointer: fine)').matches) {
  const box = document.getElementById('qr');
  box.insertAdjacentHTML('afterbegin', qrSvg(location.href, { ecc: 'Q' }));
  box.hidden = false;
}

try {
  const experience = await loadScene(sceneUrl, {
    container: '#ar',
    onProgress: ({ loaded, total }) => (status.textContent = `Loading ${loaded} / ${total}`),
    onEvent: (event) => events.push(event),
    // Models with KTX2 textures need the Basis transcoder files.
    decoders: {
      basisPath: '/node_modules/three/examples/jsm/libs/basis/',
      dracoPath: '/node_modules/three/examples/jsm/libs/draco/',
    },
    // ?analytics sends opened, found, tap and time events to the dev server, which prints them.
    ...(new URLSearchParams(location.search).has('analytics')
      ? { analytics: { endpoint: '/__analytics' } }
      : {}),
  });
  window.__experience = experience;
  // ?capture adds the photo and video shutter. Videos hold the sound of the scene and of the room
  // (the phone asks for the microphone the first time).
  if (new URLSearchParams(location.search).has('capture')) {
    const { enableCapture } = await import('@tempusxr/sdk-capture');
    window.__capture = enableCapture(experience, { microphone: true });
  }
  status.textContent = experience.scene.meta?.title ?? 'Ready';
  start.disabled = false;
  // The tap is what lets the phone play sound and video later.
  start.addEventListener('click', async () => {
    document.getElementById('gate').hidden = true;
    await experience.start();
  });
} catch (error) {
  // A world scene on an iPhone: Safari has no WebXR, so Variant Launch opens it in an App Clip.
  if (error.code === 'unsupported' && launchOnIphone()) status.textContent = 'Opening AR...';
  else status.textContent = 'This experience could not be opened.';
  const lines = [`${error.code ?? 'error'}: ${error.message}`];
  for (const issue of error.issues ?? []) lines.push(`${issue.code} ${issue.path}`);
  document.getElementById('error').textContent = lines.join('\n');
  window.__loadError = { code: error.code, file: error.file, issues: error.issues };
}

Open on your phone

Scan this code with the phone camera.

Open on this device