Skip to content

Commit e133b0a

Browse files
RDKDocRDKDoc
committed
RDKServices Jenkins Documentation Job
1 parent 66d0476 commit e133b0a

19 files changed

+436
-351
lines changed

‎docs/api/AnalyticsPlugin.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ The table below lists configuration options of the plugin.
3838
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
3939
| configuration | object | |
4040
| configuration.deviceosname | string | Device OS name |
41+
| configuration?.eventsmap | string | <sup>*(optional)*</sup> Optional path to json file with array of mapped events name |
4142
| configuration.sift | object | |
4243
| configuration.sift.schema2 | boolean | If true, enables Sift 2.0 schema, otherwise uses Sift 1.0 schema |
4344
| configuration.sift.commonschema | string | Sift schema common schema |

‎docs/api/ContentProtectionPlugin.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!-- Generated automatically, DO NOT EDIT! -->
2+
<a name="ContentProtection_Plugin"></a>
3+
# ContentProtection Plugin
4+
5+
**Version: [1.0.0](https://github.com/rdkcentral/rdkservices/blob/main/ContentProtection/CHANGELOG.md)**
6+
7+
A org.rdk.ContentProtection plugin for Thunder framework.
8+
9+
### Table of Contents
10+
11+
- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
12+
- [Description](#Description)
13+
- [Configuration](#Configuration)
14+
15+
<a name="Abbreviation,_Acronyms_and_Terms"></a>
16+
# Abbreviation, Acronyms and Terms
17+
18+
[[Refer to this link](userguide/aat.md)]
19+
20+
<a name="Description"></a>
21+
# Description
22+
23+
The `ContentProtection` plugin proxies content security capabilities of the existing DRM plugins.
24+
25+
The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#Thunder)].
26+
27+
<a name="Configuration"></a>
28+
# Configuration
29+
30+
The table below lists configuration options of the plugin.
31+
32+
| Name | Type | Description |
33+
| :-------- | :-------- | :-------- |
34+
| callsign | string | Plugin instance name (default: *org.rdk.ContentProtection*) |
35+
| classname | string | Class name: *org.rdk.ContentProtection* |
36+
| locator | string | Library name: *libWPEFrameworkContentProtection.so* |
37+
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
38+

‎docs/api/DisplaySettingsPlugin.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="DisplaySettings_Plugin"></a>
33
# DisplaySettings Plugin
44

5-
**Version: [2.0.1](https://github.com/rdkcentral/rdkservices/blob/main/DisplaySettings/CHANGELOG.md)**
5+
**Version: [2.0.4](https://github.com/rdkcentral/rdkservices/blob/main/DisplaySettings/CHANGELOG.md)**
66

77
A org.rdk.DisplaySettings plugin for Thunder framework.
88

@@ -113,7 +113,7 @@ DisplaySettings interface methods:
113113
| [setDolbyVolumeMode](#setDolbyVolumeMode) | Enables or disables Dolby Volume mode on audio track (audio output port HDMI0) |
114114
| [setDRCMode](#setDRCMode) | Sets the Dynamic Range Control (DRC) setting |
115115
| [setEnableAudioPort](#setEnableAudioPort) | Enable or disable the specified audio port based on the input audio port name |
116-
| [setForceHDRMode](#setForceHDRMode) | Enables or disables the force HDR mode |
116+
| [setForceHDRMode](#setForceHDRMode) | This API force the output HDR video format passed as input arumgents |
117117
| [setGain](#setGain) | Adjusts the gain on a specific port |
118118
| [setGraphicEqualizerMode](#setGraphicEqualizerMode) | Sets the Graphic Equalizer Mode |
119119
| [setIntelligentEqualizerMode](#setIntelligentEqualizerMode) | Sets the Intelligent Equalizer Mode (port HDMI0) |
@@ -2533,7 +2533,7 @@ This method takes no parameters.
25332533
"id": 42,
25342534
"result": {
25352535
"supportedVideoFormat": [
2536-
"`SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
2536+
"`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
25372537
],
25382538
"currentVideoFormat": "SDR",
25392539
"success": true
@@ -3558,7 +3558,7 @@ No Events
35583558
<a name="setForceHDRMode"></a>
35593559
## *setForceHDRMode*
35603560

3561-
Enables or disables the force HDR mode. If enabled, the HDR format that is currently configured on the device is used.
3561+
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.
35623562

35633563
### Events
35643564

@@ -3569,7 +3569,8 @@ No Events
35693569
| Name | Type | Description |
35703570
| :-------- | :-------- | :-------- |
35713571
| params | object | |
3572-
| params?.hdr_mode | boolean | <sup>*(optional)*</sup> `true` to force the HDR format or `false` to reset the mode to the default |
3572+
| params.hdr_mode | array | A list of supported Video formats |
3573+
| params.hdr_mode[#] | string | |
35733574

35743575
### Result
35753576

@@ -3588,7 +3589,9 @@ No Events
35883589
"id": 42,
35893590
"method": "org.rdk.DisplaySettings.setForceHDRMode",
35903591
"params": {
3591-
"hdr_mode": true
3592+
"hdr_mode": [
3593+
"`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
3594+
]
35923595
}
35933596
}
35943597
```
@@ -3955,10 +3958,10 @@ No Events
39553958
"method": "org.rdk.DisplaySettings.setMS12ProfileSettingsOverride",
39563959
"params": {
39573960
"audioPort": "SPEAKER0",
3958-
"operation": "...",
3959-
"profileName": "Sports",
3960-
"ms12SettingsName": "Dialog Enhance",
3961-
"ms12SettingsValue": "On"
3961+
"operation": "`ADD`, `REMOVE`",
3962+
"profileName": "`Sports`, `User`",
3963+
"ms12SettingsName": "`DialogEnhance`, `VolumeLevellerMode`, `VolumeLevellerLevel`, `BassEnhancer`, `SurroundVirtualizerMode`, `SurroundVirtualizerLevel`",
3964+
"ms12SettingsValue": "`0`, `1`, `2`"
39623965
}
39633966
}
39643967
```
@@ -4786,7 +4789,7 @@ Triggered when the video format of connected video port changes and returns the
47864789
"method": "client.events.videoFormatChanged",
47874790
"params": {
47884791
"supportedVideoFormat": [
4789-
"`SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
4792+
"`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`"
47904793
],
47914794
"currentVideoFormat": "SDR"
47924795
}

‎docs/api/FrameRatePlugin.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="FrameRate_Plugin"></a>
33
# FrameRate Plugin
44

5-
**Version: [1.0.6](https://github.com/rdkcentral/rdkservices/blob/main/FrameRate/CHANGELOG.md)**
5+
**Version: [1.0.8](https://github.com/rdkcentral/rdkservices/blob/main/FrameRate/CHANGELOG.md)**
66

77
A org.rdk.FrameRate plugin for Thunder framework.
88

‎docs/api/MaintenanceManagerPlugin.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="MaintenanceManagerPlugin"></a>
33
# MaintenanceManagerPlugin
44

5-
**Version: [1.0.38](https://github.com/rdkcentral/rdkservices/blob/main/MaintenanceManager/CHANGELOG.md)**
5+
**Version: [1.0.39](https://github.com/rdkcentral/rdkservices/blob/main/MaintenanceManager/CHANGELOG.md)**
66

77
A org.rdk.MaintenanceManager plugin for Thunder framework.
88

‎docs/api/MigrationPreparerPlugin.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!-- Generated automatically, DO NOT EDIT! -->
2+
<a name="MigrationPreparer_Plugin"></a>
3+
# MigrationPreparer Plugin
4+
5+
**Version: [1.0.0](https://github.com/rdkcentral/rdkservices/blob/main/MigrationPreparer/CHANGELOG.md)**
6+
7+
A org.rdk.MigrationPreparer plugin for Thunder framework.
8+
9+
### Table of Contents
10+
11+
- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
12+
- [Description](#Description)
13+
- [Configuration](#Configuration)
14+
- [Methods](#Methods)
15+
16+
<a name="Abbreviation,_Acronyms_and_Terms"></a>
17+
# Abbreviation, Acronyms and Terms
18+
19+
[[Refer to this link](userguide/aat.md)]
20+
21+
<a name="Description"></a>
22+
# Description
23+
24+
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.
25+
26+
The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#Thunder)].
27+
28+
<a name="Configuration"></a>
29+
# Configuration
30+
31+
The table below lists configuration options of the plugin.
32+
33+
| Name | Type | Description |
34+
| :-------- | :-------- | :-------- |
35+
| callsign | string | Plugin instance name (default: *org.rdk.MigrationPreparer*) |
36+
| classname | string | Class name: *org.rdk.MigrationPreparer* |
37+
| locator | string | Library name: *libWPEFrameworkMigrationPreparer.so* |
38+
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
39+
40+
<a name="Methods"></a>
41+
# Methods
42+
43+
The following methods are provided by the org.rdk.MigrationPreparer plugin:
44+
45+
MigrationPreparer interface methods:
46+
47+
| Method | Description |
48+
| :-------- | :-------- |
49+
| [write](#write) | Write key-value to the dataStore |
50+
| [Delete](#Delete) | Delete key-value from the dataStore |
51+
| [read](#read) | Read value from the dataStore |
52+
| [getcomponentreadiness](#getcomponentreadiness) | Returns the list of components that are ready for migration |
53+
| [setcomponentreadiness](#setcomponentreadiness) | Set the component that is ready for migration |
54+
| [reset](#reset) | Reset based on resettype, should delete all entries in the datastore or componentList for migration or both |
55+
56+
57+
<a name="write"></a>
58+
## *write*
59+
60+
Write key-value to the dataStore.
61+
62+
### Events
63+
64+
No Events
65+
66+
### Parameters
67+
68+
| Name | Type | Description |
69+
| :-------- | :-------- | :-------- |
70+
| params | object | |
71+
| params.name | string | key |
72+
| params.value | string | value |
73+
74+
### Result
75+
76+
| Name | Type | Description |
77+
| :-------- | :-------- | :-------- |
78+
| result | object | |
79+
| result.success | boolean | Legacy parameter (always true) |
80+
81+
### Errors
82+
83+
| Code | Message | Description |
84+
| :-------- | :-------- | :-------- |

‎docs/api/MiracastPlayerPlugin.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="MiracastPlayer_Plugin"></a>
33
# MiracastPlayer Plugin
44

5-
**Version: [1.0.11](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
5+
**Version: [1.0.12](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
66

77
A org.rdk.MiracastPlayer plugin for Thunder framework.
88

‎docs/api/MiracastServicePlugin.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="MiracastService_Plugin"></a>
33
# MiracastService Plugin
44

5-
**Version: [1.0.11](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
5+
**Version: [1.0.12](https://github.com/rdkcentral/rdkservices/blob/main/Miracast/CHANGELOG.md)**
66

77
A org.rdk.MiracastService plugin for Thunder framework.
88

‎docs/api/NetworkPlugin.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
<!-- Generated automatically, DO NOT EDIT! -->
22
<a name="NetworkPlugin"></a>
3-
# Network Plugin $${\color{red}(DEPRECATED)}$$
3+
# NetworkPlugin
44

5-
**Version: [1.3.11](https://github.com/rdkcentral/rdkservices/blob/main/Network/CHANGELOG.md)**
5+
**Version: [1.3.13](https://github.com/rdkcentral/rdkservices/blob/main/Network/CHANGELOG.md)**
66

77
A org.rdk.Network plugin for Thunder framework.
88

9-
For newer APIs, please refer: https://github.com/rdkcentral/networkmanager/blob/main/docs/NetworkManagerPlugin.md
10-
119
### Table of Contents
1210

1311
- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
@@ -817,7 +815,7 @@ No Events
817815
| :-------- | :-------- | :-------- |
818816
| params | object | |
819817
| params.endpoint | string | The host name or IP address |
820-
| params.packets | integer | The number of packets to send. Default is 3 |
818+
| params.packets | integer | The number of packets to send. Default is 15 |
821819
| params?.guid | string | <sup>*(optional)*</sup> The globally unique identifier |
822820

823821
### Result
@@ -848,7 +846,7 @@ No Events
848846
"method": "org.rdk.Network.ping",
849847
"params": {
850848
"endpoint": "45.57.221.20",
851-
"packets": 3,
849+
"packets": 10,
852850
"guid": "..."
853851
}
854852
}
@@ -1305,7 +1303,7 @@ No Events
13051303
| :-------- | :-------- | :-------- |
13061304
| params | object | |
13071305
| params.endpoint | string | The host name or IP address |
1308-
| params.packets | integer | The number of packets to send. Default is 5 |
1306+
| params.packets | integer | The number of packets to send. Default is 15 |
13091307

13101308
### Result
13111309

@@ -1328,7 +1326,7 @@ No Events
13281326
"method": "org.rdk.Network.trace",
13291327
"params": {
13301328
"endpoint": "45.57.221.20",
1331-
"packets": 5
1329+
"packets": 10
13321330
}
13331331
}
13341332
```

‎docs/api/RDKShellPlugin.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="RDKShell_Plugin"></a>
33
# RDKShell Plugin
44

5-
**Version: [1.6.3](https://github.com/rdkcentral/rdkservices/blob/main/RDKShell/CHANGELOG.md)**
5+
**Version: [1.6.4](https://github.com/rdkcentral/rdkservices/blob/main/RDKShell/CHANGELOG.md)**
66

77
A org.rdk.RDKShell plugin for Thunder framework.
88

0 commit comments

Comments
 (0)