Skip to content

Commit 9324169

Browse files
rdkcm-rdkerdkcm-rdke
committed
Auto-generate documentation from interface changes
1 parent ecf8e9f commit 9324169

File tree

2 files changed

+260
-0
lines changed

2 files changed

+260
-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: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
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 | The URL to tune to (tune://, ocap://, http://, https://) |
66+
| params.mode | string | The use of the tune request (MODE_NONE, MODE_LIVE, MODE_RECORD, MODE_PLAYBACK) |
67+
| params.managementType | string | Type of CAS management (MANAGE_NONE, MANAGE_FULL, MANAGE_NO_PSI, MANAGE_NO_TUNER) |
68+
| params.casinitdata | string | CAS specific initdata for the selected media |
69+
| params.casocdmid | string | The well-known OCDM ID of the CAS to use |
70+
### Results
71+
| Name | Type | Description |
72+
| :-------- | :-------- | :-------- |
73+
| result | object | |
74+
| result.success | bool | Returns true if the operation succeeded, false otherwise @retval Core::ERROR_NONE: Operation successful @retval Core::ERROR_GENERAL: Operation failed |
75+
76+
### Examples
77+
78+
79+
#### Request
80+
81+
```json
82+
{
83+
"jsonrpc": 2.0,
84+
"id": 0,
85+
"method": "org.rdk.UnifiedCASManagement.manage",
86+
"params": {
87+
"mediaurl": "",
88+
"mode": "",
89+
"managementType": "",
90+
"casinitdata": "",
91+
"casocdmid": ""
92+
}
93+
}
94+
```
95+
96+
97+
#### CURL Command
98+
99+
```curl
100+
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
101+
```
102+
103+
104+
#### Response
105+
106+
```json
107+
{
108+
"jsonrpc": 2.0,
109+
"id": 0,
110+
"result": {
111+
"success": true
112+
}
113+
}
114+
```
115+
116+
<a id="send"></a>
117+
## *send*
118+
119+
Sends data to the remote CAS
120+
121+
### Events
122+
Event details will be updated soon.
123+
### Parameters
124+
| Name | Type | Description |
125+
| :-------- | :-------- | :-------- |
126+
| params | object | |
127+
| params.payload | string | Data to transfer. Can be base64 coded if required |
128+
| params.source | string | Origin of the data (PUBLIC or PRIVATE) |
129+
### Results
130+
| Name | Type | Description |
131+
| :-------- | :-------- | :-------- |
132+
| result | object | |
133+
| result.success | bool | Returns true if the operation succeeded, false otherwise @retval Core::ERROR_NONE: Operation successful @retval Core::ERROR_GENERAL: Operation failed |
134+
135+
### Examples
136+
137+
138+
#### Request
139+
140+
```json
141+
{
142+
"jsonrpc": 2.0,
143+
"id": 1,
144+
"method": "org.rdk.UnifiedCASManagement.send",
145+
"params": {
146+
"payload": "",
147+
"source": ""
148+
}
149+
}
150+
```
151+
152+
153+
#### CURL Command
154+
155+
```curl
156+
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
157+
```
158+
159+
160+
#### Response
161+
162+
```json
163+
{
164+
"jsonrpc": 2.0,
165+
"id": 1,
166+
"result": {
167+
"success": true
168+
}
169+
}
170+
```
171+
172+
<a id="unmanage"></a>
173+
## *unmanage*
174+
175+
Destroy a management session
176+
177+
### Events
178+
Event details will be updated soon.
179+
### Parameters
180+
This method takes no parameters.
181+
### Results
182+
| Name | Type | Description |
183+
| :-------- | :-------- | :-------- |
184+
| result | object | |
185+
| result.success | bool | Returns true if the operation succeeded, false otherwise @retval Core::ERROR_NONE: Operation successful @retval Core::ERROR_GENERAL: Operation failed |
186+
187+
### Examples
188+
189+
190+
#### Request
191+
192+
```json
193+
{
194+
"jsonrpc": 2.0,
195+
"id": 2,
196+
"method": "org.rdk.UnifiedCASManagement.unmanage"
197+
}
198+
```
199+
200+
201+
#### CURL Command
202+
203+
```curl
204+
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
205+
```
206+
207+
208+
#### Response
209+
210+
```json
211+
{
212+
"jsonrpc": 2.0,
213+
"id": 2,
214+
"result": {
215+
"success": true
216+
}
217+
}
218+
```
219+
220+
221+
222+
<a id="Notifications"></a>
223+
# Notifications
224+
225+
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.
226+
227+
The following events are provided by the UnifiedCASManagement plugin:
228+
229+
UnifiedCASManagement interface events:
230+
231+
| Event | Description |
232+
| :-------- | :-------- |
233+
| [data](#data) | Sent when the CAS needs to send data to the caller |
234+
235+
<a id="onDataReceived"></a>
236+
## *onDataReceived*
237+
238+
Sent when the CAS needs to send data to the caller
239+
240+
### Parameters
241+
| Name | Type | Description |
242+
| :-------- | :-------- | :-------- |
243+
| params | object | |
244+
| params.payload | string | Data to transfer. Can be base64 coded if required |
245+
| params.source | string | Origin of the data (PUBLIC or PRIVATE) |
246+
247+
### Examples
248+
249+
```json
250+
{
251+
"jsonrpc": 2.0,
252+
"id": 3,
253+
"method": "org.rdk.UnifiedCASManagement.onDataReceived",
254+
"params": {
255+
"payload": "",
256+
"source": ""
257+
}
258+
}
259+
```

0 commit comments

Comments
 (0)