Update comments for foxglove.CompressedVideo schema (#129)

Timestamp refers to video frame instead of image Added note to `data` field to state that B-frames should not be used.
foxglove · Sep 29, 2023 · 03f91d4 · 03f91d4
1 parent 3009ac7
commit 03f91d4
Show file tree

Hide file tree

Showing 13 changed files with 39 additions and 39 deletions.
diff --git a/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap b/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap
@@ -187,13 +187,13 @@ import { Time } from "./Time";
 
 /** A single frame of a compressed video bitstream */
 export type CompressedVideo = {
-  /** Timestamp of image */
+  /** Timestamp of video frame */
   timestamp: Time;
 
-  /** Frame of reference for the image. The origin of the frame is the optical center of the camera. +x points to the right in the image, +y points down, and +z points into the plane of the image. */
+  /** Frame of reference for the video. The origin of the frame is the optical center of the camera. +x points to the right in the video, +y points down, and +z points into the plane of the video. */
   frame_id: string;
 
-  /** Compressed video frame data. For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). */
+  /** Compressed video frame data. For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead. */
   data: Uint8Array;
 
   /**

diff --git a/internal/schemas.ts b/internal/schemas.ts
@@ -798,19 +798,19 @@ const CompressedVideo: FoxgloveMessageSchema = {
     {
       name: "timestamp",
       type: { type: "primitive", name: "time" },
-      description: "Timestamp of image",
+      description: "Timestamp of video frame",
     },
     {
       name: "frame_id",
       type: { type: "primitive", name: "string" },
       description:
-        "Frame of reference for the image. The origin of the frame is the optical center of the camera. +x points to the right in the image, +y points down, and +z points into the plane of the image.",
+        "Frame of reference for the video. The origin of the frame is the optical center of the camera. +x points to the right in the video, +y points down, and +z points into the plane of the video.",
     },
     {
       name: "data",
       type: { type: "primitive", name: "bytes" },
       description:
-        "Compressed video frame data. For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame).",
+        "Compressed video frame data. For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead.",
     },
     {
       name: "format",

diff --git a/ros_foxglove_msgs/ros1/CompressedVideo.msg b/ros_foxglove_msgs/ros1/CompressedVideo.msg
diff --git a/ros_foxglove_msgs/ros2/CompressedVideo.msg b/ros_foxglove_msgs/ros2/CompressedVideo.msg
diff --git a/schemas/README.md b/schemas/README.md
diff --git a/schemas/flatbuffer/CompressedVideo.fbs b/schemas/flatbuffer/CompressedVideo.fbs
diff --git a/schemas/jsonschema/CompressedVideo.json b/schemas/jsonschema/CompressedVideo.json
diff --git a/schemas/jsonschema/index.ts b/schemas/jsonschema/index.ts
diff --git a/schemas/omgidl/foxglove/CompressedVideo.idl b/schemas/omgidl/foxglove/CompressedVideo.idl
diff --git a/schemas/proto/foxglove/CompressedVideo.proto b/schemas/proto/foxglove/CompressedVideo.proto
diff --git a/schemas/ros1/CompressedVideo.msg b/schemas/ros1/CompressedVideo.msg
diff --git a/schemas/ros2/CompressedVideo.msg b/schemas/ros2/CompressedVideo.msg
diff --git a/schemas/typescript/CompressedVideo.ts b/schemas/typescript/CompressedVideo.ts