@camstack/types 0.1.30 → 0.1.32

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

@@ -1,22 +1,12 @@
 import { z } from 'zod';
 import { type InferProvider } from './capability-definition.js';
 import type { IStreamBroker } from '../interfaces/stream-broker.js';
-/**
- * Per-broker RTSP restream entry. The broker exposes the public RTSP
- * restream URL for every active profile slot — consumers read the URL
- * here instead of constructing it from broker internals.
- */
 declare const RtspRestreamEntrySchema: z.ZodObject<{
     brokerId: z.ZodString;
     url: z.ZodString;
     mutedUrl: z.ZodString;
     enabled: z.ZodBoolean;
 }, z.core.$strip>;
-/**
- * Individual-client shapes for the `listClients` roster. One row per
- * consumer of the chosen broker slot (profile) — RTSP sessions,
- * decoded-frame subscribers, audio chunks.
- */
 export declare const BrokerRtspClientSchema: z.ZodObject<{
     sessionId: z.ZodString;
     remoteAddr: z.ZodString;
@@ -67,13 +57,6 @@ export type BrokerRtspClient = z.infer<typeof BrokerRtspClientSchema>;
 export type BrokerDecodedClient = z.infer<typeof BrokerDecodedClientSchema>;
 export type BrokerAudioClient = z.infer<typeof BrokerAudioClientSchema>;
 export type BrokerClients = z.infer<typeof BrokerClientsSchema>;
-/**
- * Reason rendered by the broker's placeholder image while no live RTP
- * is flowing. Each value maps 1:1 to a pre-encoded H.264 keyframe in
- * `addon-stream-broker/.../placeholder-frames.ts`. Keep aligned with
- * `PlaceholderKind` over there — the union here is the public surface
- * (cap input + provider type) and is the single source of truth.
- */
 export declare const PlaceholderReasonSchema: z.ZodEnum<{
     disabled: "disabled";
     reconnecting: "reconnecting";
@@ -82,42 +65,61 @@ export declare const PlaceholderReasonSchema: z.ZodEnum<{
     waking: "waking";
 }>;
 export type PlaceholderReason = z.infer<typeof PlaceholderReasonSchema>;
-/**
- * Stream broker — system-wide singleton cap.
- *
- * Owns two registries per device:
- *   - `cameraStreams`: the pool of physical streams published by device
- *     providers (and potentially third-party addons, e.g. an RTMP
- *     discovery addon). Ephemeral: each provider re-publishes in its
- *     own `onInitialize`.
- *   - `profileMap`: persistent operator-intent mapping
- *     `{high?, mid?, low?} -> camStreamId`. Persisted in the broker's
- *     own storage, not in `device.config`.
- *
- * Up to 3 brokers per device keyed `${deviceId}/${profile}`. Each
- * broker ingests from the URL of the cam stream currently assigned via
- * `profileMap[profile]`. Changing the assignment tears down the broker
- * and rebuilds it against the new source — stream id seen by consumers
- * never changes.
- *
- * Per-device reads (what's published, what's assigned) live on the
- * device-scoped `camera-streams` cap, surfaced via `fetchDevice()`. The
- * methods below are either mutations or system-wide dumps.
- */
+declare const VideoCodecTargetSchema: z.ZodEnum<{
+    auto: "auto";
+    H264: "H264";
+    H265: "H265";
+}>;
+export type VideoCodecTarget = z.infer<typeof VideoCodecTargetSchema>;
+declare const AudioCodecTargetSchema: z.ZodEnum<{
+    none: "none";
+    AAC: "AAC";
+    Opus: "Opus";
+    PCMU: "PCMU";
+}>;
+export type AudioCodecTarget = z.infer<typeof AudioCodecTargetSchema>;
+export declare const GetStreamWithCodecInputSchema: z.ZodObject<{
+    deviceId: z.ZodNumber;
+    videoCodec: z.ZodEnum<{
+        auto: "auto";
+        H264: "H264";
+        H265: "H265";
+    }>;
+    audioCodec: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        AAC: "AAC";
+        Opus: "Opus";
+        PCMU: "PCMU";
+    }>>;
+    maxResolution: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+    tag: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type GetStreamWithCodecInput = z.infer<typeof GetStreamWithCodecInputSchema>;
+export declare const RtpSourceSchema: z.ZodObject<{
+    url: z.ZodString;
+    videoCodec: z.ZodEnum<{
+        H264: "H264";
+        H265: "H265";
+    }>;
+    audioCodec: z.ZodString;
+    resolution: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>;
+    transcoded: z.ZodBoolean;
+    encoder: z.ZodString;
+    pipelineKey: z.ZodString;
+}, z.core.$strip>;
+export type RtpSource = z.infer<typeof RtpSourceSchema>;
 export declare const streamBrokerCapability: {
     readonly name: "stream-broker";
     readonly scope: "system";
     readonly mode: "singleton";
     readonly exposesDeviceSettings: true;
     readonly methods: {
-        /**
-         * Register a physical camera stream as an input option. Idempotent
-         * for (deviceId, camStreamId) — re-publishing updates metadata
-         * without disturbing profile assignments. The provider calls this
-         * in `onInitialize` for each stream it offers. Third-party addons
-         * may also publish (e.g. an RTMP discovery layer) — camstack has
-         * no notion of "owner" beyond the (deviceId, camStreamId) key.
-         */
         readonly publishCameraStream: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             deviceId: z.ZodNumber;
             camStreamId: z.ZodString;
@@ -148,11 +150,6 @@ export declare const streamBrokerCapability: {
         }, z.core.$strip>, z.ZodObject<{
             success: z.ZodLiteral<true>;
         }, z.core.$strip>, "mutation">;
-        /**
-         * Assign a cam stream to a profile slot. Tears down any existing
-         * broker for that slot and rebuilds against the new source. Persists
-         * the choice — survives reboots.
-         */
         readonly assignProfile: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             deviceId: z.ZodNumber;
             profile: z.ZodEnum<{
@@ -174,11 +171,6 @@ export declare const streamBrokerCapability: {
         }, z.core.$strip>, z.ZodObject<{
             success: z.ZodLiteral<true>;
         }, z.core.$strip>, "mutation">;
-        /**
-         * Full dump of every published cam stream across every device.
-         * For dashboards and cross-device tooling; per-device reads go
-         * through the `camera-streams` cap on the device proxy.
-         */
         readonly listAllCameraStreams: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodReadonly<z.ZodArray<z.ZodObject<{
             camStreamId: z.ZodString;
             deviceId: z.ZodNumber;
@@ -296,7 +288,6 @@ export declare const streamBrokerCapability: {
         }, z.core.$strip>, z.ZodObject<{
             killed: z.ZodBoolean;
         }, z.core.$strip>, "mutation">;
-        /** Rebuild the broker for a profile slot in place (re-dial source). */
         readonly restartProfile: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             deviceId: z.ZodNumber;
             profile: z.ZodEnum<{
@@ -319,12 +310,48 @@ export declare const streamBrokerCapability: {
             url: z.ZodString;
         }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
         /**
-         * Return the live IStreamBroker instance for a given brokerId. Same
-         * LOCAL-ONLY contract as before: callers (pipeline-runner) must be
-         * co-located. BrokerId is `${deviceId}/${camStreamId}` — profile
-         * lookup goes through `assignments` if a caller starts from a
-         * profile.
+         * Shared codec-targeted stream API — see Task #184.
+         * Resolution order: source-select → HW transcode → libx264/libx265.
          */
+        readonly getStreamWithCodec: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceId: z.ZodNumber;
+            videoCodec: z.ZodEnum<{
+                auto: "auto";
+                H264: "H264";
+                H265: "H265";
+            }>;
+            audioCodec: z.ZodOptional<z.ZodEnum<{
+                none: "none";
+                AAC: "AAC";
+                Opus: "Opus";
+                PCMU: "PCMU";
+            }>>;
+            maxResolution: z.ZodOptional<z.ZodObject<{
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+            }, z.core.$strip>>;
+            tag: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            url: z.ZodString;
+            videoCodec: z.ZodEnum<{
+                H264: "H264";
+                H265: "H265";
+            }>;
+            audioCodec: z.ZodString;
+            resolution: z.ZodObject<{
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+            }, z.core.$strip>;
+            transcoded: z.ZodBoolean;
+            encoder: z.ZodString;
+            pipelineKey: z.ZodString;
+        }, z.core.$strip>, "mutation">;
+        readonly releaseStreamWithCodec: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            pipelineKey: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            released: z.ZodBoolean;
+            refcount: z.ZodNumber;
+        }, z.core.$strip>, "mutation">;
         readonly getBroker: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             brokerId: z.ZodString;
         }, z.core.$strip>, z.ZodCustom<IStreamBroker | null, IStreamBroker | null>, import("./capability-definition.js").CapabilityMethodKind>;
@@ -369,12 +396,6 @@ export declare const streamBrokerCapability: {
         }, z.core.$strip>, z.ZodBoolean, import("./capability-definition.js").CapabilityMethodKind>;
     };
     readonly events: {
-        /**
-         * Emitted when a profile starts consuming a push-kind cam stream.
-         * Push-kind providers (e.g. Reolink Baichuan native streams)
-         * subscribe and begin emitting packets only on demand — battery
-         * cams stay asleep until someone actually watches.
-         */
         readonly onCamStreamDemand: import("./capability-definition.js").CapabilityEventSchema<z.ZodObject<{
             deviceId: z.ZodNumber;
             camStreamId: z.ZodString;
@@ -384,26 +405,10 @@ export declare const streamBrokerCapability: {
                 low: "low";
             }>;
         }, z.core.$strip>>;
-        /**
-         * Emitted when the last profile consuming a push-kind cam stream
-         * releases it. Providers tear down upstream connections on this
-         * signal.
-         */
         readonly onCamStreamIdle: import("./capability-definition.js").CapabilityEventSchema<z.ZodObject<{
             deviceId: z.ZodNumber;
             camStreamId: z.ZodString;
         }, z.core.$strip>>;
-        /**
-         * Emitted by a broker that failed to dial a managed-loopback
-         * source (today: `pull-rfc4571`). The publisher's transport (e.g.
-         * the Reolink lib's RFC 4571 TCP server) idle-tears-down after
-         * ~15s with no clients and may rebind to a different port on
-         * recreate, leaving the URL the broker has cached stale. The owning
-         * camera provider re-runs its publish pipeline on receipt — that
-         * call self-heals the loopback server (`ensureRfc4571Server`) and
-         * `publishCameraStream` propagates the fresh URL back into the
-         * broker's source resolver.
-         */
         readonly onRequestStreamSourceRefresh: import("./capability-definition.js").CapabilityEventSchema<z.ZodObject<{
             deviceId: z.ZodNumber;
             camStreamId: z.ZodString;

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

@@ -1 +1 @@
-{"version":3,"file":"stream-broker.cap.d.ts","sourceRoot":"","sources":["../../src/capabilities/stream-broker.cap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAA4C,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAMzG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAA;AAEnE;;;;GAIG;AACH,QAAA,MAAM,uBAAuB;;;;;iBAK3B,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;iBAQjC,CAAA;AAEF,eAAO,MAAM,yBAAyB;;;;;;iBAMpC,CAAA;AAEF,eAAO,MAAM,uBAAuB;;;;iBAIlC,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;iBAM9B,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AACvE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;EAMlC,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAEvE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,sBAAsB;;;;;;QAO/B;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAkDH;;;;WAIG;;;;;;;;;;;;;;;;;;;;;;QAoBH;;;;WAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA4BH,uEAAuE;;;;;;;;;;;;;;;;;;;;;;QAiBvE;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA2CH;;;;;WAKG;;;;;;;;;;QAMH;;;;WAIG;;;;;QAKH;;;;;;;;;;WAUG;;;;;;;CAOkC,CAAA;AAEzC,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAEhF,OAAO,EAAE,uBAAuB,EAAE,CAAA"}
+{"version":3,"file":"stream-broker.cap.d.ts","sourceRoot":"","sources":["../../src/capabilities/stream-broker.cap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAA4C,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAMzG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAA;AAEnE,QAAA,MAAM,uBAAuB;;;;;iBAK3B,CAAA;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;iBAQjC,CAAA;AAEF,eAAO,MAAM,yBAAyB;;;;;;iBAMpC,CAAA;AAEF,eAAO,MAAM,uBAAuB;;;;iBAIlC,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;iBAM9B,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AACvE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,eAAO,MAAM,uBAAuB;;;;;;EAMlC,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAIvE,QAAA,MAAM,sBAAsB;;;;EAAmC,CAAA;AAC/D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAErE,QAAA,MAAM,sBAAsB;;;;;EAA0C,CAAA;AACtE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAOrE,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;iBAMxC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEnF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;iBAQ1B,CAAA;AACF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAEvD,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqF/B;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgEkC,CAAA;AAEzC,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAEhF,OAAO,EAAE,uBAAuB,EAAE,CAAA"}