@signageos/front-applet 5.0.0-beta.7 → 5.0.0

package/docs/js-api/js-file-system.md

@@ -69,10 +69,12 @@ File System directory structure is **PERSISTENT** and is **NOT** automatically d
 | `isDirectory()` | Returns true if existing path is directory | 2.1.0 |
 | `copyFile()` | Copy file or directory to a new location | 3.3.0 |
 | `writeFile()` | Write string to a file | 3.2.0 |
+| `appendFile()` | Write string to a file | 4.13.0 |
 | `readFile()` | Read a text file | 3.3.0 |
 :::
 
 ## listStorageUnits()
+
 Return list of storage units /internal, external/ from the device. Capacity values are in bytes.
 
 ::: alert alert--info
@@ -85,6 +87,7 @@ This is a mandatory method that is required for all the other File System APIs.
 
 
 ### Javascript Example
+
 ```javascript
 // Storage units are equivalent to disk volumes (C:, D: etc on Windows; /mnt/disc1, /mnt/disc2 on Unix)
 const storageUnits = await sos.fileSystem.listStorageUnits();
@@ -94,6 +97,7 @@ const internalStorageUnit = storageUnits.find((storageUnit) => !storageUnit.remo
 
 console.log(storageUnits);
 ```
+
 ### Returns
 
 ```json
@@ -115,14 +119,15 @@ console.log(storageUnits);
 ]
 ```
 
-
 ## listFiles()
+
 List files and folders located in the internal/external storage.
 * SUCCESS: Return list of files of existing directory
 * FAIL: When listing not existing directory
 * FAIL: When listing existing file (not a directory)
 
 ### Javascript Example
+
 ```javascript
 // Storage units are equivalent to disk volumes (C:, D: etc on Windows; /mnt/disc1, /mnt/disc2 on Unix)
 const storageUnits = await sos.fileSystem.listStorageUnits();
@@ -203,16 +208,19 @@ console.log(testDirDirectoryFilePaths);
 ```
 
 ## getFile()
+
 Return a file from an internal storage
 * OK: Returns local uri of existing file
 * OK: Returns NULL of not existing file
 
 ### Parameters
+
 | Param | Type | Required | Description |
 | -------------- | ------ | :-------: | ----- |
 | `filePath`    | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // always pass storageUnit to tell the JS API where to look
 // get properties of file (at least localUri) or null when not exist
@@ -243,6 +251,7 @@ Return statement is a dynamic object! It has to be always generated and retrieve
 ```
 
 ## exists()
+
 * OK: Returns true of existing directory or file
 * OK: Returns false of not existing directory nor file
 
@@ -253,6 +262,7 @@ Return statement is a dynamic object! It has to be always generated and retrieve
 | `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // always pass storageUnit to tell the JS API where to look
 // check if there is such a file
@@ -262,9 +272,11 @@ console.log(fileExists);
 ```
 
 ### Returns
+
 Boolean value
 
 ## downloadFile()
+
 Download file to path within existing directory or **overrides existing file** in a path when successfully downloaded
 
 * OK: Download file to path within existing directory
@@ -285,6 +297,7 @@ Download file to path within existing directory or **overrides existing file** i
 :::
 
 ### Javascript Example
+
 ```javascript
 // You can download file to specific existing directory
 await sos.fileSystem.downloadFile(
@@ -294,7 +307,39 @@ await sos.fileSystem.downloadFile(
 );
 ```
 
+#### Encoding
+
+All downloads respect a standard of `Encoding` with optional compression of files. See [Mozilla standard Accept Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) and [Content Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding).
+
+Download file method is always sending optional following headers:
+```
+Accept-Encoding: gzip
+Accept-Encoding: compress
+Accept-Encoding: deflate
+Accept-Encoding: br
+Accept-Encoding: identity
+Accept-Encoding: *
+```
+
+If the server understands the `Encoding` standard, it compresses files using `gzip` algorithm before the files are sent to the client. If so, the response will contain the following headers:
+```
+Content-Encoding: gzip
+Content-Encoding: compress
+Content-Encoding: deflate
+Content-Encoding: br
+```
+So the data communication is compressed under the hood. The client will automatically decompress data before it's saved to a specified location path. So from JS API point of view, there is no requirement to decompress data by itself.
+
+The standard is supported on all following platforms:
+
+- WebOS 3+
+- Tizen 2.4+
+- Brightsign
+- Raspberry Pi
+- Windows
+
 ## deleteFile()
+
 Delete a file or directory from the path.
 
 * OK: (not recursive) Deletes an existing file or existing empty directory
@@ -310,6 +355,7 @@ Delete a file or directory from the path.
 | `recursive`| boolean  | <div class="yellow">No</div> | `TRUE` for recursive delete of all content from a directory			|
 
 ### Javascript Example
+
 ```javascript
 // Delete directory and all files inside
 //// First check, if there is such a directory
@@ -327,7 +373,9 @@ if (await sos.fileSystem.exists({ storageUnit: internalStorageUnit, filePath: 't
 ```
 
 ## moveFile()
+
 Move file OR directory to destination path or Move directory to destination path.
+
 * OK: Move file to destination path
 * OK: Move directory to destination path
 * FAIL: When destination path exists (is file or directory)
@@ -341,6 +389,7 @@ Move file OR directory to destination path or Move directory to destination path
 | `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // Move file to a different directory
 //// First check, if there is such a file and directory
@@ -356,6 +405,7 @@ if (await sos.fileSystem.exists({ storageUnit: internalStorageUnit, filePath: 't
 ```
 
 ## getFileChecksum()
+
 Returns checksum of existing file in a path.
 * OK: Returns checksum of existing file in path
 * FAIL: When file path doesn't exist
@@ -373,17 +423,20 @@ Does not work on Samsung Tizen display - [read more here](knowledge-base/md5-tiz
 | `hashFunction`   | string | <div class="red">Yes</div> | Available function is `md5` |
 
 ### Javascript Example
+
 ```javascript
 const md5Checksum = await sos.fileSystem.getFileChecksum({ storageUnit: internalStorageUnit, filePath: 'test-dir/log.1.txt.backup' }, 'md5');
 console.log(md5Checksum);
 ```
 
 ### Returns
+
 ```json
 "b3c6930b9306b8e35a978d342cf5a01e" // string
 ```
 
 ## extractFile()
+
 Extract ZIPed all files (recursively) to destination path and override existing files or merge existing directories.
 
 * OK: Extract ZIPed all files (recursively) to destination path
@@ -405,6 +458,7 @@ The directory/folder you are extracting your ZIP file into has to be created BEF
 | `archiveMethod` | string | <div class="red">Yes</div> | Available method is `zip` |
 
 ### Javascript Example
+
 ```javascript
 // Create directory 'test-dir' in a root directory
 await sos.fileSystem.createDirectory({ storageUnit: internalStorageUnit, filePath: 'test-dir' });
@@ -418,6 +472,7 @@ await sos.fileSystem.extractFile(
 ```
 
 ## createDirectory()
+
 Creates a directory in a path.
 
 * OK: Creates directory in path
@@ -425,7 +480,8 @@ Creates a directory in a path.
 * FAIL: When creating directory in not existing containing (parent) directory
 
 ::: alert alert--warning
-Never start OR end the `filePath` with a slash - `/`. It will cause error *50512*
+- Never start OR end the `filePath` with a slash - `/`. It will cause error *50512*
+- It is a good practice to check if directory exists - `isDirectory()` prior creating it
 :::
 
 ### Parameters
@@ -435,12 +491,30 @@ Never start OR end the `filePath` with a slash - `/`. It will cause error *50512
 | `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 // Create directory 'test-dir' in a root directory
 await sos.fileSystem.createDirectory({ storageUnit: internalStorageUnit, filePath: 'test-dir' });
 ```
 
+```javascript
+// Create multiple directories
+const myDirs = [
+ 'dir1',
+ 'dir2',
+ 'dir1/dir3',
+];
+await Promise.all(myDirs.map(async (dirname) => {
+ const fp = { storageUnit: internalStorageUnit, filePath: `uploads/${dirname}` };
+ if (!await sos.fileSystem.exists(fp)) {
+   await sos.fileSystem.createDirectory(fp);
+ }
+});
+// All dirs created
+```
+
 ## isDirectory()
+
 Returns true if existing path is directory.
 
 * OK: Returns true if existing path is directory
@@ -454,11 +528,13 @@ Returns true if existing path is directory.
 | `filePath` | FilePath  | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 await sos.fileSystem.isDirectory({ storageUnit: internalStorageUnit, filePath: 'test-dir' });
 ```
 
 ## copyFile()
+
 Copy file OR directory to a new location.
 
 ### Parameters
@@ -469,6 +545,7 @@ Copy file OR directory to a new location.
 | `destinationFilePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
 
 ### Javascript Example
+
 ```javascript
 await sos.fileSystem.copyFile(
    { storageUnit: internalStorageUnit, filePath: 'test-dir/log.1.txt' },
@@ -477,16 +554,13 @@ await sos.fileSystem.copyFile(
 ```
 
 ## writeFile()
+
 Write into file directly:
+
 - string support only
 - override only
 - no append
 
-::: alert alert--warning
-**LG webOS limitation**:  
-It's possible to handle only files up to **~10KB** on webOS devices. At the moment we are working on the solution regarding the file/s 'manipulation' on LG devices.
-:::
-
 ### Parameters
 
 | Param | Type | Required | Description |
@@ -496,6 +570,7 @@ It's possible to handle only files up to **~10KB** on webOS devices. At the mome
 
 
 ### Javascript Example
+
 ```javascript
 await sos.fileSystem.writeFile(
    { storageUnit: internalStorageUnit, filePath: 'test-dir/log.txt' },
@@ -503,6 +578,30 @@ await sos.fileSystem.writeFile(
 );
 ```
 
+## appendFile()
+
+Append content into file directly:
+
+- string support only
+- append only
+
+### Parameters
+
+| Param | Type | Required | Description |
+| ------ | -------- | :------: | ---- |
+| `filePath` | FilePath | <div class="red">Yes</div> | Object contains storageUnit object returned by `listStorageUnits()` and `filePath` if the file or directory |
+| `content` | String | <div class="red">Yes</div> | Parsed content as string |
+
+
+### Javascript Example
+
+```javascript
+await sos.fileSystem.appendFile(
+   { storageUnit: internalStorageUnit, filePath: 'test-dir/log.txt' },
+   'My awesome log line\n',
+);
+```
+
 ## readFile()
 Read a text file.
 

package/docs/js-api/js-hardware-serial.md

@@ -20,8 +20,8 @@ This can be leveraged to integrate a wide variety of hardware into your digital
 Such hardware could be, for example, printers, payment terminals or sensors.
 
 ::: alert alert--warning
-* Before using this API, ensure that the device supports serial via `sos.management.supports("SERIAL")`.
-* More info about how to check it, you can find [**HERE**](/api/js/management/1-js-management#supports)
+* Before using this API, ensure that the display supports serial via `sos.display.supports("SERIAL")`.
+* More info [**HERE**](/api/js/content/js-display#supports).
 :::
 
 ## All methods

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

@@ -1,5 +1,5 @@
 ---
-title:  Input
+title:  IR Remote Control Input
 author: Miroslav Behina
 date:   22.11.2018
 type:   js-api
@@ -11,11 +11,13 @@ tags:
 description: "[Content JS API] For the specific logic of an application (games for example), binding the remote control inputs can be helpful."
 ---
 
-# Input
+# IR Remote Control Input
 For the specific logic of an application (games for example), binding the remote control inputs can be helpful. 
 Only a subset of all remote control keys is supported on the specific device. Only numerical digits are guaranteed to be supported. 
 This feature must be tested by users on real devices.
 
+## Event onKeyUp()
+
 ### Parameters
 
 ::: table-responsive
@@ -24,6 +26,13 @@ This feature must be tested by users on real devices.
 | event (in listener) | Object | <div class="red">Yes</div> | Plain JS object containing keyCode as number and keyName as string and type of event (always keyup string) | 1.3.0 |
 :::
 
+### Javascript syntax
+```javascript
+await sos.input.onKeyUp((keyUpEvent) => {
+  console.log(`Pressed: ${keyUpEvent.keyCode} (${keyUpEvent.keyName})`);
+});
+```
+
 ## Map of keyCodes:
 | Name | Key code | Name | Key Code |
 | ---- | :----: | ----- | :----: |
@@ -57,3 +66,19 @@ interface IKeyUpEventListener {
 }
 onKeyUp(listener: IKeyUpEventListener): void;
 ```
+
+<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/tree/master/examples/content-js-api/remote-control">
+            <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">IR Input handling</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>

package/docs/js-api/js-offline-cache-media-files.md

@@ -66,10 +66,14 @@ Method `saveFile()` is used to save files from remote a destination into the dev
 `headers` has to be a JSON object. If you are passing the value, make sure you use `JSON.parse()`.
 :::
 
+::: alert alert--warning
+`uid` should have the same file extension (e.g.: mp4, svg, jpg) as the original file.
+:::
+
 ### Javascript example
 ```javascript
 // Example saving files into internal memory, unique id could be salted md5 hash, uri directs to our CDN
-await sos.offline.cache.saveFile('9d66725ba2105f1833731ade5b7f334e', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
+await sos.offline.cache.saveFile('9d66725ba2105f1833731ade5b7f334e.mp4', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
 .then(() => { console.log('Saved'); })
 .catch((error) => { console.error(error); });
 ```
@@ -87,15 +91,19 @@ Method `loadFile()` is used for individual file retrieval from internal memory.
 | --------- | ------------ | :---------: | --------------- |
 | `uid` | string | <div class="red">Yes</div> | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters |
 
+::: alert alert--warning
+`uid` should have the same file extension (e.g.: mp4, svg, jpg) as the original file.
+:::
+
 ### Javascript Example
 ```javascript
-await sos.offline.cache.loadFile('9d66725ba2105f1833731ade5b7f334e')
+await sos.offline.cache.loadFile('9d66725ba2105f1833731ade5b7f334e.mp4')
 .then((file) => { console.log('Loaded', file); })
 .catch((error) => { console.error(error); });
  
 // Logs into console
 {
-  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e',
+  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e.mp4',
 }
 ```
 
@@ -124,15 +132,19 @@ To get file from internal memory & save it when not yet exists we prepared `load
 | `uri`             | string         | <div class="red">Yes</div> | URL address where to get the file             |
 | `headers`        | object         | <div class="yellow">No</div> | Key, value pairs of HTTP headers to send along with the request. Used when the target file is protected by a password or if any other specific headers are needed to access it.                                   			|
 
+::: alert alert--warning
+`uid` should have the same file extension (e.g.: mp4, svg, jpg) as the original file.
+:::
+
 ### Javascript Example
 ```javascript
-await sos.offline.cache.loadOrSaveFile('9d66725ba2105f1833731ade5b7f334e', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
+await sos.offline.cache.loadOrSaveFile('9d66725ba2105f1833731ade5b7f334e.mp4', 'https://cdn.my-cms.com/files/video.mp4', { "Authorization": "Basic Zm9vOmJhcg==" })
 .then((file) => { console.log('Loaded or Saved', file); })
 .catch((error) => { console.error(error); });
  
 // Logs into console
 {
-  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e',
+  filePath: '/real/device/path/to/file/9d66725ba2105f1833731ade5b7f334e.mp4',
 }
 ```
 
@@ -187,7 +199,7 @@ Method `deleteFile()` is used for deleting previously saved file from internal m
 
 ### Javascript example
 ```javascript
-await sos.offline.cache.deleteFile('9d66725ba2105f1833731ade5b7f334e')
+await sos.offline.cache.deleteFile('9d66725ba2105f1833731ade5b7f334e.mp4')
 .then(() => { console.log('Deleted'); })
 .catch((error) => { console.error(error); });
 ```
@@ -203,7 +215,7 @@ Method `getChecksumFile()` is used for getting the checksum of file from interna
 
 ### Javascript example
 ```javascript
-await sos.offline.cache.getChecksumFile('9d66725ba2105f1833731ade5b7f334e', 'md5')
+await sos.offline.cache.getChecksumFile('9d66725ba2105f1833731ade5b7f334e.mp4', 'md5')
 .then((checksum) => { console.log('MD5 checksum is ' + checksum); })
 .catch((error) => { console.error(error); });
 ```

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

@@ -8,18 +8,19 @@ tags:
 - applet_api
 - api
 - js_api
-description: "[Content JS API] Methods to play or stop stream on displays."
+description: "[Content JS API] Methods to play or stop video streams."
 ---
 
 # Video streams
-Methods to play or stop stream on displays.
+Methods to play or stop video streams.
 
 ## All methods
 ::: table-responsive
-| Methods          | Description                                                      | Supported since |
+| Methods            | Description                                                      | Supported since |
 | ------------------ | ---------------------------------------------------------------- | --------------- |
-| `play()`           | Method start the video play                                    | 1.0.18          |
-| `stop()`           | Method stops the video play                                    | 1.0.18          |
+| `prepare()`        | Prepare video stream in the background                           | 4.7.0           |
+| `play()`           | Start playing video stream                                       | 1.0.18          |
+| `stop()`           | Stop video stream                                                | 1.0.18          |
 | `onConnected()`    | Calls a listener callback when stream connects                   | 1.0.20          |
 | `onDisconnected()` | Calls a listener callback when stream disconnects                | 1.0.20          |
 | `onError()`        | Calls a listener callback when an unexpected stream error occurs | 1.0.20          |
@@ -29,23 +30,64 @@ Methods to play or stop stream on displays.
 Are you using **Samsung Tizen** to play streams? [Read more about limitation and Tizen-specific details](knowledge-base/stream-playback-on-tizen).
 :::
 
+## prepare()
+Calls the internal player and prepares a video stream in memory, so it can later start playing instantaneously.
+
+::: alert alert--info
+If you want to play a video stream in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height = document.documentElement.clientHeight as setup parameters.
+:::
+
+### Parameters
+::: table-responsive
+|      Param     | Type                        | Required                     | Description                                   |
+| -------------- | --------------------------- | :--------------------------: | --------------------------------------------- |
+| `uri`          | String                      | <div class="red">Yes</div>   | Network address where the stream is available |
+| `x`            | Number                      | <div class="red">Yes</div>   | Stream x-position on the screen               |
+| `y`            | Number                      | <div class="red">Yes</div>   | Stream y-position on the screen               |
+| `width`        | Number                      | <div class="red">Yes</div>   | Stream width on the screen 	                  |
+| `height`		 | Number                      | <div class="red">Yes</div>   | Stream height on the screen 	              |
+| `protocol`     | String                      | <div class="red">Yes</div> | Protocol that the stream is using             |
+|^^|^^|^^| Types: `HLS`, `RTP`, `HTTP`, `UDP`, `RTMP`, `RTSP`. |
+:::
+
+### Javascript syntax
+```javascript
+await sos.stream.prepare(uri,  x,  y,  width,  height,  protocol);
+```
+
+<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/stream">
+            <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">Working example on our Github</h3>
+                <div class="wide-box__description">Stream video Applet example</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
 ## play()
-Method calls the internal player and starts the video in correct position.
+Calls the internal player and starts a video stream in correct position.
 
 ::: 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.
+If you want to play a video stream in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height = document.documentElement.clientHeight as setup parameters.
 :::
 
 ### 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 		|
-| `protocol`     | String                      | <div class="yellow">No</div> | Protocol type of stream |
+|      Param     | Type                        | Required                     | Description                                   |
+| -------------- | --------------------------- | :--------------------------: | --------------------------------------------- |
+| `uri`          | String                      | <div class="red">Yes</div>   | Network address where the stream is available |
+| `x`            | Number                      | <div class="red">Yes</div>   | Stream x-position on the screen               |
+| `y`            | Number                      | <div class="red">Yes</div>   | Stream y-position on the screen               |
+| `width`        | Number                      | <div class="red">Yes</div>   | Stream width on the screen 	                  |
+| `height`		 | Number                      | <div class="red">Yes</div>   | Stream height on the screen 	              |
+| `protocol`     | String                      | <div class="red">Yes</div> | Protocol that the stream is using             |
 |^^|^^|^^| Types: `HLS`, `RTP`, `HTTP`, `UDP`, `RTMP`, `RTSP`. |
 :::
 
@@ -71,7 +113,7 @@ await sos.stream.play(uri,  x,  y,  width,  height,  protocol);
 </div>
 
 ## stop()
-Method stops the video play. 
+Stops the video stream playback. 
 
 ### Javascript syntax
 ```javascript
@@ -80,13 +122,13 @@ await sos.stream.stop(uri,  x,  y,  width,  height);
 
 ### 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 		|
+|      Param     | Type                        | Required     | Description                                                 |
+| -------------- | --------------------------- | :------------------------: | --------------------------------------------- |
+| `uri`          | String                      | <div class="red">Yes</div> | Network address where the stream is available |
+| `x`            | Number                      | <div class="red">Yes</div> | Stream x-position on the screen               |
+| `y`            | Number                      | <div class="red">Yes</div> | Stream y-position on the screen               |
+| `width`        | Number                      | <div class="red">Yes</div> | Stream width on the screen 	                |
+| `height`		 | Number                      | <div class="red">Yes</div> | Stream height on the screen 	                |
 :::
 
 ## Event onConnected()
@@ -153,7 +195,7 @@ interface StreamEvent {
         y: number;
         width: number;
         height: number;
-        protocol?: string;
+        protocol: string;
     }
 }
 play(

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

@@ -20,6 +20,7 @@ Management API app lets you check application type and upgrade the application.
 | 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  | |
 :::
 
@@ -30,8 +31,24 @@ Method `getType()` returns the display type of application on the device.
 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 display version of application on the device.
+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