Skip to content

Commit 3536dc7

Browse files
srikanth-vvsrikanth-vv
committed
Merge branch 'release/1.14.0' into main
2 parents 77b3ebd + 886d8e3 commit 3536dc7

File tree

149 files changed

+1258
-930
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+1258
-930
lines changed

‎CHANGELOG.md‎

Lines changed: 381 additions & 92 deletions
Large diffs are not rendered by default.

‎apis/MessageControl/IMessageControl.h‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ struct EXTERNAL IMessageControl : virtual public Core::IUnknown {
3232

3333
enum { ID = ID_MESSAGE_CONTROL };
3434

35-
enum messagetype : uint8_t {
35+
enum MessageType : uint8_t {
3636
TRACING = 1,
3737
LOGGING = 2,
3838
REPORTING = 3,
@@ -41,7 +41,7 @@ struct EXTERNAL IMessageControl : virtual public Core::IUnknown {
4141
};
4242

4343
struct Control {
44-
messagetype type /* @brief Type of message */;
44+
MessageType type /* @brief Type of message */;
4545
string category /* @brief Name of the message category (e.g. Information) */;
4646
string module /* @brief Name of the module the message is originating from (e.g. Plugin_BluetoothControl) */;
4747
bool enabled /* @brief Denotes if the control is enabled (true) or disabled (false) */;
@@ -54,11 +54,11 @@ struct EXTERNAL IMessageControl : virtual public Core::IUnknown {
5454
// @param module Name of the module the message is originating from (e.g. Plugin_BluetoothControl)
5555
// @param category Name of the message category (e.g. Information)
5656
// @param enabled Denotes if control should be enabled (true) or disabled (false)
57-
virtual uint32_t Enable(const messagetype type, const string& category, const string& module, const bool enabled) = 0;
57+
virtual Core::hresult Enable(const MessageType type, const string& category, const string& module, const bool enabled) = 0;
5858

5959
// @property
6060
// @brief Retrieves a list of current message controls
61-
virtual uint32_t Controls(IControlIterator*& control /* @out */) const = 0;
61+
virtual Core::hresult Controls(IControlIterator*& control /* @out */) const = 0;
6262
};
6363

6464
} // namespace Exchange

‎apis/common.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"sourcelocation": "https://github.com/rdkcentral/ThunderInterfaces/blob/{revision}/jsonrpc/{interfacefile}",
2+
"sourcelocation": "https://github.com/rdkcentral/entservices-apis/tree/main/apis",
33
"errors": {
44
"general": {
55
"code": 1,

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This project houses required resources for Entertainment Services API documentation. The documentation is hosted as a static web site on Github and is created using the Docsify site generator.
44

5-
[View Latest Documentation](https://github.io/rdkservices/#/README ***FIX THIS)
5+
[View Latest Documentation](https://rdkcentral.github.io/entservices-apis/#/)
66

77
## Local Builds
88

‎docs/apis/AVInputPlugin.md‎

Lines changed: 163 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<a name="AVInput_Plugin"></a>
33
# AVInput Plugin
44

5-
**Version: [1.0.0]()**
6-
75
A org.rdk.AVInput plugin for Thunder framework.
86

97
### Table of Contents
@@ -52,6 +50,8 @@ AVInput interface methods:
5250
| [numberOfInputs](#numberOfInputs) | Returns an integer that specifies the number of available inputs |
5351
| [getInputDevices](#getInputDevices) | Returns an array of available HDMI/Composite Input ports |
5452
| [getEdid2AllmSupport](#getEdid2AllmSupport) | Returns the EDID ALLM bit value |
53+
| [getVRRSupport](#getVRRSupport) | Returns the EDID VRR bit value |
54+
| [getVRRFrameRate](#getVRRFrameRate) | Returns the VRR FrameRate |
5555
| [getEdidVersion](#getEdidVersion) | Returns the EDID version |
5656
| [getSPD](#getSPD) | Returns the Source Data Product Descriptor (SPD) infoFrame packet information for the specified HDMI Input device |
5757
| [getRawSPD](#getRawSPD) | Returns the Source Data Product Descriptor (SPD) infoFrame packet information for the specified HDMI Input device as raw bits |
@@ -60,6 +60,7 @@ AVInput interface methods:
6060
| [stopInput](#stopInput) | Deactivates the HDMI/Composite Input port currently selected as the primary video source |
6161
| [setAudioMixerLevels](#setAudioMixerLevels) | Sets the audio mixer level for given audio input |
6262
| [setEdid2AllmSupport](#setEdid2AllmSupport) | Sets an HDMI ALLM bit in EDID |
63+
| [setVRRSupport](#setVRRSupport) | Sets an HDMI VRR bit in EDID |
6364
| [setEdidVersion](#setEdidVersion) | Sets an HDMI EDID version |
6465
| [setVideoRectangle](#setVideoRectangle) | Sets an HDMI/Composite Input video window |
6566
| [writeEDID](#writeEDID) | Changes a current EDID value |
@@ -336,6 +337,110 @@ No Events
336337
}
337338
```
338339

340+
<a name="getVRRSupport"></a>
341+
## *getVRRSupport*
342+
343+
Returns the EDID VRR bit value.
344+
345+
### Events
346+
347+
No Events
348+
349+
### Parameters
350+
351+
| Name | Type | Description |
352+
| :-------- | :-------- | :-------- |
353+
| params | object | |
354+
| params?.portId | string | <sup>*(optional)*</sup> An ID of an HDMI/Composite Input port as returned by the `getInputDevices` method |
355+
356+
### Result
357+
358+
| Name | Type | Description |
359+
| :-------- | :-------- | :-------- |
360+
| result | object | |
361+
| result.vrrSupport | boolean | The VRR bit value in edid |
362+
| result.success | boolean | Whether the request succeeded |
363+
364+
### Example
365+
366+
#### Request
367+
368+
```json
369+
{
370+
"jsonrpc": "2.0",
371+
"id": 42,
372+
"method": "org.rdk.AVInput.getVRRSupport",
373+
"params": {
374+
"portId": "0"
375+
}
376+
}
377+
```
378+
379+
#### Response
380+
381+
```json
382+
{
383+
"jsonrpc": "2.0",
384+
"id": 42,
385+
"result": {
386+
"vrrSupport": true,
387+
"success": true
388+
}
389+
}
390+
```
391+
392+
<a name="getVRRFrameRate"></a>
393+
## *getVRRFrameRate*
394+
395+
Returns the VRR FrameRate.
396+
397+
### Events
398+
399+
No Events
400+
401+
### Parameters
402+
403+
| Name | Type | Description |
404+
| :-------- | :-------- | :-------- |
405+
| params | object | |
406+
| params?.portId | string | <sup>*(optional)*</sup> An ID of an HDMI/Composite Input port as returned by the `getInputDevices` method |
407+
408+
### Result
409+
410+
| Name | Type | Description |
411+
| :-------- | :-------- | :-------- |
412+
| result | object | |
413+
| result.currentVRRVideoFrameRate | number | The VRR FrameRate |
414+
| result.success | boolean | Whether the request succeeded |
415+
416+
### Example
417+
418+
#### Request
419+
420+
```json
421+
{
422+
"jsonrpc": "2.0",
423+
"id": 42,
424+
"method": "org.rdk.AVInput.getVRRFrameRate",
425+
"params": {
426+
"portId": "0"
427+
}
428+
}
429+
```
430+
431+
#### Response
432+
433+
```json
434+
{
435+
"jsonrpc": "2.0",
436+
"id": 42,
437+
"result": {
438+
"currentVRRVideoFrameRate": 48.6,
439+
"success": true
440+
}
441+
}
442+
```
443+
339444
<a name="getEdidVersion"></a>
340445
## *getEdidVersion*
341446

@@ -787,6 +892,58 @@ No Events
787892
}
788893
```
789894

895+
<a name="setVRRSupport"></a>
896+
## *setVRRSupport*
897+
898+
Sets an HDMI VRR bit in EDID.
899+
900+
### Events
901+
902+
No Events
903+
904+
### Parameters
905+
906+
| Name | Type | Description |
907+
| :-------- | :-------- | :-------- |
908+
| params | object | |
909+
| params.portId | string | An ID of an HDMI/Composite Input port as returned by the `getInputDevices` method |
910+
| params.vrrSupport | boolean | The VRR support in EDID |
911+
912+
### Result
913+
914+
| Name | Type | Description |
915+
| :-------- | :-------- | :-------- |
916+
| result | object | |
917+
| result.success | boolean | Whether the request succeeded |
918+
919+
### Example
920+
921+
#### Request
922+
923+
```json
924+
{
925+
"jsonrpc": "2.0",
926+
"id": 42,
927+
"method": "org.rdk.AVInput.setVRRSupport",
928+
"params": {
929+
"portId": "0",
930+
"vrrSupport": true
931+
}
932+
}
933+
```
934+
935+
#### Response
936+
937+
```json
938+
{
939+
"jsonrpc": "2.0",
940+
"id": 42,
941+
"result": {
942+
"success": true
943+
}
944+
}
945+
```
946+
790947
<a name="setEdidVersion"></a>
791948
## *setEdidVersion*
792949

@@ -1035,7 +1192,7 @@ No Events
10351192
| Name | Type | Description |
10361193
| :-------- | :-------- | :-------- |
10371194
| result | object | |
1038-
| result.mode | boolean | The current game feature status. Mode is required only for ALLM. Need to add support for future game features |
1195+
| result.mode | boolean | The current status of the game features like ALLM, VRR-HDMI, VRR-FREESYNC, VRR-FREESYNC-PREMIUM and VRR-FREESYNC-PREMIUM-PRO |
10391196

10401197
### Errors
10411198

@@ -1086,7 +1243,7 @@ AVInput interface events:
10861243
| [onInputStatusChanged](#onInputStatusChanged) | Triggered whenever the status changes for an HDMI/Composite Input |
10871244
| [onSignalChanged](#onSignalChanged) | Triggered whenever the signal status changes for an HDMI/Composite Input |
10881245
| [videoStreamInfoUpdate](#videoStreamInfoUpdate) | Triggered whenever there is an update in HDMI Input video stream info |
1089-
| [gameFeatureStatusUpdate](#gameFeatureStatusUpdate) | Triggered whenever game feature(ALLM) status changes for an HDMI Input |
1246+
| [gameFeatureStatusUpdate](#gameFeatureStatusUpdate) | Triggered whenever game feature status changes for an HDMI Input |
10901247
| [hdmiContentTypeUpdate](#hdmiContentTypeUpdate) | Triggered whenever AV Infoframe content type changes for an HDMI Input |
10911248

10921249

@@ -1221,7 +1378,7 @@ Triggered whenever there is an update in HDMI Input video stream info.
12211378
<a name="gameFeatureStatusUpdate"></a>
12221379
## *gameFeatureStatusUpdate*
12231380

1224-
Triggered whenever game feature(ALLM) status changes for an HDMI Input.
1381+
Triggered whenever game feature status changes for an HDMI Input.
12251382

12261383
### Parameters
12271384

@@ -1230,7 +1387,7 @@ Triggered whenever game feature(ALLM) status changes for an HDMI Input.
12301387
| params | object | |
12311388
| params.id | number | The port identifier for the HDMI/Composite Input |
12321389
| params.gameFeature | string | Game Feature to which current status requested |
1233-
| params.mode | boolean | The current game feature status. Mode is required only for ALLM. Need to add support for future game features |
1390+
| params.mode | boolean | The current status of the game features like ALLM, VRR-HDMI, VRR-FREESYNC, VRR-FREESYNC-PREMIUM and VRR-FREESYNC-PREMIUM-PRO |
12341391

12351392
### Example
12361393

‎docs/apis/AnalyticsPlugin.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<a name="Analytics_Plugin"></a>
33
# Analytics Plugin
44

5-
**Version: [1.0.0]()**
6-
75
A org.rdk.Analytics plugin for Thunder framework.
86

97
### Table of Contents

‎docs/apis/BluetoothPlugin.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<a name="Bluetooth_Plugin"></a>
33
# Bluetooth Plugin
44

5-
**Version: [1.0.0]()**
6-
75
A org.rdk.Bluetooth plugin for Thunder framework.
86

97
### Table of Contents

‎docs/apis/DTVPlugin.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<a name="DTV_Plugin"></a>
33
# DTV Plugin
44

5-
**Version: [1.0.0]()**
6-
75
A DTV plugin for Thunder framework.
86

97
### Table of Contents

‎docs/apis/DeviceDiagnosticsPlugin.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<a name="DeviceDiagnostics_Plugin"></a>
33
# DeviceDiagnostics Plugin
44

5-
**Version: [1.0.0]()**
6-
75
A org.rdk.DeviceDiagnostics plugin for Thunder framework.
86

97
### Table of Contents

0 commit comments

Comments
 (0)