Virtual.ink documentation

Frames is the extracted-image inspection view in the Media module. Use it when you need to evaluate individual snapshots instead of watching the full video playback.

What Frames Shows

Frames loads the snapshot list for one dataset at a time and renders those files in a responsive grid.

Each frame tile shows:

• the snapshot image
• the parsed frame number
• the original file name

Clicking a frame opens the original snapshot file in a new browser tab.

Automatic Dataset Behavior

Frames is designed to keep up with active production.

• It chooses the current dataset from the supplied initial folder when possible.
• If there is no valid initial folder, it falls back to the newest available dataset.
• When a newer dataset appears, Frames automatically switches to it.
• It polls for updates every 3 seconds.
• It also refreshes when the window regains focus or becomes visible again.

This makes Frames especially useful on an operator dashboard that should follow newly published work.

Standalone Header Controls

On the standalone page, Frames shows a header with:

• Older
• Newer
• the current dataset label and formatted timestamp
• dataset index inside the sorted list
• visible frame count
• Refresh
• Settings

Older and Newer move through the dataset list. Refresh reloads gallery and frame data immediately.

Frame Filtering And Layout

Frames supports both automatic and manual layout control.

• Automatic sizing chooses a sensible grid based on frame count and available width.
• Manual sizing lets operators set columns, padding, and thumbnail width directly.
• Frame number filtering lets you show only specific frames.

The frame number filter accepts:

• comma-separated values such as 1, 5, 10
• ranges such as 10-15
• mixed expressions such as 1, 5, 10-15

Frames Settings

The standalone Frames settings panel exposes:

• Preset
• Auto sizing
• Frames per line when auto sizing is off
• Padding when auto sizing is off
• Display width when auto sizing is off
• Frame numbers

The page also shows the preset query pattern as /frames?preset=..., which is useful when you want a stable preset-specific URL.

Keyboard Shortcuts

• Left Arrow moves to the previous dataset in the current list.
• Right Arrow moves to the next dataset in the current list.
• Escape closes the settings panel.
• Ctrl+, opens or closes settings on the standalone page.

Dashboard Tile Behavior

Frames is also available as a dashboard tile.

In embedded mode:

• the standalone header is hidden
• the tile still follows the shared current dataset
• the tile still auto-switches to newly published work
• Ctrl+, asks the parent dashboard to open tile settings instead of opening the standalone settings panel locally

Empty And Error States

Frames reports the common review states clearly:

• no datasets yet
• loading frames
• no frames found for this dataset
• no matching frames for the current filter
• load error from the gallery or snapshots endpoint

Use Frames when you need precise visual inspection. If you need rating, metadata, or sharing, move to Quickview. If you need broad gallery browsing, use Library.