Skip to content

Commit 2505a69

Browse files
sithandasithanda
authored
Merge branch 'develop' into topic/RDKEMW-5551
2 parents 8562c0c + bc80f9d commit 2505a69

File tree

2 files changed

+50
-60
lines changed

2 files changed

+50
-60
lines changed

‎apis/common.json‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -188,15 +188,5 @@
188188
"default": null,
189189
"description": "Always null"
190190
}
191-
},
192-
"result": {
193-
"type": "boolean",
194-
"default": true,
195-
"description": "Always true"
196-
},
197-
"success": {
198-
"type": "boolean",
199-
"default": true,
200-
"description": "Indicates success"
201191
}
202192
}

‎docs/apis/FrameRatePlugin.md‎

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- Generated automatically, DO NOT EDIT! -->
2-
<a name="head.FrameRate_Plugin"></a>
2+
<a name="FrameRate_Plugin"></a>
33
# FrameRate Plugin
44

55
**Version: [1.0.0]()**
@@ -8,25 +8,25 @@ A org.rdk.FrameRate plugin for Thunder framework.
88

99
### Table of Contents
1010

11-
- [Abbreviation, Acronyms and Terms](#head.Abbreviation,_Acronyms_and_Terms)
12-
- [Description](#head.Description)
13-
- [Configuration](#head.Configuration)
14-
- [Methods](#head.Methods)
15-
- [Notifications](#head.Notifications)
11+
- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
12+
- [Description](#Description)
13+
- [Configuration](#Configuration)
14+
- [Methods](#Methods)
15+
- [Notifications](#Notifications)
1616

17-
<a name="head.Abbreviation,_Acronyms_and_Terms"></a>
17+
<a name="Abbreviation,_Acronyms_and_Terms"></a>
1818
# Abbreviation, Acronyms and Terms
1919

2020
[[Refer to this link](overview/aat.md)]
2121

22-
<a name="head.Description"></a>
22+
<a name="Description"></a>
2323
# Description
2424

2525
The `FrameRate` plugin allows you to collect FPS data.
2626

27-
The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#ref.Thunder)].
27+
The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#Thunder)].
2828

29-
<a name="head.Configuration"></a>
29+
<a name="Configuration"></a>
3030
# Configuration
3131

3232
The table below lists configuration options of the plugin.
@@ -38,7 +38,7 @@ The table below lists configuration options of the plugin.
3838
| locator | string | Library name: *libWPEFrameworkFrameRate.so* |
3939
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
4040

41-
<a name="head.Methods"></a>
41+
<a name="Methods"></a>
4242
# Methods
4343

4444
The following methods are provided by the org.rdk.FrameRate plugin:
@@ -47,18 +47,18 @@ FrameRate interface methods:
4747

4848
| Method | Description |
4949
| :-------- | :-------- |
50-
| [getDisplayFrameRate](#method.getDisplayFrameRate) | Returns the current display frame rate values |
51-
| [getFrmMode](#method.getFrmMode) | Returns the current auto framerate mode |
52-
| [setCollectionFrequency](#method.setCollectionFrequency) | Sets the FPS data collection interval |
53-
| [setDisplayFrameRate](#method.setDisplayFrameRate) | Sets the display framerate values |
54-
| [setFrmMode](#method.setFrmMode) | Sets the auto framerate mode |
55-
| [startFpsCollection](#method.startFpsCollection) | Starts the FPS data collection |
56-
| [stopFpsCollection](#method.stopFpsCollection) | Stops the FPS data collection |
57-
| [updateFps](#method.updateFps) | Updates Fps values |
50+
| [getDisplayFrameRate](#getDisplayFrameRate) | Returns the current display frame rate values |
51+
| [getFrmMode](#getFrmMode) | Returns the current auto framerate mode |
52+
| [setCollectionFrequency](#setCollectionFrequency) | Sets the FPS data collection interval |
53+
| [setDisplayFrameRate](#setDisplayFrameRate) | Sets the display framerate values |
54+
| [setFrmMode](#setFrmMode) | Sets the auto framerate mode |
55+
| [startFpsCollection](#startFpsCollection) | Starts the FPS data collection |
56+
| [stopFpsCollection](#stopFpsCollection) | Stops the FPS data collection |
57+
| [updateFps](#updateFps) | Updates Fps values |
5858

5959

60-
<a name="method.getDisplayFrameRate"></a>
61-
## *getDisplayFrameRate [<sup>method</sup>](#head.Methods)*
60+
<a name="getDisplayFrameRate"></a>
61+
## *getDisplayFrameRate*
6262

6363
Returns the current display frame rate values.
6464

@@ -103,8 +103,8 @@ This method takes no parameters.
103103
}
104104
```
105105

106-
<a name="method.getFrmMode"></a>
107-
## *getFrmMode [<sup>method</sup>](#head.Methods)*
106+
<a name="getFrmMode"></a>
107+
## *getFrmMode*
108108

109109
Returns the current auto framerate mode.
110110

@@ -149,8 +149,8 @@ This method takes no parameters.
149149
}
150150
```
151151

152-
<a name="method.setCollectionFrequency"></a>
153-
## *setCollectionFrequency [<sup>method</sup>](#head.Methods)*
152+
<a name="setCollectionFrequency"></a>
153+
## *setCollectionFrequency*
154154

155155
Sets the FPS data collection interval.
156156

@@ -196,17 +196,17 @@ No Events
196196
}
197197
```
198198

199-
<a name="method.setDisplayFrameRate"></a>
200-
## *setDisplayFrameRate [<sup>method</sup>](#head.Methods)*
199+
<a name="setDisplayFrameRate"></a>
200+
## *setDisplayFrameRate*
201201

202202
Sets the display framerate values.
203203

204204
### Events
205205

206206
| Event | Description |
207207
| :-------- | :-------- |
208-
| [onDisplayFrameRateChanging](#event.onDisplayFrameRateChanging) | Triggered when the framerate changes started. |
209-
| [onDisplayFrameRateChanged](#event.onDisplayFrameRateChanged) | Triggered when the framerate changed |
208+
| [onDisplayFrameRateChanging](#onDisplayFrameRateChanging) | Triggered when the framerate changes started. |
209+
| [onDisplayFrameRateChanged](#onDisplayFrameRateChanged) | Triggered when the framerate changed |
210210
### Parameters
211211

212212
| Name | Type | Description |
@@ -245,8 +245,8 @@ Sets the display framerate values.
245245
}
246246
```
247247

248-
<a name="method.setFrmMode"></a>
249-
## *setFrmMode [<sup>method</sup>](#head.Methods)*
248+
<a name="setFrmMode"></a>
249+
## *setFrmMode*
250250

251251
Sets the auto framerate mode.
252252

@@ -292,16 +292,16 @@ No Events
292292
}
293293
```
294294

295-
<a name="method.startFpsCollection"></a>
296-
## *startFpsCollection [<sup>method</sup>](#head.Methods)*
295+
<a name="startFpsCollection"></a>
296+
## *startFpsCollection*
297297

298298
Starts the FPS data collection.
299299

300300
### Events
301301

302302
| Event | Description |
303303
| :-------- | :-------- |
304-
| [onFpsEvent](#event.onFpsEvent) | Triggered at the end of each interval as defined by the setCollectionFrequency |
304+
| [onFpsEvent](#onFpsEvent) | Triggered at the end of each interval as defined by the setCollectionFrequency |
305305
### Parameters
306306

307307
This method takes no parameters.
@@ -334,16 +334,16 @@ This method takes no parameters.
334334
}
335335
```
336336

337-
<a name="method.stopFpsCollection"></a>
338-
## *stopFpsCollection [<sup>method</sup>](#head.Methods)*
337+
<a name="stopFpsCollection"></a>
338+
## *stopFpsCollection*
339339

340340
Stops the FPS data collection.
341341

342342
### Events
343343

344344
| Event | Description |
345345
| :-------- | :-------- |
346-
| [onFpsEvent](#event.onFpsEvent) | Triggered once after the stopFpsCollection method is invoked. |
346+
| [onFpsEvent](#onFpsEvent) | Triggered once after the stopFpsCollection method is invoked. |
347347
### Parameters
348348

349349
This method takes no parameters.
@@ -376,8 +376,8 @@ This method takes no parameters.
376376
}
377377
```
378378

379-
<a name="method.updateFps"></a>
380-
## *updateFps [<sup>method</sup>](#head.Methods)*
379+
<a name="updateFps"></a>
380+
## *updateFps*
381381

382382
Updates Fps values.
383383

@@ -423,24 +423,24 @@ No Events
423423
}
424424
```
425425

426-
<a name="head.Notifications"></a>
426+
<a name="Notifications"></a>
427427
# Notifications
428428

429-
Notifications are autonomous events, triggered by the internals of the implementation, and broadcasted via JSON-RPC to all registered observers. Refer to [[Thunder](#ref.Thunder)] for information on how to register for a notification.
429+
Notifications are autonomous events, triggered by the internals of the implementation, and broadcasted via JSON-RPC to all registered observers. Refer to [[Thunder](#Thunder)] for information on how to register for a notification.
430430

431431
The following events are provided by the org.rdk.FrameRate plugin:
432432

433433
FrameRate interface events:
434434

435435
| Event | Description |
436436
| :-------- | :-------- |
437-
| [onDisplayFrameRateChanging](#event.onDisplayFrameRateChanging) | Triggered when the framerate changes started |
438-
| [onDisplayFrameRateChanged](#event.onDisplayFrameRateChanged) | Triggered when the framerate changed |
439-
| [onFpsEvent](#event.onFpsEvent) | Triggered at the end of each interval as defined by the `setCollectionFrequency` method and once after the `stopFpsCollection` method is invoked |
437+
| [onDisplayFrameRateChanging](#onDisplayFrameRateChanging) | Triggered when the framerate changes started |
438+
| [onDisplayFrameRateChanged](#onDisplayFrameRateChanged) | Triggered when the framerate changed |
439+
| [onFpsEvent](#onFpsEvent) | Triggered at the end of each interval as defined by the `setCollectionFrequency` method and once after the `stopFpsCollection` method is invoked |
440440

441441

442-
<a name="event.onDisplayFrameRateChanging"></a>
443-
## *onDisplayFrameRateChanging [<sup>event</sup>](#head.Notifications)*
442+
<a name="onDisplayFrameRateChanging"></a>
443+
## *onDisplayFrameRateChanging*
444444

445445
Triggered when the framerate changes started.
446446

@@ -463,8 +463,8 @@ Triggered when the framerate changes started.
463463
}
464464
```
465465

466-
<a name="event.onDisplayFrameRateChanged"></a>
467-
## *onDisplayFrameRateChanged [<sup>event</sup>](#head.Notifications)*
466+
<a name="onDisplayFrameRateChanged"></a>
467+
## *onDisplayFrameRateChanged*
468468

469469
Triggered when the framerate changed.
470470

@@ -487,8 +487,8 @@ Triggered when the framerate changed.
487487
}
488488
```
489489

490-
<a name="event.onFpsEvent"></a>
491-
## *onFpsEvent [<sup>event</sup>](#head.Notifications)*
490+
<a name="onFpsEvent"></a>
491+
## *onFpsEvent*
492492

493493
Triggered at the end of each interval as defined by the `setCollectionFrequency` method and once after the `stopFpsCollection` method is invoked.
494494

0 commit comments

Comments
 (0)