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

package/packages/device/README.md

@@ -1,219 +1,219 @@
----
-id: README
-title: Device
-hide_title: true
-sidebar_label: Device
----
-
-# Device
-This package contains the device driver. It uses either a platform-specific or a runtime resolved version
-based on your project settings.
-The default setting in SmartApps BIGscreen projects through rnv uses a platform-specific driver.
-
-It has these exports:
-- `device` - an instance of Device class based on your platform.
-the device initialization finishes.
-- `isClickOrEnter` - a function that returns true if the passed event is either ENTER key press or
-left mouse button press.
-- `DeviceEventMap` - a type of all supported device events
-- ~`getKeyMap`~ **deprecated** - synchronous KeyMap getter. It may return an empty object on some platforms before
-
-There is also a pathed export available at: `/keymap`. This exports all keys supported for checking.
-More on that in [Handling key inputs](#inputs)
-
-If you are creating a driver or you wish to edit a driver, please also check
-[Device Base](../driver-base/DeviceBase) documentation.
-
-## What device can do for you
-
-- [notify you of various events](#events)
-- [convert key presses into actions](#inputs)
-- [get information about the device](#information)
-- [control native features](#control)
-
-### Events
-Device supports typed event handling. There are several events common for all devices. Then each
-driver can have its own events. To access those you first need to make sure which device is instantiated.
-
-Events:
-- `networkchange` - called each time device's connection availability changes.
-```ts
-type NetworkChangeListener = (payload: { isConnected: boolean }) => void;
-```
-- `visibilitychange` - called each time the app becomes (in)active.
-Not supported by all platforms, only those that support multitasking (web, tizen).
-```ts
-type VisibilityChangeListener = (payload: { isVisible: boolean }) => void;
-```
-- `mouseactive` - called each time the app starts or ends mouse usage.
-Supported by platforms that allow mouse or similar pointing device (e.g. LG's MRCU).
-```ts
-type MouseActiveListener = (payload: { isMouseActive: boolean }) => void;
-```
-
-### Inputs
-Since device has to support multiple types of input for the same action, there are
-some helper functions that should be used over direct comparison with keycode. Example
-of such device is XBOX. It can be controlled by a keyboard/mouse or gamepad. This creates
-several keycodes for one action such as:
-- LEFT:
-  - left keyboard arrow
-  - left movement of left thumbstick
-  - left movement of right thumbstick
-  - left on D-PAD
-- ENTER:
-  - enter on keyboard
-  - A on gamepad
-
-Another reason for this is that these helper functions also take into account the layout
-of the document (left-to-right or right-to-left) and mirror left and right actions accordingly.
-This way it is possible to program the horizontal direction (left/right) actions only
-for classic LTR layout and have it transparently handled also for RTL.
-
-There are two ways to check for the pressed key:
-1. If you need an exact key or its equivalent as before mentioned LEFT case. This method does not
-take into account direction of the document (LTR or RTL):
-```ts
-// For one key
-import { BACK } from '@24i/bigscreen-sdk/device/keymap';
-
-const onKeyDown = (event: KeyboardEvent) => {
-    if (BACK.is(event)) {
-        // handle and stop the event
-    }
-}
-
-// For multiple keys
-import { switchByKey } from '@24i/bigscreen-sdk/device/keymap';
-
-const onKeyDown = (event: KeyboardEvent) => {
-    const processed = switchByKey(event, {
-        PLAY: this.onKeyPlay,
-        PAUSE: this.onKeyPause,
-        STOP: this.onKeyStop,
-    });
-}
-```
-
-2. If you need to know the direction that takes into account swapping LEFT and RIGHT for RTL layouts:
-```ts
-/**
- * Returns true for any action in the direction left, right, up or down.
- */
-isDirectionalArrow(event: KeyboardEvent): boolean;
-
-/**
- * Returns true for any action in the left direction. (or right in RTL layout)
- */
-isDirectionLeft(event: KeyboardEvent): boolean;
-
-/**
- * Returns true for any action in the right direction. (or left in RTL layout)
- */
-isDirectionRight(event: KeyboardEvent): boolean;
-
-/**
- * Returns true for any action in the up direction.
- */
-isDirectionUp(event: KeyboardEvent): boolean;
-
-/**
- * Returns true for any action in the down direction.
- */
-isDirectionDown(event: KeyboardEvent): boolean;
-
-/**
- * Returns true for any confirm action.
- */
-isClickOrEnter(event: MouseEvent | KeyboardEvent): boolean;
-
-/**
- * Returns true for any cancel action.
- */
-isBackOrEscape(event: MouseEvent | KeyboardEvent): boolean;
-```
-
-### Information
-The device supports gaining information about the device. The amount of information
-is limited by each platform and these are taken only as best effort.
-
-Supported information:
-```ts
-getManufacturerName(): Promise<string>;
-
-getPlatformName(): Promise<string>;
-
-getPlatformVersion(): Promise<string>;
-
-getDeviceName(): Promise<string>;
-
-getModelName(): Promise<string>;
-
-getFirmware(): Promise<string>;
-
-is4KSupported(): Promise<boolean>;
-
-is8KSupported(): Promise<boolean>;
-
-getUuid(): Promise<string>;
-
-isNetworkConnected(): Promise<boolean>;
-
-getConnectionType(): Promise<ConnectionType>;
-
-getLocalIP(): Promise<string>;
-
-getMacAddress(): Promise<string>;
-```
-
-### Control
-Some devices let you control the app or device itself. Some platforms (e.g. Entone STBs)
-event require some actions (e.g. volume control) to be handled by the app.
-
-Control (not all are supported by all platforms):
-```ts
-/**
- * Function that should be called to quit the application in a top level BACK key handler.
- */
-exit(options?: ExitOptions): void;
-
-/**
- * Function to restart the device/application (platform-dependent).
- */
-reboot(): void;
-
-/**
- * Returns the volume level in the range 0-100.
- */
-getVolume(): Promise<number>;
-
-/**
- * Sets the volume level in the range 0-100.
- */
-setVolume(volumePercentage: number): Promise<void>;
-
-/**
- * (Un)mutes the device.
- */
-mute(mute: boolean): Promise<void>;
-
-/**
- * Returns true if the device is muted.
- */
-isMute(): Promise<boolean>;
-
-/**
- * Returns screensaver information for supported platforms.
- */
-getScreenSaver(): Promise<ScreenSaverStatus>;
-
-/**
- * Sets screensaver information for supported platforms.
- */
-setScreenSaver(status: ScreenSaverStatus): Promise<void>;
-
-/**
- * Changes the user agent string for platforms that support it.
- */
-setUserAgent(userAgent: string): Promise<boolean>;
-```
+---
+id: README
+title: Device
+hide_title: true
+sidebar_label: Device
+---
+
+# Device
+This package contains the device driver. It uses either a platform-specific or a runtime resolved version
+based on your project settings.
+The default setting in SmartApps BIGscreen projects through rnv uses a platform-specific driver.
+
+It has these exports:
+- `device` - an instance of Device class based on your platform.
+the device initialization finishes.
+- `isClickOrEnter` - a function that returns true if the passed event is either ENTER key press or
+left mouse button press.
+- `DeviceEventMap` - a type of all supported device events
+- ~`getKeyMap`~ **deprecated** - synchronous KeyMap getter. It may return an empty object on some platforms before
+
+There is also a pathed export available at: `/keymap`. This exports all keys supported for checking.
+More on that in [Handling key inputs](#inputs)
+
+If you are creating a driver or you wish to edit a driver, please also check
+[Device Base](../driver-base/DeviceBase) documentation.
+
+## What device can do for you
+
+- [notify you of various events](#events)
+- [convert key presses into actions](#inputs)
+- [get information about the device](#information)
+- [control native features](#control)
+
+### Events
+Device supports typed event handling. There are several events common for all devices. Then each
+driver can have its own events. To access those you first need to make sure which device is instantiated.
+
+Events:
+- `networkchange` - called each time device's connection availability changes.
+```ts
+type NetworkChangeListener = (payload: { isConnected: boolean }) => void;
+```
+- `visibilitychange` - called each time the app becomes (in)active.
+Not supported by all platforms, only those that support multitasking (web, tizen).
+```ts
+type VisibilityChangeListener = (payload: { isVisible: boolean }) => void;
+```
+- `mouseactive` - called each time the app starts or ends mouse usage.
+Supported by platforms that allow mouse or similar pointing device (e.g. LG's MRCU).
+```ts
+type MouseActiveListener = (payload: { isMouseActive: boolean }) => void;
+```
+
+### Inputs
+Since device has to support multiple types of input for the same action, there are
+some helper functions that should be used over direct comparison with keycode. Example
+of such device is XBOX. It can be controlled by a keyboard/mouse or gamepad. This creates
+several keycodes for one action such as:
+- LEFT:
+  - left keyboard arrow
+  - left movement of left thumbstick
+  - left movement of right thumbstick
+  - left on D-PAD
+- ENTER:
+  - enter on keyboard
+  - A on gamepad
+
+Another reason for this is that these helper functions also take into account the layout
+of the document (left-to-right or right-to-left) and mirror left and right actions accordingly.
+This way it is possible to program the horizontal direction (left/right) actions only
+for classic LTR layout and have it transparently handled also for RTL.
+
+There are two ways to check for the pressed key:
+1. If you need an exact key or its equivalent as before mentioned LEFT case. This method does not
+take into account direction of the document (LTR or RTL):
+```ts
+// For one key
+import { BACK } from '@24i/bigscreen-sdk/device/keymap';
+
+const onKeyDown = (event: KeyboardEvent) => {
+    if (BACK.is(event)) {
+        // handle and stop the event
+    }
+}
+
+// For multiple keys
+import { switchByKey } from '@24i/bigscreen-sdk/device/keymap';
+
+const onKeyDown = (event: KeyboardEvent) => {
+    const processed = switchByKey(event, {
+        PLAY: this.onKeyPlay,
+        PAUSE: this.onKeyPause,
+        STOP: this.onKeyStop,
+    });
+}
+```
+
+2. If you need to know the direction that takes into account swapping LEFT and RIGHT for RTL layouts:
+```ts
+/**
+ * Returns true for any action in the direction left, right, up or down.
+ */
+isDirectionalArrow(event: KeyboardEvent): boolean;
+
+/**
+ * Returns true for any action in the left direction. (or right in RTL layout)
+ */
+isDirectionLeft(event: KeyboardEvent): boolean;
+
+/**
+ * Returns true for any action in the right direction. (or left in RTL layout)
+ */
+isDirectionRight(event: KeyboardEvent): boolean;
+
+/**
+ * Returns true for any action in the up direction.
+ */
+isDirectionUp(event: KeyboardEvent): boolean;
+
+/**
+ * Returns true for any action in the down direction.
+ */
+isDirectionDown(event: KeyboardEvent): boolean;
+
+/**
+ * Returns true for any confirm action.
+ */
+isClickOrEnter(event: MouseEvent | KeyboardEvent): boolean;
+
+/**
+ * Returns true for any cancel action.
+ */
+isBackOrEscape(event: MouseEvent | KeyboardEvent): boolean;
+```
+
+### Information
+The device supports gaining information about the device. The amount of information
+is limited by each platform and these are taken only as best effort.
+
+Supported information:
+```ts
+getManufacturerName(): Promise<string>;
+
+getPlatformName(): Promise<string>;
+
+getPlatformVersion(): Promise<string>;
+
+getDeviceName(): Promise<string>;
+
+getModelName(): Promise<string>;
+
+getFirmware(): Promise<string>;
+
+is4KSupported(): Promise<boolean>;
+
+is8KSupported(): Promise<boolean>;
+
+getUuid(): Promise<string>;
+
+isNetworkConnected(): Promise<boolean>;
+
+getConnectionType(): Promise<ConnectionType>;
+
+getLocalIP(): Promise<string>;
+
+getMacAddress(): Promise<string>;
+```
+
+### Control
+Some devices let you control the app or device itself. Some platforms (e.g. Entone STBs)
+event require some actions (e.g. volume control) to be handled by the app.
+
+Control (not all are supported by all platforms):
+```ts
+/**
+ * Function that should be called to quit the application in a top level BACK key handler.
+ */
+exit(options?: ExitOptions): void;
+
+/**
+ * Function to restart the device/application (platform-dependent).
+ */
+reboot(): void;
+
+/**
+ * Returns the volume level in the range 0-100.
+ */
+getVolume(): Promise<number>;
+
+/**
+ * Sets the volume level in the range 0-100.
+ */
+setVolume(volumePercentage: number): Promise<void>;
+
+/**
+ * (Un)mutes the device.
+ */
+mute(mute: boolean): Promise<void>;
+
+/**
+ * Returns true if the device is muted.
+ */
+isMute(): Promise<boolean>;
+
+/**
+ * Returns screensaver information for supported platforms.
+ */
+getScreenSaver(): Promise<ScreenSaverStatus>;
+
+/**
+ * Sets screensaver information for supported platforms.
+ */
+setScreenSaver(status: ScreenSaverStatus): Promise<void>;
+
+/**
+ * Changes the user agent string for platforms that support it.
+ */
+setUserAgent(userAgent: string): Promise<boolean>;
+```

package/packages/device/keymap.ts

@@ -1 +1 @@
-export * from '@24i/bigscreen-sdk/driver-base/keymap';
+export * from '@24i/bigscreen-sdk/driver-base/keymap';

package/packages/device/resolver/index.ts

@@ -1,2 +1,2 @@
-export { device, getKeyDigit, getKeyMap, isClickOrEnter } from '../src/resolver';
-export type { DeviceEventMap } from '../src/resolver';
+export { device, getKeyDigit, getKeyMap, isClickOrEnter } from '../src/resolver';
+export type { DeviceEventMap } from '../src/resolver';

package/packages/device/resolver/keymap.ts

@@ -1 +1 @@
-export * from '@24i/bigscreen-sdk/driver-base/keymap';
+export * from '@24i/bigscreen-sdk/driver-base/keymap';

package/packages/device/src/DeviceEventMap.ts

@@ -1 +1 @@
-export { DeviceEventMap } from '@24i/bigscreen-sdk/driver-base';
+export { DeviceEventMap } from '@24i/bigscreen-sdk/driver-base';

package/packages/device/src/device.ts

@@ -1,6 +1,6 @@
-import { Device } from './driver';
-
-const device = new Device();
-device.internalInit();
-
-export { device };
+import { Device } from './driver';
+
+const device = new Device();
+device.internalInit();
+
+export { device };

package/packages/device/src/driver/index.android.tv.ts

@@ -1 +1 @@
-export { DeviceAndroidTV as Device } from '@24i/bigscreen-sdk/driver-androidtv';
+export { DeviceAndroidTV as Device } from '@24i/bigscreen-sdk/driver-androidtv';

package/packages/device/src/driver/index.entone.ts

@@ -1 +1 @@
-export { DeviceEntone as Device } from '@24i/bigscreen-sdk/driver-entone';
+export { DeviceEntone as Device } from '@24i/bigscreen-sdk/driver-entone';

package/packages/device/src/driver/index.firetv.ts

@@ -1 +1 @@
-export { DeviceFireTV as Device } from '@24i/bigscreen-sdk/driver-firetv';
+export { DeviceFireTV as Device } from '@24i/bigscreen-sdk/driver-firetv';

package/packages/device/src/driver/index.hbbtv.tv.ts

@@ -1 +1 @@
-export { DeviceHbbTV as Device } from '@24i/bigscreen-sdk/driver-hbbtv';
+export { DeviceHbbTV as Device } from '@24i/bigscreen-sdk/driver-hbbtv';

package/packages/device/src/driver/index.kreatv.ts

@@ -1 +1 @@
-export { DeviceKreaTV as Device } from '@24i/bigscreen-sdk/driver-kreatv';
+export { DeviceKreaTV as Device } from '@24i/bigscreen-sdk/driver-kreatv';

package/packages/device/src/driver/index.saphi.tv.ts

@@ -1 +1 @@
-export { DeviceSaphi as Device } from '@24i/bigscreen-sdk/driver-saphi';
+export { DeviceSaphi as Device } from '@24i/bigscreen-sdk/driver-saphi';

package/packages/device/src/driver/index.smartcast.tv.ts

@@ -1 +1 @@
-export { DeviceSmartCast as Device } from '@24i/bigscreen-sdk/driver-smartcast';
+export { DeviceSmartCast as Device } from '@24i/bigscreen-sdk/driver-smartcast';

package/packages/device/src/driver/index.tizen.tv.ts

@@ -1 +1 @@
-export { DeviceTizen as Device } from '@24i/bigscreen-sdk/driver-tizen';
+export { DeviceTizen as Device } from '@24i/bigscreen-sdk/driver-tizen';

package/packages/device/src/driver/index.ts

@@ -1 +1 @@
-export { DeviceBrowser as Device } from '@24i/bigscreen-sdk/driver-browser';
+export { DeviceBrowser as Device } from '@24i/bigscreen-sdk/driver-browser';

package/packages/device/src/driver/index.vidaa.tv.ts

@@ -1 +1 @@
-export { DeviceVidaa as Device } from '@24i/bigscreen-sdk/driver-vidaa';
+export { DeviceVidaa as Device } from '@24i/bigscreen-sdk/driver-vidaa';

package/packages/device/src/driver/index.webos.tv.ts

@@ -1 +1 @@
-export { DeviceWebos as Device } from '@24i/bigscreen-sdk/driver-webos';
+export { DeviceWebos as Device } from '@24i/bigscreen-sdk/driver-webos';

package/packages/device/src/getKeyDigit.ts

@@ -1,35 +1,35 @@
-import { KeycodeKeyMap } from '@24i/bigscreen-sdk/driver-base';
-
-export const createGetKeyDigit = (
-    getKeyMap: () => Partial<KeycodeKeyMap>,
-): (event: KeyboardEvent) => number | undefined => {
-    const {
-        NUM_0, NUM_1, NUM_2, NUM_3, NUM_4, NUM_5, NUM_6, NUM_7, NUM_8, NUM_9,
-        KP_0, KP_1, KP_2, KP_3, KP_4, KP_5, KP_6, KP_7, KP_8, KP_9,
-    } = getKeyMap();
-
-    const digits = {
-        [NUM_0!]: 0,
-        [KP_0!]: 0,
-        [NUM_1!]: 1,
-        [KP_1!]: 1,
-        [NUM_2!]: 2,
-        [KP_2!]: 2,
-        [NUM_3!]: 3,
-        [KP_3!]: 3,
-        [NUM_4!]: 4,
-        [KP_4!]: 4,
-        [NUM_5!]: 5,
-        [KP_5!]: 5,
-        [NUM_6!]: 6,
-        [KP_6!]: 6,
-        [NUM_7!]: 7,
-        [KP_7!]: 7,
-        [NUM_8!]: 8,
-        [KP_8!]: 8,
-        [NUM_9!]: 9,
-        [KP_9!]: 9,
-    };
-
-    return (event: KeyboardEvent): number | undefined => digits[event.keyCode];
-};
+import { KeycodeKeyMap } from '@24i/bigscreen-sdk/driver-base';
+
+export const createGetKeyDigit = (
+    getKeyMap: () => Partial<KeycodeKeyMap>,
+): (event: KeyboardEvent) => number | undefined => {
+    const {
+        NUM_0, NUM_1, NUM_2, NUM_3, NUM_4, NUM_5, NUM_6, NUM_7, NUM_8, NUM_9,
+        KP_0, KP_1, KP_2, KP_3, KP_4, KP_5, KP_6, KP_7, KP_8, KP_9,
+    } = getKeyMap();
+
+    const digits = {
+        [NUM_0!]: 0,
+        [KP_0!]: 0,
+        [NUM_1!]: 1,
+        [KP_1!]: 1,
+        [NUM_2!]: 2,
+        [KP_2!]: 2,
+        [NUM_3!]: 3,
+        [KP_3!]: 3,
+        [NUM_4!]: 4,
+        [KP_4!]: 4,
+        [NUM_5!]: 5,
+        [KP_5!]: 5,
+        [NUM_6!]: 6,
+        [KP_6!]: 6,
+        [NUM_7!]: 7,
+        [KP_7!]: 7,
+        [NUM_8!]: 8,
+        [KP_8!]: 8,
+        [NUM_9!]: 9,
+        [KP_9!]: 9,
+    };
+
+    return (event: KeyboardEvent): number | undefined => digits[event.keyCode];
+};

package/packages/device/src/getKeyMap.ts

@@ -1,4 +1,4 @@
-import { KeycodeKeyMap } from '@24i/bigscreen-sdk/driver-base';
-import { device } from './device';
-
-export const getKeyMap = (): Partial<KeycodeKeyMap> => device.getKeyMapSync();
+import { KeycodeKeyMap } from '@24i/bigscreen-sdk/driver-base';
+import { device } from './device';
+
+export const getKeyMap = (): Partial<KeycodeKeyMap> => device.getKeyMapSync();

package/packages/device/src/index.ts

@@ -1,8 +1,8 @@
-import { createGetKeyDigit } from './getKeyDigit';
-import { getKeyMap } from './getKeyMap';
-
-export { getKeyMap };
-export { device } from './device';
-export type { DeviceEventMap } from './DeviceEventMap';
-export { isClickOrEnter } from './isClickOrEnter';
-export const getKeyDigit = createGetKeyDigit(getKeyMap);
+import { createGetKeyDigit } from './getKeyDigit';
+import { getKeyMap } from './getKeyMap';
+
+export { getKeyMap };
+export { device } from './device';
+export type { DeviceEventMap } from './DeviceEventMap';
+export { isClickOrEnter } from './isClickOrEnter';
+export const getKeyDigit = createGetKeyDigit(getKeyMap);

package/packages/device/src/isClickOrEnter.ts

@@ -1,3 +1,3 @@
-import { device } from './device';
-
-export const isClickOrEnter = (event: MouseEvent | KeyboardEvent) => device.isClickOrEnter(event);
+import { device } from './device';
+
+export const isClickOrEnter = (event: MouseEvent | KeyboardEvent) => device.isClickOrEnter(event);

package/packages/device/src/resolver/index.ts

@@ -1,2 +1,2 @@
-export { getKeyMap, getKeyDigit, isClickOrEnter, device } from './resolver';
-export type { DeviceEventMap } from './resolver';
+export { getKeyMap, getKeyDigit, isClickOrEnter, device } from './resolver';
+export type { DeviceEventMap } from './resolver';