@24i/bigscreen-sdk 1.0.32 → 1.0.33-alpha.2549

package/packages/driver-smartcast/src/DeviceSmartCast.ts

@@ -1,310 +1,310 @@
-import {
-    DeviceBase, ConnectionType, ScreenSaverStatus, VolumeRange,
-} from '@24i/bigscreen-sdk/driver-base';
-import { runAsync } from '@24i/bigscreen-sdk/utils/timers';
-import { getKeyMap } from './keymap';
-import { ISmartCastApi, IFA, DEFAULT_TTS_TIMEOUT, DevicePlaybackQuality } from './types';
-
-declare const window: Window & { VIZIO: ISmartCastApi };
-
-export class DeviceSmartCast extends DeviceBase {
-    keyMap = getKeyMap();
-
-    deviceId = '';
-
-    deviceModel = '';
-
-    deviceFirmware = '';
-
-    readonly backAsBackspaceInSearch = true;
-
-    devicePlaybackQualities: DevicePlaybackQuality[] = [];
-
-    closedCaptionsStatus = false;
-
-    textToSpeechStatus = false;
-
-    textToSpeechTimeout?: null | number;
-
-    lastTextToSpeechItem?: { delay: number, text: string } | null;
-
-    API?: ISmartCastApi;
-
-    IFA?: IFA;
-
-    async initDevice() {
-        this.initNetworkChangeListener();
-        this.initVisibilityChangeListener();
-        this.initMouseActiveListener();
-        await this.initPlatformApiListeners();
-    }
-
-    async initPlatformApiListeners(): Promise<void> {
-        return new Promise((resolve) => {
-            document.addEventListener('VIZIO_LIBRARY_DID_LOAD', async () => {
-                const API = window.VIZIO;
-                this.API = window.VIZIO;
-                const promises = [];
-
-                API.setClosedCaptionHandler((isEnabled: boolean) => {
-                    this.closedCaptionsStatus = isEnabled;
-                    this.triggerEvent('cctoggle', { isEnabled });
-                });
-
-                promises.push(new Promise<void>((r) => {
-                    API.setAdvertiserIDListener((advertiserID: IFA) => {
-                        this.IFA = advertiserID;
-                        r();
-                    });
-                }));
-
-                promises.push(new Promise<void>((r) => {
-                    API.getDeviceId((id: string) => {
-                        this.deviceId = id;
-                        r();
-                    });
-                }));
-
-                this.deviceModel = API.deviceModel;
-
-                promises.push(new Promise<void>((r) => {
-                    API.getFirmwareVersion((version: string) => {
-                        this.deviceFirmware = version;
-                        r();
-                    });
-                }));
-
-                promises.push(new Promise<void>((r) => {
-                    API.getDevicePlaybackQualities((qualities: DevicePlaybackQuality[]) => {
-                        this.devicePlaybackQualities = qualities;
-                        r();
-                    });
-                }));
-
-                // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                API.setContentChangeHandler(this.handleDeeplink);
-
-                await Promise.all(promises);
-
-                resolve();
-            });
-
-            document.addEventListener('VIZIO_TTS_ENABLED', () => {
-                this.textToSpeechStatus = true;
-            }, false);
-
-            document.addEventListener('VIZIO_TTS_DISABLED', () => {
-                this.lastTextToSpeechItem = null;
-                this.textToSpeechStatus = false;
-                window.clearTimeout(this.textToSpeechTimeout as any);
-                this.API?.Chromevox.cancel();
-            }, false);
-
-            const object = document.createElement('script');
-            object.src = 'http://127.0.0.1:12345/scfs/cl/js/vizio-companion-lib.js';
-            document.body.appendChild(object);
-        });
-    }
-
-    initNetworkChangeListener() {
-        window.addEventListener('online', () => {
-            this.triggerEvent('networkchange', { isConnected: true });
-        });
-        window.addEventListener('offline', () => {
-            this.triggerEvent('networkchange', { isConnected: false });
-        });
-    }
-
-    initVisibilityChangeListener() {
-        document.addEventListener('visibilitychange', () => {
-            this.triggerEvent('visibilitychange', {
-                isVisible: document.visibilityState === 'visible',
-            });
-        });
-    }
-
-    initMouseActiveListener() {
-        document.addEventListener('mousemove', this.onMouseActive);
-    }
-
-    onMouseActive = () => {
-        document.removeEventListener('mousemove', this.onMouseActive);
-        document.addEventListener('keydown', this.onMouseInactive, true);
-        this.isMouseActive = true;
-        this.triggerEvent('mouseactive', { isMouseActive: true });
-    };
-
-    onMouseInactive = (event: KeyboardEvent) => {
-        if (!this.isDirectionalArrow(event)) return;
-        document.removeEventListener('keydown', this.onMouseInactive);
-        this.initMouseActiveListener();
-
-        // to let other handlers to use this property before change
-        runAsync(() => {
-            this.isMouseActive = false;
-        });
-        this.triggerEvent('mouseactive', { isMouseActive: false });
-    };
-
-    handleDeeplink = (deeplinkUrl: string) => {
-        if (typeof deeplinkUrl !== 'string') return;
-        const newRoute = deeplinkUrl.split('#')[1];
-        if (newRoute) {
-            const currentUrl = window.location.href.split('#')[0];
-            window.location.href = `${currentUrl}#${newRoute}`;
-        }
-    };
-
-    /**
-     * Reads provided text by the device internal reader.
-     */
-    readText({ text, delay = DEFAULT_TTS_TIMEOUT }: {
-        text: string, delay?: number
-    }) {
-        if (this.textToSpeechStatus && text) {
-            if (this.textToSpeechTimeout) {
-                this.lastTextToSpeechItem = { text, delay };
-            } else {
-                this.API?.Chromevox.play(text);
-
-                this.textToSpeechTimeout = window.setTimeout(() => {
-                    this.textToSpeechTimeout = null;
-
-                    if (this.lastTextToSpeechItem) {
-                        const last = this.lastTextToSpeechItem;
-
-                        this.API?.Chromevox.play(last.text);
-                        this.lastTextToSpeechItem = null;
-                    }
-                }, delay);
-            }
-        }
-    }
-
-    exit() {
-        this.API?.exitApplication();
-    }
-
-    reboot() {
-        window.location.reload();
-    }
-
-    /**
-     * Returs the status of Closed Captions feature.
-     */
-    async getClosedCaptionsStatus() {
-        return this.closedCaptionsStatus;
-    }
-
-    /**
-     * Returs the status of Text to Speech Engine if it is available by the device.
-     */
-    async getTextToSpeechStatus() {
-        return this.textToSpeechStatus;
-    }
-
-    /**
-     * Returns filled in Vast Tag URL.
-     */
-    getVastTagUrl(template: string): null | string {
-        const IFAObject = this.IFA;
-        const resolution = this.getResolution();
-
-        if (!IFAObject) return null;
-
-        return template
-            .replace('{{width}}', String(resolution.width))
-            .replace('{{height}}', String(resolution.height))
-            .replace('{{cb}}', String(Date.now()))
-            .replace('{{user_agent}}', encodeURIComponent(window.navigator.userAgent))
-            .replace('{{ifa}}', IFAObject.IFA)
-            .replace('{{ifa_type}}', IFAObject.IFA_TYPE)
-            .replace('{{lmt}}', String(IFAObject.LMT));
-    }
-
-    async getManufacturerName() {
-        return 'VIZIO';
-    }
-
-    async getPlatformName() {
-        return 'SmartCast';
-    }
-
-    async getPlatformVersion() {
-        return '';
-    }
-
-    async getDeviceName() {
-        return 'VIZIO SmartCast';
-    }
-
-    async getModelName() {
-        return this.deviceModel;
-    }
-
-    async getFirmware() {
-        return this.deviceFirmware;
-    }
-
-    async is4KSupported() {
-        return this.devicePlaybackQualities.includes('UHD');
-    }
-
-    async is8KSupported() {
-        return false;
-    }
-
-    async getUuid() {
-        return this.deviceId;
-    }
-
-    async getVolume() {
-        return VolumeRange.UNSUPPORTED;
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async setVolume(volumePercentage: number) {
-        // not supported on SmartCast platform
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async mute(mute: boolean) {
-        // not supported on SmartCast platform
-    }
-
-    async isMute() {
-        return false;
-    }
-
-    async getScreenSaver() {
-        return { enabled: false };
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async setScreenSaver(status: ScreenSaverStatus) {
-        // not supported on SmartCast platform
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async setUserAgent(userAgent: string) {
-        return false;
-    }
-
-    async getConnectionType() {
-        return 'unknown' as ConnectionType;
-    }
-
-    async isNetworkConnected() {
-        return window.navigator.onLine;
-    }
-
-    async getLocalIP() {
-        // not supported on SmartCast platform
-        return '';
-    }
-
-    async getMacAddress() {
-        // not supported on SmartCast platform
-        return '';
-    }
-}
+import {
+    DeviceBase, ConnectionType, ScreenSaverStatus, VolumeRange,
+} from '@24i/bigscreen-sdk/driver-base';
+import { runAsync } from '@24i/bigscreen-sdk/utils/timers';
+import { getKeyMap } from './keymap';
+import { ISmartCastApi, IFA, DEFAULT_TTS_TIMEOUT, DevicePlaybackQuality } from './types';
+
+declare const window: Window & { VIZIO: ISmartCastApi };
+
+export class DeviceSmartCast extends DeviceBase {
+    keyMap = getKeyMap();
+
+    deviceId = '';
+
+    deviceModel = '';
+
+    deviceFirmware = '';
+
+    readonly backAsBackspaceInSearch = true;
+
+    devicePlaybackQualities: DevicePlaybackQuality[] = [];
+
+    closedCaptionsStatus = false;
+
+    textToSpeechStatus = false;
+
+    textToSpeechTimeout?: null | number;
+
+    lastTextToSpeechItem?: { delay: number, text: string } | null;
+
+    API?: ISmartCastApi;
+
+    IFA?: IFA;
+
+    async initDevice() {
+        this.initNetworkChangeListener();
+        this.initVisibilityChangeListener();
+        this.initMouseActiveListener();
+        await this.initPlatformApiListeners();
+    }
+
+    async initPlatformApiListeners(): Promise<void> {
+        return new Promise((resolve) => {
+            document.addEventListener('VIZIO_LIBRARY_DID_LOAD', async () => {
+                const API = window.VIZIO;
+                this.API = window.VIZIO;
+                const promises = [];
+
+                API.setClosedCaptionHandler((isEnabled: boolean) => {
+                    this.closedCaptionsStatus = isEnabled;
+                    this.triggerEvent('cctoggle', { isEnabled });
+                });
+
+                promises.push(new Promise<void>((r) => {
+                    API.setAdvertiserIDListener((advertiserID: IFA) => {
+                        this.IFA = advertiserID;
+                        r();
+                    });
+                }));
+
+                promises.push(new Promise<void>((r) => {
+                    API.getDeviceId((id: string) => {
+                        this.deviceId = id;
+                        r();
+                    });
+                }));
+
+                this.deviceModel = API.deviceModel;
+
+                promises.push(new Promise<void>((r) => {
+                    API.getFirmwareVersion((version: string) => {
+                        this.deviceFirmware = version;
+                        r();
+                    });
+                }));
+
+                promises.push(new Promise<void>((r) => {
+                    API.getDevicePlaybackQualities((qualities: DevicePlaybackQuality[]) => {
+                        this.devicePlaybackQualities = qualities;
+                        r();
+                    });
+                }));
+
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                API.setContentChangeHandler(this.handleDeeplink);
+
+                await Promise.all(promises);
+
+                resolve();
+            });
+
+            document.addEventListener('VIZIO_TTS_ENABLED', () => {
+                this.textToSpeechStatus = true;
+            }, false);
+
+            document.addEventListener('VIZIO_TTS_DISABLED', () => {
+                this.lastTextToSpeechItem = null;
+                this.textToSpeechStatus = false;
+                window.clearTimeout(this.textToSpeechTimeout as any);
+                this.API?.Chromevox.cancel();
+            }, false);
+
+            const object = document.createElement('script');
+            object.src = 'http://127.0.0.1:12345/scfs/cl/js/vizio-companion-lib.js';
+            document.body.appendChild(object);
+        });
+    }
+
+    initNetworkChangeListener() {
+        window.addEventListener('online', () => {
+            this.triggerEvent('networkchange', { isConnected: true });
+        });
+        window.addEventListener('offline', () => {
+            this.triggerEvent('networkchange', { isConnected: false });
+        });
+    }
+
+    initVisibilityChangeListener() {
+        document.addEventListener('visibilitychange', () => {
+            this.triggerEvent('visibilitychange', {
+                isVisible: document.visibilityState === 'visible',
+            });
+        });
+    }
+
+    initMouseActiveListener() {
+        document.addEventListener('mousemove', this.onMouseActive);
+    }
+
+    onMouseActive = () => {
+        document.removeEventListener('mousemove', this.onMouseActive);
+        document.addEventListener('keydown', this.onMouseInactive, true);
+        this.isMouseActive = true;
+        this.triggerEvent('mouseactive', { isMouseActive: true });
+    };
+
+    onMouseInactive = (event: KeyboardEvent) => {
+        if (!this.isDirectionalArrow(event)) return;
+        document.removeEventListener('keydown', this.onMouseInactive);
+        this.initMouseActiveListener();
+
+        // to let other handlers to use this property before change
+        runAsync(() => {
+            this.isMouseActive = false;
+        });
+        this.triggerEvent('mouseactive', { isMouseActive: false });
+    };
+
+    handleDeeplink = (deeplinkUrl: string) => {
+        if (typeof deeplinkUrl !== 'string') return;
+        const newRoute = deeplinkUrl.split('#')[1];
+        if (newRoute) {
+            const currentUrl = window.location.href.split('#')[0];
+            window.location.href = `${currentUrl}#${newRoute}`;
+        }
+    };
+
+    /**
+     * Reads provided text by the device internal reader.
+     */
+    readText({ text, delay = DEFAULT_TTS_TIMEOUT }: {
+        text: string, delay?: number
+    }) {
+        if (this.textToSpeechStatus && text) {
+            if (this.textToSpeechTimeout) {
+                this.lastTextToSpeechItem = { text, delay };
+            } else {
+                this.API?.Chromevox.play(text);
+
+                this.textToSpeechTimeout = window.setTimeout(() => {
+                    this.textToSpeechTimeout = null;
+
+                    if (this.lastTextToSpeechItem) {
+                        const last = this.lastTextToSpeechItem;
+
+                        this.API?.Chromevox.play(last.text);
+                        this.lastTextToSpeechItem = null;
+                    }
+                }, delay);
+            }
+        }
+    }
+
+    exit() {
+        this.API?.exitApplication();
+    }
+
+    reboot() {
+        window.location.reload();
+    }
+
+    /**
+     * Returs the status of Closed Captions feature.
+     */
+    async getClosedCaptionsStatus() {
+        return this.closedCaptionsStatus;
+    }
+
+    /**
+     * Returs the status of Text to Speech Engine if it is available by the device.
+     */
+    async getTextToSpeechStatus() {
+        return this.textToSpeechStatus;
+    }
+
+    /**
+     * Returns filled in Vast Tag URL.
+     */
+    getVastTagUrl(template: string): null | string {
+        const IFAObject = this.IFA;
+        const resolution = this.getResolution();
+
+        if (!IFAObject) return null;
+
+        return template
+            .replace('{{width}}', String(resolution.width))
+            .replace('{{height}}', String(resolution.height))
+            .replace('{{cb}}', String(Date.now()))
+            .replace('{{user_agent}}', encodeURIComponent(window.navigator.userAgent))
+            .replace('{{ifa}}', IFAObject.IFA)
+            .replace('{{ifa_type}}', IFAObject.IFA_TYPE)
+            .replace('{{lmt}}', String(IFAObject.LMT));
+    }
+
+    async getManufacturerName() {
+        return 'VIZIO';
+    }
+
+    async getPlatformName() {
+        return 'SmartCast';
+    }
+
+    async getPlatformVersion() {
+        return '';
+    }
+
+    async getDeviceName() {
+        return 'VIZIO SmartCast';
+    }
+
+    async getModelName() {
+        return this.deviceModel;
+    }
+
+    async getFirmware() {
+        return this.deviceFirmware;
+    }
+
+    async is4KSupported() {
+        return this.devicePlaybackQualities.includes('UHD');
+    }
+
+    async is8KSupported() {
+        return false;
+    }
+
+    async getUuid() {
+        return this.deviceId;
+    }
+
+    async getVolume() {
+        return VolumeRange.UNSUPPORTED;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async setVolume(volumePercentage: number) {
+        // not supported on SmartCast platform
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async mute(mute: boolean) {
+        // not supported on SmartCast platform
+    }
+
+    async isMute() {
+        return false;
+    }
+
+    async getScreenSaver() {
+        return { enabled: false };
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async setScreenSaver(status: ScreenSaverStatus) {
+        // not supported on SmartCast platform
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async setUserAgent(userAgent: string) {
+        return false;
+    }
+
+    async getConnectionType() {
+        return 'unknown' as ConnectionType;
+    }
+
+    async isNetworkConnected() {
+        return window.navigator.onLine;
+    }
+
+    async getLocalIP() {
+        // not supported on SmartCast platform
+        return '';
+    }
+
+    async getMacAddress() {
+        // not supported on SmartCast platform
+        return '';
+    }
+}