-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__addon__vfs.html
361 lines (353 loc) · 33.3 KB
/
group__cpp__kodi__addon__vfs.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
<!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: VFS</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__vfs.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">VFS<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></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p> <h4><code><span style="font-style: italic;">Class: </span><span style="font-style: bold;"><font color=31363b><big> kodi::addon::CInstanceVFS </big></font></span></code></h4> <b>Virtual Filesystem (VFS) add-on instance</b> </p>
<p>This instance type is used to allow Kodi various additional file system types. Be it a special file system, a compressed package or a system available over the network, everything is possible with it.</p>
<p>This usage can be requested under various conditions, for example explicitly by another addon, by a Mimetype protocol defined in <b><code>addon.xml</code></b> or supported file extensions.</p>
<p>Include the header #include <kodi/addon-instance/VFS.h> to use this class.</p>
<hr />
<p>Here is an example of what the <b><code>addon.xml.in</code></b> would look like for an VFS addon:</p>
<div class="fragment"><div class="line"><?<span class="keyword">xml</span> <span class="keyword">version</span>=<span class="stringliteral">"1.0"</span> <span class="keyword">encoding</span>=<span class="stringliteral">"UTF-8"</span>?></div>
<div class="line"><<span class="keywordtype">addon</span></div>
<div class="line"> <span class="keyword">id</span>=<span class="stringliteral">"vfs.myspecialnamefor"</span></div>
<div class="line"> <span class="keyword">version</span>=<span class="stringliteral">"1.0.0"</span></div>
<div class="line"> <span class="keyword">name</span>=<span class="stringliteral">"My VFS addon"</span></div>
<div class="line"> <span class="keyword">provider-name</span>=<span class="stringliteral">"Your Name"</span>></div>
<div class="line"> <<span class="keywordtype">requires</span>>@<span class="keyword">ADDON_DEPENDS</span>@</<span class="keywordtype">requires</span>></div>
<div class="line"> <<span class="keywordtype">extension</span></div>
<div class="line"> <span class="keyword">point</span>=<span class="stringliteral">"kodi.vfs"</span></div>
<div class="line"> <span class="keyword">protocols</span>=<span class="stringliteral">"myprot"</span></div>
<div class="line"> <span class="keyword">extensions</span>=<span class="stringliteral">".abc|.def"</span></div>
<div class="line"> <span class="keyword">files</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">filedirectories</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">directories</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">encodedhostname</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">supportDialog</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">supportPath</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">supportUsername</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">supportPassword</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">supportPort</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">supportBrowsing</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">supportWrite</span>=<span class="stringliteral">"true"</span></div>
<div class="line"> <span class="keyword">defaultPort</span>=<span class="stringliteral">"1234"</span></div>
<div class="line"> <span class="keyword">label</span>=<span class="stringliteral">"30000"</span></div>
<div class="line"> <span class="keyword">zeroconf</span>=<span class="stringliteral">"your_special_zeroconf_allowed_identifier"</span></div>
<div class="line"> <span class="keyword">library_</span>@<span class="keyword">PLATFORM</span>@=<span class="stringliteral">"@LIBRARY_FILENAME@"</span>/></div>
<div class="line"> <<span class="keywordtype">extension</span> <span class="keyword">point</span>=<span class="stringliteral">"xbmc.addon.metadata"</span>></div>
<div class="line"> <<span class="keywordtype">summary</span> <span class="keyword">lang</span>=<span class="stringliteral">"en_GB"</span>><span class="keyword">My</span> <span class="keyword">VFS</span> <span class="keyword">addon</span> <span class="keyword">summary</span></<span class="keywordtype">summary</span>></div>
<div class="line"> <<span class="keywordtype">description</span> <span class="keyword">lang</span>=<span class="stringliteral">"en_GB"</span>><span class="keyword">My</span> <span class="keyword">VFS</span> <span class="keyword">description</span></<span class="keywordtype">description</span>></div>
<div class="line"> <<span class="keywordtype">platform</span>>@<span class="keyword">PLATFORM</span>@</<span class="keywordtype">platform</span>></div>
<div class="line"> </<span class="keywordtype">extension</span>></div>
<div class="line"></<span class="keywordtype">addon</span>></div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>Regarding boolean values with "false", these can also be omitted, since this would be the default.</dd></dl>
<h3>Standard values that can be declared for processing in <code>addon.xml</code>.</h3>
<p>These values are used by Kodi to identify associated streams and file extensions and then to select the associated addon.</p>
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor="576f9f">
<th width="30%" align="left" valign="middle"><b> Labels</b></th><th width="10%" align="left" valign="middle"><b> Type</b></th><th width="60%" align="left" valign="middle"><span><b> Description </b></span> <tr bgcolor=white><td width= 30% align=left> <b><code>point</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_point"></a> string </td><td width= 60% align=left> The identification of the addon instance to VFS is mandatory <b><code>kodi.vfs</code></b>. In addition, the instance declared in the first <b><code><extension ... /></code></b> is also the main type of addon. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>defaultPort</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_defaultPort"></a> integer </td><td width= 60% align=left> Default <a href="https://en.wikipedia.org/wiki/Port_(computer_networking)">networking port</a> to use for protocol. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>directories</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_directories"></a> boolean </td><td width= 60% align=left> VFS entry can list directories. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>extensions</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_extensions"></a> string </td><td width= 60% align=left> Extensions for VFS entry.<br />
It is possible to declare several using <b><code>|</code></b>, e.g. <b><code>.abc|.def|.ghi</code></b>. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>encodedhostname</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_encodedhostname"></a> boolean </td><td width= 60% align=left> URL protocol from add-ons use encoded hostnames. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>filedirectories</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_filedirectories"></a> boolean </td><td width= 60% align=left> VFS entry contains file directories. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>files</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_directories"></a> boolean </td><td width= 60% align=left> Set to declare that VFS provides files. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>protocols</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocols"></a> boolean </td><td width= 60% align=left> Protocols for VFS entry.<br />
It is possible to declare several using <b><code>|</code></b>, e.g. <b><code>myprot1|myprot2</code></b>.<br />
<dl class="section note"><dt>Note</dt><dd>This field also used to show on GUI, see <b><code>supportBrowsing</code></b> below about <b>*2:</b>. When used there, however, only a <b>single</b> protocol is possible! </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>supportWrite</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_supportWrite"></a> boolean </td><td width= 60% align=left> Protocol supports write operations. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>zeroconf</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_zeroconf"></a> string </td><td width= 60% align=left> <a href="https://en.wikipedia.org/wiki/Zero-configuration_networking">Zero conf</a> announce string for VFS protocol. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>library_@PLATFORM@</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_library"></a> string </td><td width= 60% align=left> The runtime library used for the addon. This is usually declared by <code>cmake</code> and correctly displayed in the translated <b><code>addon.xml</code></b>. </td></tr> </dd></dl>
</th></tr>
</table>
<h3>User selectable parts of the addon.</h3>
<p>The following table describes the values that can be defined by <b><code>addon.xml</code></b> and which part they relate to for user input.</p>
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor="576f9f">
<th width="30%" align="left" valign="middle"><b> Labels</b></th><th width="10%" align="left" valign="middle"><b> Type</b></th><th width="60%" align="left" valign="middle"><span><b> Description </b></span> <tr bgcolor=white><td width= 30% align=left> <b><code>supportBrowsing</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_supportBrowsing"></a> boolean </td><td width= 60% align=left> Protocol supports server browsing. Used to open related sources by users in the window.<br />
<br />
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Associated places in Kodi: </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><div class="image">
<img src="cpp_kodi_addon_vfs_protocol_1.png" alt=""/>
</div>
</td></tr>
</table>
<br />
<b>*1:</b> The entry in the menu represented by this option corresponds to the text given with <b><code>label</code></b>. When the button is pressed, <a class="el" href="group__cpp__kodi__addon__vfs__general.html#ga89ff4d3be0c947d17fa67e3a5c153276">CInstanceVFS::GetDirectory</a> is called on the add-on to get its content.<br />
<b>*2:</b> Protocol name of the stream defined with <b><code>protocols</code></b> in xml.<br />
<dl class="section remark"><dt>Remarks</dt><dd>See also <b><code>supportDialog</code></b> about <b>*3:</b>. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>supportDialog</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_supportDialog"></a> boolean </td><td width= 60% align=left> To point out that Kodi assigns a dialog to this VFS in order to compare it with other values e.g. query supportPassword in it.<br />
This will be available when adding sources in Kodi under <b>"Add network location..."</b>.<br />
<br />
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Associated places in Kodi: </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><div class="image">
<img src="cpp_kodi_addon_vfs_protocol_2.png" alt=""/>
</div>
</td></tr>
</table>
<br />
<b>*1:</b> Field for selecting the VFS handler, the addon will be available if <b><code>supportDialog</code></b> is set to <b><code>true</code></b>.<br />
<b>*2:</b> To set the associated server address. <b>Note:</b> <em>This field is always activated and cannot be changed by the addon.</em><br />
<b>*3:</b> If <b><code>supportBrowsing</code></b> is set to <b><code>true</code></b>, the button for opening a file selection dialog is given here too, as in the file window.<br />
<b>*4:</b> This field is available if <b><code>supportPath</code></b> is set to <b><code>true</code></b>.<br />
<b>*5:</b> To edit the connection port. This field is available if <b><code>supportPort</code></b> is set to <b><code>true</code></b>.<br />
<b>*6:</b> This sets the required username and is available when <b><code>supportUsername</code></b> is set to <b><code>true</code></b>.<br />
<b>*7:</b> This sets the required password and is available when <b><code>supportPassword</code></b> is set to <b><code>true</code></b>. </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>supportPath</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_supportPath"></a> boolean </td><td width= 60% align=left> Protocol has path in addition to server name (see <b><code>supportDialog</code></b> about <b>*4:</b>). </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>supportPort</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_supportPort"></a> boolean </td><td width= 60% align=left> Protocol supports port customization (see <b><code>supportDialog</code></b> about <b>*5:</b>). </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>supportUsername</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_supportUsername"></a> boolean </td><td width= 60% align=left> Protocol uses logins (see <b><code>supportDialog</code></b> about <b>*6:</b>). </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>supportPassword</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_supportPassword"></a> boolean </td><td width= 60% align=left> Protocol supports passwords (see <b><code>supportDialog</code></b> about <b>*7:</b>). </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>protocols</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_protocols"></a> string </td><td width= 60% align=left> Protocols for VFS entry. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This field is not editable and only used on GUI to show his name, see <b><code>supportBrowsing</code></b> about <b>*2:</b> </td></tr> <tr bgcolor=white><td width= 30% align=left> <b><code>label</code></b> </td><td width= 10% align=left> <a class="anchor" id="cpp_kodi_addon_vfs_protocol_label"></a> integer </td><td width= 60% align=left> The text identification number used in Kodi for display in the menu at <b><code>supportDialog</code></b> as a selection option and at <b><code>supportBrowsing</code></b> (see his image reference <b>*1</b>) as a menu entry.<br />
This can be a text identifier in Kodi or from addon.<br />
</dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>For addon within <b>30000</b>-<b>30999</b> or <b>32000</b>-<b>32999</b>. </td></tr> </dd></dl>
</th></tr>
</table>
<dl class="section remark"><dt>Remarks</dt><dd>For more detailed description of the <b><code>addon.xml</code></b>, see also <a href="https://kodi.wiki/view/Addon.xml">https://kodi.wiki/view/Addon.xml</a>.</dd></dl>
<hr />
<p><b>Example:</b></p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <kodi/addon-instance/VFS.h></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">class </span>CMyVFS : <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_instance_v_f_s.html">kodi::addon::CInstanceVFS</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> CMyVFS(KODI_HANDLE instance, <span class="keyword">const</span> std::string& kodiVersion);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Add all your required functions, the most CInstanceVFS functions of</span></div>
<div class="line"> <span class="comment">// must be included to have addon working correctly.</span></div>
<div class="line"> ...</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line">CMyVFS::CMyVFS(KODI_HANDLE instance, <span class="keyword">const</span> std::string& kodiVersion)</div>
<div class="line"> : kodi::addon::CInstanceVFS(instance, kodiVersion)</div>
<div class="line">{</div>
<div class="line"> ...</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line">...</div>
<div class="line"> </div>
<div class="line"><span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"> </div>
<div class="line">class CMyAddon : <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_addon_base.html">kodi::addon::CAddonBase</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> CMyAddon() { }</div>
<div class="line"> <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a> CreateInstance(<span class="keywordtype">int</span> instanceType,</div>
<div class="line"> <span class="keyword">const</span> std::string& instanceID,</div>
<div class="line"> KODI_HANDLE instance,</div>
<div class="line"> <span class="keyword">const</span> std::string& version,</div>
<div class="line"> KODI_HANDLE& addonInstance) <span class="keyword">override</span>;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">// If you use only one instance in your add-on, can be instanceType and</span></div>
<div class="line"><span class="comment">// instanceID ignored</span></div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a> CMyAddon::CreateInstance(<span class="keywordtype">int</span> instanceType,</div>
<div class="line"> <span class="keyword">const</span> std::string& instanceID,</div>
<div class="line"> KODI_HANDLE instance,</div>
<div class="line"> <span class="keyword">const</span> std::string& version,</div>
<div class="line"> KODI_HANDLE& addonInstance)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">if</span> (instanceType == <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___t_y_p_e.html#ggada0b4c3c9f9c168e5e1c27145ec72357a9a6e76e43b26f8c75a9ebfdab23a0cf4">ADDON_INSTANCE_VFS</a>)</div>
<div class="line"> {</div>
<div class="line"> <a class="code" href="group__cpp__kodi.html#gaaa1f205f9375cd086229a1455ede11cc">kodi::Log</a>(<a class="code" href="group__cpp__kodi___defs___addon_log.html#gga913895aaf2ef685961947f8d6b93e038a63f8ea3699765964c764b141bf41e9cc">ADDON_LOG_INFO</a>, <span class="stringliteral">"Creating my VFS instance"</span>);</div>
<div class="line"> addonInstance = <span class="keyword">new</span> CMyVFS(instance, version);</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502a6925909b93ca05098ca5272f16e091c0">ADDON_STATUS_OK</a>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (...)</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__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502ac0720dbdce3dcb194f12a0eceb59a501">ADDON_STATUS_UNKNOWN</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line">ADDONCREATOR(CMyAddon)</div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_c_addon_base_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_c_addon_base.html">kodi::addon::CAddonBase</a></div><div class="ttdef"><b>Definition:</b> AddonBase.h:322</div></div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_c_instance_v_f_s_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_c_instance_v_f_s.html">kodi::addon::CInstanceVFS</a></div><div class="ttdef"><b>Definition:</b> VFS.h:437</div></div>
<div class="ttc" id="agroup__cpp__kodi___defs___addon_log_html_gga913895aaf2ef685961947f8d6b93e038a63f8ea3699765964c764b141bf41e9cc"><div class="ttname"><a href="group__cpp__kodi___defs___addon_log.html#gga913895aaf2ef685961947f8d6b93e038a63f8ea3699765964c764b141bf41e9cc">ADDON_LOG_INFO</a></div><div class="ttdeci">@ ADDON_LOG_INFO</div><div class="ttdoc">1 : To include information messages in the log file.</div><div class="ttdef"><b>Definition:</b> addon_base.h:177</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s_html_ga335347495ed00620451a69cfe3494502"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a></div><div class="ttdeci">ADDON_STATUS</div><div class="ttdef"><b>Definition:</b> addon_base.h:128</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s_html_gga335347495ed00620451a69cfe3494502a6925909b93ca05098ca5272f16e091c0"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502a6925909b93ca05098ca5272f16e091c0">ADDON_STATUS_OK</a></div><div class="ttdeci">@ ADDON_STATUS_OK</div><div class="ttdoc">For everything OK and no error.</div><div class="ttdef"><b>Definition:</b> addon_base.h:130</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s_html_gga335347495ed00620451a69cfe3494502ac0720dbdce3dcb194f12a0eceb59a501"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502ac0720dbdce3dcb194f12a0eceb59a501">ADDON_STATUS_UNKNOWN</a></div><div class="ttdeci">@ ADDON_STATUS_UNKNOWN</div><div class="ttdoc">Unknown and incomprehensible error.</div><div class="ttdef"><b>Definition:</b> addon_base.h:142</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___t_y_p_e_html_ggada0b4c3c9f9c168e5e1c27145ec72357a9a6e76e43b26f8c75a9ebfdab23a0cf4"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___t_y_p_e.html#ggada0b4c3c9f9c168e5e1c27145ec72357a9a6e76e43b26f8c75a9ebfdab23a0cf4">ADDON_INSTANCE_VFS</a></div><div class="ttdeci">@ ADDON_INSTANCE_VFS</div><div class="ttdoc">Virtual Filesystem (VFS) instance, see kodi::addon::CInstanceVFS.</div><div class="ttdef"><b>Definition:</b> versions.h:241</div></div>
<div class="ttc" id="agroup__cpp__kodi_html_gaaa1f205f9375cd086229a1455ede11cc"><div class="ttname"><a href="group__cpp__kodi.html#gaaa1f205f9375cd086229a1455ede11cc">kodi::Log</a></div><div class="ttdeci">void ATTRIBUTE_HIDDEN Log(const AddonLog loglevel, const char *format,...)</div><div class="ttdoc">Add a message to Kodi's log.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:749</div></div>
</div><!-- fragment --><p>The destruction of the example class <code>CMyVFS</code> is called from Kodi's header. Manually deleting the add-on instance is not required. </p>
<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__vfs___defs"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__vfs___defs.html">Definitions, structures and enumerators</a></td></tr>
<tr class="memdesc:group__cpp__kodi__addon__vfs___defs"><td class="mdescLeft"> </td><td class="mdescRight"><b>VFS add-on general variables</b> <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__cpp__kodi__addon__vfs__general"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__vfs__general.html">1. General access functions</a></td></tr>
<tr class="memdesc:group__cpp__kodi__addon__vfs__general"><td class="mdescLeft"> </td><td class="mdescRight"><b>General access functions</b> <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__cpp__kodi__addon__vfs__filecontrol"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__vfs__filecontrol.html">2. File editing functions</a></td></tr>
<tr class="memdesc:group__cpp__kodi__addon__vfs__filecontrol"><td class="mdescLeft"> </td><td class="mdescRight"><b>File editing functions.</b> <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf64445faf2b354ba02aea986d18eb291"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf64445faf2b354ba02aea986d18eb291">◆ </a></span>CInstanceVFS()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkodi_1_1addon_1_1_c_instance_v_f_s.html">CInstanceVFS</a> </td>
<td>(</td>
<td class="paramtype">KODI_HANDLE </td>
<td class="paramname"><em>instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>kodiVersion</em> = <code>""</code> </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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>VFS class constructor used to support multiple instance types. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance value given to <b><code>kodi::addon::CAddonBase::CreateInstance(...)</code></b>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">kodiVersion</td><td>[opt] given from Kodi by <a class="el" href="group__cpp__kodi__addon__addonbase.html#ga74ea538a2191541a57115fa89790358c">CAddonBase::CreateInstance</a> to identify his instance API version</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Instance path as a single is not supported by this type. It must ensure that it can be called up several times.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Only use <code>instance</code> from the <a class="el" href="group__cpp__kodi__addon__addonbase.html#ga74ea538a2191541a57115fa89790358c">CAddonBase::CreateInstance</a> or <a class="el" href="group__cpp__kodi__addon__addonbase.html#ga74ea538a2191541a57115fa89790358c">CAddonBase::CreateInstance</a> call. </dd></dl>
</div>
</div>
<a id="ga397f2048c35582199ae19d1ece876113"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga397f2048c35582199ae19d1ece876113">◆ </a></span>~CInstanceVFS()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classkodi_1_1addon_1_1_c_instance_v_f_s.html">CInstanceVFS</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </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>