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

package/packages/driver-androidtv/src/types.ts

@@ -1,113 +1,113 @@
-interface JavaScriptBridge {
-    /**
-     * It returns a JSON string with device info.
-     * @return JSON string with the information about the device brand, model and Android version.
-     * Ex. '{"deviceBrand": "Sony", "deviceModel": "BRAVIA 4K 2015", "osVersion": "7.0",
-     * "appFlavor": "appstage-bigscreen", "drmKeySystems": ["Widewine", "W3C ClearKey"],
-     * "ipLocal": "fe80::475:3045:2928:3a32%wlan0127.0.0.1", "appVersion": '0.0.1' }'
-     */
-    bridgeJavaScriptToAndroid_GetDeviceInfo: () => string,
-    /**
-     * It simulates a native Android back press.
-     */
-    bridgeJavaScriptToAndroid_Back: () => void,
-    /**
-     * It simulates a native Android stop button press.
-     */
-    bridgeJavaScriptToAndroid_StopVideo: () => void;
-    /**
-     * It sets the video to fullscreen mode
-     */
-    bridgeJavaScriptToAndroid_FullScreenVideo: () => void;
-    /**
-     * It sets the video url
-     */
-    bridgeJavaScriptToAndroid_SetVideoPath: (url: string) => void;
-    /**
-     * It returns whether the video is playing
-     */
-    bridgeJavaScriptToAndroid_IsPlaying: () => boolean;
-    /**
-     * It pauses the video
-     */
-    bridgeJavaScriptToAndroid_PauseVideo: () => void;
-    /**
-     * It plays the video
-     */
-    bridgeJavaScriptToAndroid_PlayVideo: () => void;
-    /**
-     * It returns whether the video is live
-     */
-    bridgeJavaScriptToAndroid_IsLive: () => boolean;
-    /**
-     * It returns current time of currently played video
-     */
-    bridgeJavaScriptToAndroid_GetCurrentTime: () => number;
-    /**
-     * It returns total duration of the video
-     */
-    bridgeJavaScriptToAndroid_GetTotalTime: () => number;
-    /**
-     * It seeks the video to specified milliseconds
-     */
-    bridgeJavaScriptToAndroid_SeekTo: (milliseconds: number) => void;
-    /**
-     * It returns current text track
-     */
-    bridgeJavaScriptToAndroid_getCurrentSubtitleTrack: () => string | undefined;
-    /**
-     * It returns current audio track
-     */
-    bridgeJavaScriptToAndroid_getCurrentAudioTrack: () => string | undefined;
-    /**
-     * It sets text track to be shown.
-    */
-    bridgeJavaScriptToAndroid_SetTrack: (track: string) => void;
-    /**
-     * It sets audio track to be used.
-     */
-    bridgeJavaScriptToAndroid_SetAudioTrack: (track: string) => void;
-}
-
-export type DeviceInfo = {
-    /**
-     * Device brand. Ex. "Sony"
-     */
-    deviceBrand: string,
-    /**
-     * Device model. Ex. "BRAVIA 4K 2015"
-     */
-    deviceModel: string,
-    /**
-     * Android version. Ex. "7.0"
-     */
-    osVersion: string,
-    /**
-     * Android wrapper version. Ex. "0.0.1"
-     */
-    appVersion: string,
-    /**
-     * Android flavor. Ex. "appstage-bigscreen"
-     */
-    appFlavor: string,
-    /**
-     * Underlying player engine name. Ex. "exoplayer"
-     */
-    engineName: string,
-    /**
-     * Version of player engine. Ex. "2.18.1"
-     */
-    engineVersion: string,
-    /**
-     * Android DRM key systems. Ex. ["Widewine", "W3C ClearKey"]
-     */
-    drmKeySystems: Array<string>,
-    /**
-     * Android local IP adress in array Ex. "fe80::475:3045:2928:3a32%wlan0127.0.0.1"
-     */
-    ipLocal: string,
-};
-
-export interface IJavaScriptBridge {
-    JavaScriptBridge: JavaScriptBridge,
-}
+interface JavaScriptBridge {
+    /**
+     * It returns a JSON string with device info.
+     * @return JSON string with the information about the device brand, model and Android version.
+     * Ex. '{"deviceBrand": "Sony", "deviceModel": "BRAVIA 4K 2015", "osVersion": "7.0",
+     * "appFlavor": "appstage-bigscreen", "drmKeySystems": ["Widewine", "W3C ClearKey"],
+     * "ipLocal": "fe80::475:3045:2928:3a32%wlan0127.0.0.1", "appVersion": '0.0.1' }'
+     */
+    bridgeJavaScriptToAndroid_GetDeviceInfo: () => string,
+    /**
+     * It simulates a native Android back press.
+     */
+    bridgeJavaScriptToAndroid_Back: () => void,
+    /**
+     * It simulates a native Android stop button press.
+     */
+    bridgeJavaScriptToAndroid_StopVideo: () => void;
+    /**
+     * It sets the video to fullscreen mode
+     */
+    bridgeJavaScriptToAndroid_FullScreenVideo: () => void;
+    /**
+     * It sets the video url
+     */
+    bridgeJavaScriptToAndroid_SetVideoPath: (url: string) => void;
+    /**
+     * It returns whether the video is playing
+     */
+    bridgeJavaScriptToAndroid_IsPlaying: () => boolean;
+    /**
+     * It pauses the video
+     */
+    bridgeJavaScriptToAndroid_PauseVideo: () => void;
+    /**
+     * It plays the video
+     */
+    bridgeJavaScriptToAndroid_PlayVideo: () => void;
+    /**
+     * It returns whether the video is live
+     */
+    bridgeJavaScriptToAndroid_IsLive: () => boolean;
+    /**
+     * It returns current time of currently played video
+     */
+    bridgeJavaScriptToAndroid_GetCurrentTime: () => number;
+    /**
+     * It returns total duration of the video
+     */
+    bridgeJavaScriptToAndroid_GetTotalTime: () => number;
+    /**
+     * It seeks the video to specified milliseconds
+     */
+    bridgeJavaScriptToAndroid_SeekTo: (milliseconds: number) => void;
+    /**
+     * It returns current text track
+     */
+    bridgeJavaScriptToAndroid_getCurrentSubtitleTrack: () => string | undefined;
+    /**
+     * It returns current audio track
+     */
+    bridgeJavaScriptToAndroid_getCurrentAudioTrack: () => string | undefined;
+    /**
+     * It sets text track to be shown.
+    */
+    bridgeJavaScriptToAndroid_SetTrack: (track: string) => void;
+    /**
+     * It sets audio track to be used.
+     */
+    bridgeJavaScriptToAndroid_SetAudioTrack: (track: string) => void;
+}
+
+export type DeviceInfo = {
+    /**
+     * Device brand. Ex. "Sony"
+     */
+    deviceBrand: string,
+    /**
+     * Device model. Ex. "BRAVIA 4K 2015"
+     */
+    deviceModel: string,
+    /**
+     * Android version. Ex. "7.0"
+     */
+    osVersion: string,
+    /**
+     * Android wrapper version. Ex. "0.0.1"
+     */
+    appVersion: string,
+    /**
+     * Android flavor. Ex. "appstage-bigscreen"
+     */
+    appFlavor: string,
+    /**
+     * Underlying player engine name. Ex. "exoplayer"
+     */
+    engineName: string,
+    /**
+     * Version of player engine. Ex. "2.18.1"
+     */
+    engineVersion: string,
+    /**
+     * Android DRM key systems. Ex. ["Widewine", "W3C ClearKey"]
+     */
+    drmKeySystems: Array<string>,
+    /**
+     * Android local IP adress in array Ex. "fe80::475:3045:2928:3a32%wlan0127.0.0.1"
+     */
+    ipLocal: string,
+};
+
+export interface IJavaScriptBridge {
+    JavaScriptBridge: JavaScriptBridge,
+}

package/packages/driver-base/DeviceBase.md

@@ -1,139 +1,139 @@
-# DeviceBase
-This package contains `abstract class DeviceBase` that should be extended by all drivers.
-
-## Interface
-
-### Device Events
-There is a support for fully typed device events. There are two basic events:
-```ts
-interface DeviceEventMap {
-    'networkchange': (payload: { isConnected: boolean }) => void,
-    'visibilitychange': (payload: { isVisible: boolean }) => void,
-}
-```
-You can extend (add or override) it in your device driver like this:
-```ts
-interface CustomDeviceEventMap {
-    'customevent': () => any,
-}
-
-class CustomDevice extends DeviceBase<CustomDeviceEventMap> { ... }
-```
-
-<hr />
-
-### Members
-
-#### isInitialized: boolean;
-Flag whether the device is initialized. Do not modify this. It is handled by `DeviceBase`.
-
-#### initializer: Promise\<void\>;
-This contains the Promise from `initDevice`. This is handled by `DeviceBase`.
-
-#### keyMap: Partial\<KeyMap\>;
-This is holder for the device key map. You should set this either in `constructor`
-or `initDevice`.
-
-#### eventListeners: Partial\<{ [key in keyof EventMap]: Function[] }\>;
-This is a holder for event listeners.
-
-<hr />
-
-### Methods
-
-#### async init(): Promise\<void\>;
-This function should return init Promise. If the device is initialized it should return right away.
-Do not modify this function. It is already defined in the abstract class.
-
-#### abstract initDevice() Promise\<void\>;
-The real initialization happens in this function. Write everything you need to do during initialization here.
-
-#### addEventListener\<K extends keyof EventMap\>(eventName: K, listener: EventMap[K]): void;
-Method to add event listener to various device events. Do not modify.
-
-#### removeEventListener\<K extends keyof EventMap\>(eventName: K, listener: EventMap[K]): void;
-Method to remove event listener to various device events. Do not modify.
-
-#### triggerEvent\<K extends keyof EventMap\>(eventName: K, payload: PayloadOf\<EventMap[K]\>): void;
-Method to trigger an event with a payload. Do not modify.
-
-#### async getKeyMap(): Promise\<Partial\<KeyMap\>\>;
-Returns `keyMap`;
-
-#### getKeyMapSync(): Partial\<KeyMap\>;
-Returns `keyMap` synchronously. Useful in event handlers.
-
-#### abstract exit(options?: ExitOptions): void;
-Method to exit the app. Some platforms support force exiting instead of system deciding whether
-to exit or just suspend the app.
-```ts
-type ExitOptions = { forceExit: boolean };
-```
-
-#### abstract reboot(): void;
-Method to reboot the app/device.
-
-#### abstract getManufacturerName(): Promise\<string\>;
-Returns the name of the manufacturer (like `LG`, `Samsung` etc.). Defaults to `""`.
-
-#### abstract getPlatformName(): Promise\<string\>;
-Returns the name of the platform (like `webOS`, `Tizen` etc.). Defaults to `""`.
-
-#### abstract getPlatformVersion(): Promise\<string\>;
-Returns the version of the platform. Defaults to `""`.
-
-#### abstract getDeviceName(): Promise\<string\>;
-Returns the name of the device. Defaults to `""`.
-
-#### abstract getModelName(): Promise\<string\>;
-Returns the model name. Defaults to `""`.
-
-#### abstract getFirmware(): Promise\<string\>;
-Returns the firmware of the device. Defaults to `""`.
-
-#### abstract is4KSupported(): Promise\<boolean\>;
-Indicates whether the device supports 4K UHD resolution.
-
-#### abstract is8KSupported(): Promise\<boolean\>;
-Indicates whether the device supports 8K UHD resolution.
-
-#### abstract getUuid(): Promise\<string\>;
-Returns the uuid (RFC 4122) of the device. Should not change unless the Storage
-is deleted.
-
-#### abstract getVolume(): Promise\<number\>;
-Returns the volume. Volume number is from interval 0..100. Defaults to `VolumeRange.UNSUPPORTED`.
-`VolumeRange.UNSUPPORTED` should be returned if:
-- device does not allow changing volume
-- getting volume from device was unsuccessful
-
-#### abstract setVolume(volumePercentage: number): Promise\<void\>;
-Sets the volume of the device. Volume must be in interval 0..100.
-
-#### abstract isMute(): Promise\<boolean\>;
-Returns the current mute state. Defaults to `false`.
-
-#### abstract mute(mute: boolean): Promise<void>;
-Turns on or off the silent mode.
-
-#### abstract getScreenSaver(): Promise<ScreenSaverStatus>;
-Returns the screensaver state.
-
-#### abstract setScreenSaver(status: ScreenSaverStatus): Promise<void>;
-Sets the screensaver.
-
-#### abstract setUserAgent(userAgent: string): Promise\<boolean\>;
-Sets the user agent string and returns status whether it was possible. Defaults
-to `return false;`.
-
-#### abstract isNetworkConnected(): Promise\<boolean\>;
-Returns whether the network is connected.
-
-#### abstract getConnectionType(): Promise\<ConnectionType\>;
-Returns type of the connection.
-
-#### async getLocalIP(): Promise\<string\>;
-Returns the local IP of the device. Defaults to `""`.
-
-#### async getMacAddress(): Promise\<string\>;
-Returns the MAC address of the device. Defaults to `""`.
+# DeviceBase
+This package contains `abstract class DeviceBase` that should be extended by all drivers.
+
+## Interface
+
+### Device Events
+There is a support for fully typed device events. There are two basic events:
+```ts
+interface DeviceEventMap {
+    'networkchange': (payload: { isConnected: boolean }) => void,
+    'visibilitychange': (payload: { isVisible: boolean }) => void,
+}
+```
+You can extend (add or override) it in your device driver like this:
+```ts
+interface CustomDeviceEventMap {
+    'customevent': () => any,
+}
+
+class CustomDevice extends DeviceBase<CustomDeviceEventMap> { ... }
+```
+
+<hr />
+
+### Members
+
+#### isInitialized: boolean;
+Flag whether the device is initialized. Do not modify this. It is handled by `DeviceBase`.
+
+#### initializer: Promise\<void\>;
+This contains the Promise from `initDevice`. This is handled by `DeviceBase`.
+
+#### keyMap: Partial\<KeyMap\>;
+This is holder for the device key map. You should set this either in `constructor`
+or `initDevice`.
+
+#### eventListeners: Partial\<{ [key in keyof EventMap]: Function[] }\>;
+This is a holder for event listeners.
+
+<hr />
+
+### Methods
+
+#### async init(): Promise\<void\>;
+This function should return init Promise. If the device is initialized it should return right away.
+Do not modify this function. It is already defined in the abstract class.
+
+#### abstract initDevice() Promise\<void\>;
+The real initialization happens in this function. Write everything you need to do during initialization here.
+
+#### addEventListener\<K extends keyof EventMap\>(eventName: K, listener: EventMap[K]): void;
+Method to add event listener to various device events. Do not modify.
+
+#### removeEventListener\<K extends keyof EventMap\>(eventName: K, listener: EventMap[K]): void;
+Method to remove event listener to various device events. Do not modify.
+
+#### triggerEvent\<K extends keyof EventMap\>(eventName: K, payload: PayloadOf\<EventMap[K]\>): void;
+Method to trigger an event with a payload. Do not modify.
+
+#### async getKeyMap(): Promise\<Partial\<KeyMap\>\>;
+Returns `keyMap`;
+
+#### getKeyMapSync(): Partial\<KeyMap\>;
+Returns `keyMap` synchronously. Useful in event handlers.
+
+#### abstract exit(options?: ExitOptions): void;
+Method to exit the app. Some platforms support force exiting instead of system deciding whether
+to exit or just suspend the app.
+```ts
+type ExitOptions = { forceExit: boolean };
+```
+
+#### abstract reboot(): void;
+Method to reboot the app/device.
+
+#### abstract getManufacturerName(): Promise\<string\>;
+Returns the name of the manufacturer (like `LG`, `Samsung` etc.). Defaults to `""`.
+
+#### abstract getPlatformName(): Promise\<string\>;
+Returns the name of the platform (like `webOS`, `Tizen` etc.). Defaults to `""`.
+
+#### abstract getPlatformVersion(): Promise\<string\>;
+Returns the version of the platform. Defaults to `""`.
+
+#### abstract getDeviceName(): Promise\<string\>;
+Returns the name of the device. Defaults to `""`.
+
+#### abstract getModelName(): Promise\<string\>;
+Returns the model name. Defaults to `""`.
+
+#### abstract getFirmware(): Promise\<string\>;
+Returns the firmware of the device. Defaults to `""`.
+
+#### abstract is4KSupported(): Promise\<boolean\>;
+Indicates whether the device supports 4K UHD resolution.
+
+#### abstract is8KSupported(): Promise\<boolean\>;
+Indicates whether the device supports 8K UHD resolution.
+
+#### abstract getUuid(): Promise\<string\>;
+Returns the uuid (RFC 4122) of the device. Should not change unless the Storage
+is deleted.
+
+#### abstract getVolume(): Promise\<number\>;
+Returns the volume. Volume number is from interval 0..100. Defaults to `VolumeRange.UNSUPPORTED`.
+`VolumeRange.UNSUPPORTED` should be returned if:
+- device does not allow changing volume
+- getting volume from device was unsuccessful
+
+#### abstract setVolume(volumePercentage: number): Promise\<void\>;
+Sets the volume of the device. Volume must be in interval 0..100.
+
+#### abstract isMute(): Promise\<boolean\>;
+Returns the current mute state. Defaults to `false`.
+
+#### abstract mute(mute: boolean): Promise<void>;
+Turns on or off the silent mode.
+
+#### abstract getScreenSaver(): Promise<ScreenSaverStatus>;
+Returns the screensaver state.
+
+#### abstract setScreenSaver(status: ScreenSaverStatus): Promise<void>;
+Sets the screensaver.
+
+#### abstract setUserAgent(userAgent: string): Promise\<boolean\>;
+Sets the user agent string and returns status whether it was possible. Defaults
+to `return false;`.
+
+#### abstract isNetworkConnected(): Promise\<boolean\>;
+Returns whether the network is connected.
+
+#### abstract getConnectionType(): Promise\<ConnectionType\>;
+Returns type of the connection.
+
+#### async getLocalIP(): Promise\<string\>;
+Returns the local IP of the device. Defaults to `""`.
+
+#### async getMacAddress(): Promise\<string\>;
+Returns the MAC address of the device. Defaults to `""`.

package/packages/driver-base/README.md

@@ -1,44 +1,44 @@
-# Driver Base
-This package exports [DeviceBase](./DeviceBase.md) and several other utilities for drivers.
-
-## Usable and *notable* methods
-
-### isMouseUsed
-Tool that says whether or not is the mouse currently in use or not.
-Returns `true` when mouse is in use and `false` when not.
-
-### /keymap
-`/keymap` is pathed export for getting the key map if you are developing a driver. For the keymap to
-be used by the application code, please use `/keymap` export of the `device` package.
-The platform-independent keys have default values of `code` and `keyCode` values. Each platform then
-adjusts keys to its own `codes` and `keyCodes`.
-
-If you are developing a driver you can use `overrideValues` to adjust the key values and then
-`generateKeyCodeKeyMap` to generate a map of `keyCodes` (for backwards code compatibility only).
-
-## Exports
-
-### Classes, Objects, Functions
-
-#### DeviceBase
-[DeviceBase](./DeviceBase.md)
-
-#### loadObject
-Loads object or returns its existing instance;
-
-#### ConnectionType
-type ConnectionType = 'wifi' | 'cable' | 'none' | 'unknown';
-
-#### ScreenSize
-type ScreenSize = 'unknown' | 'hd' | 'full_hd' | 'q_hd' | '4k' | '8k';
-
-### Types
-
-#### KeyMap
-Names for all possible keys. Usually if you will implement platform keymap. You might want to combine with Partial<KeyMap>
-
-#### Volume
-Type for volume objects.
-
-#### DeviceEventMap
-Map of basic device events and their listeners.
+# Driver Base
+This package exports [DeviceBase](./DeviceBase.md) and several other utilities for drivers.
+
+## Usable and *notable* methods
+
+### isMouseUsed
+Tool that says whether or not is the mouse currently in use or not.
+Returns `true` when mouse is in use and `false` when not.
+
+### /keymap
+`/keymap` is pathed export for getting the key map if you are developing a driver. For the keymap to
+be used by the application code, please use `/keymap` export of the `device` package.
+The platform-independent keys have default values of `code` and `keyCode` values. Each platform then
+adjusts keys to its own `codes` and `keyCodes`.
+
+If you are developing a driver you can use `overrideValues` to adjust the key values and then
+`generateKeyCodeKeyMap` to generate a map of `keyCodes` (for backwards code compatibility only).
+
+## Exports
+
+### Classes, Objects, Functions
+
+#### DeviceBase
+[DeviceBase](./DeviceBase.md)
+
+#### loadObject
+Loads object or returns its existing instance;
+
+#### ConnectionType
+type ConnectionType = 'wifi' | 'cable' | 'none' | 'unknown';
+
+#### ScreenSize
+type ScreenSize = 'unknown' | 'hd' | 'full_hd' | 'q_hd' | '4k' | '8k';
+
+### Types
+
+#### KeyMap
+Names for all possible keys. Usually if you will implement platform keymap. You might want to combine with Partial<KeyMap>
+
+#### Volume
+Type for volume objects.
+
+#### DeviceEventMap
+Map of basic device events and their listeners.

package/packages/driver-base/src/ConnectionType.ts

@@ -1 +1 @@
-export type ConnectionType = 'wifi' | 'cable' | 'none' | 'unknown';
+export type ConnectionType = 'wifi' | 'cable' | 'none' | 'unknown';