Skip to content

Commit 5cc3500

Browse files
rdkcm-rdkerdkcm-rdke
committed
Auto-generate documentation from interface changes
1 parent 6a935c5 commit 5cc3500

File tree

2 files changed

+275
-0
lines changed

2 files changed

+275
-0
lines changed

‎docs/_sidebar.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
- [RDKShell<sup>@</sup>](apis/RDKShellPlugin.md)
4646
- [RDKWindowManager](apis/RDKWindowManager.md)
4747
- [RemoteControl<sup>@</sup>](apis/RemoteControlPlugin.md)
48+
- [ResourceManager](apis/ResourceManager.md)
4849
- [ResourceManager<sup>@</sup>](apis/ResourceManagerPlugin.md)
4950
- [ScreenCapture](apis/ScreenCapture.md)
5051
- [SharedStorage](apis/SharedStorage.md)

‎docs/apis/ResourceManager.md‎

Lines changed: 274 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,274 @@
1+
<!-- Generated automatically, DO NOT EDIT! -->
2+
<a id="ResourceManager_Plugin"></a>
3+
# ResourceManager Plugin
4+
5+
**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/ResourceManager/IResourceManager.h)**
6+
7+
A ResourceManager 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 id="abbreviation-acronyms-and-terms"></a>
17+
# Abbreviation, Acronyms and Terms
18+
19+
[[Refer to this link](overview/aat.md)]
20+
21+
<a id="Description"></a>
22+
# Description
23+
24+
The `ResourceManager` plugin provides an interface for ResourceManager.
25+
26+
The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](https://rdkcentral.github.io/Thunder/)].
27+
28+
<a id="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.ResourceManager) |
36+
| classname | string | Class name: *ResourceManager* |
37+
| locator | string | Library name: *libWPEFrameworkResourceManager.so* |
38+
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
39+
40+
<a id="Methods"></a>
41+
# Methods
42+
43+
The following methods are provided by the ResourceManager plugin:
44+
45+
ResourceManager interface methods:
46+
47+
| Method | Description |
48+
| :-------- | :-------- |
49+
| [getBlockedAVApplications](#getBlockedAVApplications) | Gets list of applications with blocked AV access |
50+
| [reserveTTSResource](#reserveTTSResource) | Reserves TTS resource for a single application |
51+
| [reserveTTSResourceForApps](#reserveTTSResourceForApps) | Reserves TTS resource for multiple applications |
52+
| [setAVBlocked](#setAVBlocked) | Sets AV blocking status for an application |
53+
54+
<a id="getBlockedAVApplications"></a>
55+
## *getBlockedAVApplications*
56+
57+
Gets list of applications with blocked AV access
58+
59+
### Events
60+
Event details will be updated soon.
61+
### Parameters
62+
This method takes no parameters.
63+
### Results
64+
| Name | Type | Description |
65+
| :-------- | :-------- | :-------- |
66+
| result | object | |
67+
| result.clients | IClientIterator | list of blocked applications |
68+
| result.clients[#] | string | |
69+
| result.success | bool | bool |
70+
71+
### Examples
72+
73+
74+
#### Request
75+
76+
```json
77+
{
78+
"jsonrpc": 2.0,
79+
"id": 0,
80+
"method": "org.rdk.ResourceManager.getBlockedAVApplications"
81+
}
82+
```
83+
84+
85+
#### CURL Command
86+
87+
```curl
88+
curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.ResourceManager.getBlockedAVApplications"}' http://127.0.0.1:9998/jsonrpc
89+
```
90+
91+
92+
#### Response
93+
94+
```json
95+
{
96+
"jsonrpc": 2.0,
97+
"id": 0,
98+
"result": {
99+
"clients": [
100+
""
101+
],
102+
"success": true
103+
}
104+
}
105+
```
106+
107+
<a id="reserveTTSResource"></a>
108+
## *reserveTTSResource*
109+
110+
Reserves TTS resource for a single application
111+
112+
### Events
113+
Event details will be updated soon.
114+
### Parameters
115+
| Name | Type | Description |
116+
| :-------- | :-------- | :-------- |
117+
| params | object | |
118+
| params.appId | string | string |
119+
### Results
120+
| Name | Type | Description |
121+
| :-------- | :-------- | :-------- |
122+
| result | object | |
123+
| result.success | bool | bool |
124+
125+
### Examples
126+
127+
128+
#### Request
129+
130+
```json
131+
{
132+
"jsonrpc": 2.0,
133+
"id": 1,
134+
"method": "org.rdk.ResourceManager.reserveTTSResource",
135+
"params": {
136+
"appId": ""
137+
}
138+
}
139+
```
140+
141+
142+
#### CURL Command
143+
144+
```curl
145+
curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.ResourceManager.reserveTTSResource", "params": {"appId": ""}}' http://127.0.0.1:9998/jsonrpc
146+
```
147+
148+
149+
#### Response
150+
151+
```json
152+
{
153+
"jsonrpc": 2.0,
154+
"id": 1,
155+
"result": {
156+
"success": true
157+
}
158+
}
159+
```
160+
161+
<a id="reserveTTSResourceForApps"></a>
162+
## *reserveTTSResourceForApps*
163+
164+
Reserves TTS resource for multiple applications
165+
166+
### Events
167+
Event details will be updated soon.
168+
### Parameters
169+
| Name | Type | Description |
170+
| :-------- | :-------- | :-------- |
171+
| params | object | |
172+
| params.appids | IAppIdIterator | list of application IDs |
173+
| params.appids[#] | string | |
174+
### Results
175+
| Name | Type | Description |
176+
| :-------- | :-------- | :-------- |
177+
| result | object | |
178+
| result.success | bool | bool |
179+
180+
### Examples
181+
182+
183+
#### Request
184+
185+
```json
186+
{
187+
"jsonrpc": 2.0,
188+
"id": 2,
189+
"method": "org.rdk.ResourceManager.reserveTTSResourceForApps",
190+
"params": [
191+
""
192+
]
193+
}
194+
```
195+
196+
197+
#### CURL Command
198+
199+
```curl
200+
curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.ResourceManager.reserveTTSResourceForApps", "params": [""]}' http://127.0.0.1:9998/jsonrpc
201+
```
202+
203+
204+
#### Response
205+
206+
```json
207+
{
208+
"jsonrpc": 2.0,
209+
"id": 2,
210+
"result": {
211+
"success": true
212+
}
213+
}
214+
```
215+
216+
<a id="setAVBlocked"></a>
217+
## *setAVBlocked*
218+
219+
Sets AV blocking status for an application
220+
221+
### Events
222+
Event details will be updated soon.
223+
### Parameters
224+
| Name | Type | Description |
225+
| :-------- | :-------- | :-------- |
226+
| params | object | |
227+
| params.appId | string | string |
228+
| params.blocked | bool | bool |
229+
### Results
230+
| Name | Type | Description |
231+
| :-------- | :-------- | :-------- |
232+
| result | object | |
233+
| result.message | string | string |
234+
| result.success | bool | bool |
235+
236+
### Examples
237+
238+
239+
#### Request
240+
241+
```json
242+
{
243+
"jsonrpc": 2.0,
244+
"id": 3,
245+
"method": "org.rdk.ResourceManager.setAVBlocked",
246+
"params": {
247+
"appId": "",
248+
"blocked": true
249+
}
250+
}
251+
```
252+
253+
254+
#### CURL Command
255+
256+
```curl
257+
curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.ResourceManager.setAVBlocked", "params": {"appId": "", "blocked": true}}' http://127.0.0.1:9998/jsonrpc
258+
```
259+
260+
261+
#### Response
262+
263+
```json
264+
{
265+
"jsonrpc": 2.0,
266+
"id": 3,
267+
"result": {
268+
"message": "",
269+
"success": true
270+
}
271+
}
272+
```
273+
274+

0 commit comments

Comments
 (0)