@clockworkdog/cogs-client 2.1.0 → 2.2.0

package/dist/CogsConnection.d.ts

@@ -35,6 +35,10 @@ export default class CogsConnection<Manifest extends CogsPluginManifest> {
     private audioOutputs;
     private _selectedAudioOutput;
     get selectedAudioOutput(): string;
+    /**
+     * URL parameters use for the websocket connection and asset URLs
+     */
+    private urlParams;
     constructor(manifest: Manifest, { hostname, port }?: {
         hostname?: string;
         port?: number;

package/dist/CogsConnection.js

@@ -28,7 +28,8 @@ class CogsConnection {
      * Return asset URLs using the information about the client and server support for HTTP/2
      */
     getAssetUrl(path) {
-        return (0, urls_1.assetUrl)(path, this.supportsHttp2Assets);
+        var _a, _b;
+        return `${(0, urls_1.assetUrl)(path, this.supportsHttp2Assets)}?${(_b = (_a = this.urlParams) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : ''}`;
     }
     get selectedAudioOutput() {
         return this._selectedAudioOutput;
@@ -53,9 +54,22 @@ class CogsConnection {
          */
         this.audioOutputs = undefined;
         this._selectedAudioOutput = '';
+        /**
+         * URL parameters use for the websocket connection and asset URLs
+         */
+        this.urlParams = null;
         this.currentState = { ...initialClientState };
         const { useReconnectingWebsocket, path, pathParams, supportsHttp2Assets } = websocketParametersFromUrl(document.location.href);
-        const socketUrl = `ws://${hostname}:${port}${path}${pathParams ? '?' + pathParams : ''}`;
+        // Store the URL parameters for use in asset URLs
+        // and add screen dimensions which COGS can use to determine the best asset quality to serve
+        //
+        // Note that content always runs fullscreen and
+        // we assume the screen resolution will not change while the content is running.
+        this.urlParams = new URLSearchParams(pathParams);
+        this.urlParams.set('screenWidth', window.screen.width.toString());
+        this.urlParams.set('screenHeight', window.screen.height.toString());
+        this.urlParams.set('screenPixelRatio', window.devicePixelRatio.toString());
+        const socketUrl = `ws://${hostname}:${port}${path}?${this.urlParams}`;
         this.websocket = useReconnectingWebsocket ? new reconnecting_websocket_1.default(socketUrl) : new WebSocket(socketUrl);
         this.clientSupportsHttp2Assets = !!supportsHttp2Assets;
         this.websocket.onopen = () => {
@@ -245,8 +259,9 @@ function websocketParametersFromUrl(url) {
         const serial = (_g = pathParams.get('serial')) !== null && _g !== void 0 ? _g : '';
         pathParams.delete('serial');
         // Check if cogs-box-av is a version which added support for ignoring HTTP/2 self-signed certificates
-        const version = (_h = pathParams.get('v')) !== null && _h !== void 0 ? _h : '';
-        const supportsHttp2Assets = (0, compare_versions_1.validate)(version) && (0, compare_versions_1.satisfies)(version, '>=4.9.0');
+        const firmwareVersion = ((_h = pathParams.get('f')) !== null && _h !== void 0 ? _h : '').replace(/^v/, '');
+        const isCogsBoxAvDevBuild = firmwareVersion === '0.0.0'; // We assume dev firmware builds have HTTP/2 assets support - Added in 2024-03
+        const supportsHttp2Assets = isCogsBoxAvDevBuild || ((0, compare_versions_1.validate)(firmwareVersion) && (0, compare_versions_1.satisfies)(firmwareVersion, '>=4.9.0'));
         return {
             path: `/client/${encodeURIComponent(serial)}`,
             pathParams,