@signageos/front-applet 8.1.3 → 8.2.0

package/docs/sos/offline/index.md

@@ -4,16 +4,22 @@ sidebar_position: 0
 
 # offline
 
-<Admonition type="info" icon="" title="">
-  Learn more about using this API [here](https://developers.signageos.io/docs/applets/api-guides/offline-content#caching-css--javascript-sosoffline)
-</Admonition>
+Web-based applications often require additional assets to function, but downloading them every time is undesirable. The JS Applet SDK offers a wide range of APIs for storing different kinds of assets.
 
-The `sos.offline` API groups together methods for storing and using JS, CSS and font files.
+Generally, there are four types of assets:
+- CSS & JavaScript files
+- Fonts
+- Audio-visual content (image, video, and audio files)
+- Arbitrary data (e.g., JSON files, plain text, binary data)
 
-:::warning
+And the SDK also provides two different APIs:
+- `sos.offline` & `sos.offline.cache`: A file system abstraction for caching files that are removed when the applet configuration is changed or the applet is reloaded. This method is usually preferred if the files can be re-downloaded.
+- `sos.fileSystem`: Direct access to the file system. All files are stored permanently and are not removed when the applet configuration changes.
 
-Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
+Using the `sos.offline` and `sos.offline.cache` APIs allows you to ship an applet without content, including only basic bootstrapping code, and load the content dynamically. The content will then be available even when the device is offline.
 
+:::warning
+Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
 :::
 
 ## Methods
@@ -22,9 +28,18 @@ Emulator has certain limitations while handling offline files. [Read more here](
 
 The `addFile()` method downloads the specified file and stores it locally.
 
+CSS and JavaScript files are specific because they must be loaded with an HTML tag. The `sos.offline` API methods download, save, and append the resource to the web page. When adding a file, choose a unique identifier (`uid`) that should not change for the resource. The file will be overwritten if another file is added with the same `uid`.
+
+:::info
+The file URL must point to a file. If your URI leads to a redirect (e.g. from http to https), the API will not work.
+:::
+
 ```ts expandable
 addFile(file: ISaveFile): Promise<void>;
 // show-more
+/**
+ * Interface represents a file that can be saved to cache and loaded into applet resources.
+ */
 interface ISaveFile {
     uid: string;
     uri: string;
@@ -48,17 +63,33 @@ interface IElement {
 
 ```
 
+#### Params
+
+| Name           | Type                         | Required         | Description                                                                                   |
+|----------------|------------------------------|------------------|-----------------------------------------------------------------------------------------------|
+| `file`         | `ISaveFile`                  |  <div>Yes</div>  | URI of the file to be downloaded.                                                             |
+| `file.uid`     | `string`                     |  <div>Yes</div>  | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 characters. |
+| `file.type`    | `IFileType`                  |  <div>Yes</div>  | Type of the file, e.g. 'javascript', 'css', etc.                                              |
+| `file.headers` | `{ [key: string]: string; }` |  <div>No</div>   | HTTP headers to be sent with the request for the file.                                        |
+| `file.flags`   | `IFlag[]`                    |  <div>No</div>   | Additional flags for appending stored files to the DOM or other operations                    |
+
+#### Return value
+
+Resolves when the file is added and the file is appended to the document when flags are used.
+
+#### Possible errors
+
+
+- If the `file` parameter is not an object.
+- If the `file` parameter does not contain a valid parameters.
+
 #### Example
 
 ```ts
 await sos.offline.addFile({
-	// Source URL
 	uri: 'https://code.jquery.com/jquery-3.7.1.slim.min.js',
-	// Unique identifier of the resource
 	uid: 'jquery-3.7.1.slim.min.js',
-	// Indicate that the downloaded file is a JavaScript file
 	type: sos.offline.types.javascript,
-	// After the file is downloaded, it will be appended to document.body
 	flags: [sos.offline.flags.append(document.body)],
 });
 ```
@@ -67,11 +98,17 @@ await sos.offline.addFile({
 
 ### addFiles()
 
-The `addFiles()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored is **not** guaranteed.
+The `addFiles()` method downloads the specified files and stores them locally.
+The order in which the files are downloaded and stored is **not** guaranteed.
+
+CSS and JavaScript files are specific because they must be loaded with an HTML tag. The `sos.offline` API methods download, save, and append the resource to the web page. When adding a file, choose a unique identifier (`uid`) that should not change for the resource. The file will be overwritten if another file is added with the same `uid`.
 
 ```ts expandable
-addFiles(files: ISaveFile[]): Promise<void[]>;
+addFiles(files: ISaveFile[]): Promise<Awaited<void>[]>;
 // show-more
+/**
+ * Interface represents a file that can be saved to cache and loaded into applet resources.
+ */
 interface ISaveFile {
     uid: string;
     uri: string;
@@ -95,6 +132,20 @@ interface IElement {
 
 ```
 
+#### Params
+
+| Name    | Type          | Required         | Description                                         |
+|---------|---------------|------------------|-----------------------------------------------------|
+| `files` | `ISaveFile[]` |  <div>Yes</div>  | Array of files to be downloaded and stored locally. |
+
+#### Return value
+
+Resolves when all files are added.
+
+#### Possible errors
+
+If the `files` parameter is not an array of objects.
+
 #### Example
 
 ```ts
@@ -111,15 +162,26 @@ await sos.offline.addFile([{
 }]);
 ```
 
+:::note[GitHub Example]
+
+- [ Example of Applet that save files and load them in one file](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/offline-resources)
+
+:::
+
 <Separator />
 
 ### addFilesSync()
 
-The `addFilesSync()` method downloads the specified files and stores them locally. The order in which the files are downloaded and stored **is** guaranteed.
+Method `addFile()` will allow you to load single resource into applet. If you want to load more resource, use `addFiles()`.
+
+The order in which the files are downloaded and stored **is** guaranteed.
 
 ```ts expandable
 addFilesSync(files: ISaveFile[]): Promise<void>;
 // show-more
+/**
+ * Interface represents a file that can be saved to cache and loaded into applet resources.
+ */
 interface ISaveFile {
     uid: string;
     uri: string;
@@ -143,6 +205,33 @@ interface IElement {
 
 ```
 
+#### Params
+
+| Name    | Type          | Required         | Description                                         |
+|---------|---------------|------------------|-----------------------------------------------------|
+| `files` | `ISaveFile[]` |  <div>Yes</div>  | Array of files to be downloaded and stored locally. |
+
+#### Return value
+
+Resolves when all files are added and the files are appended to the document when flags are used.
+
+#### Possible errors
+
+If the `files` parameter is not an array of objects
+
+#### Example
+
+```ts
+const file = { // File that will be loaded into an applet
+    "uri": "https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js",
+    "uid": "jquery-2.2.4.min.js",
+    "type": sos.offline.types.javascript,
+    "flags": [sos.offline.flags.append(document.body)]
+}
+
+await sos.offline.addFile(file); // And finally load file
+```
+
 <Separator />
 
 ### addFont()
@@ -183,14 +272,28 @@ type AnyString = string & {};
 
 #### Params
 
-| Name                             | Type           | Description                                                                                         |
-|----------------------------------|----------------|-----------------------------------------------------------------------------------------------------|
-| `font.uid`                       | `string`       | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters. |
-| `font.append`                    | `HTMLElement`  | Reference to HTMLElement where the generated font-face will resist.                                 |
-| `font.fontFamily`                | `string`       | Font family that can be referenced from your CSS.                                                   |
-| `font.formats`                   | `IFontFormats` | URI where these formats will be downloaded from.                                                    |
-| `font.fontStretch` *(optional)*  | `string`       | Allows you to make text wider or narrower.                                                          |
-| `font.fontStyle` *(optional)*    | `IFontStyle`   | Specifies the font style for a text. (Either `normal`, `italic`, `oblique`, `initial` or `inherit`) |
-| `font.fontWeight` *(optional)*   | `string`       | Sets how thick or thin characters in text should be displayed                                       |
-| `font.unicodeRange` *(optional)* | `string`       | Defines the range of unicode characters the font supports, default value is "U+0-10FFFF"            |
-| `font.formats`                   | `IFontFormats` | Dictionary of supported formats with its files                                                      |
+| Name                | Type           | Required         | Description                                                                                         |
+|---------------------|----------------|------------------|-----------------------------------------------------------------------------------------------------|
+| `font.uid`          | `string`       |  <div>Yes</div>  | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters. |
+| `font.append`       | `HTMLElement`  |  <div>Yes</div>  | Reference to HTMLElement where the generated font-face will resist.                                 |
+| `font.fontFamily`   | `string`       |  <div>Yes</div>  | Font family that can be referenced from your CSS.                                                   |
+| `font.formats`      | `IFontFormats` |  <div>Yes</div>  | URI where these formats will be downloaded from.                                                    |
+| `font.fontStretch`  | `string`       |  <div>No</div>   | Allows you to make text wider or narrower.                                                          |
+| `font.fontStyle`    | `IFontStyle`   |  <div>No</div>   | Specifies the font style for a text. (Either `normal`, `italic`, `oblique`, `initial` or `inherit`) |
+| `font.fontWeight`   | `string`       |  <div>No</div>   | Sets how thick or thin characters in text should be displayed                                       |
+| `font.unicodeRange` | `string`       |  <div>No</div>   | Defines the range of Unicode characters the font supports, default value is "U+0-10FFFF"            |
+| `font.formats`      | `IFontFormats` |  <div>Yes</div>  | Dictionary of supported formats with its files                                                      |
+
+#### Return value
+
+Resolves when the font is added and the style element is appended to the document.
+
+#### Possible errors
+
+If the `font` parameter is not an object.
+
+:::note[GitHub Example]
+
+- [ Example of Applet that loads custom font](https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/fonts)
+
+:::

package/docs/sos/osd.md

@@ -4,18 +4,25 @@ sidebar_position: 0
 
 # osd
 
-The `sos.osd` API groups together methods for working with the OSD (On Screen Display).
+The `sos.osd` API groups together methods for working with the signageOS OSD (On Screen Display).
+
+More information about the OSD can be found in the [OSD Introduction](https://docs.signageos.io/hc/en-us/articles/4405231839890-OSD-menu-by-signageOS)
 
 ## Methods
 
 ### showOSD()
 
 The `showOSD()` method opens the OSD without typing the pin.
+Note: The OSD will be opened after 6 seconds.
 
 ```ts expandable
 showOSD(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the OSD is shown.
+
 ## API Example
 
 ```ts

package/docs/sos/proofOfPlay.md

@@ -4,6 +4,10 @@ sidebar_position: 0
 
 # proofOfPlay
 
+The `sos.proofOfPlay` API provides methods for recording information about played content on the device.
+
+Can be useful for tracking the playback of content, which can be used for analytics, reporting, or debugging purposes.
+
 ## Methods
 
 ### recordItemPlayed()
@@ -14,6 +18,9 @@ with additional metadata about current applet and device to signageOS.
 ```ts expandable
 recordItemPlayed(options: IRecordItemOptions): Promise<void>;
 // show-more
+/**
+ * Interface representing options for a record item in the Proof of Play applet.
+ */
 interface IRecordItemOptions {
     name: string;
     customId?: string;
@@ -26,6 +33,27 @@ interface IRecordItemOptions {
 
 ```
 
+#### Params
+
+| Name                      | Type                                       | Required         | Description                                                                                                  |
+|---------------------------|--------------------------------------------|------------------|--------------------------------------------------------------------------------------------------------------|
+| `options`                 | `IRecordItemOptions`                       |  <div>Yes</div>  | The options for recording the played item.                                                                   |
+| `options.name`            | `string`                                   |  <div>Yes</div>  | The name of the item that was played.                                                                        |
+| `options.customId`        | `string`                                   |  <div>No</div>   | An optional custom identifier for the item.                                                                  |
+| `options.type`            | `"video" \| "image" \| "html" \| "custom"` |  <div>No</div>   | The type of the item that was played. It can be one of the following: `video`, `image`, `html`, or `custom`. |
+| `options.tags`            | `string[]`                                 |  <div>No</div>   | An array of tags associated with the item.                                                                   |
+| `options.fileName`        | `string`                                   |  <div>No</div>   | The name of the file that was played.                                                                        |
+| `options.playbackSuccess` | `boolean`                                  |  <div>No</div>   | A boolean indicating whether the playback was successful.                                                    |
+| `options.errorMessage`    | `string`                                   |  <div>No</div>   | An optional error message if the playback was not successful.                                                |
+
+#### Return value
+
+A promise that resolves when the item has been recorded.
+
+#### Possible errors
+
+If any of the provided options are invalid.
+
 ## API Example
 
 ```ts

package/docs/sos/stream.md

@@ -109,9 +109,9 @@ interface IVideoProperties {
 
 #### Params
 
-| Name      | Type               | Description                                           |
-|-----------|--------------------|-------------------------------------------------------|
-| `videoId` | `IVideoProperties` | The video properties of the stream to get tracks for. |
+| Name      | Type               | Required         | Description                                           |
+|-----------|--------------------|------------------|-------------------------------------------------------|
+| `videoId` | `IVideoProperties` |  <div>Yes</div>  | The video properties of the stream to get tracks for. |
 
 #### Return value
 
@@ -263,9 +263,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                         | Description                                               |
-|------------|----------------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamEvent<"connected">) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                         | Required         | Description                                               |
+|------------|----------------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamEvent<"connected">) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -419,9 +419,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                            | Description                                               |
-|------------|-------------------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamEvent<"disconnected">) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                            | Required         | Description                                               |
+|------------|-------------------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamEvent<"disconnected">) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -584,9 +584,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                 | Description                                               |
-|------------|--------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamErrorEvent) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                 | Required         | Description                                               |
+|------------|--------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamErrorEvent) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -739,9 +739,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                     | Description                                               |
-|------------|------------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamEvent<"pause">) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                     | Required         | Description                                               |
+|------------|------------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamEvent<"pause">) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -894,9 +894,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                    | Description                                               |
-|------------|-----------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamEvent<"play">) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                    | Required         | Description                                               |
+|------------|-----------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamEvent<"play">) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -1049,9 +1049,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                       | Description                                               |
-|------------|--------------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamEvent<"prepare">) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                       | Required         | Description                                               |
+|------------|--------------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamEvent<"prepare">) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -1204,9 +1204,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                      | Description                                               |
-|------------|-------------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamEvent<"resume">) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                      | Required         | Description                                               |
+|------------|-------------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamEvent<"resume">) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -1361,9 +1361,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                    | Description                                               |
-|------------|-----------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamEvent<"stop">) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                    | Required         | Description                                               |
+|------------|-----------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamEvent<"stop">) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -1590,9 +1590,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type                                         | Description                                               |
-|------------|----------------------------------------------|-----------------------------------------------------------|
-| `listener` | `(event: IStreamTracksChangedEvent) => void` | The listener function to be called when the event occurs. |
+| Name       | Type                                         | Required         | Description                                               |
+|------------|----------------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(event: IStreamTracksChangedEvent) => void` |  <div>Yes</div>  | The listener function to be called when the event occurs. |
 
 #### Return value
 
@@ -1625,13 +1625,13 @@ pause(uri: string, x: number, y: number, width: number, height: number): Promise
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Network address where the stream is available. |
-| `x`      | `number` | Stream x-position on the screen                |
-| `y`      | `number` | Stream y-position on the screen                |
-| `width`  | `number` | Stream width on the screen                     |
-| `height` | `number` | Stream height on the screen                    |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Network address where the stream is available. |
+| `x`      | `number` |  <div>Yes</div>  | Stream x-position on the screen                |
+| `y`      | `number` |  <div>Yes</div>  | Stream y-position on the screen                |
+| `width`  | `number` |  <div>Yes</div>  | Stream width on the screen                     |
+| `height` | `number` |  <div>Yes</div>  | Stream height on the screen                    |
 
 #### Return value
 
@@ -1715,14 +1715,14 @@ interface IOptions {
 
 #### Params
 
-| Name                   | Type                                                                      | Description                                    |
-|------------------------|---------------------------------------------------------------------------|------------------------------------------------|
-| `uri`                  | `string`                                                                  | Network address where the stream is available. |
-| `x`                    | `number`                                                                  | Stream x-position on the screen                |
-| `y`                    | `number`                                                                  | Stream y-position on the screen                |
-| `width`                | `number`                                                                  | Stream width on the screen                     |
-| `height`               | `number`                                                                  | Stream height on the screen                    |
-| `options` *(optional)* | `IStreamOptions \| "HLS" \| "RTP" \| "HTTP" \| "UDP" \| "RTMP" \| "RTSP"` | Additional options for the stream              |
+| Name      | Type                                                                      | Required         | Description                                    |
+|-----------|---------------------------------------------------------------------------|------------------|------------------------------------------------|
+| `uri`     | `string`                                                                  |  <div>Yes</div>  | Network address where the stream is available. |
+| `x`       | `number`                                                                  |  <div>Yes</div>  | Stream x-position on the screen                |
+| `y`       | `number`                                                                  |  <div>Yes</div>  | Stream y-position on the screen                |
+| `width`   | `number`                                                                  |  <div>Yes</div>  | Stream width on the screen                     |
+| `height`  | `number`                                                                  |  <div>Yes</div>  | Stream height on the screen                    |
+| `options` | `IStreamOptions \| "HLS" \| "RTP" \| "HTTP" \| "UDP" \| "RTMP" \| "RTSP"` |  <div>No</div>   | Additional options for the stream              |
 
 #### Return value
 
@@ -1858,14 +1858,14 @@ interface IOptions {
 
 #### Params
 
-| Name                   | Type                                                                             | Description                                    |
-|------------------------|----------------------------------------------------------------------------------|------------------------------------------------|
-| `uri`                  | `string`                                                                         | Network address where the stream is available. |
-| `x`                    | `number`                                                                         | Stream x-position on the screen                |
-| `y`                    | `number`                                                                         | Stream y-position on the screen                |
-| `width`                | `number`                                                                         | Stream width on the screen                     |
-| `height`               | `number`                                                                         | Stream height on the screen                    |
-| `options` *(optional)* | `IStreamPrepareOptions \| "HLS" \| "RTP" \| "HTTP" \| "UDP" \| "RTMP" \| "RTSP"` | Additional options for the stream              |
+| Name      | Type                                                                             | Required         | Description                                    |
+|-----------|----------------------------------------------------------------------------------|------------------|------------------------------------------------|
+| `uri`     | `string`                                                                         |  <div>Yes</div>  | Network address where the stream is available. |
+| `x`       | `number`                                                                         |  <div>Yes</div>  | Stream x-position on the screen                |
+| `y`       | `number`                                                                         |  <div>Yes</div>  | Stream y-position on the screen                |
+| `width`   | `number`                                                                         |  <div>Yes</div>  | Stream width on the screen                     |
+| `height`  | `number`                                                                         |  <div>Yes</div>  | Stream height on the screen                    |
+| `options` | `IStreamPrepareOptions \| "HLS" \| "RTP" \| "HTTP" \| "UDP" \| "RTMP" \| "RTSP"` |  <div>No</div>   | Additional options for the stream              |
 
 #### Return value
 
@@ -1936,11 +1936,11 @@ type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
 
 #### Params
 
-| Name                   | Type               | Description                                                                                      |
-|------------------------|--------------------|--------------------------------------------------------------------------------------------------|
-| `videoId`              | `IVideoProperties` | The video properties of the stream to reset track for.                                           |
-| `trackType`            | `TrackType`        | The type of the track to reset (e.g., 'TEXT', 'AUDIO', 'VIDEO').                                 |
-| `groupId` *(optional)* | `string`           | The group ID of the track to reset. If not provided, the first track in the group will be reset. |
+| Name        | Type               | Required         | Description                                                                                      |
+|-------------|--------------------|------------------|--------------------------------------------------------------------------------------------------|
+| `videoId`   | `IVideoProperties` |  <div>Yes</div>  | The video properties of the stream to reset track for.                                           |
+| `trackType` | `TrackType`        |  <div>Yes</div>  | The type of the track to reset (e.g., 'TEXT', 'AUDIO', 'VIDEO').                                 |
+| `groupId`   | `string`           |  <div>No</div>   | The group ID of the track to reset. If not provided, the first track in the group will be reset. |
 
 #### Return value
 
@@ -1971,13 +1971,13 @@ resume(uri: string, x: number, y: number, width: number, height: number): Promis
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Network address where the stream is available. |
-| `x`      | `number` | Stream x-position on the screen                |
-| `y`      | `number` | Stream y-position on the screen                |
-| `width`  | `number` | Stream width on the screen                     |
-| `height` | `number` | Stream height on the screen                    |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Network address where the stream is available. |
+| `x`      | `number` |  <div>Yes</div>  | Stream x-position on the screen                |
+| `y`      | `number` |  <div>Yes</div>  | Stream y-position on the screen                |
+| `width`  | `number` |  <div>Yes</div>  | Stream width on the screen                     |
+| `height` | `number` |  <div>Yes</div>  | Stream height on the screen                    |
 
 #### Return value
 
@@ -2026,12 +2026,12 @@ type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
 
 #### Params
 
-| Name         | Type               | Description                                                       |
-|--------------|--------------------|-------------------------------------------------------------------|
-| `videoId`    | `IVideoProperties` | The video properties of the stream to select track for.           |
-| `trackType`  | `TrackType`        | The type of the track to select (e.g., 'TEXT', 'AUDIO', 'VIDEO'). |
-| `groupId`    | `string`           | The group ID of the track to select.                              |
-| `trackIndex` | `number`           | The index of the track to select within the group.                |
+| Name         | Type               | Required         | Description                                                       |
+|--------------|--------------------|------------------|-------------------------------------------------------------------|
+| `videoId`    | `IVideoProperties` |  <div>Yes</div>  | The video properties of the stream to select track for.           |
+| `trackType`  | `TrackType`        |  <div>Yes</div>  | The type of the track to select (e.g., 'TEXT', 'AUDIO', 'VIDEO'). |
+| `groupId`    | `string`           |  <div>Yes</div>  | The group ID of the track to select.                              |
+| `trackIndex` | `number`           |  <div>Yes</div>  | The index of the track to select within the group.                |
 
 #### Return value
 
@@ -2073,13 +2073,13 @@ stop(uri: string, x: number, y: number, width: number, height: number): Promise<
 
 #### Params
 
-| Name     | Type     | Description                                    |
-|----------|----------|------------------------------------------------|
-| `uri`    | `string` | Network address where the stream is available. |
-| `x`      | `number` | Stream x-position on the screen                |
-| `y`      | `number` | Stream y-position on the screen                |
-| `width`  | `number` | Stream width on the screen                     |
-| `height` | `number` | Stream height on the screen                    |
+| Name     | Type     | Required         | Description                                    |
+|----------|----------|------------------|------------------------------------------------|
+| `uri`    | `string` |  <div>Yes</div>  | Network address where the stream is available. |
+| `x`      | `number` |  <div>Yes</div>  | Stream x-position on the screen                |
+| `y`      | `number` |  <div>Yes</div>  | Stream y-position on the screen                |
+| `width`  | `number` |  <div>Yes</div>  | Stream width on the screen                     |
+| `height` | `number` |  <div>Yes</div>  | Stream height on the screen                    |
 
 #### Return value