interface_v_l_c_media_discoverer.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>VLCKit: VLCMediaDiscoverer Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">VLCKit
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.14 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Instance Methods</a> &#124;
  64. <a href="#pub-static-methods">Class Methods</a> &#124;
  65. <a href="#properties">Properties</a> &#124;
  66. <a href="interface_v_l_c_media_discoverer-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">VLCMediaDiscoverer Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#import &lt;<a class="el" href="_v_l_c_media_discoverer_8h_source.html">VLCMediaDiscoverer.h</a>&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for VLCMediaDiscoverer:</div>
  74. <div class="dyncontent">
  75. <div class="center">
  76. <img src="interface_v_l_c_media_discoverer.png" usemap="#VLCMediaDiscoverer_map" alt=""/>
  77. <map id="VLCMediaDiscoverer_map" name="VLCMediaDiscoverer_map">
  78. </map>
  79. </div></div>
  80. <table class="memberdecls">
  81. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  82. Instance Methods</h2></td></tr>
  83. <tr class="memitem:a41cd6e81501ef6d0f90788c6dc761cce"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#a41cd6e81501ef6d0f90788c6dc761cce">initWithName:</a></td></tr>
  84. <tr class="separator:a41cd6e81501ef6d0f90788c6dc761cce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:af97ed30ce3de1cd00b7ae8e1c34e308c"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#af97ed30ce3de1cd00b7ae8e1c34e308c">initWithName:libraryInstance:</a></td></tr>
  86. <tr class="separator:af97ed30ce3de1cd00b7ae8e1c34e308c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ae24d8b9250ccead549c829071f7cf184"><td class="memItemLeft" align="right" valign="top">(int)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#ae24d8b9250ccead549c829071f7cf184">startDiscoverer</a></td></tr>
  88. <tr class="separator:ae24d8b9250ccead549c829071f7cf184"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:aedebd3f4b61febe5ca436af1f1ea7508"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#aedebd3f4b61febe5ca436af1f1ea7508">stopDiscoverer</a></td></tr>
  90. <tr class="separator:aedebd3f4b61febe5ca436af1f1ea7508"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:abefec909660b69a00410cab13c2d9a5b"><td class="memItemLeft" align="right" valign="top">(NSString *localizedName)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#abefec909660b69a00410cab13c2d9a5b">__attribute__</a></td></tr>
  92. <tr class="separator:abefec909660b69a00410cab13c2d9a5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table><table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  95. Class Methods</h2></td></tr>
  96. <tr class="memitem:a57b40dcdb0b650aea2feed95fdd30d83"><td class="memItemLeft" align="right" valign="top">((deprecated)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_media_discoverer.html#a57b40dcdb0b650aea2feed95fdd30d83">__attribute__</a></td></tr>
  97. <tr class="separator:a57b40dcdb0b650aea2feed95fdd30d83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a867e500dc5948bcb63206f814dffc138"><td class="memItemLeft" align="right" valign="top">(NSArray *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_media_discoverer.html#a867e500dc5948bcb63206f814dffc138">availableMediaDiscovererForCategoryType:</a></td></tr>
  99. <tr class="separator:a867e500dc5948bcb63206f814dffc138"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table><table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  102. Properties</h2></td></tr>
  103. <tr class="memitem:a7c84bb252d3183d9314b447a16a68b06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_discoverer.html#a7c84bb252d3183d9314b447a16a68b06">libraryInstance</a></td></tr>
  104. <tr class="separator:a7c84bb252d3183d9314b447a16a68b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ace04441c5b6e7b968772a5f9c3da6ce9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_v_l_c_media_list.html">VLCMediaList</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_discoverer.html#ace04441c5b6e7b968772a5f9c3da6ce9">discoveredMedia</a></td></tr>
  106. <tr class="separator:ace04441c5b6e7b968772a5f9c3da6ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:abbd18cde0dc5c6982ec6a5c356fe9f7e"><td class="memItemLeft" align="right" valign="top">BOOL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_discoverer.html#abbd18cde0dc5c6982ec6a5c356fe9f7e">isRunning</a></td></tr>
  108. <tr class="separator:abbd18cde0dc5c6982ec6a5c356fe9f7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table>
  110. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  111. <div class="textblock"><p><a class="el" href="interface_v_l_c_media_discoverer.html">VLCMediaDiscoverer</a> </p>
  112. </div><h2 class="groupheader">Method Documentation</h2>
  113. <a id="a57b40dcdb0b650aea2feed95fdd30d83"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#a57b40dcdb0b650aea2feed95fdd30d83">&#9670;&nbsp;</a></span>__attribute__() <span class="overload">[1/2]</span></h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">+ ((deprecated) __attribute__ </td>
  120. <td></td>
  121. <td class="paramname"></td>
  122. <td></td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <p>The full list of available media discoverers </p><dl class="section return"><dt>Returns</dt><dd>returns an empty array for binary compatibility, will be removed in subsequent releases </dd></dl>
  127. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>use availableMediaDiscovererForCategoryType instead </dd></dl>
  128. </div>
  129. </div>
  130. <a id="abefec909660b69a00410cab13c2d9a5b"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#abefec909660b69a00410cab13c2d9a5b">&#9670;&nbsp;</a></span>__attribute__() <span class="overload">[2/2]</span></h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">- (NSString* localizedName) __attribute__ </td>
  137. <td></td>
  138. <td class="paramtype">((deprecated))&#160;</td>
  139. <td class="paramname"></td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>localized name of the discovery module if available, otherwise in US English </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>Will be removed in the next major release, may return an empty string for binary compatibility </dd></dl>
  145. </div>
  146. </div>
  147. <a id="a867e500dc5948bcb63206f814dffc138"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a867e500dc5948bcb63206f814dffc138">&#9670;&nbsp;</a></span>availableMediaDiscovererForCategoryType:()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">+ (NSArray *) availableMediaDiscovererForCategoryType: </td>
  154. <td></td>
  155. <td class="paramtype">(VLCMediaDiscovererCategoryType)&#160;</td>
  156. <td class="paramname"><em>categoryType</em></td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <dl class="params"><dt>Parameters</dt><dd>
  162. <table class="params">
  163. <tr><td class="paramname">categoryType</td><td>VLCMediaDiscovererCategory you are looking for </td></tr>
  164. </table>
  165. </dd>
  166. </dl>
  167. <dl class="section return"><dt>Returns</dt><dd>an array of dictionaries describing the available discoverers for the requested type </dd></dl>
  168. </div>
  169. </div>
  170. <a id="a41cd6e81501ef6d0f90788c6dc761cce"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#a41cd6e81501ef6d0f90788c6dc761cce">&#9670;&nbsp;</a></span>initWithName:()</h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">- (instancetype) initWithName: </td>
  177. <td></td>
  178. <td class="paramtype">(NSString *)&#160;</td>
  179. <td class="paramname"><em>aServiceName</em></td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>Initializes new object with specified name. </p><dl class="params"><dt>Parameters</dt><dd>
  185. <table class="params">
  186. <tr><td class="paramname">aServiceName</td><td>Name of the service for this <a class="el" href="interface_v_l_c_media_discoverer.html">VLCMediaDiscoverer</a> object. </td></tr>
  187. </table>
  188. </dd>
  189. </dl>
  190. <dl class="section return"><dt>Returns</dt><dd>Newly created media discoverer. </dd></dl>
  191. <dl class="section note"><dt>Note</dt><dd>with VLCKit 3.0 and above, you need to start the discoverer explicitly after creation </dd></dl>
  192. </div>
  193. </div>
  194. <a id="af97ed30ce3de1cd00b7ae8e1c34e308c"></a>
  195. <h2 class="memtitle"><span class="permalink"><a href="#af97ed30ce3de1cd00b7ae8e1c34e308c">&#9670;&nbsp;</a></span>initWithName:libraryInstance:()</h2>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">- (instancetype) <a class="el" href="interface_v_l_c_media_discoverer.html#a41cd6e81501ef6d0f90788c6dc761cce">initWithName:</a> </td>
  201. <td></td>
  202. <td class="paramtype">(NSString *)&#160;</td>
  203. <td class="paramname"><em>aServiceName</em></td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey">libraryInstance:</td>
  207. <td></td>
  208. <td class="paramtype">(<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *)&#160;</td>
  209. <td class="paramname"><em>libraryInstance</em>&#160;</td>
  210. </tr>
  211. <tr>
  212. <td></td>
  213. <td></td>
  214. <td></td><td></td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>same as above but with a custom <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> instance </p><dl class="section note"><dt>Note</dt><dd>Using this mode can lead to a significant performance impact - use only if you know what you are doing </dd></dl>
  219. </div>
  220. </div>
  221. <a id="ae24d8b9250ccead549c829071f7cf184"></a>
  222. <h2 class="memtitle"><span class="permalink"><a href="#ae24d8b9250ccead549c829071f7cf184">&#9670;&nbsp;</a></span>startDiscoverer()</h2>
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">- (int) startDiscoverer </td>
  228. <td></td>
  229. <td class="paramname"></td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <p>start media discovery </p><dl class="section return"><dt>Returns</dt><dd>-1 if start failed, otherwise 0 </dd></dl>
  235. </div>
  236. </div>
  237. <a id="aedebd3f4b61febe5ca436af1f1ea7508"></a>
  238. <h2 class="memtitle"><span class="permalink"><a href="#aedebd3f4b61febe5ca436af1f1ea7508">&#9670;&nbsp;</a></span>stopDiscoverer()</h2>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <table class="memname">
  242. <tr>
  243. <td class="memname">- (void) stopDiscoverer </td>
  244. <td></td>
  245. <td class="paramname"></td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>stop media discovery </p>
  251. </div>
  252. </div>
  253. <h2 class="groupheader">Property Documentation</h2>
  254. <a id="ace04441c5b6e7b968772a5f9c3da6ce9"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#ace04441c5b6e7b968772a5f9c3da6ce9">&#9670;&nbsp;</a></span>discoveredMedia</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="mlabels">
  259. <tr>
  260. <td class="mlabels-left">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">- (<a class="el" href="interface_v_l_c_media_list.html">VLCMediaList</a>*) discoveredMedia</td>
  264. </tr>
  265. </table>
  266. </td>
  267. <td class="mlabels-right">
  268. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">weak</span></span> </td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>a read-only property to retrieve the list of discovered media items </p>
  273. </div>
  274. </div>
  275. <a id="abbd18cde0dc5c6982ec6a5c356fe9f7e"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#abbd18cde0dc5c6982ec6a5c356fe9f7e">&#9670;&nbsp;</a></span>isRunning</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="mlabels">
  280. <tr>
  281. <td class="mlabels-left">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">- (BOOL) isRunning</td>
  285. </tr>
  286. </table>
  287. </td>
  288. <td class="mlabels-right">
  289. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>read-only property to check if the discovery service is active </p><dl class="section return"><dt>Returns</dt><dd>boolean value </dd></dl>
  294. </div>
  295. </div>
  296. <a id="a7c84bb252d3183d9314b447a16a68b06"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#a7c84bb252d3183d9314b447a16a68b06">&#9670;&nbsp;</a></span>libraryInstance</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">- (<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a>*) libraryInstance</td>
  306. </tr>
  307. </table>
  308. </td>
  309. <td class="mlabels-right">
  310. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">nonatomic</span><span class="mlabel">assign</span></span> </td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. <p>The library instance used by the discoverers </p><dl class="section note"><dt>Note</dt><dd>unless for debug, you are wrong if you want to use this selector </dd></dl>
  315. </div>
  316. </div>
  317. <hr/>The documentation for this class was generated from the following file:<ul>
  318. <li>Headers/Public/<a class="el" href="_v_l_c_media_discoverer_8h_source.html">VLCMediaDiscoverer.h</a></li>
  319. </ul>
  320. </div><!-- contents -->
  321. <!-- start footer part -->
  322. <hr class="footer"/><address class="footer"><small>
  323. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  324. <img class="footer" src="doxygen.png" alt="doxygen"/>
  325. </a> 1.8.14
  326. </small></address>
  327. </body>
  328. </html>