reference new example on video asset and video frame reference archet…

…ypes
rerun-io · Sep 12, 2024 · 8d4ad66 · 8d4ad66
1 parent 771d49a
commit 8d4ad66
Show file tree

Hide file tree

Showing 12 changed files with 373 additions and 13 deletions.
diff --git a/crates/store/re_types/definitions/rerun/archetypes/asset_video.fbs b/crates/store/re_types/definitions/rerun/archetypes/asset_video.fbs
@@ -7,7 +7,9 @@ namespace rerun.archetypes;
 /// Follow <https://github.com/rerun-io/rerun/issues/7298> for updates on the native support.
 ///
 /// In order to display a video, you need to log a [archetypes.VideoFrameReference] for each frame.
-// TODO(#7368): More docs and examples on how to use this.
+///
+/// \example archetypes/video_manual_frames title="Video with explicit frames" image="https://static.rerun.io/video_manual_frames/320a44e1e06b8b3a3161ecbbeae3e04d1ccb9589/1200w.png"
+// TODO(#7368): Example and reference to `send_video_frames` API.
 table AssetVideo (
   "attr.rerun.experimental"
 ) {

diff --git a/crates/store/re_types/definitions/rerun/archetypes/video_frame_reference.fbs b/crates/store/re_types/definitions/rerun/archetypes/video_frame_reference.fbs
@@ -2,8 +2,11 @@ namespace rerun.archetypes;
 
 /// References a single video frame.
 ///
-/// Used to display video frames from a [archetypes.AssetVideo].
-// TODO(#7368): More docs and examples on how to use this.
+/// Used to display individual video frames from a [archetypes.AssetVideo].
+/// To show an entire video, a fideo frame reference for each frame of the video should be logged.
+///
+/// \example archetypes/video_manual_frames title="Video with explicit frames" image="https://static.rerun.io/video_manual_frames/320a44e1e06b8b3a3161ecbbeae3e04d1ccb9589/1200w.png"
+// TODO(#7368): Example and reference to `send_video_frames` API.
 table VideoFrameReference (
     "attr.rerun.experimental"
 ){
@@ -22,5 +25,9 @@ table VideoFrameReference (
     /// If none is specified, the video is assumed to be at the same entity.
     /// Note that blueprint overrides on the referenced video will be ignored regardless,
     /// as this is always interpreted as a reference to the data store.
+    ///
+    /// For a series of video frame references, it is recommended to specify this path only once
+    /// at the beginning of the series and then rely on latest-at query semantics to
+    /// keep the video reference active.
     video_reference: rerun.components.EntityPath ("attr.rerun.component_optional", nullable, order: 2000);
 }
diff --git a/crates/store/re_types/src/archetypes/asset_video.rs b/crates/store/re_types/src/archetypes/asset_video.rs
diff --git a/crates/store/re_types/src/archetypes/video_frame_reference.rs b/crates/store/re_types/src/archetypes/video_frame_reference.rs
diff --git a/crates/viewer/re_viewer/src/reflection/mod.rs b/crates/viewer/re_viewer/src/reflection/mod.rs
diff --git a/docs/content/reference/types/archetypes/asset_video.md b/docs/content/reference/types/archetypes/asset_video.md
diff --git a/docs/content/reference/types/archetypes/video_frame_reference.md b/docs/content/reference/types/archetypes/video_frame_reference.md
diff --git a/docs/snippets/all/archetypes/video_manual_frames.py b/docs/snippets/all/archetypes/video_manual_frames.py
@@ -1,8 +1,5 @@
-"""
-Log a video asset using manually created frame references.
-
-TODO(#7298): ⚠️ Video is currently only supported in the Rerun web viewer.
-"""
+"""Log a video asset using manually created frame references."""
+# TODO(#7298): ⚠️ Video is currently only supported in the Rerun web viewer.
 
 import sys
 

diff --git a/rerun_cpp/src/rerun/archetypes/asset_video.hpp b/rerun_cpp/src/rerun/archetypes/asset_video.hpp