Skip to content

Commit 2a5a184

Browse files
rdkcm-rdkerdkcm-rdke
committed
Auto-generate documentation from interface changes
1 parent 8ffacd2 commit 2a5a184

File tree

2 files changed

+266
-0
lines changed

2 files changed

+266
-0
lines changed

‎docs/_sidebar.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
- [Telemetry](apis/Telemetry.md)
5656
- [TextToSpeech<sup>@</sup>](apis/TextToSpeechPlugin.md)
5757
- [TextTrack](apis/TextTrack.md)
58+
- [UnifiedCASManagement](apis/UnifiedCASManagement.md)
5859
- [USBDevice](apis/USBDevice.md)
5960
- [USBMassStorage](apis/USBMassStorage.md)
6061
- [UserSettings](apis/UserSettings.md)

‎docs/apis/UnifiedCASManagement.md‎

Lines changed: 265 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,265 @@
1+
<!-- Generated automatically, DO NOT EDIT! -->
2+
<a id="UnifiedCASManagement_Plugin"></a>
3+
# UnifiedCASManagement Plugin
4+
5+
**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/UnifiedCASManagement/IUnifiedCASManagement.h)**
6+
7+
A UnifiedCASManagement 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+
- [Notifications](#Notifications)
16+
17+
<a id="abbreviation-acronyms-and-terms"></a>
18+
# Abbreviation, Acronyms and Terms
19+
20+
[[Refer to this link](overview/aat.md)]
21+
22+
<a id="Description"></a>
23+
# Description
24+
25+
The `UnifiedCASManagement` plugin provides an interface for UnifiedCASManagement.
26+
27+
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/)].
28+
29+
<a id="Configuration"></a>
30+
# Configuration
31+
32+
The table below lists configuration options of the plugin.
33+
34+
| Name | Type | Description |
35+
| :-------- | :-------- | :-------- |
36+
| callsign | string | Plugin instance name (default: org.rdk.UnifiedCASManagement) |
37+
| classname | string | Class name: *UnifiedCASManagement* |
38+
| locator | string | Library name: *libWPEFrameworkUnifiedCASManagement.so* |
39+
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
40+
41+
<a id="Methods"></a>
42+
# Methods
43+
44+
The following methods are provided by the UnifiedCASManagement plugin:
45+
46+
UnifiedCASManagement interface methods:
47+
48+
| Method | Description |
49+
| :-------- | :-------- |
50+
| [manage](#manage) | Manage a well-known CAS (setup CAS management session) |
51+
| [send](#send) | Sends data to the remote CAS |
52+
| [unmanage](#unmanage) | Destroy a management session |
53+
54+
<a id="manage"></a>
55+
## *manage*
56+
57+
Manage a well-known CAS (setup CAS management session)
58+
59+
### Events
60+
Event details will be updated soon.
61+
### Parameters
62+
| Name | Type | Description |
63+
| :-------- | :-------- | :-------- |
64+
| params | object | |
65+
| params.mediaurl | string | string - The URL to tune to (tune://, ocap://, http://, https://) |
66+
| params.mode | string | string - The use of the tune request (MODE_NONE, MODE_LIVE, MODE_RECORD, MODE_PLAYBACK) |
67+
| params.managementType | string | string - Type of CAS management (MANAGE_NONE, MANAGE_FULL, MANAGE_NO_PSI, MANAGE_NO_TUNER) |
68+
| params.casinitdata | string | string - CAS specific initdata for the selected media |
69+
| params.casocdmid | string | string - The well-known OCDM ID of the CAS to use |
70+
### Results
71+
| Name | Type | Description |
72+
| :-------- | :-------- | :-------- |
73+
| result | object | |
74+
| result.message | string | string |
75+
| result.success | bool | bool |
76+
77+
### Examples
78+
79+
80+
#### Request
81+
82+
```json
83+
{
84+
"jsonrpc": 2.0,
85+
"id": 0,
86+
"method": "org.rdk.UnifiedCASManagement.manage",
87+
"params": {
88+
"mediaurl": "",
89+
"mode": "",
90+
"managementType": "",
91+
"casinitdata": "",
92+
"casocdmid": ""
93+
}
94+
}
95+
```
96+
97+
98+
#### CURL Command
99+
100+
```curl
101+
curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.UnifiedCASManagement.manage", "params": {"mediaurl": "", "mode": "", "managementType": "", "casinitdata": "", "casocdmid": ""}}' http://127.0.0.1:9998/jsonrpc
102+
```
103+
104+
105+
#### Response
106+
107+
```json
108+
{
109+
"jsonrpc": 2.0,
110+
"id": 0,
111+
"result": {
112+
"message": "",
113+
"success": true
114+
}
115+
}
116+
```
117+
118+
<a id="send"></a>
119+
## *send*
120+
121+
Sends data to the remote CAS
122+
123+
### Events
124+
Event details will be updated soon.
125+
### Parameters
126+
| Name | Type | Description |
127+
| :-------- | :-------- | :-------- |
128+
| params | object | |
129+
| params.payload | string | string - Data to transfer. Can be base64 coded if required |
130+
| params.source | string | string - Origin of the data (PUBLIC or PRIVATE) |
131+
### Results
132+
| Name | Type | Description |
133+
| :-------- | :-------- | :-------- |
134+
| result | object | |
135+
| result.message | string | string |
136+
| result.success | bool | bool |
137+
138+
### Examples
139+
140+
141+
#### Request
142+
143+
```json
144+
{
145+
"jsonrpc": 2.0,
146+
"id": 1,
147+
"method": "org.rdk.UnifiedCASManagement.send",
148+
"params": {
149+
"payload": "",
150+
"source": ""
151+
}
152+
}
153+
```
154+
155+
156+
#### CURL Command
157+
158+
```curl
159+
curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.UnifiedCASManagement.send", "params": {"payload": "", "source": ""}}' http://127.0.0.1:9998/jsonrpc
160+
```
161+
162+
163+
#### Response
164+
165+
```json
166+
{
167+
"jsonrpc": 2.0,
168+
"id": 1,
169+
"result": {
170+
"message": "",
171+
"success": true
172+
}
173+
}
174+
```
175+
176+
<a id="unmanage"></a>
177+
## *unmanage*
178+
179+
Destroy a management session
180+
181+
### Events
182+
Event details will be updated soon.
183+
### Parameters
184+
This method takes no parameters.
185+
### Results
186+
| Name | Type | Description |
187+
| :-------- | :-------- | :-------- |
188+
| result | object | |
189+
| result.message | string | string |
190+
| result.success | bool | bool |
191+
192+
### Examples
193+
194+
195+
#### Request
196+
197+
```json
198+
{
199+
"jsonrpc": 2.0,
200+
"id": 2,
201+
"method": "org.rdk.UnifiedCASManagement.unmanage"
202+
}
203+
```
204+
205+
206+
#### CURL Command
207+
208+
```curl
209+
curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.UnifiedCASManagement.unmanage"}' http://127.0.0.1:9998/jsonrpc
210+
```
211+
212+
213+
#### Response
214+
215+
```json
216+
{
217+
"jsonrpc": 2.0,
218+
"id": 2,
219+
"result": {
220+
"message": "",
221+
"success": true
222+
}
223+
}
224+
```
225+
226+
227+
228+
<a id="Notifications"></a>
229+
# Notifications
230+
231+
Notifications are autonomous events, triggered by the internals of the implementation, and broadcasted via JSON-RPC to all registered observers. Refer to [[Thunder](https://rdkcentral.github.io/Thunder/)] for information on how to register for a notification.
232+
233+
The following events are provided by the UnifiedCASManagement plugin:
234+
235+
UnifiedCASManagement interface events:
236+
237+
| Event | Description |
238+
| :-------- | :-------- |
239+
| [data](#data) | Sent when the CAS needs to send data to the caller |
240+
241+
<a id="event_data"></a>
242+
## *event_data*
243+
244+
Sent when the CAS needs to send data to the caller
245+
246+
### Parameters
247+
| Name | Type | Description |
248+
| :-------- | :-------- | :-------- |
249+
| params | object | |
250+
| params.payload | string | string - Data to transfer. Can be base64 coded if required |
251+
| params.source | string | string - Origin of the data (PUBLIC or PRIVATE) |
252+
253+
### Examples
254+
255+
```json
256+
{
257+
"jsonrpc": 2.0,
258+
"id": 3,
259+
"method": "org.rdk.UnifiedCASManagement.event_data",
260+
"params": {
261+
"payload": "",
262+
"source": ""
263+
}
264+
}
265+
```

0 commit comments

Comments
 (0)