@signageos/front-applet 4.11.0

package/docs/js-api/js-video.md

@@ -0,0 +1,282 @@
+---
+title:  Video Playback
+author: Miroslav Behina
+date:   22.11.2018
+type:   js-api
+tags:
+- applet
+- applet_api
+- api
+- js_api
+description: "[Content JS API] We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation."
+---
+
+# Video Playback
+We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation.
+
+## All methods/events
+::: table-responsive
+| Methods/Events  | Description | Supported since |
+| ----------------- | ----------- | ------ | :---------------: |
+| `play()` | Start video playing | 1.0.3 |
+| `prepare()` | Prepare next video | 1.0.3 |
+| `pause()` | Pause video | 1.0.3 |
+| `stop()` | Completely stop video | 1.0.3 |
+| `resume()` | Continue in playing | 1.0.3 |
+| `onceEnded()` | Wait until video ends | 1.0.29 |
+| `onEnded()` | Event called when video ends | 1.0.3 |
+| `onError()` | Event called when video emits error | 1.0.3 |
+:::
+
+::: alert alert--warning
+First 5 parameters (uri, x, y, width, height) are unique identifiers for playing the video using play, stop, resume and pause methods.
+:::
+
+::: alert alert--info
+If you want to play video in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height = document.documentElement.clientHeight as setup parameters.
+:::
+
+## How it works
+![Gapless video playback lifecycle](../img/gapless_video_playback_lifecycle.png)
+
+
+## play()
+Play method calls the internal player and starts the video in correct position.
+
+### Parameters
+::: table-responsive
+| Param | Type | Required | Description |
+| ------ | ------ | :--------: | -------- |
+| `uri` | String | <div class="red">Yes</div> | Address to remote (online) or local video file |
+| `x` | Number | <div class="red">Yes</div> | 	x-position for video on screen |
+| `y` | Number | <div class="red">Yes</div> |	y-position for video on screen |
+| `width` | Number | <div class="red">Yes</div> | 	Video width on screen |
+| `height` | Number | <div class="red">Yes</div> | Video height on screen |
+:::
+
+### Javascript
+```javascript
+await sos.video.play(uri, x, y, width, height);
+```
+
+<div class="row d-flex align-content-stretch force-padding-20">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/video-loop-one">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Play one video in endless loop</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+<div class="row d-flex align-content-stretch force-padding-10">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/video-multiple">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Play multiple videos in endless loop</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+<div class="row d-flex align-content-stretch force-padding-10">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/video-and-images">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Switching video and images in endless loop</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+## prepare()
+Prepare method calls the internal player and preload the video into memory.
+
+::: alert alert--info
+Using `prepare()` is mandatory for gapless playback
+:::
+
+::: alert alert--warning
+`4k` parameter is no longer needed since Front-display v7.5.0, Tizen Core App v2.1.0.  
+`volume` is supported only on the RaspberryPi.
+:::
+
+### Parameters
+::: table-responsive
+| Param | Type | Required | Description |
+| ------ | ------ | :--------: | -------- |
+| `uri` | String | <div class="red">Yes</div> | Address to remote /online/ or local video file |
+| `x` | Number | <div class="red">Yes</div> | 	x-position for video on screen |
+| `y` | Number | <div class="red">Yes</div> |	y-position for video on screen |
+| `width` | Number | <div class="red">Yes</div> | 	Video width on screen |
+| `height` | Number | <div class="red">Yes</div> | Video height on screen |
+| `options` | Object | <div class="yellow">No</div> | Additional video properties |
+:::
+
+### Options properties
+::: table-responsive
+| Property | Type | Required | Description |
+| ------- | ------ | :------:| -----------|
+| `4k` | Boolean | <div class="yellow">No</div> | Support for 4k video |
+|^^|^^|^^| Deprecated since Tizen Core App v2.1.0 |
+| `background` | Boolean | <div class="yellow">No</div> |  Bring video behind the applet html (similar to z-index: -1) |
+| `volume` | Number | <div class="yellow">No</div> | Adjust volume of playing video itself (doesn't adjust display speaker volume) |
+|^^|^^|^^| Supported only on **RaspberryPi** |
+:::
+
+### Javascript
+```javascript
+// playing video
+await sos.video.prepare(uri, x, y, width, height);
+// or advanced usage
+await sos.video.prepare(uri, x, y, width, height, {
+	'4k': true,
+	background: true,
+	volume: 60,
+});
+```
+
+## stop(), pause() and resume()
+All these methods call the internal player. All variables are mandatory in order to ensure video identification.
+
+### Parameters
+::: table-responsive
+| Param | Type | Required | Description |
+| ------ | ------ | :--------: | -------- |
+| `uri` | String | <div class="red">Yes</div> | Address to remote (online) or local video file |
+| `x` | Number | <div class="red">Yes</div> | 	x-position for video on screen |
+| `y` | Number | <div class="red">Yes</div> |	y-position for video on screen |
+| `width` | Number | <div class="red">Yes</div> | 	Video width on screen |
+| `height` | Number | <div class="red">Yes</div> | Video height on screen |
+:::
+
+### Javascript
+```javascript
+// stop video
+await sos.video.stop(uri, x, y, width, height);
+ 
+// pause
+await sos.video.pause(uri, x, y, width, height);
+ 
+// resume
+await sos.video.resume(uri, x, y, width, height);
+```
+
+## Event onceEnded
+Wait until one specific video is ended.
+
+### Parameters
+::: table-responsive
+| Param | Type | Required | Description |
+| ------ | ------ | :--------: | -------- |
+| `uri` | String | <div class="red">Yes</div> | Address to remote (online) or local video file |
+| `x` | Number | <div class="red">Yes</div> | 	x-position for video on screen |
+| `y` | Number | <div class="red">Yes</div> |	y-position for video on screen |
+| `width` | Number | <div class="red">Yes</div> | 	Video width on screen |
+| `height` | Number | <div class="red">Yes</div> | Video height on screen |
+:::
+
+### Javascript
+```javascript
+// wai on end of video
+await sos.video.onceEnded(uri, x, y, width, height);
+```
+
+## Events onEnded, onError
+All events about played videos can be binded using above mentioned methods. It will emit all events of all playing videos. Video source of emited event can be identified by srcArguments object available in event.
+
+Listener method added as argument accepts event object. It contains these properties:
+
+::: table-responsive
+| Property | Description |
+| ------ | ------ |
+| `type` |	Type of event which can be ended or error string |
+| `srcArguments` |	Arguments which was passed to play method.<br> Contains uri, x, y, width & height. |
+:::
+
+### Javascript
+```javascript
+// detect video ended
+await sos.video.onEnded((event) => { console.log(event); });
+ 
+// detect video error
+await sos.video.onError((event) => { console.log(event); });
+```
+
+## Usage with Typescript
+You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-typescript).
+
+```typescript
+play(
+	uri: string,
+	x: number,
+	y: number,
+	width: number,
+	height: number
+): Promise<void>;
+prepare(
+	uri: string,
+	x: number,
+	y: number,
+	width: number,
+	height: number,
+	options?: {
+		'4k'?: boolean;
+		background?: boolean;
+		volume?: number;
+	}
+): Promise<void>;
+stop(
+	uri: string,
+	x: number,
+	y: number,
+	width: number,
+	height: number
+): Promise<void>;
+pause(
+	uri: string,
+	x: number,
+	y: number,
+	width: number,
+	height: number
+): Promise<void>;
+resume(
+	uri: string,
+	x: number,
+	y: number,
+	width: number,
+	height: number
+): Promise<void>;
+```
+
+## Errors
+Although we are doing our best, following errors may occur when working with the video stream.
+
+::: table-responsive
+| Code | Type | Message |
+| ---- | ---- | ------- |
+| 41501 | AppletVideoError | This video was not played yet. The arguments: `arguments` |
+| 51501 | InternalVideoError | Couldn't play the video. |
+| 51502 | InternalVideoError | Couldn't prepare the video. |
+| 51503 | InternalVideoError | Couldn't stop the video. |
+| 51504 | InternalVideoError | Couldn't pause the video. |
+| 51505 | InternalVideoError | Couldn't resume the video. |
+:::

package/docs/management-api/1-js-management.md

@@ -0,0 +1,133 @@
+---
+title:  Management
+author: Miroslav Behina
+date:   1.4.2018
+type:   js-management-api
+tags:
+- applet
+- applet_api
+- api
+- js_management_api
+description: "[Management JS API] To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored."
+---
+
+# Management
+
+To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored.
+
+## All methods
+::: table-responsive
+| Method  | Description | Supported since |
+| ------ | -------- | :------------: |
+| `supports()` | Enum of supported features | 2.0.0 |
+| `getModel()` | Information about device model | 2.0.0 |
+| `getSerialNumber()` | Information about device serial number | 2.1.0 |
+| `getBatteryStatus()` | Information about the battery level and battery charging status | 2.1.0 |
+| `getNetworkInfo()` | Information about network connections, IPs and DNS | 4.0.0 |
+| `getTemperature()` | Current device temperature | 3.0.0 |
+| `resetSettings()` | Clear all settings on device | 4.0.0 |
+| `factoryReset()` | Do a device factory reset | 4.0.0 |
+:::
+
+## Examples
+<div class="row d-flex align-content-stretch force-padding-10">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/basics/">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Basic usage of management API</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+<div class="row d-flex align-content-stretch force-padding-10">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-getters/">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Getting basic management API data</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+<div class="row d-flex align-content-stretch force-padding-10">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-setters/">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Setting basic management API data</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+## supports()
+Method `supports()` will show you what capabilities the deployed device currently has.
+
+::: table-responsive
+|      Param     | Type                           |Description                   |
+| -------------- | ----------------------------- | ---------------------------- |
+| `capability`     | String                       | Name of capability |
+:::
+
+### Javascript example
+```javascript
+await sos.management.supports("NETWORK_INFO"); // Returns boolean
+```
+
+## getModel()
+Method `getModel()` will display the model of your device.
+
+```javascript
+await sos.management.getModel(); // Returns string ex. Philips-10BDL3051T
+```
+
+## getSerialNumber()
+Method `getSerialNumber()` will display device's serial number.
+
+```javascript
+await sos.management.getSerialNumber(); // Returns string ex. AU1A1xxxxxx07502
+```
+
+
+## getBatteryStatus()
+Method `getBatteryStatus()` will display information about device's battery.
+
+```javascript
+await sos.management.getBatteryStatus(); // Returns object
+```
+
+### Example of response
+```json
+{
+	"chargeType": "AC",
+	"isCharging": true,
+	"lastChargingTime": "2019-02-01T19:27:30.393Z",
+	"percentage": 100,
+	"updatedAt": "2019-02-01T19:27:31.247Z"
+}
+```
+
+## getTemperature() 
+Method `getTemperature()` will display information about the current temperature of the device. 
+
+```typescript
+await sos.management.getTemperature(); // Returns number values 0-100
+```

package/docs/management-api/10-js-management-application.md

@@ -0,0 +1,123 @@
+---
+title:  App
+author: Krystof Woldrich
+date:   24.4.2018
+type:   js-management-api
+tags:
+- applet
+- applet_api
+- api
+- js_management_api
+description: "[Management JS API] Management API app lets you check application type and upgrade the application."
+---
+
+# App
+
+Management API app lets you check application type and upgrade the application.
+
+## All methods
+::: table-responsive
+| Method | Description | Supported since |
+| ------ | -------- | ------------- |
+| `getType()` | Information about the platform your application is running on (eg. Tizen) | |
+| `getVersion()` | Information about current version of your application is running on the device (eg. 2.0.5) | |
+| `upgrade()` | Upgrade/Downgrade the Core App  | |
+:::
+
+## getType() 
+Method `getType()` returns the display type of application on the device.
+
+```javascript
+await sos.management.app.getType(); // Returns ex. sssp, android
+```
+
+**Returns one of the following types:**  
+- `android`
+- `brightsign`
+- `default` (Emulator)
+- `linux` (Raspberry Pi)
+- `sssp`
+- `tizen`
+- `webos`
+- `windows`
+
+::: alert alert--info
+If you need to get specific Android brand or Raspberry Pi model, use the [Firmware API](api/js/management/latest/2-js-management-firmware) `getType()`.
+:::
+
+## getVersion()
+Method `getVersion()` returns the version of Core App application on the device.
+
+*This API is only available for Applets deployed via Timing from Box or REST API.*
+
+```javascript
+await sos.management.app.getVersion(); // Returns ex. 2.0.0
+```
+
+## upgrade()
+Method `upgrade()` will upgrade the [Core App](knowledge-base/application-version-and-release-policy) on the device.
+
+
+### A) Upgrading signageOS Core App
+To upgrade to signageOS Core App, use the following parameters:
+
+::: table-responsive
+|      Param     |Type                           | Value |Description                   |
+| -------------- | ----------------------------- | ------- | --------------------- |
+| `baseUrl`     | String                        | `https://cdn.your-cms.com/tizen/`| Location of the new version of the Core App |
+| `version`     | String                        |  `x.x.x` | Core App version |
+:::
+
+<div class="row d-flex align-content-stretch force-padding-10">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" href="/changelogs">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                   <i class="fas fa-sticky-note svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">List of our latest core app versions</h3>
+                <div class="wide-box__description">signageOS Documentation</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+### Javascript example
+```javascript
+await sos.management.app.upgrade('https://example.com/signageos-core-app.zip', '2.0.0');
+```
+
+<br>
+
+### B) Upgrading Open Core App with built-in Applet
+If you are [building your own Core App](/knowledge-base/open-standalone-signageos-provisioning) with the built-in Applet, use only one parameter `absolutePathUrl`.
+
+The `absolutePathUrl` should point to the application file, e.g. `https://cdn.your-cms.com/rpi/linux_202006100815_1.0.1_779c303408.zip`.
+
+::: table-responsive
+|      Param     |Type                           | Value |Description                   |
+| -------------- | ----------------------------- | ------- | --------------------- |
+| `absolutePathUrl`| String     | `https://cdn.your-cms.com/rpi/linux_xxx.zip`| Location of the new version of the Open Core App with built-in Applet |
+:::
+
+### Javascript example
+```javascript
+await sos.management.app.upgrade('https://cdn.your-cms.com/rpi/linux_xxx.zip');
+```
+
+<br>
+
+Because each of the platforms (Tizen, webOS, BrightSign, etc.) are different, use the following table to define correct `absolutePathUrl`:
+
+::: table-responsive
+| Platform | absolutePathUrl | Note |
+| -------- | --------------- | ---- |
+| Tizen | `https://cdn.your-cms.com/core-apps/landscape` <br/> `https://cdn.your-cms.com/core-apps/portrait` | |
+| SSSP | `https://cdn.your-cms.com/core-apps/landscape_full-hd` <br/> `https://cdn.your-cms.com/core-apps/portrait_full-hd` | |
+| webOS | `https://cdn.your-cms.com/core-apps/com.lg.app.signage_latest.ipk` <br/> `https://cdn.your-cms.com/core-apps/com.lg.app.signage_latest.zip` |  `.zip` is for old webOS 1.0 and 2.0 only |
+| Android | `https://cdn.your-cms.com/core-apps/io.signageos.open_3.1.0.android.apk` | If you are building for specific version of Android (e.g. Benq) you will have a BenQ specific apk|
+| BrightSign | `https://cdn.your-cms.com/core-apps/display-brightsign.zip` | |
+| NEC / RPi | `https://cdn.your-cms.com/core-apps/linux_202006100815_1.0.1_779c303408.zip` | |
+:::