Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Neon Sample Rec for Neon Player #683

Closed
wants to merge 1 commit into from
Closed

Add Neon Sample Rec for Neon Player #683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions neon/neon-player/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@

Once you have the recording, open Neon Player and drag-and-drop the folder into the application window.

Don't have a recording yet? [Download a sample recording](https://api.cloud.pupil-labs.com/v2/workspaces/3d240903-cbf7-485a-84b1-3498f00e236c/recordings.zip?id=7c141c32-7a8d-411c-9428-70d16de9a9ea&share-key=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiJmY2Q5NWJkYS1lZjVhLTRlN2YtOWZiYi01NTc1NWFhYWQzZTAiLCJtZXRob2QiOiJHRVQiLCJwYXRoIjoiL3YyL3dvcmtzcGFjZXMvM2QyNDA5MDMtY2JmNy00ODVhLTg0YjEtMzQ5OGYwMGUyMzZjL3JlY29yZGluZ3MuemlwIiwicXVlcnkiOiJpZD03YzE0MWMzMi03YThkLTQxMWMtOTQyOC03MGQxNmRlOWE5ZWEiLCJleHAiOjE4NjkyMjA3NzkuMjEzMDEzNn0.xfR9ZqOWmql1EmAkqc_mszL63hER_s8HziAzfn89-QI "Download sample recording to use in Neon Player").

::: info
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.
:::
Expand All @@ -29,19 +31,19 @@

::: info

Recordings extracted from the phone do not contain [eye state](../data-collection/data-streams/#_3d-eye-states) or [pupillometry](../data-collection/data-streams/#pupil-diameters), and the sampling rate matches that at the time of recording.

Check warning on line 34 in neon/neon-player/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (pupillometry)

Recordings downloaded from [Pupil Cloud](./../pupil-cloud/) will be at 200Hz.
:::

## Neon Player Window

![Neon Player Callout](./pp-callout.jpg)

Check warning on line 41 in neon/neon-player/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (Callout)

1. **Graphs**: This area contains performance graphs. The graphs display `CPU` and `FPS` (FPS = Video playback speed).
1. **Hot Keys**: This area contains clickable buttons for plugins.
1. **Timeline Events**: Plugins can add temporal events to this expandable panel.
1. **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.

Check warning on line 46 in neon/neon-player/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (spacebar)

Check warning on line 46 in neon/neon-player/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (playhead)

- **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.
Expand Down Expand Up @@ -101,7 +103,7 @@

- Start **Neon Player** and load a recording.
- Open a Plugin - From the `Plugin Manager` GUI menu (which can be found in the Sidebar), toggle any Plugin of your choice. The `Vis Circle` plugin is activated by default.
- Playback - press the play button or `space` bar on your keyboard to view the video playback with visualization overlay, or drag the playhead in the seek bar to scrub through the dataset.

Check warning on line 106 in neon/neon-player/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (playhead)
- 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.

Check warning on line 107 in neon/neon-player/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (seekbar)
- Export Video & Raw Data - From the `Plugin Manager` view, load the `World Video Exporter` plugin and the `Raw Data Exporter` plugin. Press `e` on your keyboard or the ⬇ `download icon` button in the left hand side of the window to start the export.
- View the exported data in the `exports` directory.
Loading