@awarevue/api-types 2.0.144 → 2.0.146

package/dist/api/commands/playback-server.d.ts

@@ -0,0 +1,440 @@
+import { z } from 'zod';
+export declare const sPlaybackSessionId: z.ZodString;
+export declare const sPlaybackSessionCamera: z.ZodObject<{
+    camera: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodObject<{
+        name: z.ZodString;
+        foreignRef: z.ZodString;
+        provider: z.ZodString;
+        providerMetadata: z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>;
+        presets: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            params: z.ZodUnknown;
+            isDefault: z.ZodBoolean;
+            assignedRef: z.ZodNullable<z.ZodString>;
+            createdOn: z.ZodString;
+            lastModifiedOn: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"alarm">;
+    }, z.core.$strip>, z.ZodObject<{
+        ptzCapable: z.ZodBoolean;
+        ptzPanSpeed: z.ZodNumber;
+        ptzTiltSpeed: z.ZodNumber;
+        ptzZoomSpeed: z.ZodNumber;
+        panMin: z.ZodNumber;
+        panMax: z.ZodNumber;
+        tiltMin: z.ZodNumber;
+        tiltMax: z.ZodNumber;
+        zoomMin: z.ZodNumber;
+        zoomMax: z.ZodNumber;
+        streams: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            displayName: z.ZodString;
+            externalPlayerUrl: z.ZodNullable<z.ZodString>;
+            rtspUrl: z.ZodNullable<z.ZodString>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+            lensType: z.ZodEnum<{
+                flat: "flat";
+                fisheye: "fisheye";
+            }>;
+            mountPoint: z.ZodEnum<{
+                wall: "wall";
+                ceiling: "ceiling";
+                floor: "floor";
+            }>;
+        }, z.core.$strip>>;
+        defaultStreamId: z.ZodString;
+        autoSwitchStreams: z.ZodBoolean;
+        streamNaming: z.ZodEnum<{
+            cameraStreamNo: "cameraStreamNo";
+            cameraStream: "cameraStream";
+            stream: "stream";
+        }>;
+        type: z.ZodLiteral<"camera">;
+    }, z.core.$strip>, z.ZodObject<{
+        canReportOpenState: z.ZodBoolean;
+        canReportLockState: z.ZodBoolean;
+        canControlLock: z.ZodBoolean;
+        canRelease: z.ZodBoolean;
+        type: z.ZodLiteral<"door">;
+    }, z.core.$strip>, z.ZodObject<{
+        inputs: z.ZodArray<z.ZodString>;
+        outputs: z.ZodArray<z.ZodString>;
+        type: z.ZodLiteral<"io-board">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"camera-lift">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"motion-sensor">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"generic-sensor">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"panic-button">;
+    }, z.core.$strip>, z.ZodObject<{
+        sipUri: z.ZodString;
+        sipUser: z.ZodString;
+        sipPassword: z.ZodString;
+        sipRealm: z.ZodString;
+        remoteExtension: z.ZodString;
+        type: z.ZodLiteral<"intercom-terminal">;
+    }, z.core.$strip>, z.ZodObject<{
+        sipWsUrl: z.ZodString;
+        type: z.ZodLiteral<"pbx">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"server">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"intercom-operator">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"device-gateway">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"presence-tracker">;
+    }, z.core.$strip>, z.ZodObject<{
+        credentialTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            card: "card";
+            pin: "pin";
+            fingerprint: "fingerprint";
+            face: "face";
+            retina: "retina";
+        }>>>;
+        type: z.ZodLiteral<"reader">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"display">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"nvr-recorder">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"nvr-exporter">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"playback-server">;
+    }, z.core.$strip>, z.ZodObject<{
+        capabilities: z.ZodArray<z.ZodEnum<{
+            motionDetection: "motionDetection";
+            labelDetection: "labelDetection";
+            faceRecognition: "faceRecognition";
+            semanticSearch: "semanticSearch";
+        }>>;
+        type: z.ZodLiteral<"nvr-analytics-server">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position-tracker">;
+    }, z.core.$strip>], "type">>]>, z.ZodTuple<[z.ZodString, z.ZodString], null>]>;
+    streamId: z.ZodString;
+}, z.core.$strip>;
+export type PlaybackSessionCamera = z.infer<typeof sPlaybackSessionCamera>;
+export declare const sOpenPlaybackSessionCommand: z.ZodObject<{
+    command: z.ZodLiteral<"playback-server.open-session">;
+    params: z.ZodObject<{
+        sessionId: z.ZodString;
+        cameras: z.ZodArray<z.ZodObject<{
+            camera: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodObject<{
+                name: z.ZodString;
+                foreignRef: z.ZodString;
+                provider: z.ZodString;
+                providerMetadata: z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>;
+                presets: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    name: z.ZodString;
+                    params: z.ZodUnknown;
+                    isDefault: z.ZodBoolean;
+                    assignedRef: z.ZodNullable<z.ZodString>;
+                    createdOn: z.ZodString;
+                    lastModifiedOn: z.ZodString;
+                }, z.core.$strip>>;
+            }, z.core.$strip>, z.ZodDiscriminatedUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"alarm">;
+            }, z.core.$strip>, z.ZodObject<{
+                ptzCapable: z.ZodBoolean;
+                ptzPanSpeed: z.ZodNumber;
+                ptzTiltSpeed: z.ZodNumber;
+                ptzZoomSpeed: z.ZodNumber;
+                panMin: z.ZodNumber;
+                panMax: z.ZodNumber;
+                tiltMin: z.ZodNumber;
+                tiltMax: z.ZodNumber;
+                zoomMin: z.ZodNumber;
+                zoomMax: z.ZodNumber;
+                streams: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    displayName: z.ZodString;
+                    externalPlayerUrl: z.ZodNullable<z.ZodString>;
+                    rtspUrl: z.ZodNullable<z.ZodString>;
+                    width: z.ZodNullable<z.ZodNumber>;
+                    height: z.ZodNullable<z.ZodNumber>;
+                    lensType: z.ZodEnum<{
+                        flat: "flat";
+                        fisheye: "fisheye";
+                    }>;
+                    mountPoint: z.ZodEnum<{
+                        wall: "wall";
+                        ceiling: "ceiling";
+                        floor: "floor";
+                    }>;
+                }, z.core.$strip>>;
+                defaultStreamId: z.ZodString;
+                autoSwitchStreams: z.ZodBoolean;
+                streamNaming: z.ZodEnum<{
+                    cameraStreamNo: "cameraStreamNo";
+                    cameraStream: "cameraStream";
+                    stream: "stream";
+                }>;
+                type: z.ZodLiteral<"camera">;
+            }, z.core.$strip>, z.ZodObject<{
+                canReportOpenState: z.ZodBoolean;
+                canReportLockState: z.ZodBoolean;
+                canControlLock: z.ZodBoolean;
+                canRelease: z.ZodBoolean;
+                type: z.ZodLiteral<"door">;
+            }, z.core.$strip>, z.ZodObject<{
+                inputs: z.ZodArray<z.ZodString>;
+                outputs: z.ZodArray<z.ZodString>;
+                type: z.ZodLiteral<"io-board">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"camera-lift">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"motion-sensor">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"generic-sensor">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"panic-button">;
+            }, z.core.$strip>, z.ZodObject<{
+                sipUri: z.ZodString;
+                sipUser: z.ZodString;
+                sipPassword: z.ZodString;
+                sipRealm: z.ZodString;
+                remoteExtension: z.ZodString;
+                type: z.ZodLiteral<"intercom-terminal">;
+            }, z.core.$strip>, z.ZodObject<{
+                sipWsUrl: z.ZodString;
+                type: z.ZodLiteral<"pbx">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"server">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"intercom-operator">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"device-gateway">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"presence-tracker">;
+            }, z.core.$strip>, z.ZodObject<{
+                credentialTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    card: "card";
+                    pin: "pin";
+                    fingerprint: "fingerprint";
+                    face: "face";
+                    retina: "retina";
+                }>>>;
+                type: z.ZodLiteral<"reader">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"display">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"nvr-recorder">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"nvr-exporter">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"playback-server">;
+            }, z.core.$strip>, z.ZodObject<{
+                capabilities: z.ZodArray<z.ZodEnum<{
+                    motionDetection: "motionDetection";
+                    labelDetection: "labelDetection";
+                    faceRecognition: "faceRecognition";
+                    semanticSearch: "semanticSearch";
+                }>>;
+                type: z.ZodLiteral<"nvr-analytics-server">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"system">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"position-tracker">;
+            }, z.core.$strip>], "type">>]>, z.ZodTuple<[z.ZodString, z.ZodString], null>]>;
+            streamId: z.ZodString;
+        }, z.core.$strip>>;
+        time: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type OpenPlaybackSessionCommand = z.infer<typeof sOpenPlaybackSessionCommand>;
+export declare const sClosePlaybackSessionCommand: z.ZodObject<{
+    command: z.ZodLiteral<"playback-server.close-session">;
+    params: z.ZodObject<{
+        sessionId: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type ClosePlaybackSessionCommand = z.infer<typeof sClosePlaybackSessionCommand>;
+export declare const sPlayPlaybackSessionCommand: z.ZodObject<{
+    command: z.ZodLiteral<"playback-server.play">;
+    params: z.ZodObject<{
+        sessionId: z.ZodString;
+        rate: z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PlayPlaybackSessionCommand = z.infer<typeof sPlayPlaybackSessionCommand>;
+export declare const sPausePlaybackSessionCommand: z.ZodObject<{
+    command: z.ZodLiteral<"playback-server.pause">;
+    params: z.ZodObject<{
+        sessionId: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PausePlaybackSessionCommand = z.infer<typeof sPausePlaybackSessionCommand>;
+export declare const sSeekPlaybackSessionCommand: z.ZodObject<{
+    command: z.ZodLiteral<"playback-server.seek">;
+    params: z.ZodObject<{
+        sessionId: z.ZodString;
+        time: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type SeekPlaybackSessionCommand = z.infer<typeof sSeekPlaybackSessionCommand>;
+export type PlaybackServerCommand = OpenPlaybackSessionCommand | ClosePlaybackSessionCommand | PlayPlaybackSessionCommand | PausePlaybackSessionCommand | SeekPlaybackSessionCommand;
+export declare const playbackServerCommandSchemas: {
+    readonly 'playback-server.open-session': z.ZodObject<{
+        command: z.ZodLiteral<"playback-server.open-session">;
+        params: z.ZodObject<{
+            sessionId: z.ZodString;
+            cameras: z.ZodArray<z.ZodObject<{
+                camera: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodObject<{
+                    name: z.ZodString;
+                    foreignRef: z.ZodString;
+                    provider: z.ZodString;
+                    providerMetadata: z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>;
+                    presets: z.ZodArray<z.ZodObject<{
+                        id: z.ZodString;
+                        name: z.ZodString;
+                        params: z.ZodUnknown;
+                        isDefault: z.ZodBoolean;
+                        assignedRef: z.ZodNullable<z.ZodString>;
+                        createdOn: z.ZodString;
+                        lastModifiedOn: z.ZodString;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>, z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    type: z.ZodLiteral<"alarm">;
+                }, z.core.$strip>, z.ZodObject<{
+                    ptzCapable: z.ZodBoolean;
+                    ptzPanSpeed: z.ZodNumber;
+                    ptzTiltSpeed: z.ZodNumber;
+                    ptzZoomSpeed: z.ZodNumber;
+                    panMin: z.ZodNumber;
+                    panMax: z.ZodNumber;
+                    tiltMin: z.ZodNumber;
+                    tiltMax: z.ZodNumber;
+                    zoomMin: z.ZodNumber;
+                    zoomMax: z.ZodNumber;
+                    streams: z.ZodArray<z.ZodObject<{
+                        id: z.ZodString;
+                        displayName: z.ZodString;
+                        externalPlayerUrl: z.ZodNullable<z.ZodString>;
+                        rtspUrl: z.ZodNullable<z.ZodString>;
+                        width: z.ZodNullable<z.ZodNumber>;
+                        height: z.ZodNullable<z.ZodNumber>;
+                        lensType: z.ZodEnum<{
+                            flat: "flat";
+                            fisheye: "fisheye";
+                        }>;
+                        mountPoint: z.ZodEnum<{
+                            wall: "wall";
+                            ceiling: "ceiling";
+                            floor: "floor";
+                        }>;
+                    }, z.core.$strip>>;
+                    defaultStreamId: z.ZodString;
+                    autoSwitchStreams: z.ZodBoolean;
+                    streamNaming: z.ZodEnum<{
+                        cameraStreamNo: "cameraStreamNo";
+                        cameraStream: "cameraStream";
+                        stream: "stream";
+                    }>;
+                    type: z.ZodLiteral<"camera">;
+                }, z.core.$strip>, z.ZodObject<{
+                    canReportOpenState: z.ZodBoolean;
+                    canReportLockState: z.ZodBoolean;
+                    canControlLock: z.ZodBoolean;
+                    canRelease: z.ZodBoolean;
+                    type: z.ZodLiteral<"door">;
+                }, z.core.$strip>, z.ZodObject<{
+                    inputs: z.ZodArray<z.ZodString>;
+                    outputs: z.ZodArray<z.ZodString>;
+                    type: z.ZodLiteral<"io-board">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"camera-lift">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"motion-sensor">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"generic-sensor">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"panic-button">;
+                }, z.core.$strip>, z.ZodObject<{
+                    sipUri: z.ZodString;
+                    sipUser: z.ZodString;
+                    sipPassword: z.ZodString;
+                    sipRealm: z.ZodString;
+                    remoteExtension: z.ZodString;
+                    type: z.ZodLiteral<"intercom-terminal">;
+                }, z.core.$strip>, z.ZodObject<{
+                    sipWsUrl: z.ZodString;
+                    type: z.ZodLiteral<"pbx">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"server">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"intercom-operator">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"device-gateway">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"presence-tracker">;
+                }, z.core.$strip>, z.ZodObject<{
+                    credentialTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                        card: "card";
+                        pin: "pin";
+                        fingerprint: "fingerprint";
+                        face: "face";
+                        retina: "retina";
+                    }>>>;
+                    type: z.ZodLiteral<"reader">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"display">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"nvr-recorder">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"nvr-exporter">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"playback-server">;
+                }, z.core.$strip>, z.ZodObject<{
+                    capabilities: z.ZodArray<z.ZodEnum<{
+                        motionDetection: "motionDetection";
+                        labelDetection: "labelDetection";
+                        faceRecognition: "faceRecognition";
+                        semanticSearch: "semanticSearch";
+                    }>>;
+                    type: z.ZodLiteral<"nvr-analytics-server">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"system">;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"position-tracker">;
+                }, z.core.$strip>], "type">>]>, z.ZodTuple<[z.ZodString, z.ZodString], null>]>;
+                streamId: z.ZodString;
+            }, z.core.$strip>>;
+            time: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    readonly 'playback-server.close-session': z.ZodObject<{
+        command: z.ZodLiteral<"playback-server.close-session">;
+        params: z.ZodObject<{
+            sessionId: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    readonly 'playback-server.play': z.ZodObject<{
+        command: z.ZodLiteral<"playback-server.play">;
+        params: z.ZodObject<{
+            sessionId: z.ZodString;
+            rate: z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    readonly 'playback-server.pause': z.ZodObject<{
+        command: z.ZodLiteral<"playback-server.pause">;
+        params: z.ZodObject<{
+            sessionId: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    readonly 'playback-server.seek': z.ZodObject<{
+        command: z.ZodLiteral<"playback-server.seek">;
+        params: z.ZodObject<{
+            sessionId: z.ZodString;
+            time: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+};

package/dist/api/commands/playback-server.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playbackServerCommandSchemas = exports.sSeekPlaybackSessionCommand = exports.sPausePlaybackSessionCommand = exports.sPlayPlaybackSessionCommand = exports.sClosePlaybackSessionCommand = exports.sOpenPlaybackSessionCommand = exports.sPlaybackSessionCamera = exports.sPlaybackSessionId = void 0;
+const primitives_1 = require("../../primitives");
+const zod_1 = require("zod");
+// A playback session is named by its caller, so the same name can be
+// commanded again (idempotently) and agreed on in advance.
+exports.sPlaybackSessionId = zod_1.z
+    .string()
+    .regex(/^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/)
+    .describe('Name of the playback session, chosen by the caller: a letter or digit, then up to 63 letters, digits, ".", "_" or "-"');
+exports.sPlaybackSessionCamera = zod_1.z.object({
+    camera: primitives_1.sDeviceParam,
+    streamId: zod_1.z.string().nonempty(),
+});
+// COMMANDS
+exports.sOpenPlaybackSessionCommand = zod_1.z.object({
+    command: zod_1.z.literal('playback-server.open-session'),
+    params: zod_1.z.object({
+        sessionId: exports.sPlaybackSessionId,
+        cameras: zod_1.z
+            .array(exports.sPlaybackSessionCamera)
+            .min(1)
+            .describe('The complete list of cameras in the session; sent for an existing session it replaces the list'),
+        time: zod_1.z
+            .number()
+            .int()
+            .positive()
+            .describe('Initial position (unix ms); applies only when the session is created'),
+    }),
+});
+exports.sClosePlaybackSessionCommand = zod_1.z.object({
+    command: zod_1.z.literal('playback-server.close-session'),
+    params: zod_1.z.object({
+        sessionId: exports.sPlaybackSessionId,
+    }),
+});
+exports.sPlayPlaybackSessionCommand = zod_1.z.object({
+    command: zod_1.z.literal('playback-server.play'),
+    params: zod_1.z.object({
+        sessionId: exports.sPlaybackSessionId,
+        rate: zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2)]),
+    }),
+});
+exports.sPausePlaybackSessionCommand = zod_1.z.object({
+    command: zod_1.z.literal('playback-server.pause'),
+    params: zod_1.z.object({
+        sessionId: exports.sPlaybackSessionId,
+    }),
+});
+exports.sSeekPlaybackSessionCommand = zod_1.z.object({
+    command: zod_1.z.literal('playback-server.seek'),
+    params: zod_1.z.object({
+        sessionId: exports.sPlaybackSessionId,
+        time: zod_1.z.number().int().positive().describe('Position (unix ms)'),
+    }),
+});
+exports.playbackServerCommandSchemas = {
+    'playback-server.open-session': exports.sOpenPlaybackSessionCommand,
+    'playback-server.close-session': exports.sClosePlaybackSessionCommand,
+    'playback-server.play': exports.sPlayPlaybackSessionCommand,
+    'playback-server.pause': exports.sPausePlaybackSessionCommand,
+    'playback-server.seek': exports.sSeekPlaybackSessionCommand,
+};

package/dist/api/commands/server.d.ts

@@ -111,6 +111,8 @@ export declare const sNotify: z.ZodObject<{
             type: z.ZodLiteral<"nvr-recorder">;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"nvr-exporter">;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"playback-server">;
         }, z.core.$strip>, z.ZodObject<{
             capabilities: z.ZodArray<z.ZodEnum<{
                 motionDetection: "motionDetection";
@@ -250,6 +252,8 @@ export declare const serverCommands: {
                 type: z.ZodLiteral<"nvr-recorder">;
             }, z.core.$strip>, z.ZodObject<{
                 type: z.ZodLiteral<"nvr-exporter">;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"playback-server">;
             }, z.core.$strip>, z.ZodObject<{
                 capabilities: z.ZodArray<z.ZodEnum<{
                     motionDetection: "motionDetection";

package/dist/api/events/all.d.ts

@@ -9,6 +9,7 @@ import { PresenceTrackerEvent } from './presence-tracker';
 import { ReaderEvent } from './reader';
 import { ServerEvent } from './server';
 import { NvrExporterEvent } from './nvr-exporter';
+import { PlaybackServerEvent } from './playback-server';
 import { DeviceType } from '../../objects/device';
 import { NotificationSeverity } from '../../primitives';
 export declare const sDeviceCommandTriggered: z.ZodObject<{
@@ -49,7 +50,7 @@ export interface NotificationAcknowledgedEvent {
     kind: 'notification-acknowledged';
     notificationId: string;
 }
-export type AnyDeviceEvent = DeviceCommandTriggered | CameraEvent | DoorEvent | AlarmEvent | MotionDetectedEvent | ReaderEvent | PanicButtonEvent | DeviceConnectedEvent | DeviceDisconnectedEvent | NotificationCreatedEvent | NotificationAcknowledgedEvent | IntercomTerminalEvent | ServerEvent | PresenceTrackerEvent | IoBoardEvent | NvrExporterEvent | SensorActivatedEvent;
+export type AnyDeviceEvent = DeviceCommandTriggered | CameraEvent | DoorEvent | AlarmEvent | MotionDetectedEvent | ReaderEvent | PanicButtonEvent | DeviceConnectedEvent | DeviceDisconnectedEvent | NotificationCreatedEvent | NotificationAcknowledgedEvent | IntercomTerminalEvent | ServerEvent | PresenceTrackerEvent | IoBoardEvent | NvrExporterEvent | PlaybackServerEvent | SensorActivatedEvent;
 export declare const sEventHeader: z.ZodObject<{
     id: z.ZodString;
     timestamp: z.ZodNumber;
@@ -80,6 +81,20 @@ export declare const eventSchemaByKind: {
     'sensor-activated': z.ZodObject<{
         kind: z.ZodLiteral<"sensor-activated">;
     }, z.core.$strip>;
+    'playback-session-opened': z.ZodObject<{
+        kind: z.ZodLiteral<"playback-session-opened">;
+        sessionId: z.ZodString;
+    }, z.core.$strip>;
+    'playback-session-closed': z.ZodObject<{
+        kind: z.ZodLiteral<"playback-session-closed">;
+        sessionId: z.ZodString;
+        reason: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    'playback-session-link-issued': z.ZodObject<{
+        kind: z.ZodLiteral<"playback-session-link-issued">;
+        sessionId: z.ZodString;
+        userId: z.ZodString;
+    }, z.core.$strip>;
     'nvr-export-started': z.ZodObject<{
         kind: z.ZodLiteral<"nvr-export-started">;
         exportId: z.ZodString;

package/dist/api/events/all.js

@@ -11,6 +11,7 @@ const panic_button_1 = require("./panic-button");
 const presence_tracker_1 = require("./presence-tracker");
 const reader_1 = require("./reader");
 const nvr_exporter_1 = require("./nvr-exporter");
+const playback_server_1 = require("./playback-server");
 exports.sDeviceCommandTriggered = zod_1.z.object({
     kind: zod_1.z.literal('device-command'),
     userId: zod_1.z.string().nonempty().optional(),
@@ -84,6 +85,9 @@ exports.eventKindLabels = {
     'door-closed': 'Door Closed',
     'nvr-export-started': 'NVR Export Started',
     'nvr-export-deleted': 'NVR Export Deleted',
+    'playback-session-opened': 'Playback Session Opened',
+    'playback-session-closed': 'Playback Session Closed',
+    'playback-session-link-issued': 'Playback Session Link Issued',
     'notification-created': 'Notification Created',
     'notification-acknowledged': 'Notification Acknowledged',
     'user-logged-in': 'User Logged In',
@@ -102,6 +106,7 @@ exports.eventSchemaByKind = {
     ...presence_tracker_1.presenceTrackerEventSchemaByKind,
     ...reader_1.readerEventSchemaByKind,
     ...nvr_exporter_1.nvrExporterEventSchemasByKind,
+    ...playback_server_1.playbackServerEventSchemasByKind,
     'motion-detected': exports.sMotionDetected,
     'device-command': exports.sDeviceCommandTriggered,
     'device-connected': exports.sDeviceConnectedEvent,
@@ -118,6 +123,7 @@ exports.eventsByDeviceType = {
     'motion-sensor': ['motion-detected'],
     'generic-sensor': ['sensor-activated'],
     'nvr-exporter': Object.keys(nvr_exporter_1.nvrExporterEventSchemasByKind),
+    'playback-server': Object.keys(playback_server_1.playbackServerEventSchemasByKind),
 };
 const isDeviceEvent = (event) => {
     if (typeof event !== 'object' || event === null)

package/dist/api/events/index.d.ts

@@ -9,4 +9,5 @@ export * from './alarm';
 export * from './presence-tracker';
 export * from './display';
 export * from './nvr-exporter';
+export * from './playback-server';
 export * from './all';

package/dist/api/events/index.js

@@ -25,4 +25,5 @@ __exportStar(require("./alarm"), exports);
 __exportStar(require("./presence-tracker"), exports);
 __exportStar(require("./display"), exports);
 __exportStar(require("./nvr-exporter"), exports);
+__exportStar(require("./playback-server"), exports);
 __exportStar(require("./all"), exports);

package/dist/api/events/playback-server.d.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+export declare const sPlaybackSessionOpened: z.ZodObject<{
+    kind: z.ZodLiteral<"playback-session-opened">;
+    sessionId: z.ZodString;
+}, z.core.$strip>;
+export type PlaybackSessionOpened = z.infer<typeof sPlaybackSessionOpened>;
+export declare const sPlaybackSessionClosed: z.ZodObject<{
+    kind: z.ZodLiteral<"playback-session-closed">;
+    sessionId: z.ZodString;
+    reason: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PlaybackSessionClosed = z.infer<typeof sPlaybackSessionClosed>;
+export declare const sPlaybackSessionLinkIssued: z.ZodObject<{
+    kind: z.ZodLiteral<"playback-session-link-issued">;
+    sessionId: z.ZodString;
+    userId: z.ZodString;
+}, z.core.$strip>;
+export type PlaybackSessionLinkIssued = z.infer<typeof sPlaybackSessionLinkIssued>;
+export type PlaybackServerEvent = PlaybackSessionOpened | PlaybackSessionClosed | PlaybackSessionLinkIssued;
+export declare const playbackServerEventSchemasByKind: {
+    readonly 'playback-session-opened': z.ZodObject<{
+        kind: z.ZodLiteral<"playback-session-opened">;
+        sessionId: z.ZodString;
+    }, z.core.$strip>;
+    readonly 'playback-session-closed': z.ZodObject<{
+        kind: z.ZodLiteral<"playback-session-closed">;
+        sessionId: z.ZodString;
+        reason: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly 'playback-session-link-issued': z.ZodObject<{
+        kind: z.ZodLiteral<"playback-session-link-issued">;
+        sessionId: z.ZodString;
+        userId: z.ZodString;
+    }, z.core.$strip>;
+};

package/dist/api/events/playback-server.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playbackServerEventSchemasByKind = exports.sPlaybackSessionLinkIssued = exports.sPlaybackSessionClosed = exports.sPlaybackSessionOpened = void 0;
+const zod_1 = require("zod");
+// EVENTS
+exports.sPlaybackSessionOpened = zod_1.z.object({
+    kind: zod_1.z.literal('playback-session-opened'),
+    sessionId: zod_1.z.string().nonempty(),
+});
+exports.sPlaybackSessionClosed = zod_1.z.object({
+    kind: zod_1.z.literal('playback-session-closed'),
+    sessionId: zod_1.z.string().nonempty(),
+    reason: zod_1.z
+        .string()
+        .optional()
+        .describe('"closed" when closed by a command, "ended" when the session ended by itself'),
+});
+// Records who was given a viewer link to which session. Never carries the link.
+exports.sPlaybackSessionLinkIssued = zod_1.z.object({
+    kind: zod_1.z.literal('playback-session-link-issued'),
+    sessionId: zod_1.z.string().nonempty(),
+    userId: zod_1.z.string(),
+});
+exports.playbackServerEventSchemasByKind = {
+    'playback-session-opened': exports.sPlaybackSessionOpened,
+    'playback-session-closed': exports.sPlaybackSessionClosed,
+    'playback-session-link-issued': exports.sPlaybackSessionLinkIssued,
+};