@clockworkdog/cogs-client 1.3.1 → 1.4.0

package/dist/CogsConnection.d.ts

@@ -74,6 +74,12 @@ export default class CogsConnection<CustomTypes extends {
     sendInitialMediaClipStates(allMediaClipStates: AllMediaClipStatesMessage): void;
     sendMediaClipState(mediaClipState: MediaClipStateMessage): void;
     sendAudioOutputs(audioOutputs: MediaDeviceInfo[]): void;
+    /**
+     * Show or hide the plugin window.
+     * @param visible Whether to show or hide the window
+     * This is only relevant for plugins, not for Media Master content.
+     */
+    setPluginWindowVisible(visible: boolean): void;
     addEventListener<EventName extends keyof ConnectionEventListeners<CustomTypes>, EventValue extends ConnectionEventListeners<CustomTypes>[EventName]>(type: EventName, listener: (ev: CustomEvent<EventValue>) => void, options?: boolean | AddEventListenerOptions): void;
     removeEventListener<EventName extends keyof ConnectionEventListeners<CustomTypes>, EventValue extends ConnectionEventListeners<CustomTypes>[EventName]>(type: EventName, listener: (ev: CustomEvent<EventValue>) => void, options?: boolean | EventListenerOptions): void;
     private dispatchEvent;

package/dist/CogsConnection.js

@@ -146,6 +146,16 @@ class CogsConnection {
             this.websocket.send(JSON.stringify({ audioOutputs }));
         }
     }
+    /**
+     * Show or hide the plugin window.
+     * @param visible Whether to show or hide the window
+     * This is only relevant for plugins, not for Media Master content.
+     */
+    setPluginWindowVisible(visible) {
+        if (this.isConnected) {
+            this.websocket.send(JSON.stringify({ window: { visible } }));
+        }
+    }
     // Type-safe wrapper around EventTarget
     addEventListener(type, listener, options) {
         this.eventTarget.addEventListener(type, listener, options);

package/dist/RtspStreamer.d.ts

@@ -0,0 +1,21 @@
+import type { Html5VideoPipeline as THtml5VideoPipeline } from 'media-stream-library';
+/**
+ * Manages a websocket connection to the COGS TCP relay which can be used to send RTSP video
+ * feeds to the web.
+ */
+export default class RtspStreamer {
+    private _websocketUri;
+    constructor({ hostname, port, path, }?: {
+        hostname?: string;
+        port?: number;
+        path?: string;
+    });
+    /**
+     * Start an RTSP video stream on with the given URI on the given video element.
+     * @returns The playing HTML5 video pipeline.
+     */
+    play(params: {
+        uri: string;
+        videoElement: HTMLVideoElement;
+    }): THtml5VideoPipeline;
+}

package/dist/RtspStreamer.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// We need to require this rather than importing it to ensure Webpack picks the correct version of the library.
+// We also then need to import the same class as a type so we can return the correct Typescript types.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+/// @ts-ignore
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { Html5VideoPipeline, isRtcpBye } = require('media-stream-library/dist/browser-cjs.js');
+const urls_1 = require("./helpers/urls");
+/**
+ * Manages a websocket connection to the COGS TCP relay which can be used to send RTSP video
+ * feeds to the web.
+ */
+class RtspStreamer {
+    constructor({ hostname = document.location.hostname, port = urls_1.COGS_SERVER_PORT, path = '/tcp-proxy', } = {}) {
+        this._websocketUri = `ws://${hostname}:${port}${path}`;
+    }
+    /**
+     * Start an RTSP video stream on with the given URI on the given video element.
+     * @returns The playing HTML5 video pipeline.
+     */
+    play(params) {
+        const { uri, videoElement } = params;
+        const pipeline = new Html5VideoPipeline({
+            ws: { uri: this._websocketUri },
+            rtsp: { uri: uri },
+            mediaElement: videoElement,
+        });
+        // Restart stream on RTCP BYE (stream ended)
+        pipeline.rtsp.onRtcp = (rtcp) => {
+            if (isRtcpBye(rtcp)) {
+                setTimeout(() => this.play(params), 0);
+            }
+        };
+        // Start playback when ready
+        pipeline.ready.then(() => {
+            pipeline.rtsp.play();
+        });
+        return pipeline;
+    }
+}
+exports.default = RtspStreamer;