Skip to main content

A viser extension with out-of-the-box support for the time dimension

Project description

viser4d

viser4d is a small extension of viser for recorded 3D scenes with a time dimension.

Features include:

  • Record scene updates across discrete timesteps with with server.at(t):.
  • Play, pause, scrub, and step through the timeline directly in the browser.
  • Stream long recordings in chunks and preload nearby timeline blocks for responsive scrubbing.
  • Keep playback client-local so different browser tabs can explore the same recording independently.
  • Attach timeline-synced audio tracks.
  • Export recordings as .viser files or standalone HTML.

The goal is to keep viser's live scene API while adding a separate recorded timeline API for playback and export.

Chunking is controlled by viser4d.ChunkStreamingConfig. By default, Viser4dServer populates it from VISER4D_BLOCK_SIZE and VISER4D_CLIENT_CHUNK_CACHE_SIZE, falling back to 32 steps per block and a 1GB per-client preload budget. You can also pass chunk_streaming=viser4d.ChunkStreamingConfig(...) for one server instance.

Installation

You can install viser4d with pip:

pip install viser4d

Quickstart

import numpy as np
import viser4d

server = viser4d.Viser4dServer(num_steps=10, fps=10)

server.scene.add_frame("/origin", axes_length=0.25)
server.scene.add_grid("/ground", width=10.0, height=10.0)

point_cloud = None
for t in range(10):
    with server.at(t) as timeline:
        points = np.random.uniform(-1.0, 1.0, size=(200, 3))
        if point_cloud is None:
            point_cloud = timeline.scene.add_point_cloud(
                "/points",
                points=points,
                colors=(255, 200, 0),
            )
        else:
            point_cloud.points = points

server.sleep_forever()

Open the viewer in your browser and use the built-in Playback controls to play, pause, scrub, and step through the recorded timeline.

Outside server.at(t), server.scene behaves like normal viser. Inside server.at(t), writes to timeline.scene and timeline.audio are recorded into the timeline.

More Examples

Export

blob = server.serialize()
html = server.as_html()

Use server.serialize() to export a .viser recording and server.as_html() to export a self-contained HTML viewer.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

viser4d-0.16.2.tar.gz (63.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

viser4d-0.16.2-py3-none-any.whl (69.7 kB view details)

Uploaded Python 3

File details

Details for the file viser4d-0.16.2.tar.gz.

File metadata

  • Download URL: viser4d-0.16.2.tar.gz
  • Upload date:
  • Size: 63.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for viser4d-0.16.2.tar.gz
Algorithm Hash digest
SHA256 852848f8c3eaee17b8ce61783049bae6a73275bdaef93154477413c6e7e66b51
MD5 646bc85367c09b8aaf5460ce449e7034
BLAKE2b-256 5b20bb4a48cbb46e8a06838af6cfec12072e6c286dcf2fdc4b8e97ad9a4b88c2

See more details on using hashes here.

File details

Details for the file viser4d-0.16.2-py3-none-any.whl.

File metadata

  • Download URL: viser4d-0.16.2-py3-none-any.whl
  • Upload date:
  • Size: 69.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for viser4d-0.16.2-py3-none-any.whl
Algorithm Hash digest
SHA256 acfb719062a83c31ba4eceee68aad3d2ed05616c5b80416fe33753e872ce9294
MD5 52af1505b875f4b70c39d083b3403662
BLAKE2b-256 dd136074907559b5f0e821a4d9dcd4b0e7891513b174b10ea6705a9adaa94e38

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page