@signageos/front-applet 8.2.1 → 8.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundle.js +20 -6
- package/dist/bundle.js.map +1 -1
- package/docs/index.md +9 -9
- package/docs/sos/browser.md +11 -3
- package/docs/sos/display.md +13 -20
- package/docs/sos/fileSystem.md +31 -6
- package/docs/sos/hardware/barcodeScanner.md +9 -0
- package/docs/sos/hardware/index.md +9 -0
- package/docs/sos/native/mdc.md +8 -3
- package/docs/sos/osd.md +9 -0
- package/docs/sos/video.md +9 -0
- package/docs/sos_management/app.md +97 -18
- package/docs/sos_management/audio.md +43 -2
- package/docs/sos_management/autoRecovery.md +101 -0
- package/docs/sos_management/debug.md +84 -1
- package/docs/sos_management/firmware.md +64 -1
- package/docs/sos_management/index.md +217 -19
- package/docs/sos_management/network.md +84 -29
- package/docs/sos_management/os.md +59 -4
- package/docs/sos_management/package.md +25 -3
- package/docs/sos_management/power.md +142 -18
- package/docs/sos_management/proxy.md +54 -3
- package/docs/sos_management/remoteControl.md +55 -4
- package/docs/sos_management/screen.md +140 -29
- package/docs/sos_management/security.md +48 -5
- package/docs/sos_management/time.md +76 -9
- package/docs/sos_management/wifi.md +207 -45
- package/es6/FrontApplet/Browser/Browser.d.ts +11 -3
- package/es6/FrontApplet/Browser/Browser.js +13 -4
- package/es6/FrontApplet/Browser/Browser.js.map +1 -1
- package/es6/FrontApplet/Command/Command.js +8 -10
- package/es6/FrontApplet/Command/Command.js.map +1 -1
- package/es6/FrontApplet/Connect/Connect.js +2 -2
- package/es6/FrontApplet/Connect/Connect.js.map +1 -1
- package/es6/FrontApplet/Debug/debugDecorator.d.ts +1 -1
- package/es6/FrontApplet/Debug/debugDecorator.js.map +1 -1
- package/es6/FrontApplet/DeviceInfo/DeviceInfo.js +1 -1
- package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map +1 -1
- package/es6/FrontApplet/Display/Display.d.ts +14 -19
- package/es6/FrontApplet/Display/Display.js +14 -19
- package/es6/FrontApplet/Display/Display.js.map +1 -1
- package/es6/FrontApplet/FileSystem/FileSystem.d.ts +27 -5
- package/es6/FrontApplet/FileSystem/FileSystem.js +27 -5
- package/es6/FrontApplet/FileSystem/FileSystem.js.map +1 -1
- package/es6/FrontApplet/FileSystem/StorageUnitsChangedMessage.d.ts +1 -2
- package/es6/FrontApplet/Font/fontFaceGenerator.js +1 -1
- package/es6/FrontApplet/Font/fontFaceGenerator.js.map +1 -1
- package/es6/FrontApplet/FrontApplet.js +3 -3
- package/es6/FrontApplet/FrontApplet.js.map +1 -1
- package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.d.ts +10 -1
- package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js +9 -0
- package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js.map +1 -1
- package/es6/FrontApplet/Hardware/Hardware.d.ts +9 -0
- package/es6/FrontApplet/Hardware/Hardware.js +9 -0
- package/es6/FrontApplet/Hardware/Hardware.js.map +1 -1
- package/es6/FrontApplet/Iframe/Iframe.js +1 -1
- package/es6/FrontApplet/Iframe/Iframe.js.map +1 -1
- package/es6/FrontApplet/Input/Input.js +2 -1
- package/es6/FrontApplet/Input/Input.js.map +1 -1
- package/es6/FrontApplet/Management/App/App.d.ts +53 -17
- package/es6/FrontApplet/Management/App/App.js +23 -12
- package/es6/FrontApplet/Management/App/App.js.map +1 -1
- package/es6/FrontApplet/Management/App/IApp.d.ts +3 -0
- package/es6/FrontApplet/Management/Audio/Audio.d.ts +24 -3
- package/es6/FrontApplet/Management/Audio/Audio.js +24 -3
- package/es6/FrontApplet/Management/Audio/Audio.js.map +1 -1
- package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.d.ts +49 -3
- package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js +49 -3
- package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js.map +1 -1
- package/es6/FrontApplet/Management/Debug/Debug.d.ts +44 -2
- package/es6/FrontApplet/Management/Debug/Debug.js +43 -1
- package/es6/FrontApplet/Management/Debug/Debug.js.map +1 -1
- package/es6/FrontApplet/Management/Firmware/Firmware.d.ts +41 -4
- package/es6/FrontApplet/Management/Firmware/Firmware.js +33 -0
- package/es6/FrontApplet/Management/Firmware/Firmware.js.map +1 -1
- package/es6/FrontApplet/Management/Management.d.ts +119 -21
- package/es6/FrontApplet/Management/Management.js +119 -22
- package/es6/FrontApplet/Management/Management.js.map +1 -1
- package/es6/FrontApplet/Management/Network/Network.d.ts +44 -25
- package/es6/FrontApplet/Management/Network/Network.js +28 -14
- package/es6/FrontApplet/Management/Network/Network.js.map +1 -1
- package/es6/FrontApplet/Management/OS/IOS.d.ts +3 -0
- package/es6/FrontApplet/Management/OS/OS.d.ts +32 -4
- package/es6/FrontApplet/Management/OS/OS.js +32 -4
- package/es6/FrontApplet/Management/OS/OS.js.map +1 -1
- package/es6/FrontApplet/Management/Package/Package.d.ts +18 -3
- package/es6/FrontApplet/Management/Package/Package.js +18 -4
- package/es6/FrontApplet/Management/Package/Package.js.map +1 -1
- package/es6/FrontApplet/Management/Power/IPower.d.ts +3 -0
- package/es6/FrontApplet/Management/Power/IPower.js.map +1 -1
- package/es6/FrontApplet/Management/Power/Power.d.ts +67 -20
- package/es6/FrontApplet/Management/Power/Power.js +71 -25
- package/es6/FrontApplet/Management/Power/Power.js.map +1 -1
- package/es6/FrontApplet/Management/Proxy/Proxy.d.ts +28 -3
- package/es6/FrontApplet/Management/Proxy/Proxy.js +28 -3
- package/es6/FrontApplet/Management/Proxy/Proxy.js.map +1 -1
- package/es6/FrontApplet/Management/RemoteControl/RemoteControl.d.ts +23 -5
- package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js +23 -5
- package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js.map +1 -1
- package/es6/FrontApplet/Management/Screen/Screen.d.ts +77 -32
- package/es6/FrontApplet/Management/Screen/Screen.js +65 -26
- package/es6/FrontApplet/Management/Screen/Screen.js.map +1 -1
- package/es6/FrontApplet/Management/Security/Security.d.ts +25 -7
- package/es6/FrontApplet/Management/Security/Security.js +25 -7
- package/es6/FrontApplet/Management/Security/Security.js.map +1 -1
- package/es6/FrontApplet/Management/Time/Time.d.ts +47 -11
- package/es6/FrontApplet/Management/Time/Time.js +29 -7
- package/es6/FrontApplet/Management/Time/Time.js.map +1 -1
- package/es6/FrontApplet/Management/Wifi/IWifi.d.ts +3 -0
- package/es6/FrontApplet/Management/Wifi/IWifi.js.map +1 -1
- package/es6/FrontApplet/Management/Wifi/Wifi.d.ts +137 -42
- package/es6/FrontApplet/Management/Wifi/Wifi.js +139 -43
- package/es6/FrontApplet/Management/Wifi/Wifi.js.map +1 -1
- package/es6/FrontApplet/NativeCommands/MDC/Mdc.d.ts +8 -3
- package/es6/FrontApplet/NativeCommands/MDC/Mdc.js +8 -3
- package/es6/FrontApplet/NativeCommands/MDC/Mdc.js.map +1 -1
- package/es6/FrontApplet/OSD/OSD.d.ts +9 -0
- package/es6/FrontApplet/OSD/OSD.js +9 -0
- package/es6/FrontApplet/OSD/OSD.js.map +1 -1
- package/es6/FrontApplet/Offline/Cache/Cache.js +2 -2
- package/es6/FrontApplet/Offline/Cache/Cache.js.map +1 -1
- package/es6/FrontApplet/Offline/Flags/AppendFlagController.d.ts +1 -1
- package/es6/FrontApplet/Offline/Flags/AppendFlagController.js.map +1 -1
- package/es6/FrontApplet/Offline/Offline.js +2 -2
- package/es6/FrontApplet/Offline/Offline.js.map +1 -1
- package/es6/FrontApplet/Sync/Sync.js +6 -3
- package/es6/FrontApplet/Sync/Sync.js.map +1 -1
- package/es6/FrontApplet/Touch/Touch.js +2 -1
- package/es6/FrontApplet/Touch/Touch.js.map +1 -1
- package/es6/FrontApplet/Validate/Validate.d.ts +1 -1
- package/es6/FrontApplet/Validate/Validate.js +9 -9
- package/es6/FrontApplet/Validate/Validate.js.map +1 -1
- package/es6/FrontApplet/Validate/ValidateObjectInterface.js +10 -10
- package/es6/FrontApplet/Validate/ValidateObjectInterface.js.map +1 -1
- package/es6/FrontApplet/Video/Video.d.ts +9 -0
- package/es6/FrontApplet/Video/Video.js +11 -1
- package/es6/FrontApplet/Video/Video.js.map +1 -1
- package/es6/Monitoring/FileSystem/fileSystemCommands.d.ts +2 -2
- package/es6/Monitoring/Management/Screen/handleScreenRequests.js +2 -1
- package/es6/Monitoring/Management/Screen/handleScreenRequests.js.map +1 -1
- package/es6/bundle.js +5 -5
- package/es6/bundle.js.map +1 -1
- package/package.json +16 -21
|
@@ -1,7 +1,16 @@
|
|
|
1
1
|
import IPostMessage from '../../IPostMessage';
|
|
2
2
|
import IRemoteControl from './IRemoteControl';
|
|
3
3
|
/**
|
|
4
|
-
* The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using IR remote controller (TV controller).
|
|
4
|
+
* The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using an IR remote controller (TV controller).
|
|
5
|
+
*
|
|
6
|
+
* <details>
|
|
7
|
+
* <summary>Remote Control Management Capabilities</summary>
|
|
8
|
+
* | Capability | Description |
|
|
9
|
+
* |:------------|:-------------|
|
|
10
|
+
* | `SET_REMOTE_CONTROL_ENABLED` | If device supports setting remote control |
|
|
11
|
+
*
|
|
12
|
+
* If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
|
|
13
|
+
* </details>
|
|
5
14
|
*/
|
|
6
15
|
export default class RemoteControl implements IRemoteControl {
|
|
7
16
|
private messagePrefix;
|
|
@@ -12,14 +21,13 @@ export default class RemoteControl implements IRemoteControl {
|
|
|
12
21
|
* The `enable()` method enables remote control.
|
|
13
22
|
*
|
|
14
23
|
* :::warning
|
|
15
|
-
*
|
|
16
|
-
* **Android:** In order to prevent Android from displaying Android homepage and thus not showing your content, you
|
|
24
|
+
* **Android:** To prevent Android from displaying the Android homepage and thus not showing your content, you
|
|
17
25
|
* must Enable Kiosk Mode (or Lock Remote Control) either through Box device settings or through API.
|
|
18
26
|
*
|
|
19
27
|
* Always set the Remote Control Lock to `enable` after the deployment.
|
|
20
|
-
*
|
|
21
28
|
* :::
|
|
22
|
-
*
|
|
29
|
+
* @returns {Promise<void>} A promise that resolves when the remote control is successfully enabled.
|
|
30
|
+
* @throws {Error} If the device does not support remote control management.
|
|
23
31
|
* @since 3.0.0
|
|
24
32
|
*
|
|
25
33
|
* @example
|
|
@@ -29,6 +37,8 @@ export default class RemoteControl implements IRemoteControl {
|
|
|
29
37
|
/**
|
|
30
38
|
* The `disable()` method disables remote control.
|
|
31
39
|
*
|
|
40
|
+
* @retuns {Promise<void>} A promise that resolves when the remote control is successfully disabled.
|
|
41
|
+
* @throws {Error} If the device does not support remote control management.
|
|
32
42
|
* @since 3.0.0
|
|
33
43
|
*
|
|
34
44
|
* @example
|
|
@@ -38,6 +48,8 @@ export default class RemoteControl implements IRemoteControl {
|
|
|
38
48
|
/**
|
|
39
49
|
* The `isEnabled()` method returns whether the remote control is enabled.
|
|
40
50
|
*
|
|
51
|
+
* @returns {Promise<boolean>} A promise that resolves to `true` if remote control is enabled, otherwise `false`.
|
|
52
|
+
* @throws {Error} If the device does not support remote control management.
|
|
41
53
|
* @since 4.0.0
|
|
42
54
|
*
|
|
43
55
|
* @example
|
|
@@ -47,6 +59,8 @@ export default class RemoteControl implements IRemoteControl {
|
|
|
47
59
|
/**
|
|
48
60
|
* The `lock()` method is an alias for the `disable()` method.
|
|
49
61
|
*
|
|
62
|
+
* @returns {Promise<void>} A promise that resolves when the remote control is successfully locked (disabled).
|
|
63
|
+
* @throws {Error} If the device does not support remote control management.
|
|
50
64
|
* @since 4.0.0
|
|
51
65
|
*
|
|
52
66
|
* @example
|
|
@@ -56,6 +70,8 @@ export default class RemoteControl implements IRemoteControl {
|
|
|
56
70
|
/**
|
|
57
71
|
* The `unlock()` method is an alias for the `enable()` method.
|
|
58
72
|
*
|
|
73
|
+
* @returns {Promise<void>} A promise that resolves when the remote control is successfully unlocked (enabled).
|
|
74
|
+
* @throws {Error} If the device does not support remote control management.
|
|
59
75
|
* @since 4.0.0
|
|
60
76
|
*
|
|
61
77
|
* @example
|
|
@@ -65,6 +81,8 @@ export default class RemoteControl implements IRemoteControl {
|
|
|
65
81
|
/**
|
|
66
82
|
* The `isLocked()` method returns whether the remote control is locked (disabled).
|
|
67
83
|
*
|
|
84
|
+
* @returns {Promise<boolean>} A promise that resolves to `true` if the remote control is locked (disabled), otherwise `false`.
|
|
85
|
+
* @throws {Error} If the device does not support remote control management.
|
|
68
86
|
* @since 4.0.0
|
|
69
87
|
*
|
|
70
88
|
* @example
|
|
@@ -1,7 +1,16 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
/**
|
|
4
|
-
* The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using IR remote controller (TV controller).
|
|
4
|
+
* The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using an IR remote controller (TV controller).
|
|
5
|
+
*
|
|
6
|
+
* <details>
|
|
7
|
+
* <summary>Remote Control Management Capabilities</summary>
|
|
8
|
+
* | Capability | Description |
|
|
9
|
+
* |:------------|:-------------|
|
|
10
|
+
* | `SET_REMOTE_CONTROL_ENABLED` | If device supports setting remote control |
|
|
11
|
+
*
|
|
12
|
+
* If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
|
|
13
|
+
* </details>
|
|
5
14
|
*/
|
|
6
15
|
class RemoteControl {
|
|
7
16
|
messagePrefix;
|
|
@@ -15,14 +24,13 @@ class RemoteControl {
|
|
|
15
24
|
* The `enable()` method enables remote control.
|
|
16
25
|
*
|
|
17
26
|
* :::warning
|
|
18
|
-
*
|
|
19
|
-
* **Android:** In order to prevent Android from displaying Android homepage and thus not showing your content, you
|
|
27
|
+
* **Android:** To prevent Android from displaying the Android homepage and thus not showing your content, you
|
|
20
28
|
* must Enable Kiosk Mode (or Lock Remote Control) either through Box device settings or through API.
|
|
21
29
|
*
|
|
22
30
|
* Always set the Remote Control Lock to `enable` after the deployment.
|
|
23
|
-
*
|
|
24
31
|
* :::
|
|
25
|
-
*
|
|
32
|
+
* @returns {Promise<void>} A promise that resolves when the remote control is successfully enabled.
|
|
33
|
+
* @throws {Error} If the device does not support remote control management.
|
|
26
34
|
* @since 3.0.0
|
|
27
35
|
*
|
|
28
36
|
* @example
|
|
@@ -34,6 +42,8 @@ class RemoteControl {
|
|
|
34
42
|
/**
|
|
35
43
|
* The `disable()` method disables remote control.
|
|
36
44
|
*
|
|
45
|
+
* @retuns {Promise<void>} A promise that resolves when the remote control is successfully disabled.
|
|
46
|
+
* @throws {Error} If the device does not support remote control management.
|
|
37
47
|
* @since 3.0.0
|
|
38
48
|
*
|
|
39
49
|
* @example
|
|
@@ -45,6 +55,8 @@ class RemoteControl {
|
|
|
45
55
|
/**
|
|
46
56
|
* The `isEnabled()` method returns whether the remote control is enabled.
|
|
47
57
|
*
|
|
58
|
+
* @returns {Promise<boolean>} A promise that resolves to `true` if remote control is enabled, otherwise `false`.
|
|
59
|
+
* @throws {Error} If the device does not support remote control management.
|
|
48
60
|
* @since 4.0.0
|
|
49
61
|
*
|
|
50
62
|
* @example
|
|
@@ -59,6 +71,8 @@ class RemoteControl {
|
|
|
59
71
|
/**
|
|
60
72
|
* The `lock()` method is an alias for the `disable()` method.
|
|
61
73
|
*
|
|
74
|
+
* @returns {Promise<void>} A promise that resolves when the remote control is successfully locked (disabled).
|
|
75
|
+
* @throws {Error} If the device does not support remote control management.
|
|
62
76
|
* @since 4.0.0
|
|
63
77
|
*
|
|
64
78
|
* @example
|
|
@@ -70,6 +84,8 @@ class RemoteControl {
|
|
|
70
84
|
/**
|
|
71
85
|
* The `unlock()` method is an alias for the `enable()` method.
|
|
72
86
|
*
|
|
87
|
+
* @returns {Promise<void>} A promise that resolves when the remote control is successfully unlocked (enabled).
|
|
88
|
+
* @throws {Error} If the device does not support remote control management.
|
|
73
89
|
* @since 4.0.0
|
|
74
90
|
*
|
|
75
91
|
* @example
|
|
@@ -81,6 +97,8 @@ class RemoteControl {
|
|
|
81
97
|
/**
|
|
82
98
|
* The `isLocked()` method returns whether the remote control is locked (disabled).
|
|
83
99
|
*
|
|
100
|
+
* @returns {Promise<boolean>} A promise that resolves to `true` if the remote control is locked (disabled), otherwise `false`.
|
|
101
|
+
* @throws {Error} If the device does not support remote control management.
|
|
84
102
|
* @since 4.0.0
|
|
85
103
|
*
|
|
86
104
|
* @example
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RemoteControl.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/RemoteControl/RemoteControl.ts"],"names":[],"mappings":";;AAGA
|
|
1
|
+
{"version":3,"file":"RemoteControl.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/RemoteControl/RemoteControl.ts"],"names":[],"mappings":";;AAGA;;;;;;;;;;;GAWG;AACH,MAAqB,aAAa;IAGxB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;SACtD,CAAC,CAAC;QAEH,OAAO,sBAAsB,CAAC;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,IAAI;QAChB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,QAAQ;QACpB,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,OAAgB;QACxC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA/GD,gCA+GC"}
|
|
@@ -3,26 +3,37 @@ import IBrightness from './IBrightness';
|
|
|
3
3
|
import IOrientation from './IOrientation';
|
|
4
4
|
import IScreen from './IScreen';
|
|
5
5
|
/**
|
|
6
|
-
* The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows
|
|
7
|
-
* resolution or orientation, set brightness, retrieve the current brightness of the display and manipulate the power mode.
|
|
6
|
+
* The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows for manipulating the screen
|
|
7
|
+
* resolution or orientation, set brightness, retrieve the current brightness of the display, and manipulate the power mode.
|
|
8
8
|
*
|
|
9
9
|
* :::warning
|
|
10
|
-
*
|
|
11
|
-
* This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend to reboot any
|
|
10
|
+
* This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend rebooting any
|
|
12
11
|
* device once a day.
|
|
13
|
-
*
|
|
14
12
|
* :::
|
|
15
13
|
*
|
|
16
14
|
* :::info
|
|
17
|
-
*
|
|
18
15
|
* There is a specific behavior based on the device type you operate:
|
|
19
|
-
* **On SoC displays** (e.g
|
|
16
|
+
* **On SoC displays** (e.g., Samsung Tizen, LG webOS, Android-based SoC displays from Sony, Vestel Philips,...)
|
|
20
17
|
* - `powerOn()` and `powerOff()` are turning the display backlight and the panel off
|
|
18
|
+
* **On external media players** (e.g., BrightSign, Windows PC, Android players, Raspberry Pi)
|
|
19
|
+
* - `powerOn()` and `powerOff()` are turning off the video output (typically HDMI-out); this functionality does not manage the connected display backlight and needs to be controlled via RS232 or another way.
|
|
20
|
+
* :::
|
|
21
21
|
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
22
|
+
* <details>
|
|
23
|
+
* <summary>Screen Management Capabilities</summary>
|
|
24
|
+
* | Capability | Description |
|
|
25
|
+
* |:------------|:-------------|
|
|
26
|
+
* | `SET_BRIGHTNESS` | If device can brightness. |
|
|
27
|
+
* | `GET_BRIGHTNESS` | If device can return current brightness. |
|
|
28
|
+
* | `SCREEN_RESIZE` | If the device can change screen resolution and orientation. |
|
|
29
|
+
* | `ORIENTATION_LANDSCAPE` | If device supports landscape orientation. |
|
|
30
|
+
* | `ORIENTATION_PORTRAIT` | If device supports portrait orientation. |
|
|
31
|
+
* | `ORIENTATION_LANDSCAPE_FLIPPED` | If device supports flipped landscape orientation. |
|
|
32
|
+
* | `ORIENTATION_PORTRAIT_FLIPPED` | If device supports flipped portrait orientation. |
|
|
33
|
+
* | `ORIENTATION_AUTO` | If device supports auto orientation. |
|
|
24
34
|
*
|
|
25
|
-
*
|
|
35
|
+
* If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
|
|
36
|
+
* </details>
|
|
26
37
|
*/
|
|
27
38
|
export default class Screen implements IScreen {
|
|
28
39
|
private messagePrefix;
|
|
@@ -30,20 +41,23 @@ export default class Screen implements IScreen {
|
|
|
30
41
|
/** @internal */
|
|
31
42
|
constructor(messagePrefix: string, postMessage: IPostMessage<any>);
|
|
32
43
|
/**
|
|
33
|
-
* The `resize()` method changes resolution and orientation of the display.
|
|
44
|
+
* The `resize()` method changes the resolution and orientation of the display.
|
|
34
45
|
*
|
|
35
46
|
* :::info
|
|
36
|
-
*
|
|
37
|
-
* For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen which will be downloaded to the device [Read more how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
|
|
38
|
-
*
|
|
47
|
+
* For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen, which will be downloaded to the device [Read more on how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
|
|
39
48
|
* :::
|
|
40
49
|
*
|
|
41
|
-
* @param baseUrl SSSP & Tizen devices
|
|
50
|
+
* @param baseUrl SSSP & Tizen devices require installing an orientation-specific Core App if you want to switch orientation to portrait or landscape.
|
|
42
51
|
* @param orientation Screen orientation
|
|
43
52
|
* @param resolution Where it applies (mainly SSSP 2/3)
|
|
44
53
|
* @param currentVersion Core App version
|
|
45
|
-
* @param videoOrientation If the video has different orientation than the HTML5 content
|
|
46
|
-
*
|
|
54
|
+
* @param videoOrientation If the video has a different orientation than the HTML5 content
|
|
55
|
+
* @returns {Promise<void>} A promise that resolves when the screen is successfully resized.
|
|
56
|
+
* @throws {Error} If `baseUrl` is not a valid URL
|
|
57
|
+
* @throws {Error} If `orientation` is not a valid orientation
|
|
58
|
+
* @throws {Error} If `resolution` is not a valid resolution
|
|
59
|
+
* @throws {Error} If `currentVersion` is not a valid string
|
|
60
|
+
* @throws {Error} If `videoOrientation` is not a valid video orientation
|
|
47
61
|
* @since 3.0.0
|
|
48
62
|
*
|
|
49
63
|
* @example
|
|
@@ -55,7 +69,7 @@ export default class Screen implements IScreen {
|
|
|
55
69
|
* "1.0.4"
|
|
56
70
|
* );
|
|
57
71
|
*
|
|
58
|
-
* // for all other supported
|
|
72
|
+
* // for all other supported devices
|
|
59
73
|
* await sos.management.screen.resize(
|
|
60
74
|
* "",
|
|
61
75
|
* "PORTRAIT",
|
|
@@ -69,31 +83,54 @@ export default class Screen implements IScreen {
|
|
|
69
83
|
/**
|
|
70
84
|
* The `getOrientation()` method returns the current orientation of the screen.
|
|
71
85
|
*
|
|
86
|
+
* @returns {Promise<IOrientation>} A promise that resolves to the current screen orientation.
|
|
87
|
+
* @throws {Error} If the orientation cannot be retrieved.
|
|
72
88
|
* @since 4.7.0
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* const orientation = (await sos.management.screen.getOrientation()).screenOrientation;
|
|
92
|
+
* console.log(`Current screen orientation is: ${orientation}`);
|
|
73
93
|
*/
|
|
74
94
|
getOrientation(): Promise<IOrientation>;
|
|
75
95
|
/**
|
|
76
|
-
* The `setBrightness()` method sets the brightness of the screen. It supports
|
|
96
|
+
* The `setBrightness()` method sets the brightness of the screen. It supports two different brightness values for 2 time points in the day.
|
|
77
97
|
*
|
|
78
98
|
* @param timeFrom1 Time in the XX:XX format
|
|
79
99
|
* @param brightness1 Brightness value between 0 and 100
|
|
80
100
|
* @param timeFrom2 Time in the XX:XX format
|
|
81
101
|
* @param brightness2 Brightness value between 0 and 100
|
|
82
|
-
*
|
|
102
|
+
* @return {Promise<void>} A promise that resolves when the brightness is successfully set.
|
|
103
|
+
* @throws {Error} If `timeFrom1` is not a valid time in the XX:XX format
|
|
104
|
+
* @throws {Error} If `brightness1` is not a number between 0 and 100
|
|
105
|
+
* @throws {Error} If `timeFrom2` is not a valid time in the XX:XX format
|
|
106
|
+
* @throws {Error} If `brightness2` is not a number between 0 and 100
|
|
83
107
|
* @since 3.0.0
|
|
84
108
|
*
|
|
109
|
+
* @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/brightness/ | Applet Example with Brightness setup}
|
|
110
|
+
*
|
|
85
111
|
* @example
|
|
112
|
+
* // Set brightness to 10% between 00:00 and 17:00, and to 30% between 17:00 and 23:59
|
|
86
113
|
* await sos.management.screen.setBrightness(
|
|
87
114
|
* '00:00',
|
|
88
115
|
* '10',
|
|
89
116
|
* '17:00',
|
|
90
117
|
* '30'
|
|
91
118
|
* );
|
|
119
|
+
*
|
|
120
|
+
* // Set brightness to 50% all day
|
|
121
|
+
* await sos.management.screen.setBrightness(
|
|
122
|
+
* 00:00,
|
|
123
|
+
* 50,
|
|
124
|
+
* 23:59,
|
|
125
|
+
* 50
|
|
126
|
+
* );
|
|
92
127
|
*/
|
|
93
128
|
setBrightness(timeFrom1: string, brightness1: number, timeFrom2: string, brightness2: number): Promise<void>;
|
|
94
129
|
/**
|
|
95
130
|
* The `getBrightness()` method returns information about the currently set brightness values.
|
|
96
131
|
*
|
|
132
|
+
* @returns {Promise<IBrightness>} A promise that resolves to the current brightness settings.
|
|
133
|
+
* @throws {Error} If the brightness cannot be retrieved.
|
|
97
134
|
* @since 3.0.0
|
|
98
135
|
*/
|
|
99
136
|
getBrightness(): Promise<IBrightness>;
|
|
@@ -102,23 +139,28 @@ export default class Screen implements IScreen {
|
|
|
102
139
|
*/
|
|
103
140
|
takeAndUploadScreenshot(uploadBaseUrl: string): Promise<string>;
|
|
104
141
|
/**
|
|
105
|
-
* The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified
|
|
106
|
-
* (`https://upload.signageos.io`) or a dedicated server
|
|
142
|
+
* The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified URL. This can be either a signageOS upload URL
|
|
143
|
+
* (`https://upload.signageos.io`) or a dedicated server URL for uploading screenshots. The format in which the screenshot is uploaded may be
|
|
107
144
|
* different for every platform.
|
|
108
145
|
*
|
|
109
146
|
* To implement a custom screenshot upload server, it needs to implement these endpoints:
|
|
110
147
|
* - POST `/upload/file?prefix=screenshot/` - Endpoint for receiving screenshot using form data, with the image set to the `file` field.
|
|
111
|
-
* - POST `/upload/raw?prefix=screenshot/` - Endpoint for receiving screenshots as
|
|
112
|
-
* - POST `/upload/image-data-uri?prefix=screenshot/` - Endpoint for receiving screenshots encoded as a data
|
|
148
|
+
* - POST `/upload/raw?prefix=screenshot/` - Endpoint for receiving screenshots as raw data.
|
|
149
|
+
* - POST `/upload/image-data-uri?prefix=screenshot/` - Endpoint for receiving screenshots encoded as a data URL.
|
|
113
150
|
*
|
|
114
|
-
* signageOS provides standalone server
|
|
151
|
+
* signageOS provides a standalone server that implements all of those methods. It is offered to all of our partners through the
|
|
115
152
|
* [support ticketing system](https://box.signageos.io/support/).
|
|
116
153
|
*
|
|
117
|
-
* @param uploadBaseUrl URL to which the screenshot will be uploaded. It can be either a signageOS upload
|
|
154
|
+
* @param uploadBaseUrl URL to which the screenshot will be uploaded. It can be either a signageOS upload URL or a custom server URL.
|
|
118
155
|
* @param computeHash Whether to compute a hash of the screenshot and return it in the response.
|
|
119
|
-
*
|
|
156
|
+
* @return {Promise<{screenshotUrl, aHash}>} A promise that resolves to an object containing the screenshot URL and optionally a hash of the screenshot.
|
|
157
|
+
* @throws {Error} If `uploadBaseUrl` is not a valid URL
|
|
158
|
+
* @throws {Error} If `computeHash` is not a boolean
|
|
159
|
+
* @throws {Error} If the screenshot cannot be taken or uploaded.
|
|
120
160
|
* @since 3.0.0
|
|
121
161
|
*
|
|
162
|
+
* @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/screenshot-upload | Applet Example with Screenshot Upload}
|
|
163
|
+
*
|
|
122
164
|
* @example
|
|
123
165
|
* const { screenshotUrl, aHash } = await sos.management.screen.takeAndUploadScreenshot(
|
|
124
166
|
* 'https://your.upload.server/upload/file?prefix=screenshot/',
|
|
@@ -132,28 +174,31 @@ export default class Screen implements IScreen {
|
|
|
132
174
|
/**
|
|
133
175
|
* The `powerOn()` method turns the screen on.
|
|
134
176
|
*
|
|
135
|
-
*
|
|
177
|
+
* @returns {Promise<void>} A promise that resolves when the screen is successfully turned on.
|
|
178
|
+
* @throws {Error} If the screen cannot be turned on.
|
|
136
179
|
* @since 3.0.0
|
|
137
180
|
*/
|
|
138
181
|
powerOn(): Promise<void>;
|
|
139
182
|
/**
|
|
140
|
-
* The `powerOff()` method
|
|
183
|
+
* The `powerOff()` method turns the screen off. It will turn off the display backlight and the panel, and it will also disable the applet.
|
|
141
184
|
*
|
|
142
185
|
* :::warning
|
|
143
|
-
*
|
|
144
|
-
* On Android devices, `powerOff()` also shuts down the webview and the Applet. It's default Android behavior that cannot be changed. Once
|
|
186
|
+
* On Android devices, `powerOff()` also shuts down the webview and the Applet. It's the default Android behavior that cannot be changed. Once
|
|
145
187
|
* the Applet is off, you cannot call `powerOn()` to resume the playback.
|
|
146
188
|
*
|
|
147
189
|
* To manage the display On/Off state, use [REST API Power Actions](https://developers.signageos.io/api/#tag/DevicePower-Actions) instead.
|
|
148
|
-
*
|
|
149
190
|
* :::
|
|
150
191
|
*
|
|
192
|
+
* @returns {Promise<void>} A promise that resolves when the screen is successfully turned off.
|
|
193
|
+
* @throws {Error} If the screen cannot be turned off.
|
|
151
194
|
* @since 3.0.0
|
|
152
195
|
*/
|
|
153
196
|
powerOff(): Promise<void>;
|
|
154
197
|
/**
|
|
155
198
|
* The `isPoweredOn()` method returns whether the screen is on.
|
|
156
199
|
*
|
|
200
|
+
* @returns {Promise<boolean>} A promise that resolves to a boolean indicating whether the screen is powered on.
|
|
201
|
+
* @throws {Error} If the power state cannot be retrieved.
|
|
157
202
|
* @since 3.0.0
|
|
158
203
|
*/
|
|
159
204
|
isPoweredOn(): Promise<boolean>;
|
|
@@ -6,28 +6,38 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
6
6
|
const DeviceHelper_1 = require("../helpers/DeviceHelper");
|
|
7
7
|
const VideoHelper_1 = require("../helpers/VideoHelper");
|
|
8
8
|
const Validate_1 = __importDefault(require("../../Validate/Validate"));
|
|
9
|
-
// TODO: how does this work if there are multiple displays
|
|
10
9
|
/**
|
|
11
|
-
* The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows
|
|
12
|
-
* resolution or orientation, set brightness, retrieve the current brightness of the display and manipulate the power mode.
|
|
10
|
+
* The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows for manipulating the screen
|
|
11
|
+
* resolution or orientation, set brightness, retrieve the current brightness of the display, and manipulate the power mode.
|
|
13
12
|
*
|
|
14
13
|
* :::warning
|
|
15
|
-
*
|
|
16
|
-
* This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend to reboot any
|
|
14
|
+
* This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend rebooting any
|
|
17
15
|
* device once a day.
|
|
18
|
-
*
|
|
19
16
|
* :::
|
|
20
17
|
*
|
|
21
18
|
* :::info
|
|
22
|
-
*
|
|
23
19
|
* There is a specific behavior based on the device type you operate:
|
|
24
|
-
* **On SoC displays** (e.g
|
|
20
|
+
* **On SoC displays** (e.g., Samsung Tizen, LG webOS, Android-based SoC displays from Sony, Vestel Philips,...)
|
|
25
21
|
* - `powerOn()` and `powerOff()` are turning the display backlight and the panel off
|
|
22
|
+
* **On external media players** (e.g., BrightSign, Windows PC, Android players, Raspberry Pi)
|
|
23
|
+
* - `powerOn()` and `powerOff()` are turning off the video output (typically HDMI-out); this functionality does not manage the connected display backlight and needs to be controlled via RS232 or another way.
|
|
24
|
+
* :::
|
|
26
25
|
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <details>
|
|
27
|
+
* <summary>Screen Management Capabilities</summary>
|
|
28
|
+
* | Capability | Description |
|
|
29
|
+
* |:------------|:-------------|
|
|
30
|
+
* | `SET_BRIGHTNESS` | If device can brightness. |
|
|
31
|
+
* | `GET_BRIGHTNESS` | If device can return current brightness. |
|
|
32
|
+
* | `SCREEN_RESIZE` | If the device can change screen resolution and orientation. |
|
|
33
|
+
* | `ORIENTATION_LANDSCAPE` | If device supports landscape orientation. |
|
|
34
|
+
* | `ORIENTATION_PORTRAIT` | If device supports portrait orientation. |
|
|
35
|
+
* | `ORIENTATION_LANDSCAPE_FLIPPED` | If device supports flipped landscape orientation. |
|
|
36
|
+
* | `ORIENTATION_PORTRAIT_FLIPPED` | If device supports flipped portrait orientation. |
|
|
37
|
+
* | `ORIENTATION_AUTO` | If device supports auto orientation. |
|
|
29
38
|
*
|
|
30
|
-
*
|
|
39
|
+
* If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
|
|
40
|
+
* </details>
|
|
31
41
|
*/
|
|
32
42
|
class Screen {
|
|
33
43
|
messagePrefix;
|
|
@@ -38,20 +48,23 @@ class Screen {
|
|
|
38
48
|
this.postMessage = postMessage;
|
|
39
49
|
}
|
|
40
50
|
/**
|
|
41
|
-
* The `resize()` method changes resolution and orientation of the display.
|
|
51
|
+
* The `resize()` method changes the resolution and orientation of the display.
|
|
42
52
|
*
|
|
43
53
|
* :::info
|
|
44
|
-
*
|
|
45
|
-
* For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen which will be downloaded to the device [Read more how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
|
|
46
|
-
*
|
|
54
|
+
* For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen, which will be downloaded to the device [Read more on how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
|
|
47
55
|
* :::
|
|
48
56
|
*
|
|
49
|
-
* @param baseUrl SSSP & Tizen devices
|
|
57
|
+
* @param baseUrl SSSP & Tizen devices require installing an orientation-specific Core App if you want to switch orientation to portrait or landscape.
|
|
50
58
|
* @param orientation Screen orientation
|
|
51
59
|
* @param resolution Where it applies (mainly SSSP 2/3)
|
|
52
60
|
* @param currentVersion Core App version
|
|
53
|
-
* @param videoOrientation If the video has different orientation than the HTML5 content
|
|
54
|
-
*
|
|
61
|
+
* @param videoOrientation If the video has a different orientation than the HTML5 content
|
|
62
|
+
* @returns {Promise<void>} A promise that resolves when the screen is successfully resized.
|
|
63
|
+
* @throws {Error} If `baseUrl` is not a valid URL
|
|
64
|
+
* @throws {Error} If `orientation` is not a valid orientation
|
|
65
|
+
* @throws {Error} If `resolution` is not a valid resolution
|
|
66
|
+
* @throws {Error} If `currentVersion` is not a valid string
|
|
67
|
+
* @throws {Error} If `videoOrientation` is not a valid video orientation
|
|
55
68
|
* @since 3.0.0
|
|
56
69
|
*
|
|
57
70
|
* @example
|
|
@@ -63,7 +76,7 @@ class Screen {
|
|
|
63
76
|
* "1.0.4"
|
|
64
77
|
* );
|
|
65
78
|
*
|
|
66
|
-
* // for all other supported
|
|
79
|
+
* // for all other supported devices
|
|
67
80
|
* await sos.management.screen.resize(
|
|
68
81
|
* "",
|
|
69
82
|
* "PORTRAIT",
|
|
@@ -97,7 +110,13 @@ class Screen {
|
|
|
97
110
|
/**
|
|
98
111
|
* The `getOrientation()` method returns the current orientation of the screen.
|
|
99
112
|
*
|
|
113
|
+
* @returns {Promise<IOrientation>} A promise that resolves to the current screen orientation.
|
|
114
|
+
* @throws {Error} If the orientation cannot be retrieved.
|
|
100
115
|
* @since 4.7.0
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* const orientation = (await sos.management.screen.getOrientation()).screenOrientation;
|
|
119
|
+
* console.log(`Current screen orientation is: ${orientation}`);
|
|
101
120
|
*/
|
|
102
121
|
async getOrientation() {
|
|
103
122
|
const { screenOrientation } = await this.postMessage({
|
|
@@ -106,22 +125,37 @@ class Screen {
|
|
|
106
125
|
return screenOrientation;
|
|
107
126
|
}
|
|
108
127
|
/**
|
|
109
|
-
* The `setBrightness()` method sets the brightness of the screen. It supports
|
|
128
|
+
* The `setBrightness()` method sets the brightness of the screen. It supports two different brightness values for 2 time points in the day.
|
|
110
129
|
*
|
|
111
130
|
* @param timeFrom1 Time in the XX:XX format
|
|
112
131
|
* @param brightness1 Brightness value between 0 and 100
|
|
113
132
|
* @param timeFrom2 Time in the XX:XX format
|
|
114
133
|
* @param brightness2 Brightness value between 0 and 100
|
|
115
|
-
*
|
|
134
|
+
* @return {Promise<void>} A promise that resolves when the brightness is successfully set.
|
|
135
|
+
* @throws {Error} If `timeFrom1` is not a valid time in the XX:XX format
|
|
136
|
+
* @throws {Error} If `brightness1` is not a number between 0 and 100
|
|
137
|
+
* @throws {Error} If `timeFrom2` is not a valid time in the XX:XX format
|
|
138
|
+
* @throws {Error} If `brightness2` is not a number between 0 and 100
|
|
116
139
|
* @since 3.0.0
|
|
117
140
|
*
|
|
141
|
+
* @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/brightness/ | Applet Example with Brightness setup}
|
|
142
|
+
*
|
|
118
143
|
* @example
|
|
144
|
+
* // Set brightness to 10% between 00:00 and 17:00, and to 30% between 17:00 and 23:59
|
|
119
145
|
* await sos.management.screen.setBrightness(
|
|
120
146
|
* '00:00',
|
|
121
147
|
* '10',
|
|
122
148
|
* '17:00',
|
|
123
149
|
* '30'
|
|
124
150
|
* );
|
|
151
|
+
*
|
|
152
|
+
* // Set brightness to 50% all day
|
|
153
|
+
* await sos.management.screen.setBrightness(
|
|
154
|
+
* 00:00,
|
|
155
|
+
* 50,
|
|
156
|
+
* 23:59,
|
|
157
|
+
* 50
|
|
158
|
+
* );
|
|
125
159
|
*/
|
|
126
160
|
async setBrightness(timeFrom1, brightness1, timeFrom2, brightness2) {
|
|
127
161
|
(0, Validate_1.default)({ brightness1 }).required().number().min(0).max(100);
|
|
@@ -149,6 +183,8 @@ class Screen {
|
|
|
149
183
|
/**
|
|
150
184
|
* The `getBrightness()` method returns information about the currently set brightness values.
|
|
151
185
|
*
|
|
186
|
+
* @returns {Promise<IBrightness>} A promise that resolves to the current brightness settings.
|
|
187
|
+
* @throws {Error} If the brightness cannot be retrieved.
|
|
152
188
|
* @since 3.0.0
|
|
153
189
|
*/
|
|
154
190
|
async getBrightness() {
|
|
@@ -192,7 +228,8 @@ class Screen {
|
|
|
192
228
|
/**
|
|
193
229
|
* The `powerOn()` method turns the screen on.
|
|
194
230
|
*
|
|
195
|
-
*
|
|
231
|
+
* @returns {Promise<void>} A promise that resolves when the screen is successfully turned on.
|
|
232
|
+
* @throws {Error} If the screen cannot be turned on.
|
|
196
233
|
* @since 3.0.0
|
|
197
234
|
*/
|
|
198
235
|
async powerOn() {
|
|
@@ -201,17 +238,17 @@ class Screen {
|
|
|
201
238
|
});
|
|
202
239
|
}
|
|
203
240
|
/**
|
|
204
|
-
* The `powerOff()` method
|
|
241
|
+
* The `powerOff()` method turns the screen off. It will turn off the display backlight and the panel, and it will also disable the applet.
|
|
205
242
|
*
|
|
206
243
|
* :::warning
|
|
207
|
-
*
|
|
208
|
-
* On Android devices, `powerOff()` also shuts down the webview and the Applet. It's default Android behavior that cannot be changed. Once
|
|
244
|
+
* On Android devices, `powerOff()` also shuts down the webview and the Applet. It's the default Android behavior that cannot be changed. Once
|
|
209
245
|
* the Applet is off, you cannot call `powerOn()` to resume the playback.
|
|
210
246
|
*
|
|
211
247
|
* To manage the display On/Off state, use [REST API Power Actions](https://developers.signageos.io/api/#tag/DevicePower-Actions) instead.
|
|
212
|
-
*
|
|
213
248
|
* :::
|
|
214
249
|
*
|
|
250
|
+
* @returns {Promise<void>} A promise that resolves when the screen is successfully turned off.
|
|
251
|
+
* @throws {Error} If the screen cannot be turned off.
|
|
215
252
|
* @since 3.0.0
|
|
216
253
|
*/
|
|
217
254
|
async powerOff() {
|
|
@@ -222,6 +259,8 @@ class Screen {
|
|
|
222
259
|
/**
|
|
223
260
|
* The `isPoweredOn()` method returns whether the screen is on.
|
|
224
261
|
*
|
|
262
|
+
* @returns {Promise<boolean>} A promise that resolves to a boolean indicating whether the screen is powered on.
|
|
263
|
+
* @throws {Error} If the power state cannot be retrieved.
|
|
225
264
|
* @since 3.0.0
|
|
226
265
|
*/
|
|
227
266
|
async isPoweredOn() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Screen.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Screen/Screen.ts"],"names":[],"mappings":";;;;;AAGA,0DAAkE;AAClE,wDAAyE;AACzE,uEAA+C;AAG/C
|
|
1
|
+
{"version":3,"file":"Screen.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Screen/Screen.ts"],"names":[],"mappings":";;;;;AAGA,0DAAkE;AAClE,wDAAyE;AACzE,uEAA+C;AAG/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAqB,MAAM;IAGjB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,KAAK,CAAC,MAAM,CAClB,OAAe,EACf,WAAmB,EACnB,UAAkB,EAClB,cAAsB,EACtB,gBAAyB;QAEzB,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACvC,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACjD,IAAI,OAAO,0BAAW,CAAC,WAAuC,CAAC,KAAK,WAAW,EAAE,CAAC;YACjF,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,yBAAU,CAAC,UAAqC,CAAC,KAAK,WAAW,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,gBAAgB,IAAI,OAAO,yBAAgB,CAAC,gBAAiD,CAAC,KAAK,WAAW,EAAE,CAAC;YACpH,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACtC,OAAO;YACP,WAAW;YACX,UAAU;YACV,cAAc;YACd,gBAAgB;SAChB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACpD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACI,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,WAAmB,EAAE,SAAiB,EAAE,WAAmB;QACxG,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC;aACrB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,aAAa,CAAC;aAC1B,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC;aACrB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,aAAa,CAAC;aAC1B,SAAS,EAAE,CAAC;QAEd,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;YAC9C,SAAS;YACT,WAAW;YACX,SAAS;YACT,WAAW;SACX,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa;QACzB,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACnD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;SAC9C,CAAC,CAAC;QAEH,OAAO,gBAAgB,CAAC;IACzB,CAAC;IAsCD,gBAAgB;IACT,KAAK,CAAC,uBAAuB,CAAC,GAAG,IAAkC;QACzE,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,WAAW,EAAE,CAAC;YACnE,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;YAC7B,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;YAC7C,MAAM,QAAQ,GAAoB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACxD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC1C,aAAa;aACb,CAAC,CAAC;YACH,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,QAAQ,CAAC,CAAC,qDAAqD;YACvE,CAAC;iBAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,eAAe,IAAI,QAAQ,EAAE,CAAC;gBACxE,MAAM,EAAE,aAAa,EAAE,GAAG,QAAQ,CAAC;gBACnC,OAAO,aAAa,CAAC;YACtB,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,GAAG,IAAI,CAAC;YAC1C,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;YAC7C,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC1C,aAAa;gBACb,WAAW;aACX,CAAC,CAAC;YAEH,OAAO;gBACN,aAAa;gBACb,KAAK;aACL,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACzC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACnD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAChD,CAAC,CAAC;QAEH,OAAO,gBAAgB,CAAC;IACzB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7C,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;CACD;AAlSD,yBAkSC"}
|