@foxglove/schemas 1.6.0 → 1.6.2

package/schemas/ros2/CompressedVideo.msg

@@ -3,16 +3,20 @@
 
 # Generated by https://github.com/foxglove/schemas
 
-# Timestamp of image
+# Timestamp of video frame
 builtin_interfaces/Time timestamp
 
-# 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.
 string frame_id
 
-# 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.
 uint8[] data
 
-# Video format
+# Video format.
 # 
-# Supported values: `h264`
+# Supported values: `h264` (Annex B formatted data only)
 string format

package/schemas/ros2/PointsAnnotation.msg

@@ -29,7 +29,7 @@ foxglove_msgs/Point2[] points
 # Outline color
 foxglove_msgs/Color outline_color
 
-# Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`.
+# Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`, `LINE_STRIP` or `LINE_LOOP`.
 foxglove_msgs/Color[] outline_colors
 
 # Fill color

package/schemas/typescript/CompressedImage.d.ts

@@ -10,7 +10,7 @@ export type CompressedImage = {
     /**
      * Image format
      *
-     * Supported values: `webp`, `jpeg`, `png`
+     * Supported values: image media types supported by Chrome, such as `webp`, `jpeg`, `png`
      */
     format: string;
 };

package/schemas/typescript/CompressedImage.ts

@@ -17,7 +17,7 @@ export type CompressedImage = {
   /**
    * Image format
    * 
-   * Supported values: `webp`, `jpeg`, `png`
+   * Supported values: image media types supported by Chrome, such as `webp`, `jpeg`, `png`
    */
   format: string;
 };

package/schemas/typescript/CompressedVideo.d.ts

@@ -1,16 +1,24 @@
 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;
     /**
-     * Video format
+     * Video format.
      *
-     * Supported values: `h264`
+     * Supported values: `h264` (Annex B formatted data only)
      */
     format: string;
 };

package/schemas/typescript/CompressedVideo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CompressedVideo.d.ts","sourceRoot":"","sources":["CompressedVideo.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,qDAAqD;AACrD,MAAM,MAAM,eAAe,GAAG;IAC5B,yBAAyB;IACzB,SAAS,EAAE,IAAI,CAAC;IAEhB,qMAAqM;IACrM,QAAQ,EAAE,MAAM,CAAC;IAEjB,+OAA+O;IAC/O,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"CompressedVideo.d.ts","sourceRoot":"","sources":["CompressedVideo.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,qDAAqD;AACrD,MAAM,MAAM,eAAe,GAAG;IAC5B,+BAA+B;IAC/B,SAAS,EAAE,IAAI,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/schemas/typescript/CompressedVideo.ts

@@ -5,19 +5,27 @@ 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;
 
   /**
-   * Video format
+   * Video format.
    * 
-   * Supported values: `h264`
+   * Supported values: `h264` (Annex B formatted data only)
    */
   format: string;
 };

package/schemas/typescript/PointsAnnotation.d.ts

@@ -12,7 +12,7 @@ export type PointsAnnotation = {
     points: Point2[];
     /** Outline color */
     outline_color: Color;
-    /** Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`. */
+    /** Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`, `LINE_STRIP` or `LINE_LOOP`. */
     outline_colors: Color[];
     /** Fill color */
     fill_color: Color;

package/schemas/typescript/PointsAnnotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PointsAnnotation.d.ts","sourceRoot":"","sources":["PointsAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,8BAA8B;IAC9B,SAAS,EAAE,IAAI,CAAC;IAEhB,wCAAwC;IACxC,IAAI,EAAE,oBAAoB,CAAC;IAE3B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB,oBAAoB;IACpB,aAAa,EAAE,KAAK,CAAC;IAErB,uGAAuG;IACvG,cAAc,EAAE,KAAK,EAAE,CAAC;IAExB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"PointsAnnotation.d.ts","sourceRoot":"","sources":["PointsAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,8BAA8B;IAC9B,SAAS,EAAE,IAAI,CAAC;IAEhB,wCAAwC;IACxC,IAAI,EAAE,oBAAoB,CAAC;IAE3B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB,oBAAoB;IACpB,aAAa,EAAE,KAAK,CAAC;IAErB,oIAAoI;IACpI,cAAc,EAAE,KAAK,EAAE,CAAC;IAExB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/schemas/typescript/PointsAnnotation.ts

@@ -20,7 +20,7 @@ export type PointsAnnotation = {
   /** Outline color */
   outline_color: Color;
 
-  /** Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`. */
+  /** Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`, `LINE_STRIP` or `LINE_LOOP`. */
   outline_colors: Color[];
 
   /** Fill color */