@norskvideo/norsk-sdk 1.0.344 → 1.0.345

package/dist/norsk-sdk.d.ts

@@ -1577,6 +1577,12 @@ export declare interface Interval {
     d: number;
 }
 
+/** @public */
+export declare interface IntervalTimestamp {
+    n: number;
+    d: number;
+}
+
 /**
  * @public
  * see: {@link NorskTransform.jitterBuffer}
@@ -1825,6 +1831,10 @@ export declare class Norsk {
      * Implements the {@link NorskProcessor} interface
      */
     processor: NorskProcessor;
+    /**
+     * Implements the {@link NorskDebug} interface
+     */
+    debug: NorskDebug;
     /**
      * Implements the {@link NorskSystem} interface
      */
@@ -1870,6 +1880,17 @@ export declare interface NorskControl {
     audioMeasureLevels(settings: AudioMeasureLevelsSettings): Promise<AudioMeasureLevelsNode>;
 }
 
+/**
+ * @public
+ * Methods that allow you to inspect a system (typically during development)
+ */
+export declare interface NorskDebug {
+    /** Creates a node to intercept all the timestamps of any subscribed stream
+     * @param settings - Configuration for the report node
+     */
+    streamTimestampReport(settings: StreamTimestampReportSettings): Promise<StreamTimestampReportNode>;
+}
+
 /**
  * @public
  * Methods that allow you to both ingest and egest media from your application
@@ -3563,6 +3584,23 @@ export declare interface StreamTimestampNudgeSettings extends ProcessorNodeSetti
     nudge?: number;
 }
 
+/**
+ * @public
+ * see: {@link NorskDebug.streamTimestampReport}
+ */
+export declare class StreamTimestampReportNode extends AutoSinkMediaNode<string> {
+    close(): void;
+}
+
+/**
+ * @public
+ * Settings to control MP4 file output
+ * see {@link NorskOutput.fileMp4}
+ */
+export declare interface StreamTimestampReportSettings extends SinkNodeSettings<StreamTimestampReportNode> {
+    onTimestamp?: (streamKey: StreamKey, timestamp: IntervalTimestamp) => Promise<void>;
+}
+
 export declare interface SubscribeDestination {
     id?: string;
     sourceContextChange(responseCallback: (error?: SubscriptionError) => void): Promise<boolean>;

package/lib/src/media_nodes/debug.d.ts

@@ -0,0 +1,28 @@
+import { AutoSinkMediaNode, SinkNodeSettings } from "./common";
+import { IntervalTimestamp, StreamKey } from "./types";
+/**
+ * @public
+ * Settings to control MP4 file output
+ * see {@link NorskOutput.fileMp4}
+ */
+export interface StreamTimestampReportSettings extends SinkNodeSettings<StreamTimestampReportNode> {
+    onTimestamp?: (streamKey: StreamKey, timestamp: IntervalTimestamp) => Promise<void>;
+}
+/**
+ * @public
+ * see: {@link NorskDebug.streamTimestampReport}
+ */
+export declare class StreamTimestampReportNode extends AutoSinkMediaNode<string> {
+    close(): void;
+}
+/**
+ * @public
+ * Methods that allow you to inspect a system (typically during development)
+ */
+export interface NorskDebug {
+    /** Creates a node to intercept all the timestamps of any subscribed stream
+     * @param settings - Configuration for the report node
+     */
+    streamTimestampReport(settings: StreamTimestampReportSettings): Promise<StreamTimestampReportNode>;
+}
+//# sourceMappingURL=debug.d.ts.map

package/lib/src/media_nodes/debug.js

@@ -0,0 +1,81 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamTimestampReportNode = void 0;
+const media_pb_1 = require("@norskvideo/norsk-api/lib/media_pb");
+const common_1 = require("./common");
+const media_pb_2 = require("@norskvideo/norsk-api/lib/media_pb");
+const types_1 = require("./types");
+/**
+ * @public
+ * see: {@link NorskDebug.streamTimestampReport}
+ */
+class StreamTimestampReportNode extends common_1.AutoSinkMediaNode {
+    /** @internal */
+    constructor(settings, client, unregisterNode) {
+        super(client, () => this.grpcStream, (subscription) => __awaiter(this, void 0, void 0, function* () {
+            return this.grpcStream.write((0, common_1.provideFull)(media_pb_1.StreamTimestampReportMessage, (0, common_1.mkMessageCase)({ subscription })));
+        }), settings.onSubscriptionError);
+        const config = (0, common_1.provideFull)(media_pb_1.StreamTimestampReportConfiguration, {
+            id: settings.id ? (0, common_1.provideFull)(media_pb_2.MediaNodeId, {
+                id: settings.id
+            }) : undefined
+        });
+        this.grpcStream = this.client.createDebugStreamTimestampReport();
+        this.grpcStream.write((0, common_1.provideFull)(media_pb_1.StreamTimestampReportMessage, (0, common_1.mkMessageCase)({ configuration: config })));
+        this.initialised = new Promise((resolve, reject) => {
+            this.grpcStream.on("data", (data) => {
+                const messageCase = data.message.case;
+                switch (messageCase) {
+                    case undefined:
+                        break;
+                    case "subscriptionResponse":
+                        super.subscriptionResponse(data.message.value);
+                        break;
+                    case "nodeId": {
+                        this.id = data.message.value.id;
+                        settings.onCreate && settings.onCreate(this);
+                        resolve();
+                        break;
+                    }
+                    case "inboundContext": {
+                        const context = data.message.value;
+                        super.handleInboundContext(context);
+                        break;
+                    }
+                    case "report": {
+                        if (settings.onTimestamp) {
+                            if (data.message.value.pts && data.message.value.stream)
+                                settings.onTimestamp((0, types_1.fromStreamKey)(data.message.value.stream), data.message.value.pts);
+                        }
+                        break;
+                    }
+                    default:
+                        (0, common_1.exhaustiveCheck)(messageCase);
+                }
+            });
+            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "debugStreamTimestampReport", reject, settings);
+        });
+    }
+    /** @internal */
+    static create(settings, client, unregisterNode) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const node = new StreamTimestampReportNode(settings, client, unregisterNode);
+            yield node.initialised;
+            return node;
+        });
+    }
+    close() {
+        this.grpcStream.cancel();
+    }
+}
+exports.StreamTimestampReportNode = StreamTimestampReportNode;
+//# sourceMappingURL=debug.js.map

package/lib/src/media_nodes/types.d.ts

@@ -2,6 +2,11 @@ import { ExplicitChannel, AudioCodec, FrameRate } from "@norskvideo/norsk-api/li
 /** @public */
 export declare type MediaNodeId = string;
 /** @public */
+export interface IntervalTimestamp {
+    n: number;
+    d: number;
+}
+/** @public */
 export interface StreamKey {
     streamId: number;
     programNumber: number;

package/lib/src/sdk.d.ts

@@ -6,11 +6,13 @@ import { Gain, NorskProcessor, NorskDuplex } from "./media_nodes/processor";
 import { NorskOutput } from "./media_nodes/output";
 import { EncryptionSettings, StreamKey, StreamMetadata, Context } from "./media_nodes/types";
 import { NorskSystem } from "./system";
+import { NorskDebug } from "./media_nodes/debug";
 export * from "./types";
 export * from "./system";
 export * from "./media_nodes/types";
 export * from "./media_nodes/input";
 export * from "./media_nodes/output";
+export * from "./media_nodes/debug";
 export * from "./media_nodes/processor";
 export * from "./media_nodes/common";
 export { AudioCodec } from "@norskvideo/norsk-api/lib/media_pb";
@@ -76,6 +78,10 @@ export declare class Norsk {
      * Implements the {@link NorskProcessor} interface
      */
     processor: NorskProcessor;
+    /**
+     * Implements the {@link NorskDebug} interface
+     */
+    debug: NorskDebug;
     /**
      * Implements the {@link NorskSystem} interface
      */

package/lib/src/sdk.js

@@ -46,11 +46,13 @@ const input_1 = require("./media_nodes/input");
 const processor_1 = require("./media_nodes/processor");
 const output_1 = require("./media_nodes/output");
 const system_1 = require("./system");
+const debug_1 = require("./media_nodes/debug");
 __exportStar(require("./types"), exports);
 __exportStar(require("./system"), exports);
 __exportStar(require("./media_nodes/types"), exports);
 __exportStar(require("./media_nodes/input"), exports);
 __exportStar(require("./media_nodes/output"), exports);
+__exportStar(require("./media_nodes/debug"), exports);
 __exportStar(require("./media_nodes/processor"), exports);
 __exportStar(require("./media_nodes/common"), exports);
 var media_pb_2 = require("@norskvideo/norsk-api/lib/media_pb");
@@ -113,6 +115,9 @@ class Norsk {
             fileTs: (settings) => __awaiter(this, void 0, void 0, function* () { return output_1.FileTsOutputNode.create(settings, this.client, unregisterNode).then(registerNode); }),
             fileMp4: (settings) => __awaiter(this, void 0, void 0, function* () { return output_1.FileMp4OutputNode.create(settings, this.client, unregisterNode).then(registerNode); }),
         };
+        this.debug = {
+            streamTimestampReport: (settings) => __awaiter(this, void 0, void 0, function* () { return debug_1.StreamTimestampReportNode.create(settings, this.client, unregisterNode).then(registerNode); }),
+        };
         this.processor = new processor_1.NorskProcessor(this.client);
         this.system = {
             hardwareInfo: () => __awaiter(this, void 0, void 0, function* () { return (0, system_1.hardwareInfo)(this.client); }), // does not produce a node...

package/package.json

@@ -1,11 +1,11 @@
 {
   "license": "MIT",
   "name": "@norskvideo/norsk-sdk",
-  "version": "1.0.344",
+  "version": "1.0.345",
   "dependencies": {
     "@bufbuild/protobuf": "^0.3.0",
     "@grpc/grpc-js": "^1.2.2",
-    "@norskvideo/norsk-api": "1.0.344",
+    "@norskvideo/norsk-api": "1.0.345",
     "typescript-nullable": "^0.6.0"
   },
   "files": [

package/src/sdk.ts

@@ -8,8 +8,7 @@ import {
 import {
   Wave,
   NorskStatusEvent,
-  SineWave,
-  Context as ContextPB,
+  SineWave
 } from "@norskvideo/norsk-api/lib/media_pb";
 import { Empty } from "@bufbuild/protobuf";
 import { debuglog, exhaustiveCheck, norskHost, norskPort } from "./shared/utils";
@@ -86,12 +85,14 @@ import {
 } from "./media_nodes/output";
 import { EncryptionSettings, StreamKey, StreamMetadata, Context } from "./media_nodes/types";
 import { hardwareInfo, NorskSystem } from "./system";
+import { NorskDebug, StreamTimestampReportNode, StreamTimestampReportSettings } from "./media_nodes/debug";
 
 export * from "./types";
 export * from "./system";
 export * from "./media_nodes/types";
 export * from "./media_nodes/input";
 export * from "./media_nodes/output";
+export * from "./media_nodes/debug";
 export * from "./media_nodes/processor";
 export * from "./media_nodes/common";
 export { AudioCodec } from "@norskvideo/norsk-api/lib/media_pb";
@@ -181,6 +182,11 @@ export class Norsk {
    * Implements the {@link NorskProcessor} interface
    */
   public processor: NorskProcessor;
+
+  /**
+   * Implements the {@link NorskDebug} interface
+   */
+  public debug: NorskDebug;
   /**
    * Implements the {@link NorskSystem} interface
    */
@@ -456,6 +462,10 @@ export class Norsk {
       fileMp4: async (settings: FileMp4OutputSettings) =>
         FileMp4OutputNode.create(settings, this.client, unregisterNode).then(registerNode),
     };
+    this.debug = {
+      streamTimestampReport: async (settings: StreamTimestampReportSettings) =>
+        StreamTimestampReportNode.create(settings, this.client, unregisterNode).then(registerNode),
+    };
     this.processor = new NorskProcessor(this.client);
     this.system = {
       hardwareInfo: async () => hardwareInfo(this.client), // does not produce a node...