Neon Player is a cross-platform desktop application for playing back and exporting Neon recordings. It runs in an offline context; no interaction with Pupil Cloud is required.
Loading a Recording
To load a recording, you first need to download or export it to your computer:
- Direct transfer from Neon Companion Device – For detailed instructions, refer to this guide.
- Download from Pupil Cloud – Right-click on a recording in Pupil Cloud, select Download, and ensure you choose the "Native Recording Data" format.
Once you have the recording, open Neon Player and drag-and-drop the folder into the application window.
Neon Player will never remove or overwrite any of your raw data gathered at the time of recording. Instead, it will create a new folder,
neon_player, which contains the Neon Player compatible files.
Recordings downloaded from Pupil Cloud will be at 200Hz.
Neon Player Window
Graphs: This area contains performance graphs. The graphs display
FPS(FPS = Video playback speed).
Hot Keys: This area contains clickable buttons for plugins.
Timeline Events: Plugins can add temporal events to this expandable panel.
Timeline: Control the playback of the video with the play/pause button (or spacebar on your keyboard). Drag the playhead (vertical line) to the desired point in time.
- Trimming: Drag the green rounded rectangles at either end of the timeline to set beginning and ending trim markers. The trim section markers specify the section of the video/data to export.
- Frame Stepping: You can use the arrow keys on your keyboard or the
>>buttons to advance one frame at a time while the playback is paused.
- Playback Speed: To change the playback speed, use the arrow keys on your keyboard or the
>>buttons during playback. There are 5 available playback speeds:
Menu: This area contains settings and contextual information for each plugin.
Sidebar: This area contains clickable buttons for each plugin. System plugins are loaded in the top and user added plugins are added below the horizontal separator.
|Play and pause video
|Step to previous frame 1 / Decrease playback speed 2
|Step to next frame 1 / Increase playback speed 2
|Surface tracker: Add new surface
|Add annotation (default keyboard shortcut)
|Fixation: Show next
|Fixation: Show previous
1 While paused 2 During playback
Neon Player uses a plugin framework to add functionality. Visualizations, fixations, blinks, and data exports are all implemented using this structure.
There are two general types of plugins:
- Unique: You can only launch one instance of this plugin.
- Not unique: You can launch multiple instances of this type of plugin. For example, you can load one
Vis Circleplugin to render the gaze position with a translucent green circle, and another
Vis Circleplugin to render the gaze circle with a green stroke of 3 pixel thickness. You can think of these types of plugins as additive.
You can export data and videos by pressing
e on your keyboard, or use the download button in the Neon Player window.
Upon activation, all loaded plugins with export capabilities will initiate the export process. Some exports operate in the background, you can monitor their progress via a GUI progress bar. This allows you to continue working with Neon Player.
Exports are separated from your raw data and contained in the
exports subdirectory. Multiple exports will create a new folders, which are auto-named according to their creation order, e.g.
You can select the frame range to export by setting trim marks in the seek bar or directly in the
General Settings menu.
Longer running exports, e.g. video exports, go through three phases: Queued, Running, and Completed. Export tasks can be cancelled while being queued or running. Completed tasks are kept in the list for reference.
Neon Player is similar to a video player. You can playback recordings and can load plugins to build visualizations.
Here is an example workflow:
- Start Neon Player and load a recording.
- Open a Plugin - From the
Plugin ManagerGUI menu (which can be found in the Sidebar), toggle any Plugin of your choice. The
Vis Circleplugin is activated by default.
- Playback - press the play button or
spacebar on your keyboard to view the video playback with visualization overlay, or drag the playhead in the seek bar to scrub through the dataset.
- Set trim marks - drag the green rounded rectangle at the beginning and end of the seekbar to set the trim marks. This will set the start and end frame for the exporter and for other plugins.
- Export Video & Raw Data - From the
Plugin Managerview, load the
World Video Exporterplugin and the
Raw Data Exporterplugin. Press
eon your keyboard or the ⬇
download iconbutton in the left hand side of the window to start the export.
- View the exported data in the