FG-2933: Add CompressedAudio schema

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
     branches: [main]
     tags: ["releases/**"]
   pull_request:
-    branches: ["*"]
+    branches: ["**"]
 
 jobs:
   build:

internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap

@@ -236,6 +236,40 @@ export type CompressedVideo = {
    */
   format: string;
 };
+",
+  "CompressedAudio" => "// Generated by https://github.com/foxglove/schemas
+// Options: {}
+
+import { Time } from "./Time";
+
+/** A single frame of a compressed audio bitstream */
+export type CompressedAudio = {
+  /** Timestamp of audio frame */
+  timestamp: Time;
+
+  /** Compressed audio frame data. */
+  data: Uint8Array;
+
+  /**
+   * Audio format.
+   * 
+   * Supported values: \`opus\`.
+   */
+  format: string;
+
+  /**
+   * Frame type.
+   * 
+   *  Supported values: \`key\`, \`delta\`.
+   */
+  type: string;
+
+  /** Number of audio samples per second. */
+  sample_rate: number;
+
+  /** Number of audio channels in the input. */
+  number_of_channels: number;
+};
 ",
   "CylinderPrimitive" => "// Generated by https://github.com/foxglove/schemas
 // Options: {}
@@ -1104,6 +1138,7 @@ export enum PositionCovarianceType {
 export * from "./CameraCalibration";
 export * from "./CircleAnnotation";
 export * from "./Color";
+export * from "./CompressedAudio";
 export * from "./CompressedImage";
 export * from "./CompressedVideo";
 export * from "./CubePrimitive";

internal/schemas.ts

@@ -843,6 +843,44 @@ Specifically, the requirements for different \`format\` values are:
   ],
 };
 
+const CompressedAudio: FoxgloveMessageSchema = {
+  type: "message",
+  name: "CompressedAudio",
+  description: "A single frame of a compressed audio bitstream",
+  fields: [
+    {
+      name: "timestamp",
+      type: { type: "primitive", name: "time" },
+      description: "Timestamp of audio frame",
+    },
+    {
+      name: "data",
+      type: { type: "primitive", name: "bytes" },
+      description: `Compressed audio frame data.`,
+    },
+    {
+      name: "format",
+      type: { type: "primitive", name: "string" },
+      description: "Audio format.\n\nSupported values: `opus`.",
+    },
+    {
+      name: "type",
+      type: { type: "primitive", name: "string" },
+      description: "Frame type.\n\n Supported values: `key`, `delta`.",
+    },
+    {
+      name: "sample_rate",
+      type: { type: "primitive", name: "uint32" },
+      description: "Number of audio samples per second.",
+    },
+    {
+      name: "number_of_channels",
+      type: { type: "primitive", name: "uint32" },
+      description: "Number of audio channels in the input.",
+    },
+  ],
+};
+
 const RawImage: FoxgloveMessageSchema = {
   type: "message",
   name: "RawImage",
@@ -1482,6 +1520,7 @@ export const foxgloveMessageSchemas = {
   Color,
   CompressedImage,
   CompressedVideo,
+  CompressedAudio,
   CylinderPrimitive,
   CubePrimitive,
   FrameTransform,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/schemas",
-  "version": "1.6.6",
+  "version": "1.6.7",
   "description": "Foxglove-defined message schemas for ROS, Protobuf, FlatBuffers, OMG IDL, and JSON",
   "license": "MIT",
   "repository": {