-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__addon__pvr__supports_channel_groups.html
396 lines (384 loc) · 38.4 KB
/
group__cpp__kodi__addon__pvr__supports_channel_groups.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: 3. Channel Groups (optional)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__kodi__addon__pvr__supports_channel_groups.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">3. Channel Groups (optional)<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__addon.html">Interface - kodi::addon</a> » <a class="el" href="group__cpp__kodi__addon__instances.html">Addon type instances</a> » <a class="el" href="group__cpp__kodi__addon__pvr.html">PVR</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>Bring in this functions if you have set <a class="el" href="group__cpp__kodi__addon__pvr___defs___p_v_r_capabilities.html#ga3b6d35a66f3bb9279f2b4ad9f1746657">supportsChannelGroups</a> to true</b><br />
This is used to divide available addon channels into groups, which can then be selected by the user. </p>
<hr />
<p><b>Channel group parts in interface:</b><br />
Copy this to your project and extend with your parts or leave functions complete away where not used or supported.</p>
<p><em>Header parts:</em> </p><div class="fragment"><div class="line"><a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> <a class="code" href="group__cpp__kodi__addon__pvr__supports_channel_groups.html#ga4e3ccc3aa5f628c194ee696c11f2adc0">GetChannelGroupsAmount</a>(<span class="keywordtype">int</span>& amount) <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> <a class="code" href="group__cpp__kodi__addon__pvr__supports_channel_groups.html#gabb3bc13df7f09f6fb5becf0be7d2d0b9">GetChannelGroups</a>(<span class="keywordtype">bool</span> radio, <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_groups_result_set.html">kodi::addon::PVRChannelGroupsResultSet</a>& results) <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> <a class="code" href="group__cpp__kodi__addon__pvr__supports_channel_groups.html#ga24a8893b9fd780858b08ee7be386a2d3">GetChannelGroupMembers</a>(<span class="keyword">const</span> <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group.html">kodi::addon::PVRChannelGroup</a>& group, <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group_members_result_set.html">kodi::addon::PVRChannelGroupMembersResultSet</a>& results) <span class="keyword">override</span>;</div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_p_v_r_channel_group_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_p_v_r_channel_group.html">kodi::addon::PVRChannelGroup</a></div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:38</div></div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_p_v_r_channel_group_members_result_set_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_p_v_r_channel_group_members_result_set.html">kodi::addon::PVRChannelGroupMembersResultSet</a></div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:238</div></div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_p_v_r_channel_groups_result_set_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_p_v_r_channel_groups_result_set.html">kodi::addon::PVRChannelGroupsResultSet</a></div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:103</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r_html_ga4cf1fba691fffe5b92e8f27159673894"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a></div><div class="ttdeci">PVR_ERROR</div><div class="ttdef"><b>Definition:</b> pvr_general.h:35</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr__supports_channel_groups_html_ga24a8893b9fd780858b08ee7be386a2d3"><div class="ttname"><a href="group__cpp__kodi__addon__pvr__supports_channel_groups.html#ga24a8893b9fd780858b08ee7be386a2d3">kodi::addon::CInstancePVRClient::GetChannelGroupMembers</a></div><div class="ttdeci">virtual PVR_ERROR GetChannelGroupMembers(const kodi::addon::PVRChannelGroup &group, kodi::addon::PVRChannelGroupMembersResultSet &results)</div><div class="ttdoc">Get a list of members on a group.</div><div class="ttdef"><b>Definition:</b> PVR.h:1248</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr__supports_channel_groups_html_ga4e3ccc3aa5f628c194ee696c11f2adc0"><div class="ttname"><a href="group__cpp__kodi__addon__pvr__supports_channel_groups.html#ga4e3ccc3aa5f628c194ee696c11f2adc0">kodi::addon::CInstancePVRClient::GetChannelGroupsAmount</a></div><div class="ttdeci">virtual PVR_ERROR GetChannelGroupsAmount(int &amount)</div><div class="ttdoc">Get the total amount of channel groups on the backend if it supports channel groups.</div><div class="ttdef"><b>Definition:</b> PVR.h:1137</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr__supports_channel_groups_html_gabb3bc13df7f09f6fb5becf0be7d2d0b9"><div class="ttname"><a href="group__cpp__kodi__addon__pvr__supports_channel_groups.html#gabb3bc13df7f09f6fb5becf0be7d2d0b9">kodi::addon::CInstancePVRClient::GetChannelGroups</a></div><div class="ttdeci">virtual PVR_ERROR GetChannelGroups(bool radio, kodi::addon::PVRChannelGroupsResultSet &results)</div><div class="ttdoc">Get a list of available channel groups on addon.</div><div class="ttdef"><b>Definition:</b> PVR.h:1185</div></div>
</div><!-- fragment --><p> <em>Source parts:</em> </p><div class="fragment"><div class="line"><a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> CMyInstance::GetChannelGroupsAmount(<span class="keywordtype">int</span>& amount)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894a74b91c0db41b0e83f772e2f21bdd388f">PVR_ERROR_NOT_IMPLEMENTED</a>; </div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> CMyInstance::GetChannelGroups(<span class="keywordtype">bool</span> radio, <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_groups_result_set.html">kodi::addon::PVRChannelGroupsResultSet</a>& results)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894a74b91c0db41b0e83f772e2f21bdd388f">PVR_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> CMyInstance::GetChannelGroupMembers(<span class="keyword">const</span> <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group.html">kodi::addon::PVRChannelGroup</a>& group, <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group_members_result_set.html">kodi::addon::PVRChannelGroupMembersResultSet</a>& results)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894a74b91c0db41b0e83f772e2f21bdd388f">PVR_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r_html_gga4cf1fba691fffe5b92e8f27159673894a74b91c0db41b0e83f772e2f21bdd388f"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894a74b91c0db41b0e83f772e2f21bdd388f">PVR_ERROR_NOT_IMPLEMENTED</a></div><div class="ttdeci">@ PVR_ERROR_NOT_IMPLEMENTED</div><div class="ttdoc">-2 : The method that Kodi called is not implemented by the add-on.</div><div class="ttdef"><b>Definition:</b> pvr_general.h:43</div></div>
</div><!-- fragment --> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cpp__kodi__addon__pvr__supports_channel_groups__header__addon__auto__check"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__pvr__supports_channel_groups__header__addon__auto__check.html">Group header include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__cpp__kodi__addon__pvr__supports_channel_groups__source__addon__auto__check"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__pvr__supports_channel_groups__source__addon__auto__check.html">Group source include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga4e3ccc3aa5f628c194ee696c11f2adc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e3ccc3aa5f628c194ee696c11f2adc0">◆ </a></span>GetChannelGroupsAmount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> GetChannelGroupsAmount </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"><em>amount</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the total amount of channel groups on the backend if it supports channel groups. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">amount</td><td>The total amount of channel groups on the backend </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894af0b0d4ad6cc0f3f31b583016cb289358">PVR_ERROR_NO_ERROR</a> if the amount has been fetched successfully.</dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>Required if <a class="el" href="group__cpp__kodi__addon__pvr___defs___p_v_r_capabilities.html#ga3b6d35a66f3bb9279f2b4ad9f1746657">supportsChannelGroups</a> is set to true. </dd></dl>
</div>
</div>
<a id="gabb3bc13df7f09f6fb5becf0be7d2d0b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb3bc13df7f09f6fb5becf0be7d2d0b9">◆ </a></span>GetChannelGroups()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> GetChannelGroups </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>radio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkodi_1_1addon_1_1_p_v_r_channel_groups_result_set.html">kodi::addon::PVRChannelGroupsResultSet</a> & </td>
<td class="paramname"><em>results</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of available channel groups on addon. </p>
<p>Request the list of all channel groups from the backend if it supports channel groups.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">radio</td><td>True to get the radio channel groups, false to get the TV channel groups. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">results</td><td>List of available groups on addon defined with <a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html">class PVRChannelGroup</a>, them transferred with <a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_groups_result_set.html">class PVRChannelGroupsResultSet</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894af0b0d4ad6cc0f3f31b583016cb289358">PVR_ERROR_NO_ERROR</a> if the list has been fetched successfully.</dd></dl>
<hr />
<p><b>The following table contains values that can be set with <a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html">class PVRChannelGroup</a> :</b> </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Name </th><th class="markdownTableHeadNone">Type </th><th class="markdownTableHeadNone">Set call </th><th class="markdownTableHeadNone">Get call </th><th class="markdownTableHeadNone">Usage </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Group name</b> </td><td class="markdownTableBodyNone"><code>std::string</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gad609f2d922ae4996e53641f32e9e32ee">SetGroupName</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gae491887bdb654649b8363c8489ca72cf">GetGroupName</a> </td><td class="markdownTableBodyNone"><em>required to set</em> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Is radio</b> </td><td class="markdownTableBodyNone"><code>bool</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#ga8b3860a303aa470f357edbb6a14141a8">SetIsRadio</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gab521f1240726c204327f5d243beb26aa">GetIsRadio</a> </td><td class="markdownTableBodyNone"><em>required to set</em> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Position</b> </td><td class="markdownTableBodyNone"><code>unsigned int</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#ga0122eac7156289ab2b029041c59c56af">SetPosition</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#ga8c99601efe5886f3c7b630df2228ea86">GetPosition</a> </td><td class="markdownTableBodyNone"><em>optional</em> </td></tr>
</table>
<hr />
<dl class="section remark"><dt>Remarks</dt><dd>Required if <a class="el" href="group__cpp__kodi__addon__pvr___defs___p_v_r_capabilities.html#ga3b6d35a66f3bb9279f2b4ad9f1746657">supportsChannelGroups</a> is set to true.</dd></dl>
<hr />
<p><b>Example:</b> </p><div class="fragment"><div class="line">...</div>
<div class="line">PVR_ERROR CMyPVRInstance::GetChannelGroups(<span class="keywordtype">bool</span> radio, <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_groups_result_set.html">kodi::addon::PVRChannelGroupsResultSet</a>& groups)</div>
<div class="line">{</div>
<div class="line"> <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group.html">kodi::addon::PVRChannelGroup</a> group;</div>
<div class="line"> group.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#ga8b3860a303aa470f357edbb6a14141a8">SetIsRadio</a>(<span class="keyword">false</span>);</div>
<div class="line"> group.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gad609f2d922ae4996e53641f32e9e32ee">SetGroupName</a>(<span class="stringliteral">"My group name"</span>);</div>
<div class="line"> group.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#ga0122eac7156289ab2b029041c59c56af">SetPosition</a>(1);</div>
<div class="line"> ...</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Give it now to Kodi</span></div>
<div class="line"> results.Add(group);</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894af0b0d4ad6cc0f3f31b583016cb289358">PVR_ERROR_NO_ERROR</a>;</div>
<div class="line">}</div>
<div class="line">...</div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_html_ga0122eac7156289ab2b029041c59c56af"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#ga0122eac7156289ab2b029041c59c56af">kodi::addon::PVRChannelGroup::SetPosition</a></div><div class="ttdeci">void SetPosition(unsigned int position)</div><div class="ttdoc">optional Sort position of the group (0 indicates that the backend doesn't support sorting of groups).</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:81</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_html_ga8b3860a303aa470f357edbb6a14141a8"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#ga8b3860a303aa470f357edbb6a14141a8">kodi::addon::PVRChannelGroup::SetIsRadio</a></div><div class="ttdeci">void SetIsRadio(bool isRadio)</div><div class="ttdoc">required true If this is a radio channel group, false otherwise.</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:73</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_html_gad609f2d922ae4996e53641f32e9e32ee"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gad609f2d922ae4996e53641f32e9e32ee">kodi::addon::PVRChannelGroup::SetGroupName</a></div><div class="ttdeci">void SetGroupName(const std::string &groupName)</div><div class="ttdoc">required Name of this channel group.</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:63</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r_html_gga4cf1fba691fffe5b92e8f27159673894af0b0d4ad6cc0f3f31b583016cb289358"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894af0b0d4ad6cc0f3f31b583016cb289358">PVR_ERROR_NO_ERROR</a></div><div class="ttdeci">@ PVR_ERROR_NO_ERROR</div><div class="ttdoc">0 : No error occurred.</div><div class="ttdef"><b>Definition:</b> pvr_general.h:37</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ga24a8893b9fd780858b08ee7be386a2d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga24a8893b9fd780858b08ee7be386a2d3">◆ </a></span>GetChannelGroupMembers()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#ga4cf1fba691fffe5b92e8f27159673894">PVR_ERROR</a> GetChannelGroupMembers </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classkodi_1_1addon_1_1_p_v_r_channel_group.html">kodi::addon::PVRChannelGroup</a> & </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkodi_1_1addon_1_1_p_v_r_channel_group_members_result_set.html">kodi::addon::PVRChannelGroupMembersResultSet</a> & </td>
<td class="paramname"><em>results</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of members on a group. </p>
<p>Request the list of all group members of a group from the backend if it supports channel groups.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">group</td><td>The group to get the members for. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">results</td><td>List of available group member channels defined with <a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html">class PVRChannelGroupMember</a>, them transferred with <a class="el" href="classkodi_1_1addon_1_1_p_v_r_channel_group_members_result_set.html">PVRChannelGroupMembersResultSet</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894af0b0d4ad6cc0f3f31b583016cb289358">PVR_ERROR_NO_ERROR</a> if the list has been fetched successfully.</dd></dl>
<hr />
<p><b>The following table contains values that can be set with <a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html">class PVRChannelGroupMember</a> :</b> </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Name </th><th class="markdownTableHeadNone">Type </th><th class="markdownTableHeadNone">Set call </th><th class="markdownTableHeadNone">Get call </th><th class="markdownTableHeadNone">Usage </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Group name</b> </td><td class="markdownTableBodyNone"><code>std::string</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#gad609f2d922ae4996e53641f32e9e32ee">SetGroupName</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#gae491887bdb654649b8363c8489ca72cf">GetGroupName</a> </td><td class="markdownTableBodyNone"><em>required to set</em> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Channel unique id</b> </td><td class="markdownTableBodyNone"><code>unsigned int</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga919cff6bdb138ca04f38b0de78d3889c">SetChannelUniqueId</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#gaa88a36a4e7c36c9a1e57130000eca423">GetChannelUniqueId</a> </td><td class="markdownTableBodyNone"><em>required to set</em> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Channel Number</b> </td><td class="markdownTableBodyNone"><code>unsigned int</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga6c60822100d7394bb5eff26cff51addb">SetChannelNumber</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#gae804ad5c22b5d9f2fb817452ac8af0c4">GetChannelNumber</a> </td><td class="markdownTableBodyNone"><em>optional</em> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Sub channel number</b> </td><td class="markdownTableBodyNone"><code>unsigned int</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga790ccda5c0e6caba4e27f6cccc8c41c0">SetSubChannelNumber</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga6118523a6e099495afa3378d91734284">GetSubChannelNumber</a> </td><td class="markdownTableBodyNone"><em>optional</em> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Order</b> </td><td class="markdownTableBodyNone"><code>int</code> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel___p_v_r_channel.html#ga2e9eb372a46d80a2561b5ec944a00917">SetOrder</a> </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__pvr___defs___channel___p_v_r_channel.html#gaf038ca8c7f6a718505df3138892c65e7">GetOrder</a> </td><td class="markdownTableBodyNone"><em>optional</em> </td></tr>
</table>
<hr />
<dl class="section remark"><dt>Remarks</dt><dd>Required if <a class="el" href="group__cpp__kodi__addon__pvr___defs___p_v_r_capabilities.html#ga3b6d35a66f3bb9279f2b4ad9f1746657">supportsChannelGroups</a> is set to true.</dd></dl>
<hr />
<p><b>Example:</b> </p><div class="fragment"><div class="line">...</div>
<div class="line">PVR_ERROR CMyPVRInstance::GetChannelGroupMembers(<span class="keyword">const</span> <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group.html">kodi::addon::PVRChannelGroup</a>& group,</div>
<div class="line"> <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group_members_result_set.html">kodi::addon::PVRChannelGroupMembersResultSet</a>& results)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& myGroup : m_myGroups)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">if</span> (myGroup.strGroupName == group.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gae491887bdb654649b8363c8489ca72cf">GetGroupName</a>())</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> iChannelPtr = 0; iChannelPtr < myGroup.members.size(); iChannelPtr++)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordtype">int</span> iId = myGroup.members.at(iChannelPtr) - 1;</div>
<div class="line"> <span class="keywordflow">if</span> (iId < 0 || iId > (<span class="keywordtype">int</span>)m_channels.size() - 1)</div>
<div class="line"> <span class="keywordflow">continue</span>;</div>
<div class="line"> </div>
<div class="line"> PVRDemoChannel &channel = m_channels.at(iId);</div>
<div class="line"> <a class="code" href="classkodi_1_1addon_1_1_p_v_r_channel_group_member.html">kodi::addon::PVRChannelGroupMember</a> kodiGroupMember;</div>
<div class="line"> kodiGroupMember.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#gad609f2d922ae4996e53641f32e9e32ee">SetGroupName</a>(group.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gae491887bdb654649b8363c8489ca72cf">GetGroupName</a>());</div>
<div class="line"> kodiGroupMember.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga919cff6bdb138ca04f38b0de78d3889c">SetChannelUniqueId</a>(channel.iUniqueId);</div>
<div class="line"> kodiGroupMember.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga6c60822100d7394bb5eff26cff51addb">SetChannelNumber</a>(channel.iChannelNumber);</div>
<div class="line"> kodiGroupMember.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga790ccda5c0e6caba4e27f6cccc8c41c0">SetSubChannelNumber</a>(channel.iSubChannelNumber);</div>
<div class="line"> </div>
<div class="line"> results.<a class="code" href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_members_result_set.html#ga2d95dcdcdc7d79cc6ee91ac4c557bbaf">Add</a>(kodiGroupMember);</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__pvr___defs___general___p_v_r___e_r_r_o_r.html#gga4cf1fba691fffe5b92e8f27159673894af0b0d4ad6cc0f3f31b583016cb289358">PVR_ERROR_NO_ERROR</a>;</div>
<div class="line">}</div>
<div class="line">...</div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_p_v_r_channel_group_member_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_p_v_r_channel_group_member.html">kodi::addon::PVRChannelGroupMember</a></div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:149</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_html_gae491887bdb654649b8363c8489ca72cf"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group.html#gae491887bdb654649b8363c8489ca72cf">kodi::addon::PVRChannelGroup::GetGroupName</a></div><div class="ttdeci">std::string GetGroupName() const</div><div class="ttdoc">To get with SetGroupName changed values.</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:69</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member_html_ga6c60822100d7394bb5eff26cff51addb"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga6c60822100d7394bb5eff26cff51addb">kodi::addon::PVRChannelGroupMember::SetChannelNumber</a></div><div class="ttdeci">void SetChannelNumber(unsigned int channelNumber)</div><div class="ttdoc">optional Channel number within the group.</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:196</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member_html_ga790ccda5c0e6caba4e27f6cccc8c41c0"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga790ccda5c0e6caba4e27f6cccc8c41c0">kodi::addon::PVRChannelGroupMember::SetSubChannelNumber</a></div><div class="ttdeci">void SetSubChannelNumber(unsigned int subChannelNumber)</div><div class="ttdoc">optional Sub channel number within the group (ATSC).</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:206</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member_html_ga919cff6bdb138ca04f38b0de78d3889c"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#ga919cff6bdb138ca04f38b0de78d3889c">kodi::addon::PVRChannelGroupMember::SetChannelUniqueId</a></div><div class="ttdeci">void SetChannelUniqueId(unsigned int channelUniqueId)</div><div class="ttdoc">required Unique id of the member.</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:186</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member_html_gad609f2d922ae4996e53641f32e9e32ee"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_member.html#gad609f2d922ae4996e53641f32e9e32ee">kodi::addon::PVRChannelGroupMember::SetGroupName</a></div><div class="ttdeci">void SetGroupName(const std::string &groupName)</div><div class="ttdoc">required Name of the channel group to add the channel to.</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:176</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_members_result_set_html_ga2d95dcdcdc7d79cc6ee91ac4c557bbaf"><div class="ttname"><a href="group__cpp__kodi__addon__pvr___defs___channel_group___p_v_r_channel_group_members_result_set.html#ga2d95dcdcdc7d79cc6ee91ac4c557bbaf">kodi::addon::PVRChannelGroupMembersResultSet::Add</a></div><div class="ttdeci">void Add(const kodi::addon::PVRChannelGroupMember &tag)</div><div class="ttdoc">To add and give content from addon to Kodi on related call.</div><div class="ttdef"><b>Definition:</b> ChannelGroups.h:254</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ga7d1babe65b0971470ff4d21cf71c5218"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7d1babe65b0971470ff4d21cf71c5218">◆ </a></span>TriggerChannelGroupsUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void TriggerChannelGroupsUpdate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Callback to Kodi Function</b><br />
Request Kodi to update it's list of channel groups. </p>
<dl class="section remark"><dt>Remarks</dt><dd>Only called from addon itself </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>