Playback: voyant_playback_check

Validate a recording and print frame metadata.

Validates recorded .bin data integrity and prints frame-by-frame metadata — useful for checking a recording without opening the full visualizer.

Use voyant_playback_check --help to see all available options.

Data Sources

Use a Voyant *.bin data file from either:

Usage

Basic Playback

voyant_playback_check --input my_recording.bin

Custom Playback Speed

voyant_playback_check --input my_recording.bin --rate 3.0

Continuous Looping

voyant_playback_check --input my_recording.bin --loopback

Expected Output

When playing back a valid recording:

Found valid Voyant data log file: DataLogPrefix { magic: [86, 89, 78, 84], file_header_size: 28 }
Log created at: 1743622138.467240245
Starting playback at 1.00x speed (filtering invalid points)...
(Press Ctrl+C to stop)
Frame header: VoyantHeaderWrapper { ... frame_index: 4418, ... }
Points Count: 15093
-----------------------------------
...

Shows the log file header, creation timestamp, and per-frame metadata including frame index and point counts.

Options

  • --input <FILE> - Path to the binary recording file
  • --rate <MULTIPLIER> - Playback speed (1.0 = real-time, 2.0 = double speed) (default: 1.0)
  • --loopback - Repeat playback when reaching end of file
  • --keep-invalid-points - Include invalid points in point counts

Troubleshooting

If playback fails:

  • Verify the file is a valid Voyant .bin recording
  • Check file permissions and path
  • Ensure the file wasn’t corrupted during transfer

Copyright © Voyant Photonics, Inc.

This site uses Just the Docs, a documentation theme for Jekyll.