-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__addon__inputstream___defs___stream_constants.html
227 lines (207 loc) · 11.4 KB
/
group__cpp__kodi__addon__inputstream___defs___stream_constants.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
<!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: 2. Stream constants</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__inputstream___defs___stream_constants.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="headertitle">
<div class="title">2. Stream constants<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__inputstream.html">Inputstream</a> » <a class="el" href="group__cpp__kodi__addon__inputstream___defs.html">Definitions, structures and enumerators</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>Used to exchange any additional data between the caller and processor.</b><br />
This includes the standardized values, in addition, an addon can also use its own special uses to be exchanged in the same way. </p>
<p>These values can be used by other addons (e.g. video addon) or stream files to select the respective inputstream addon and to transfer additional values.</p>
<hr />
<p><b>Example:</b></p>
<p>This example use the <a class="el" href="group__cpp__kodi__addon__inputstream___defs___stream_constants.html#ga54715484cd08d58d6dda9b8e9d9ec867">STREAM_PROPERTY_INPUTSTREAM</a> on a <b><code>*.strm</code></b> file to select needed addon and a additional value where related to selected addon itself.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#KODIPROP:inputstream=inputstream.adaptive</span></div>
<div class="line"><span class="preprocessor">#KODIPROP:inputstream.adaptive.manifest_type=mpd</span></div>
<div class="line"><span class="preprocessor">http:</span><span class="comment">//rdmedia.bbc.co.uk/dash/ondemand/testcard/1/client_manifest-events-multilang.mpd</span></div>
</div><!-- fragment --><p>These are then given to Kodi and the respectively selected addon by means of his <a class="el" href="group__cpp__kodi__addon__inputstream.html#ga269c22d439a1c51eb2b0c61a439620b9">Open</a> call in <a class="el" href="group__cpp__kodi__addon__inputstream___defs___inputstream_property.html#ga6e6bff07f1689c0e65c455314699e419">kodi::addon::InputstreamProperty::GetProperties</a>.</p>
<p>The largest possible amount of these <b><code>#KODIPROP</code></b> values is defined with <a class="el" href="group__cpp__kodi__addon__inputstream___defs___stream_constants.html#gab275451ee9e7abc80afb7d939a58795e">STREAM_MAX_PROPERTY_COUNT</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga54715484cd08d58d6dda9b8e9d9ec867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga54715484cd08d58d6dda9b8e9d9ec867">◆ </a></span>STREAM_PROPERTY_INPUTSTREAM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STREAM_PROPERTY_INPUTSTREAM   "inputstream"</td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of the inputstream add-on that should be used by Kodi to play the stream. </p>
<p>Leave blank to use Kodi's built-in playing capabilities or to allow ffmpeg to handle directly set to <a class="el" href="group__cpp__kodi__addon__inputstream___defs___stream_constants.html#ga7479d97779516794af50cda4060b3ec7">STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG</a>. </p>
</div>
</div>
<a id="ga08bc50f45218909b8a8d87e9a59e63c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga08bc50f45218909b8a8d87e9a59e63c8">◆ </a></span>STREAM_PROPERTY_INPUTSTREAM_PLAYER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STREAM_PROPERTY_INPUTSTREAM_PLAYER   "inputstream-player"</td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of the default player to use for this inputstream add-on that should be used by Kodi to play the stream. </p>
<p>Leave blank to use Kodi's built-in player selection mechanism. Permitted values are:</p><ul>
<li>"videodefaultplayer"</li>
<li>"audiodefaultplayer" </li>
</ul>
</div>
</div>
<a id="ga64a0a9d3eb2b283afbf89efa79021852"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64a0a9d3eb2b283afbf89efa79021852">◆ </a></span>STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STREAM_PROPERTY_INPUTSTREAM_INSTANCE_ID   "inputstream-instance-id"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Identification string for an input stream. </p>
<p>This value can be used in addition to <a class="el" href="group__cpp__kodi__addon__inputstream___defs___stream_constants.html#ga54715484cd08d58d6dda9b8e9d9ec867">STREAM_PROPERTY_INPUTSTREAM</a>. It is used to provide the respective inpustream addon with additional identification.</p>
<p>The difference between this and other stream properties is that it is also passed in the associated <a class="el" href="group__cpp__kodi__addon__addonbase.html#ga74ea538a2191541a57115fa89790358c">kodi::addon::CAddonBase::CreateInstance</a> call.</p>
<p>This makes it possible to select different processing classes within the associated add-on. </p>
</div>
</div>
<a id="ga8e56792644826e277432f5b0da0c4561"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e56792644826e277432f5b0da0c4561">◆ </a></span>STREAM_PROPERTY_ISREALTIMESTREAM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STREAM_PROPERTY_ISREALTIMESTREAM   "isrealtimestream"</td>
</tr>
</table>
</div><div class="memdoc">
<p>"true" to denote that the stream that should be played is a realtime stream. Any other value indicates that this is not a realtime stream. </p>
</div>
</div>
<a id="ga7479d97779516794af50cda4060b3ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7479d97779516794af50cda4060b3ec7">◆ </a></span>STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STREAM_PROPERTY_VALUE_INPUTSTREAMFFMPEG   "inputstream.ffmpeg"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Special value for <a class="el" href="group__cpp__kodi__addon__inputstream___defs___stream_constants.html#ga54715484cd08d58d6dda9b8e9d9ec867">STREAM_PROPERTY_INPUTSTREAM</a> to use ffmpeg to directly play a stream URL. </p>
</div>
</div>
<a id="gab275451ee9e7abc80afb7d939a58795e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab275451ee9e7abc80afb7d939a58795e">◆ </a></span>STREAM_MAX_PROPERTY_COUNT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STREAM_MAX_PROPERTY_COUNT   30</td>
</tr>
</table>
</div><div class="memdoc">
<p>Max number of properties that can be sent to an Inputstream addon. </p>
</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>