interface_v_l_c_renderer_discoverer.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>VLCKit: VLCRendererDiscoverer 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.15 -->
  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_renderer_discoverer-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">VLCRendererDiscoverer Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#import &lt;<a class="el" href="_v_l_c_renderer_discoverer_8h_source.html">VLCRendererDiscoverer.h</a>&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for VLCRendererDiscoverer:</div>
  74. <div class="dyncontent">
  75. <div class="center">
  76. <img src="interface_v_l_c_renderer_discoverer.png" alt=""/>
  77. </div></div>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Instance Methods</h2></td></tr>
  81. <tr class="memitem:a6168c53319b51261d2e7a59b5ea89fff"><td class="memItemLeft" align="right" valign="top"><a id="a6168c53319b51261d2e7a59b5ea89fff"></a>
  82. (instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <b>NS_UNAVAILABLE</b></td></tr>
  83. <tr class="separator:a6168c53319b51261d2e7a59b5ea89fff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a955ed444b32f6fd9dedbecc880142567"><td class="memItemLeft" align="right" valign="top">(instancetype _Nullable)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_renderer_discoverer.html#a955ed444b32f6fd9dedbecc880142567">initWithName:</a></td></tr>
  85. <tr class="separator:a955ed444b32f6fd9dedbecc880142567"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:acb4c6a5e9321cdd8432bd0f6e6ebee1d"><td class="memItemLeft" align="right" valign="top">(NSArray&lt; <a class="el" href="interface_v_l_c_renderer_item.html">VLCRendererItem</a> * &gt; *)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_renderer_discoverer.html#acb4c6a5e9321cdd8432bd0f6e6ebee1d">renderers</a></td></tr>
  87. <tr class="separator:acb4c6a5e9321cdd8432bd0f6e6ebee1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a5f344593f78573d3cba3bc9b89ccea14"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_renderer_discoverer.html#a5f344593f78573d3cba3bc9b89ccea14">start</a></td></tr>
  89. <tr class="separator:a5f344593f78573d3cba3bc9b89ccea14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ab7ca6afa57b5f53f6284791fde3f8839"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_renderer_discoverer.html#ab7ca6afa57b5f53f6284791fde3f8839">stop</a></td></tr>
  91. <tr class="separator:ab7ca6afa57b5f53f6284791fde3f8839"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table><table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  94. Class Methods</h2></td></tr>
  95. <tr class="memitem:aa6ffdcd169141a032021df59fdfe3e14"><td class="memItemLeft" align="right" valign="top">(NSArray&lt; <a class="el" href="interface_v_l_c_renderer_discoverer_description.html">VLCRendererDiscovererDescription</a> * &gt; *_Nullable)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_renderer_discoverer.html#aa6ffdcd169141a032021df59fdfe3e14">list</a></td></tr>
  96. <tr class="separator:aa6ffdcd169141a032021df59fdfe3e14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  99. Properties</h2></td></tr>
  100. <tr class="memitem:a831fc60a7a5ea8bc1114bc36cb051f66"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_renderer_discoverer.html#a831fc60a7a5ea8bc1114bc36cb051f66">name</a></td></tr>
  101. <tr class="separator:a831fc60a7a5ea8bc1114bc36cb051f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ad1782fa86584819376e5686797b765ee"><td class="memItemLeft" align="right" valign="top">NSArray&lt; <a class="el" href="interface_v_l_c_renderer_item.html">VLCRendererItem</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_renderer_discoverer.html#ad1782fa86584819376e5686797b765ee">renderers</a></td></tr>
  103. <tr class="separator:ad1782fa86584819376e5686797b765ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a06b6ab494062dd31592e2bff75132fe1"><td class="memItemLeft" align="right" valign="top">id&lt; <a class="el" href="protocol_v_l_c_renderer_discoverer_delegate-p.html">VLCRendererDiscovererDelegate</a> &gt; _Nullable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_renderer_discoverer.html#a06b6ab494062dd31592e2bff75132fe1">delegate</a></td></tr>
  105. <tr class="separator:a06b6ab494062dd31592e2bff75132fe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table>
  107. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  108. <div class="textblock"><p>Renderer Discoverer </p>
  109. </div><h2 class="groupheader">Method Documentation</h2>
  110. <a id="a955ed444b32f6fd9dedbecc880142567"></a>
  111. <h2 class="memtitle"><span class="permalink"><a href="#a955ed444b32f6fd9dedbecc880142567">&#9670;&nbsp;</a></span>initWithName:()</h2>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <table class="memname">
  115. <tr>
  116. <td class="memname">- (instancetype _Nullable) initWithName: </td>
  117. <td></td>
  118. <td class="paramtype">(NSString *)&#160;</td>
  119. <td class="paramname"><em>name</em></td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. <p>Instanciates a <code><a class="el" href="interface_v_l_c_renderer_discoverer.html">VLCRendererDiscoverer</a></code> </p><dl class="params"><dt>Parameters</dt><dd>
  125. <table class="params">
  126. <tr><td class="paramname">name</td><td>Name of the renderer discoverer </td></tr>
  127. </table>
  128. </dd>
  129. </dl>
  130. <dl class="section return"><dt>Returns</dt><dd>A new <code><a class="el" href="interface_v_l_c_renderer_discoverer.html">VLCRendererDiscoverer</a></code> object, only if there were no errors </dd></dl>
  131. </div>
  132. </div>
  133. <a id="aa6ffdcd169141a032021df59fdfe3e14"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#aa6ffdcd169141a032021df59fdfe3e14">&#9670;&nbsp;</a></span>list()</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">+ (NSArray&lt;<a class="el" href="interface_v_l_c_renderer_discoverer_description.html">VLCRendererDiscovererDescription</a> *&gt; * _Nullable) list </td>
  140. <td></td>
  141. <td class="paramname"></td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Returns an <code>NSArray</code> of <code><a class="el" href="interface_v_l_c_renderer_discoverer_description.html">VLCRendererDiscovererDescription</a></code> </p><dl class="section note"><dt>Note</dt><dd>Call this method to retreive information in order to instanciate a <code> </code><a class="el" href="interface_v_l_c_renderer_discoverer.html">VLCRendererDiscoverer</a><code> \return An</code>NSArray<code>of</code>VLCRendererDiscovererDescription` </dd></dl>
  147. </div>
  148. </div>
  149. <a id="acb4c6a5e9321cdd8432bd0f6e6ebee1d"></a>
  150. <h2 class="memtitle"><span class="permalink"><a href="#acb4c6a5e9321cdd8432bd0f6e6ebee1d">&#9670;&nbsp;</a></span>renderers()</h2>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">- (NSArray&lt;<a class="el" href="interface_v_l_c_renderer_item.html">VLCRendererItem</a> *&gt; *) renderers </td>
  156. <td></td>
  157. <td class="paramname"></td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Returns discovered renderers </p><dl class="section return"><dt>Returns</dt><dd>discovered renderers </dd></dl>
  163. </div>
  164. </div>
  165. <a id="a5f344593f78573d3cba3bc9b89ccea14"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#a5f344593f78573d3cba3bc9b89ccea14">&#9670;&nbsp;</a></span>start()</h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">- (BOOL) start </td>
  172. <td></td>
  173. <td class="paramname"></td>
  174. <td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Start the renderer discoverer </p><dl class="section return"><dt>Returns</dt><dd><code>YES</code> if successful, <code>NO</code> otherwise </dd></dl>
  179. </div>
  180. </div>
  181. <a id="ab7ca6afa57b5f53f6284791fde3f8839"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#ab7ca6afa57b5f53f6284791fde3f8839">&#9670;&nbsp;</a></span>stop()</h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">- (void) stop </td>
  188. <td></td>
  189. <td class="paramname"></td>
  190. <td></td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Stops the renderer discoverer </p><dl class="section note"><dt>Note</dt><dd>This cannot fail </dd></dl>
  195. </div>
  196. </div>
  197. <h2 class="groupheader">Property Documentation</h2>
  198. <a id="a06b6ab494062dd31592e2bff75132fe1"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#a06b6ab494062dd31592e2bff75132fe1">&#9670;&nbsp;</a></span>delegate</h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="mlabels">
  203. <tr>
  204. <td class="mlabels-left">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">- (id&lt;<a class="el" href="protocol_v_l_c_renderer_discoverer_delegate-p.html">VLCRendererDiscovererDelegate</a>&gt; _Nullable) delegate</td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">nonatomic</span><span class="mlabel">weak</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Receiver's delegate </p>
  217. </div>
  218. </div>
  219. <a id="a831fc60a7a5ea8bc1114bc36cb051f66"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#a831fc60a7a5ea8bc1114bc36cb051f66">&#9670;&nbsp;</a></span>name</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">- (NSString*) name</td>
  229. </tr>
  230. </table>
  231. </td>
  232. <td class="mlabels-right">
  233. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">nonatomic</span><span class="mlabel">copy</span></span> </td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Name of the renderer discoverer </p>
  238. </div>
  239. </div>
  240. <a id="ad1782fa86584819376e5686797b765ee"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#ad1782fa86584819376e5686797b765ee">&#9670;&nbsp;</a></span>renderers</h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="mlabels">
  245. <tr>
  246. <td class="mlabels-left">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">- (NSArray&lt;<a class="el" href="interface_v_l_c_renderer_item.html">VLCRendererItem</a> *&gt;*) renderers</td>
  250. </tr>
  251. </table>
  252. </td>
  253. <td class="mlabels-right">
  254. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">nonatomic</span><span class="mlabel">copy</span></span> </td>
  255. </tr>
  256. </table>
  257. </div><div class="memdoc">
  258. <p>Renderers of the discoverer </p>
  259. </div>
  260. </div>
  261. <hr/>The documentation for this class was generated from the following file:<ul>
  262. <li>Headers/Public/<a class="el" href="_v_l_c_renderer_discoverer_8h_source.html">VLCRendererDiscoverer.h</a></li>
  263. </ul>
  264. </div><!-- contents -->
  265. <!-- start footer part -->
  266. <hr class="footer"/><address class="footer"><small>
  267. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  268. <img class="footer" src="doxygen.png" alt="doxygen"/>
  269. </a> 1.8.15
  270. </small></address>
  271. </body>
  272. </html>