Skip to content

Commit 6c0d4c2

Browse files
authored
Merge pull request #55 from waterlinked/54-add-sonar-replay-page
Adds docs page about Sonar Replay and how to use it.
2 parents 2a477ae + aaf5e61 commit 6c0d4c2

File tree

9 files changed

+47
-0
lines changed

9 files changed

+47
-0
lines changed
273 KB
Loading
233 KB
Loading

docs/img/sonar-replay/chapters.png

364 KB
Loading
143 KB
Loading

docs/img/sonar-replay/landing.png

80.6 KB
Loading

docs/img/sonar-replay/playback.png

249 KB
Loading
101 KB
Loading

docs/sonar-3d/sonar-replay.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Sonar Replay
2+
3+
Sonar Replay allows play back of recordings taken with the [Sonar 3D-15](https://waterlinked.com/3dsonar) directly in your browser. You can access [Sonar Replay here](https://sonar.replay.waterlinked.com). The interface is similar to that of the Sonar 3D-15, but with some changes.
4+
5+
All processing is done in your browser and not uploaded anywhere.
6+
7+
![Sonar Replay Main View](../img/sonar-replay/landing.png)
8+
9+
!!! Note
10+
Sonar Replay is still in development. Some features may not be fully functional or implemented yet.
11+
12+
Click the file input to select a file or drag and drop a file onto the browser window. Alternatively use one of the provided examples by clicking "Load demo".
13+
14+
Processing time depends on the file size, device and browser. While processing, an estimated remaining time is shown.
15+
16+
![Sonar Replay Processing Recording](../img/sonar-replay/processing-recording.png)
17+
18+
!!! Note
19+
We recommend recordings smaller than 300 MB for the best experience.
20+
21+
## Play back
22+
Once processing is complete, the 3D point cloud is shown and play back will start immediately. Scrub through the recording using the play back slider, pause, adjust play back speed and get an overview of the recording with "Chapters".
23+
24+
![Sonar Replay](../img/sonar-replay/playback.png)
25+
26+
## Chapters
27+
Sonar Replay will automatically create chapter previews of the provided recording. Access this by clicking the "Chapters" button or by hitting <code>C</code> on your keyboard. Note that all recorded timestamps are in UTC (Coordinated Universal Time) and reflect the sonar's time settings at the time of recording.
28+
29+
![Sonar Replay](../img/sonar-replay/chapters.png)
30+
31+
!!! Tip
32+
Quickly jump to a chapter by clicking the preview image.
33+
34+
Chapter preview can be expanded to a larger version by clicking the magnifying glass icon that appears when hovering the chapter preview.
35+
36+
![Sonar Replay](../img/sonar-replay/chapter-preview.png)
37+
38+
## Adjust settings
39+
Much like the real Sonar 3D-15, settings can be adjusted to better fit your use case and observe the recording. Toggle the settings tray by clicking the "Settings" button or hit <code>S</code> on your keyboard. From here many settings can be adjusted like point size, color palette and toggling elements in the 3D view.
40+
41+
![Sonar Replay](../img/sonar-replay/adjust-settings.png)
42+
43+
## Help
44+
Get a quick overview of all main parts of the interface by clicking the <code>?</code> (Question) icon top left or by hitting <code>H</code> on your keyboard.
45+
46+
![Sonar Replay](../img/sonar-replay/help-overlay.png)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ nav:
4949
- Software Updates: sonar-3d/sonar-3d-15-software-update.md
5050
- Settings: sonar-3d/sonar-3d-15-config.md
5151
- Networking: sonar-3d/sonar-3d-15-networking.md
52+
- Sonar Replay: sonar-3d/sonar-replay.md
5253
- FAQ: sonar-3d/sonar-3d-15-faq.md
5354

5455
- Underwater GPS:

0 commit comments

Comments
 (0)