@camstack/types 0.1.35 → 0.1.37

package/dist/capabilities/stream-params.cap.d.ts

@@ -0,0 +1,482 @@
+import { z } from 'zod';
+import { type InferNativeProvider } from './capability-definition.js';
+import { DeviceType } from '../device/device-type.js';
+/** One of the camera's stream profiles. */
+export declare const StreamProfileSchema: z.ZodEnum<{
+    sub: "sub";
+    main: "main";
+    ext: "ext";
+}>;
+/** The current encoding config of one stream profile. */
+declare const StreamProfileConfigSchema: z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    codec: z.ZodEnum<{
+        h264: "h264";
+        h265: "h265";
+    }>;
+    framerate: z.ZodNumber;
+    bitrate: z.ZodNumber;
+    bitrateMode: z.ZodOptional<z.ZodEnum<{
+        vbr: "vbr";
+        cbr: "cbr";
+    }>>;
+    encoderProfile: z.ZodOptional<z.ZodEnum<{
+        high: "high";
+        main: "main";
+        baseline: "baseline";
+    }>>;
+    gop: z.ZodOptional<z.ZodNumber>;
+    audio: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const StreamParamsStatusSchema: z.ZodObject<{
+    main: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        codec: z.ZodEnum<{
+            h264: "h264";
+            h265: "h265";
+        }>;
+        framerate: z.ZodNumber;
+        bitrate: z.ZodNumber;
+        bitrateMode: z.ZodOptional<z.ZodEnum<{
+            vbr: "vbr";
+            cbr: "cbr";
+        }>>;
+        encoderProfile: z.ZodOptional<z.ZodEnum<{
+            high: "high";
+            main: "main";
+            baseline: "baseline";
+        }>>;
+        gop: z.ZodOptional<z.ZodNumber>;
+        audio: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    sub: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        codec: z.ZodEnum<{
+            h264: "h264";
+            h265: "h265";
+        }>;
+        framerate: z.ZodNumber;
+        bitrate: z.ZodNumber;
+        bitrateMode: z.ZodOptional<z.ZodEnum<{
+            vbr: "vbr";
+            cbr: "cbr";
+        }>>;
+        encoderProfile: z.ZodOptional<z.ZodEnum<{
+            high: "high";
+            main: "main";
+            baseline: "baseline";
+        }>>;
+        gop: z.ZodOptional<z.ZodNumber>;
+        audio: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    ext: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        codec: z.ZodEnum<{
+            h264: "h264";
+            h265: "h265";
+        }>;
+        framerate: z.ZodNumber;
+        bitrate: z.ZodNumber;
+        bitrateMode: z.ZodOptional<z.ZodEnum<{
+            vbr: "vbr";
+            cbr: "cbr";
+        }>>;
+        encoderProfile: z.ZodOptional<z.ZodEnum<{
+            high: "high";
+            main: "main";
+            baseline: "baseline";
+        }>>;
+        gop: z.ZodOptional<z.ZodNumber>;
+        audio: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    lastFetchedAt: z.ZodNumber;
+}, z.core.$strip>;
+/** What a profile CAN be set to — drives the UI selectors. */
+declare const StreamProfileOptionsSchema: z.ZodObject<{
+    resolutions: z.ZodArray<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+    codecs: z.ZodArray<z.ZodEnum<{
+        h264: "h264";
+        h265: "h265";
+    }>>;
+    framerates: z.ZodArray<z.ZodNumber>;
+    bitrates: z.ZodArray<z.ZodNumber>;
+    bitrateRange: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    supportsBitrateMode: z.ZodBoolean;
+    supportsEncoderProfile: z.ZodBoolean;
+    supportsGop: z.ZodBoolean;
+    gop: z.ZodOptional<z.ZodObject<{
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+        step: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const StreamParamsOptionsSchema: z.ZodObject<{
+    main: z.ZodOptional<z.ZodObject<{
+        resolutions: z.ZodArray<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        codecs: z.ZodArray<z.ZodEnum<{
+            h264: "h264";
+            h265: "h265";
+        }>>;
+        framerates: z.ZodArray<z.ZodNumber>;
+        bitrates: z.ZodArray<z.ZodNumber>;
+        bitrateRange: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        supportsBitrateMode: z.ZodBoolean;
+        supportsEncoderProfile: z.ZodBoolean;
+        supportsGop: z.ZodBoolean;
+        gop: z.ZodOptional<z.ZodObject<{
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+            step: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    sub: z.ZodOptional<z.ZodObject<{
+        resolutions: z.ZodArray<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        codecs: z.ZodArray<z.ZodEnum<{
+            h264: "h264";
+            h265: "h265";
+        }>>;
+        framerates: z.ZodArray<z.ZodNumber>;
+        bitrates: z.ZodArray<z.ZodNumber>;
+        bitrateRange: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        supportsBitrateMode: z.ZodBoolean;
+        supportsEncoderProfile: z.ZodBoolean;
+        supportsGop: z.ZodBoolean;
+        gop: z.ZodOptional<z.ZodObject<{
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+            step: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    ext: z.ZodOptional<z.ZodObject<{
+        resolutions: z.ZodArray<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        codecs: z.ZodArray<z.ZodEnum<{
+            h264: "h264";
+            h265: "h265";
+        }>>;
+        framerates: z.ZodArray<z.ZodNumber>;
+        bitrates: z.ZodArray<z.ZodNumber>;
+        bitrateRange: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        supportsBitrateMode: z.ZodBoolean;
+        supportsEncoderProfile: z.ZodBoolean;
+        supportsGop: z.ZodBoolean;
+        gop: z.ZodOptional<z.ZodObject<{
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+            step: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** A partial change to one profile — every field optional; a provider
+ *  ignores fields it doesn't support. */
+export declare const StreamProfilePatchSchema: z.ZodObject<{
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    codec: z.ZodOptional<z.ZodEnum<{
+        h264: "h264";
+        h265: "h265";
+    }>>;
+    framerate: z.ZodOptional<z.ZodNumber>;
+    bitrate: z.ZodOptional<z.ZodNumber>;
+    bitrateMode: z.ZodOptional<z.ZodEnum<{
+        vbr: "vbr";
+        cbr: "cbr";
+    }>>;
+    encoderProfile: z.ZodOptional<z.ZodEnum<{
+        high: "high";
+        main: "main";
+        baseline: "baseline";
+    }>>;
+    gop: z.ZodOptional<z.ZodNumber>;
+    audio: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type StreamParamsStatus = z.infer<typeof StreamParamsStatusSchema>;
+export type StreamParamsOptions = z.infer<typeof StreamParamsOptionsSchema>;
+export type StreamProfile = z.infer<typeof StreamProfileSchema>;
+export type StreamProfilePatch = z.infer<typeof StreamProfilePatchSchema>;
+export declare const streamParamsCapability: {
+    readonly name: "stream-params";
+    readonly scope: "device";
+    readonly mode: "singleton";
+    readonly deviceTypes: readonly [DeviceType.Camera];
+    readonly deviceConfig: {
+        readonly ui: {
+            readonly kind: "derived-form";
+            readonly builderId: "stream-params";
+            readonly tab: "streaming";
+        };
+    };
+    readonly methods: {
+        readonly getOptions: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceId: z.ZodNumber;
+        }, z.core.$strip>, z.ZodObject<{
+            main: z.ZodOptional<z.ZodObject<{
+                resolutions: z.ZodArray<z.ZodObject<{
+                    width: z.ZodNumber;
+                    height: z.ZodNumber;
+                }, z.core.$strip>>;
+                codecs: z.ZodArray<z.ZodEnum<{
+                    h264: "h264";
+                    h265: "h265";
+                }>>;
+                framerates: z.ZodArray<z.ZodNumber>;
+                bitrates: z.ZodArray<z.ZodNumber>;
+                bitrateRange: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                supportsBitrateMode: z.ZodBoolean;
+                supportsEncoderProfile: z.ZodBoolean;
+                supportsGop: z.ZodBoolean;
+                gop: z.ZodOptional<z.ZodObject<{
+                    min: z.ZodNumber;
+                    max: z.ZodNumber;
+                    step: z.ZodNumber;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+            sub: z.ZodOptional<z.ZodObject<{
+                resolutions: z.ZodArray<z.ZodObject<{
+                    width: z.ZodNumber;
+                    height: z.ZodNumber;
+                }, z.core.$strip>>;
+                codecs: z.ZodArray<z.ZodEnum<{
+                    h264: "h264";
+                    h265: "h265";
+                }>>;
+                framerates: z.ZodArray<z.ZodNumber>;
+                bitrates: z.ZodArray<z.ZodNumber>;
+                bitrateRange: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                supportsBitrateMode: z.ZodBoolean;
+                supportsEncoderProfile: z.ZodBoolean;
+                supportsGop: z.ZodBoolean;
+                gop: z.ZodOptional<z.ZodObject<{
+                    min: z.ZodNumber;
+                    max: z.ZodNumber;
+                    step: z.ZodNumber;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+            ext: z.ZodOptional<z.ZodObject<{
+                resolutions: z.ZodArray<z.ZodObject<{
+                    width: z.ZodNumber;
+                    height: z.ZodNumber;
+                }, z.core.$strip>>;
+                codecs: z.ZodArray<z.ZodEnum<{
+                    h264: "h264";
+                    h265: "h265";
+                }>>;
+                framerates: z.ZodArray<z.ZodNumber>;
+                bitrates: z.ZodArray<z.ZodNumber>;
+                bitrateRange: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                supportsBitrateMode: z.ZodBoolean;
+                supportsEncoderProfile: z.ZodBoolean;
+                supportsGop: z.ZodBoolean;
+                gop: z.ZodOptional<z.ZodObject<{
+                    min: z.ZodNumber;
+                    max: z.ZodNumber;
+                    step: z.ZodNumber;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
+        readonly setProfile: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceId: z.ZodNumber;
+            profile: z.ZodEnum<{
+                sub: "sub";
+                main: "main";
+                ext: "ext";
+            }>;
+            patch: z.ZodObject<{
+                width: z.ZodOptional<z.ZodNumber>;
+                height: z.ZodOptional<z.ZodNumber>;
+                codec: z.ZodOptional<z.ZodEnum<{
+                    h264: "h264";
+                    h265: "h265";
+                }>>;
+                framerate: z.ZodOptional<z.ZodNumber>;
+                bitrate: z.ZodOptional<z.ZodNumber>;
+                bitrateMode: z.ZodOptional<z.ZodEnum<{
+                    vbr: "vbr";
+                    cbr: "cbr";
+                }>>;
+                encoderProfile: z.ZodOptional<z.ZodEnum<{
+                    high: "high";
+                    main: "main";
+                    baseline: "baseline";
+                }>>;
+                gop: z.ZodOptional<z.ZodNumber>;
+                audio: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodVoid, "mutation">;
+        /**
+         * Build the `ConfigUISchema` (admin-ui `ConfigFormBuilder` input
+         * shape) for this camera's stream-encoder settings — one section per
+         * profile (main / sub / ext) with the resolution / codec / framerate
+         * / bitrate / bitrate-mode / encoder-profile / GOP controls the
+         * firmware actually exposes.
+         *
+         * Driven by `getOptions` (camera-probed availability) + `getStatus`
+         * (current per-profile config); each field's `default` is seeded
+         * from the live config so the form renders the camera state in one
+         * pass. Returns `null` when the camera exposes no configurable
+         * stream property — the renderer then shows the unsupported message.
+         *
+         * Output is `z.unknown().nullable()` — the same convention every
+         * other `ConfigUISchema`-returning cap method uses (`device-ops`,
+         * `device-manager`); `ConfigUISchema` is a TS-only type with no
+         * companion Zod schema, and a concrete object would collapse
+         * unrelated AppRouter branches to `unknown` during codegen.
+         */
+        readonly getConfigSchema: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceId: z.ZodNumber;
+        }, z.core.$strip>, z.ZodNullable<z.ZodUnknown>, import("./capability-definition.js").CapabilityMethodKind>;
+    };
+    readonly status: {
+        readonly schema: z.ZodObject<{
+            main: z.ZodOptional<z.ZodObject<{
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+                codec: z.ZodEnum<{
+                    h264: "h264";
+                    h265: "h265";
+                }>;
+                framerate: z.ZodNumber;
+                bitrate: z.ZodNumber;
+                bitrateMode: z.ZodOptional<z.ZodEnum<{
+                    vbr: "vbr";
+                    cbr: "cbr";
+                }>>;
+                encoderProfile: z.ZodOptional<z.ZodEnum<{
+                    high: "high";
+                    main: "main";
+                    baseline: "baseline";
+                }>>;
+                gop: z.ZodOptional<z.ZodNumber>;
+                audio: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>>;
+            sub: z.ZodOptional<z.ZodObject<{
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+                codec: z.ZodEnum<{
+                    h264: "h264";
+                    h265: "h265";
+                }>;
+                framerate: z.ZodNumber;
+                bitrate: z.ZodNumber;
+                bitrateMode: z.ZodOptional<z.ZodEnum<{
+                    vbr: "vbr";
+                    cbr: "cbr";
+                }>>;
+                encoderProfile: z.ZodOptional<z.ZodEnum<{
+                    high: "high";
+                    main: "main";
+                    baseline: "baseline";
+                }>>;
+                gop: z.ZodOptional<z.ZodNumber>;
+                audio: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>>;
+            ext: z.ZodOptional<z.ZodObject<{
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+                codec: z.ZodEnum<{
+                    h264: "h264";
+                    h265: "h265";
+                }>;
+                framerate: z.ZodNumber;
+                bitrate: z.ZodNumber;
+                bitrateMode: z.ZodOptional<z.ZodEnum<{
+                    vbr: "vbr";
+                    cbr: "cbr";
+                }>>;
+                encoderProfile: z.ZodOptional<z.ZodEnum<{
+                    high: "high";
+                    main: "main";
+                    baseline: "baseline";
+                }>>;
+                gop: z.ZodOptional<z.ZodNumber>;
+                audio: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>>;
+            lastFetchedAt: z.ZodNumber;
+        }, z.core.$strip>;
+        readonly kind: "poll";
+    };
+    readonly runtimeState: z.ZodObject<{
+        main: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            codec: z.ZodEnum<{
+                h264: "h264";
+                h265: "h265";
+            }>;
+            framerate: z.ZodNumber;
+            bitrate: z.ZodNumber;
+            bitrateMode: z.ZodOptional<z.ZodEnum<{
+                vbr: "vbr";
+                cbr: "cbr";
+            }>>;
+            encoderProfile: z.ZodOptional<z.ZodEnum<{
+                high: "high";
+                main: "main";
+                baseline: "baseline";
+            }>>;
+            gop: z.ZodOptional<z.ZodNumber>;
+            audio: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        sub: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            codec: z.ZodEnum<{
+                h264: "h264";
+                h265: "h265";
+            }>;
+            framerate: z.ZodNumber;
+            bitrate: z.ZodNumber;
+            bitrateMode: z.ZodOptional<z.ZodEnum<{
+                vbr: "vbr";
+                cbr: "cbr";
+            }>>;
+            encoderProfile: z.ZodOptional<z.ZodEnum<{
+                high: "high";
+                main: "main";
+                baseline: "baseline";
+            }>>;
+            gop: z.ZodOptional<z.ZodNumber>;
+            audio: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        ext: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            codec: z.ZodEnum<{
+                h264: "h264";
+                h265: "h265";
+            }>;
+            framerate: z.ZodNumber;
+            bitrate: z.ZodNumber;
+            bitrateMode: z.ZodOptional<z.ZodEnum<{
+                vbr: "vbr";
+                cbr: "cbr";
+            }>>;
+            encoderProfile: z.ZodOptional<z.ZodEnum<{
+                high: "high";
+                main: "main";
+                baseline: "baseline";
+            }>>;
+            gop: z.ZodOptional<z.ZodNumber>;
+            audio: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        lastFetchedAt: z.ZodNumber;
+    }, z.core.$strip>;
+};
+export type IStreamParamsProvider = InferNativeProvider<typeof streamParamsCapability>;
+export { StreamProfileConfigSchema, StreamProfileOptionsSchema };
+//# sourceMappingURL=stream-params.cap.d.ts.map

package/dist/capabilities/stream-params.cap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-params.cap.d.ts","sourceRoot":"","sources":["../../src/capabilities/stream-params.cap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAqC,KAAK,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AACxG,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAErD,2CAA2C;AAC3C,eAAO,MAAM,mBAAmB;;;;EAAiC,CAAA;AAEjE,yDAAyD;AACzD,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;iBAU7B,CAAA;AAEF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMnC,CAAA;AAEF,8DAA8D;AAC9D,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;iBAgB9B,CAAA;AAEF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIpC,CAAA;AAEF;yCACyC;AACzC,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;iBAUnC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AACzE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAC/D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAEzE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAsB/B;;;;;;;;;;;;;;;;;;WAkBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWkC,CAAA;AAEzC,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAEtF,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,CAAA"}