Merge pull request #6013 from RDKDoc/documentupdate

RDKServices Jenkins Documentation Job

docs/api/AnalyticsPlugin.md

@@ -38,6 +38,7 @@ The table below lists configuration options of the plugin.
 | autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
 | configuration | object |  |
 | configuration.deviceosname | string | Device OS name |
+| configuration?.eventsmap | string | <sup>*(optional)*</sup> Optional path to json file with array of mapped events name |
 | configuration.sift | object |  |
 | configuration.sift.schema2 | boolean | If true, enables Sift 2.0 schema, otherwise uses Sift 1.0 schema |
 | configuration.sift.commonschema | string | Sift schema common schema |

docs/api/ContentProtectionPlugin.md

@@ -0,0 +1,38 @@
+<!-- Generated automatically, DO NOT EDIT! -->
+<a name="ContentProtection_Plugin"></a>
+# ContentProtection Plugin
+
+**Version: [1.0.0](https://github.com/rdkcentral/rdkservices/blob/main/ContentProtection/CHANGELOG.md)**
+
+A org.rdk.ContentProtection plugin for Thunder framework.
+
+### Table of Contents
+
+- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
+- [Description](#Description)
+- [Configuration](#Configuration)
+
+<a name="Abbreviation,_Acronyms_and_Terms"></a>
+# Abbreviation, Acronyms and Terms
+
+[[Refer to this link](userguide/aat.md)]
+
+<a name="Description"></a>
+# Description
+
+The `ContentProtection` plugin proxies content security capabilities of the existing DRM plugins.
+
+The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#Thunder)].
+
+<a name="Configuration"></a>
+# Configuration
+
+The table below lists configuration options of the plugin.
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| callsign | string | Plugin instance name (default: *org.rdk.ContentProtection*) |
+| classname | string | Class name: *org.rdk.ContentProtection* |
+| locator | string | Library name: *libWPEFrameworkContentProtection.so* |
+| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
+

docs/api/DisplaySettingsPlugin.md

@@ -2,7 +2,7 @@
 <a name="DisplaySettings_Plugin"></a>
 # DisplaySettings Plugin
 
-**Version: [2.0.1](https://github.com/rdkcentral/rdkservices/blob/main/DisplaySettings/CHANGELOG.md)**
+**Version: [2.0.4](https://github.com/rdkcentral/rdkservices/blob/main/DisplaySettings/CHANGELOG.md)**
 
 A org.rdk.DisplaySettings plugin for Thunder framework.
 
@@ -113,7 +113,7 @@ DisplaySettings interface methods:
 | [setDolbyVolumeMode](#setDolbyVolumeMode) | Enables or disables Dolby Volume mode on audio track (audio output port HDMI0) |
 | [setDRCMode](#setDRCMode) | Sets the Dynamic Range Control (DRC) setting |
 | [setEnableAudioPort](#setEnableAudioPort) | Enable or disable the specified audio port based on the input audio port name |
-| [setForceHDRMode](#setForceHDRMode) | Enables or disables the force HDR mode |
+| [setForceHDRMode](#setForceHDRMode) |  This API force the output HDR video format passed as input arumgents |
 | [setGain](#setGain) | Adjusts the gain on a specific port |
 | [setGraphicEqualizerMode](#setGraphicEqualizerMode) | Sets the Graphic Equalizer Mode |
 | [setIntelligentEqualizerMode](#setIntelligentEqualizerMode) | Sets the Intelligent Equalizer Mode (port HDMI0) |
@@ -2533,7 +2533,7 @@ This method takes no parameters.
     "id": 42,
     "result": {
         "supportedVideoFormat": [
-            "`SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
+            "`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
         ],
         "currentVideoFormat": "SDR",
         "success": true
@@ -3558,7 +3558,7 @@ No Events
 <a name="setForceHDRMode"></a>
 ## *setForceHDRMode*
 
-Enables or disables the force HDR mode. If enabled, the HDR format that is currently configured on the device is used.
+ This API force the output HDR video format passed as input arumgents. If force output video format is set as "NONE"  or this API not called video format changes as per input video format type.
 
 ### Events
 
@@ -3569,7 +3569,8 @@ No Events
 | Name | Type | Description |
 | :-------- | :-------- | :-------- |
 | params | object |  |
-| params?.hdr_mode | boolean | <sup>*(optional)*</sup> `true` to force the HDR format or `false` to reset the mode to the default |
+| params.hdr_mode | array | A list of supported Video formats |
+| params.hdr_mode[#] | string |  |
 
 ### Result
 
@@ -3588,7 +3589,9 @@ No Events
     "id": 42,
     "method": "org.rdk.DisplaySettings.setForceHDRMode",
     "params": {
-        "hdr_mode": true
+        "hdr_mode": [
+            "`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
+        ]
     }
 }
 ```
@@ -3955,10 +3958,10 @@ No Events
     "method": "org.rdk.DisplaySettings.setMS12ProfileSettingsOverride",
     "params": {
         "audioPort": "SPEAKER0",
-        "operation": "...",
-        "profileName": "Sports",
-        "ms12SettingsName": "Dialog Enhance",
-        "ms12SettingsValue": "On"
+        "operation": "`ADD`, `REMOVE`",
+        "profileName": "`Sports`, `User`",
+        "ms12SettingsName": "`DialogEnhance`, `VolumeLevellerMode`, `VolumeLevellerLevel`, `BassEnhancer`, `SurroundVirtualizerMode`, `SurroundVirtualizerLevel`",
+        "ms12SettingsValue": "`0`, `1`, `2`"
     }
 }
 ```
@@ -4786,7 +4789,7 @@ Triggered when the video format of connected video port changes and returns the
     "method": "client.events.videoFormatChanged",
     "params": {
         "supportedVideoFormat": [
-            "`SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
+            "`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
         ],
         "currentVideoFormat": "SDR"
     }

docs/api/FrameRatePlugin.md

@@ -2,7 +2,7 @@
 <a name="FrameRate_Plugin"></a>
 # FrameRate Plugin
 
-**Version: [1.0.6](https://github.com/rdkcentral/rdkservices/blob/main/FrameRate/CHANGELOG.md)**
+**Version: [1.0.8](https://github.com/rdkcentral/rdkservices/blob/main/FrameRate/CHANGELOG.md)**
 
 A org.rdk.FrameRate plugin for Thunder framework.
 

docs/api/MaintenanceManagerPlugin.md

@@ -2,7 +2,7 @@
 <a name="MaintenanceManagerPlugin"></a>
 # MaintenanceManagerPlugin
 
-**Version: [1.0.38](https://github.com/rdkcentral/rdkservices/blob/main/MaintenanceManager/CHANGELOG.md)**
+**Version: [1.0.39](https://github.com/rdkcentral/rdkservices/blob/main/MaintenanceManager/CHANGELOG.md)**
 
 A org.rdk.MaintenanceManager plugin for Thunder framework.
 

docs/api/MigrationPreparerPlugin.md

@@ -0,0 +1,84 @@
+<!-- Generated automatically, DO NOT EDIT! -->
+<a name="MigrationPreparer_Plugin"></a>
+# MigrationPreparer Plugin
+
+**Version: [1.0.0](https://github.com/rdkcentral/rdkservices/blob/main/MigrationPreparer/CHANGELOG.md)**
+
+A org.rdk.MigrationPreparer plugin for Thunder framework.
+
+### Table of Contents
+
+- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
+- [Description](#Description)
+- [Configuration](#Configuration)
+- [Methods](#Methods)
+
+<a name="Abbreviation,_Acronyms_and_Terms"></a>
+# Abbreviation, Acronyms and Terms
+
+[[Refer to this link](userguide/aat.md)]
+
+<a name="Description"></a>
+# Description
+
+The `MigrationPreparer` that is responsible for persisting and notifying listeners of any change of key/value pairs and get/set value of MigrationReady RFC value.
+
+The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#Thunder)].
+
+<a name="Configuration"></a>
+# Configuration
+
+The table below lists configuration options of the plugin.
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| callsign | string | Plugin instance name (default: *org.rdk.MigrationPreparer*) |
+| classname | string | Class name: *org.rdk.MigrationPreparer* |
+| locator | string | Library name: *libWPEFrameworkMigrationPreparer.so* |
+| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
+
+<a name="Methods"></a>
+# Methods
+
+The following methods are provided by the org.rdk.MigrationPreparer plugin:
+
+MigrationPreparer interface methods:
+
+| Method | Description |
+| :-------- | :-------- |
+| [write](#write) | Write key-value to the dataStore |
+| [Delete](#Delete) | Delete key-value from the dataStore |
+| [read](#read) | Read value from the dataStore |
+| [getcomponentreadiness](#getcomponentreadiness) | Returns the list of components that are ready for migration |
+| [setcomponentreadiness](#setcomponentreadiness) | Set the component that is ready for migration |
+| [reset](#reset) | Reset based on resettype, should delete all entries in the datastore or componentList for migration or both |
+
+
+<a name="write"></a>
+## *write*
+
+Write key-value to the dataStore.
+
+### Events
+
+No Events
+
+### Parameters
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.name | string | key |
+| params.value | string | value |
+
+### Result
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | object |  |
+| result.success | boolean | Legacy parameter (always true) |
+
+### Errors
+
+| Code | Message | Description |
+| :-------- | :-------- | :-------- |

docs/api/MiracastPlayerPlugin.md

@@ -2,7 +2,7 @@
 <a name="MiracastPlayer_Plugin"></a>
 # MiracastPlayer Plugin
 
-**Version: [1.0.11](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
+**Version: [1.0.12](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
 
 A org.rdk.MiracastPlayer plugin for Thunder framework.
 

docs/api/MiracastServicePlugin.md

@@ -2,7 +2,7 @@
 <a name="MiracastService_Plugin"></a>
 # MiracastService Plugin
 
-**Version: [1.0.11](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
+**Version: [1.0.12](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
 
 A org.rdk.MiracastService plugin for Thunder framework.
 

docs/api/NetworkPlugin.md

@@ -1,13 +1,11 @@
 <!-- Generated automatically, DO NOT EDIT! -->
 <a name="NetworkPlugin"></a>
-# Network Plugin $${\color{red}(DEPRECATED)}$$
+# NetworkPlugin
 
-**Version: [1.3.11](https://github.com/rdkcentral/rdkservices/blob/main/Network/CHANGELOG.md)**
+**Version: [1.3.13](https://github.com/rdkcentral/rdkservices/blob/main/Network/CHANGELOG.md)**
 
 A org.rdk.Network plugin for Thunder framework.
 
-For newer APIs, please refer: https://github.com/rdkcentral/networkmanager/blob/main/docs/NetworkManagerPlugin.md
-
 ### Table of Contents
 
 - [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
@@ -817,7 +815,7 @@ No Events
 | :-------- | :-------- | :-------- |
 | params | object |  |
 | params.endpoint | string | The host name or IP address |
-| params.packets | integer | The number of packets to send. Default is 3 |
+| params.packets | integer | The number of packets to send. Default is 15 |
 | params?.guid | string | <sup>*(optional)*</sup> The globally unique identifier |
 
 ### Result
@@ -848,7 +846,7 @@ No Events
     "method": "org.rdk.Network.ping",
     "params": {
         "endpoint": "45.57.221.20",
-        "packets": 3,
+        "packets": 10,
         "guid": "..."
     }
 }
@@ -1305,7 +1303,7 @@ No Events
 | :-------- | :-------- | :-------- |
 | params | object |  |
 | params.endpoint | string | The host name or IP address |
-| params.packets | integer | The number of packets to send. Default is 5 |
+| params.packets | integer | The number of packets to send. Default is 15 |
 
 ### Result
 
@@ -1328,7 +1326,7 @@ No Events
     "method": "org.rdk.Network.trace",
     "params": {
         "endpoint": "45.57.221.20",
-        "packets": 5
+        "packets": 10
     }
 }
 ```

docs/api/RDKShellPlugin.md

@@ -2,7 +2,7 @@
 <a name="RDKShell_Plugin"></a>
 # RDKShell Plugin
 
-**Version: [1.6.3](https://github.com/rdkcentral/rdkservices/blob/main/RDKShell/CHANGELOG.md)**
+**Version: [1.6.4](https://github.com/rdkcentral/rdkservices/blob/main/RDKShell/CHANGELOG.md)**
 
 A org.rdk.RDKShell plugin for Thunder framework.
 

docs/api/RemoteActionMappingPlugin.md

@@ -2,7 +2,7 @@
 <a name="RemoteActionMapping_Plugin"></a>
 # RemoteActionMapping Plugin
 
-**Version: [1.0.8](https://github.com/rdkcentral/rdkservices/blob/main/RemoteActionMapping/CHANGELOG.md)**
+**Version: [1.0.9](https://github.com/rdkcentral/rdkservices/blob/main/RemoteActionMapping/CHANGELOG.md)**
 
 A org.rdk.RemoteActionMapping plugin for Thunder framework.
 

docs/api/ScreenCapturePlugin.md

@@ -2,7 +2,7 @@
 <a name="ScreenCapture_Plugin"></a>
 # ScreenCapture Plugin
 
-**Version: [1.0.6](https://github.com/rdkcentral/rdkservices/blob/main/ScreenCapture/CHANGELOG.md)**
+**Version: [1.0.7](https://github.com/rdkcentral/rdkservices/blob/main/ScreenCapture/CHANGELOG.md)**
 
 A org.rdk.ScreenCapture plugin for Thunder framework.
 

docs/api/StateObserverPlugin.md

@@ -2,7 +2,7 @@
 <a name="StateObserver_Plugin"></a>
 # StateObserver Plugin
 
-**Version: [1.0.3](https://github.com/rdkcentral/rdkservices/blob/main/StateObserver/CHANGELOG.md)**
+**Version: [1.0.4](https://github.com/rdkcentral/rdkservices/blob/main/StateObserver/CHANGELOG.md)**
 
 A com.comcast.StateObserver plugin for Thunder framework.