voyant_playback_check

🚧 These docs are currently out of date. 🚧

They reflect the Meadowlark (Carbon dev kit) API and may not apply to Carbon systems.
Fully updated documentation will be published when Carbon Alpha ships in April 2026.

Questions? Reach out to us at: support@voyantphotonics.com

Validate recorded data integrity and display frame metadata. Useful for verifying recordings without full visualization.

Use voyant_playback_check --help to see all available options.

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

You can download sample datasets from the Playback Tools section.

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
Logged using API version: 0.1.0
Starting playback at 1.00x speed (filtering invalid points)...
(Press Ctrl+C to stop)
Frame header: VoyantHeaderWrapper { ... frame_index: 4418, device_class: Ldk, ... }
Points Count: 15093
-----------------------------------
...

Shows log file info, creation timestamp, API version, and frame-by-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.