@blueyerobotics/protocol-definitions 3.2.0-7ccc4a0d → 3.2.0-82141b1d

package/dist/message_formats.d.ts

@@ -216,7 +216,7 @@ export declare enum Resolution {
     RESOLUTION_HD_720P = 2,
     /** RESOLUTION_FULLHD_1080P - 1080p Full HD (1920x1080). */
     RESOLUTION_FULLHD_1080P = 1,
-    /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160). */
+    /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
     RESOLUTION_UHD_4K = 3,
     UNRECOGNIZED = -1
 }
@@ -228,7 +228,7 @@ export declare enum Framerate {
     FRAMERATE_UNSPECIFIED = 0,
     /** FRAMERATE_FPS_30 - 30 frames per second. */
     FRAMERATE_FPS_30 = 1,
-    /** FRAMERATE_FPS_25 - 25 frames per second. */
+    /** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
     FRAMERATE_FPS_25 = 2,
     UNRECOGNIZED = -1
 }
@@ -251,7 +251,7 @@ export declare enum StreamingProtocol {
     STREAMING_PROTOCOL_UNSPECIFIED = 0,
     /** STREAMING_PROTOCOL_RTSP_H264 - RTSP streaming protocol using H264 codec. */
     STREAMING_PROTOCOL_RTSP_H264 = 1,
-    /** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. */
+    /** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. No recording when activated. */
     STREAMING_PROTOCOL_RTSP_MJPEG = 2,
     UNRECOGNIZED = -1
 }
@@ -731,6 +731,8 @@ export interface RecordState {
     multibeamSeconds: number;
     /** Multibeam record fps. */
     multibeamFps: number;
+    /** Storage location used for recording. */
+    storageLocation: StorageLocation;
 }
 /** Time-lapse state published if time-lapse mission is running. */
 export interface TimeLapseState {
@@ -1498,6 +1500,12 @@ export interface CameraParameters {
     backlightCompensation: number;
     /** Noise reduction (-20..20), -20 as default. Only available on Ultra. */
     denoise: number;
+    /** Enable eHDR mode. Default true. Only available on Ultra. */
+    ehdrEnabled: boolean;
+    /** Minimum number of eHDR frames. (1..4), default 1. Only available on Ultra. */
+    ehdrExposureMinNumber: number;
+    /** Maximum number of eHDR frames. (1..4), default 2. Only on Ultra. Setting larger than 2 can reduce the framerate. */
+    ehdrExposureMaxNumber: number;
     /** Stream, recording and image resolution (deprecated). */
     resolution: Resolution;
     /** Stream resolution. */
@@ -1510,8 +1518,6 @@ export interface CameraParameters {
     framerate: Framerate;
     /** Which camera the parameters belong to. */
     camera: Camera;
-    /** Prioritize fixed frame rate over quality on Ultra. */
-    fixedFramerate: boolean;
 }
 /**
  * Overlay parameters.

package/dist/message_formats.js

@@ -775,7 +775,7 @@ var Resolution;
     Resolution[Resolution["RESOLUTION_HD_720P"] = 2] = "RESOLUTION_HD_720P";
     /** RESOLUTION_FULLHD_1080P - 1080p Full HD (1920x1080). */
     Resolution[Resolution["RESOLUTION_FULLHD_1080P"] = 1] = "RESOLUTION_FULLHD_1080P";
-    /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160). */
+    /** RESOLUTION_UHD_4K - 4K Ultra HD (3840x2160, Only supported on X3 Ultra). */
     Resolution[Resolution["RESOLUTION_UHD_4K"] = 3] = "RESOLUTION_UHD_4K";
     Resolution[Resolution["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(Resolution || (exports.Resolution = Resolution = {}));
@@ -826,7 +826,7 @@ var Framerate;
     Framerate[Framerate["FRAMERATE_UNSPECIFIED"] = 0] = "FRAMERATE_UNSPECIFIED";
     /** FRAMERATE_FPS_30 - 30 frames per second. */
     Framerate[Framerate["FRAMERATE_FPS_30"] = 1] = "FRAMERATE_FPS_30";
-    /** FRAMERATE_FPS_25 - 25 frames per second. */
+    /** FRAMERATE_FPS_25 - 25 frames per second. (Only supported on Pioneer/Pro/X1/X3) */
     Framerate[Framerate["FRAMERATE_FPS_25"] = 2] = "FRAMERATE_FPS_25";
     Framerate[Framerate["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(Framerate || (exports.Framerate = Framerate = {}));
@@ -907,7 +907,7 @@ var StreamingProtocol;
     StreamingProtocol[StreamingProtocol["STREAMING_PROTOCOL_UNSPECIFIED"] = 0] = "STREAMING_PROTOCOL_UNSPECIFIED";
     /** STREAMING_PROTOCOL_RTSP_H264 - RTSP streaming protocol using H264 codec. */
     StreamingProtocol[StreamingProtocol["STREAMING_PROTOCOL_RTSP_H264"] = 1] = "STREAMING_PROTOCOL_RTSP_H264";
-    /** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. */
+    /** STREAMING_PROTOCOL_RTSP_MJPEG - RTSP streaming protocol using MJPEG codec. No recording when activated. */
     StreamingProtocol[StreamingProtocol["STREAMING_PROTOCOL_RTSP_MJPEG"] = 2] = "STREAMING_PROTOCOL_RTSP_MJPEG";
     StreamingProtocol[StreamingProtocol["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(StreamingProtocol || (exports.StreamingProtocol = StreamingProtocol = {}));
@@ -3792,6 +3792,7 @@ function createBaseRecordState() {
         multibeamIsRecording: false,
         multibeamSeconds: 0,
         multibeamFps: 0,
+        storageLocation: 0,
     };
 }
 exports.RecordState = {
@@ -3823,6 +3824,9 @@ exports.RecordState = {
         if (message.multibeamFps !== 0) {
             writer.uint32(77).float(message.multibeamFps);
         }
+        if (message.storageLocation !== 0) {
+            writer.uint32(80).int32(message.storageLocation);
+        }
         return writer;
     },
     decode(input, length) {
@@ -3895,6 +3899,13 @@ exports.RecordState = {
                     message.multibeamFps = reader.float();
                     continue;
                 }
+                case 10: {
+                    if (tag !== 80) {
+                        break;
+                    }
+                    message.storageLocation = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -3914,6 +3925,7 @@ exports.RecordState = {
             multibeamIsRecording: isSet(object.multibeamIsRecording) ? gt.Boolean(object.multibeamIsRecording) : false,
             multibeamSeconds: isSet(object.multibeamSeconds) ? gt.Number(object.multibeamSeconds) : 0,
             multibeamFps: isSet(object.multibeamFps) ? gt.Number(object.multibeamFps) : 0,
+            storageLocation: isSet(object.storageLocation) ? storageLocationFromJSON(object.storageLocation) : 0,
         };
     },
     toJSON(message) {
@@ -3945,6 +3957,9 @@ exports.RecordState = {
         if (message.multibeamFps !== 0) {
             obj.multibeamFps = message.multibeamFps;
         }
+        if (message.storageLocation !== 0) {
+            obj.storageLocation = storageLocationToJSON(message.storageLocation);
+        }
         return obj;
     },
     create(base) {
@@ -3961,6 +3976,7 @@ exports.RecordState = {
         message.multibeamIsRecording = object.multibeamIsRecording ?? false;
         message.multibeamSeconds = object.multibeamSeconds ?? 0;
         message.multibeamFps = object.multibeamFps ?? 0;
+        message.storageLocation = object.storageLocation ?? 0;
         return message;
     },
 };
@@ -9668,13 +9684,15 @@ function createBaseCameraParameters() {
         sharpness: 0,
         backlightCompensation: 0,
         denoise: 0,
+        ehdrEnabled: false,
+        ehdrExposureMinNumber: 0,
+        ehdrExposureMaxNumber: 0,
         resolution: 0,
         streamResolution: 0,
         recordingResolution: 0,
         streamingProtocol: 0,
         framerate: 0,
         camera: 0,
-        fixedFramerate: false,
     };
 }
 exports.CameraParameters = {
@@ -9718,6 +9736,15 @@ exports.CameraParameters = {
         if (message.denoise !== 0) {
             writer.uint32(144).int32(message.denoise);
         }
+        if (message.ehdrEnabled !== false) {
+            writer.uint32(168).bool(message.ehdrEnabled);
+        }
+        if (message.ehdrExposureMinNumber !== 0) {
+            writer.uint32(176).int32(message.ehdrExposureMinNumber);
+        }
+        if (message.ehdrExposureMaxNumber !== 0) {
+            writer.uint32(184).int32(message.ehdrExposureMaxNumber);
+        }
         if (message.resolution !== 0) {
             writer.uint32(48).int32(message.resolution);
         }
@@ -9736,9 +9763,6 @@ exports.CameraParameters = {
         if (message.camera !== 0) {
             writer.uint32(64).int32(message.camera);
         }
-        if (message.fixedFramerate !== false) {
-            writer.uint32(152).bool(message.fixedFramerate);
-        }
         return writer;
     },
     decode(input, length) {
@@ -9839,6 +9863,27 @@ exports.CameraParameters = {
                     message.denoise = reader.int32();
                     continue;
                 }
+                case 21: {
+                    if (tag !== 168) {
+                        break;
+                    }
+                    message.ehdrEnabled = reader.bool();
+                    continue;
+                }
+                case 22: {
+                    if (tag !== 176) {
+                        break;
+                    }
+                    message.ehdrExposureMinNumber = reader.int32();
+                    continue;
+                }
+                case 23: {
+                    if (tag !== 184) {
+                        break;
+                    }
+                    message.ehdrExposureMaxNumber = reader.int32();
+                    continue;
+                }
                 case 6: {
                     if (tag !== 48) {
                         break;
@@ -9881,13 +9926,6 @@ exports.CameraParameters = {
                     message.camera = reader.int32();
                     continue;
                 }
-                case 19: {
-                    if (tag !== 152) {
-                        break;
-                    }
-                    message.fixedFramerate = reader.bool();
-                    continue;
-                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -9911,13 +9949,15 @@ exports.CameraParameters = {
             sharpness: isSet(object.sharpness) ? gt.Number(object.sharpness) : 0,
             backlightCompensation: isSet(object.backlightCompensation) ? gt.Number(object.backlightCompensation) : 0,
             denoise: isSet(object.denoise) ? gt.Number(object.denoise) : 0,
+            ehdrEnabled: isSet(object.ehdrEnabled) ? gt.Boolean(object.ehdrEnabled) : false,
+            ehdrExposureMinNumber: isSet(object.ehdrExposureMinNumber) ? gt.Number(object.ehdrExposureMinNumber) : 0,
+            ehdrExposureMaxNumber: isSet(object.ehdrExposureMaxNumber) ? gt.Number(object.ehdrExposureMaxNumber) : 0,
             resolution: isSet(object.resolution) ? resolutionFromJSON(object.resolution) : 0,
             streamResolution: isSet(object.streamResolution) ? resolutionFromJSON(object.streamResolution) : 0,
             recordingResolution: isSet(object.recordingResolution) ? resolutionFromJSON(object.recordingResolution) : 0,
             streamingProtocol: isSet(object.streamingProtocol) ? streamingProtocolFromJSON(object.streamingProtocol) : 0,
             framerate: isSet(object.framerate) ? framerateFromJSON(object.framerate) : 0,
             camera: isSet(object.camera) ? cameraFromJSON(object.camera) : 0,
-            fixedFramerate: isSet(object.fixedFramerate) ? gt.Boolean(object.fixedFramerate) : false,
         };
     },
     toJSON(message) {
@@ -9961,6 +10001,15 @@ exports.CameraParameters = {
         if (message.denoise !== 0) {
             obj.denoise = Math.round(message.denoise);
         }
+        if (message.ehdrEnabled !== false) {
+            obj.ehdrEnabled = message.ehdrEnabled;
+        }
+        if (message.ehdrExposureMinNumber !== 0) {
+            obj.ehdrExposureMinNumber = Math.round(message.ehdrExposureMinNumber);
+        }
+        if (message.ehdrExposureMaxNumber !== 0) {
+            obj.ehdrExposureMaxNumber = Math.round(message.ehdrExposureMaxNumber);
+        }
         if (message.resolution !== 0) {
             obj.resolution = resolutionToJSON(message.resolution);
         }
@@ -9979,9 +10028,6 @@ exports.CameraParameters = {
         if (message.camera !== 0) {
             obj.camera = cameraToJSON(message.camera);
         }
-        if (message.fixedFramerate !== false) {
-            obj.fixedFramerate = message.fixedFramerate;
-        }
         return obj;
     },
     create(base) {
@@ -10002,13 +10048,15 @@ exports.CameraParameters = {
         message.sharpness = object.sharpness ?? 0;
         message.backlightCompensation = object.backlightCompensation ?? 0;
         message.denoise = object.denoise ?? 0;
+        message.ehdrEnabled = object.ehdrEnabled ?? false;
+        message.ehdrExposureMinNumber = object.ehdrExposureMinNumber ?? 0;
+        message.ehdrExposureMaxNumber = object.ehdrExposureMaxNumber ?? 0;
         message.resolution = object.resolution ?? 0;
         message.streamResolution = object.streamResolution ?? 0;
         message.recordingResolution = object.recordingResolution ?? 0;
         message.streamingProtocol = object.streamingProtocol ?? 0;
         message.framerate = object.framerate ?? 0;
         message.camera = object.camera ?? 0;
-        message.fixedFramerate = object.fixedFramerate ?? false;
         return message;
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueyerobotics/protocol-definitions",
-  "version": "3.2.0-7ccc4a0d",
+  "version": "3.2.0-82141b1d",
   "license": "LGPL-3.0-only",
   "description": "TypeScript definitions for Blueye Robotics protocols",
   "repository": {