interface_v_l_c_library.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  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: VLCLibrary 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_library-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">VLCLibrary Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#import &lt;<a class="el" href="_v_l_c_library_8h_source.html">VLCLibrary.h</a>&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for VLCLibrary:</div>
  74. <div class="dyncontent">
  75. <div class="center">
  76. <img src="interface_v_l_c_library.png" usemap="#VLCLibrary_map" alt=""/>
  77. <map id="VLCLibrary_map" name="VLCLibrary_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:ab029c774c0b133dc9c15b9f4446de8c5"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_library.html#ab029c774c0b133dc9c15b9f4446de8c5">initWithOptions:</a></td></tr>
  84. <tr class="separator:ab029c774c0b133dc9c15b9f4446de8c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:af5b1c9572d7eaa15c575215b14df148a"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_library.html#af5b1c9572d7eaa15c575215b14df148a">setHumanReadableName:withHTTPUserAgent:</a></td></tr>
  86. <tr class="separator:af5b1c9572d7eaa15c575215b14df148a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a206f9468fc0694a35ff0fbc39d6b77ee"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_library.html#a206f9468fc0694a35ff0fbc39d6b77ee">setApplicationIdentifier:withVersion:andApplicationIconName:</a></td></tr>
  88. <tr class="separator:a206f9468fc0694a35ff0fbc39d6b77ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. </table><table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  91. Class Methods</h2></td></tr>
  92. <tr class="memitem:a7eddfd69ce66ffc5603bc68a5777187e"><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_library.html#a7eddfd69ce66ffc5603bc68a5777187e">sharedLibrary</a></td></tr>
  93. <tr class="separator:a7eddfd69ce66ffc5603bc68a5777187e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table><table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  96. Properties</h2></td></tr>
  97. <tr class="memitem:a30523c86de4b6a2fbc86f1d6a8274b59"><td class="memItemLeft" align="right" valign="top">BOOL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a30523c86de4b6a2fbc86f1d6a8274b59">debugLogging</a></td></tr>
  98. <tr class="separator:a30523c86de4b6a2fbc86f1d6a8274b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a0b0d7e806f3c1c49243873f99c3608fa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a0b0d7e806f3c1c49243873f99c3608fa">debugLoggingLevel</a></td></tr>
  100. <tr class="separator:a0b0d7e806f3c1c49243873f99c3608fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a99403afc6373f5f0ca5b89b6c64d3f32"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a99403afc6373f5f0ca5b89b6c64d3f32">version</a></td></tr>
  102. <tr class="separator:a99403afc6373f5f0ca5b89b6c64d3f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a91485a448eb7b18c7b5c36bba4c56184"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a91485a448eb7b18c7b5c36bba4c56184">compiler</a></td></tr>
  104. <tr class="separator:a91485a448eb7b18c7b5c36bba4c56184"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a9201c5f4b1ee745e31e3875835914124"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a9201c5f4b1ee745e31e3875835914124">changeset</a></td></tr>
  106. <tr class="separator:a9201c5f4b1ee745e31e3875835914124"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:abb375a92ef38f3cacab3d1d501b747d3"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#abb375a92ef38f3cacab3d1d501b747d3">instance</a></td></tr>
  108. <tr class="separator:abb375a92ef38f3cacab3d1d501b747d3"><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>The <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> is the base library of the VLCKit.framework. This object provides a shared instance that exposes the internal functionalities of libvlc and libvlc-control. The <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> object is instantiated automatically when VLCKit.framework is loaded into memory. Also, it is automatically destroyed when the VLCKit.framework is unloaded from memory.</p>
  112. <p>Currently, the framework does not support multiple instances of <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a>. Furthermore, you cannot destroy any instiantiation of <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a>, as previously noted, this is done automatically by the dynamic link loader. </p>
  113. </div><h2 class="groupheader">Method Documentation</h2>
  114. <a id="ab029c774c0b133dc9c15b9f4446de8c5"></a>
  115. <h2 class="memtitle"><span class="permalink"><a href="#ab029c774c0b133dc9c15b9f4446de8c5">&#9670;&nbsp;</a></span>initWithOptions:()</h2>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">- (instancetype) initWithOptions: </td>
  121. <td></td>
  122. <td class="paramtype">(NSArray *)&#160;</td>
  123. <td class="paramname"><em>options</em></td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>returns an individual instance which can be customized with options </p><dl class="params"><dt>Parameters</dt><dd>
  129. <table class="params">
  130. <tr><td class="paramname">options</td><td>a NSArray with NSString instance containing the options </td></tr>
  131. </table>
  132. </dd>
  133. </dl>
  134. <dl class="section return"><dt>Returns</dt><dd>the individual library instance </dd></dl>
  135. </div>
  136. </div>
  137. <a id="a206f9468fc0694a35ff0fbc39d6b77ee"></a>
  138. <h2 class="memtitle"><span class="permalink"><a href="#a206f9468fc0694a35ff0fbc39d6b77ee">&#9670;&nbsp;</a></span>setApplicationIdentifier:withVersion:andApplicationIconName:()</h2>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">- (void) setApplicationIdentifier: </td>
  144. <td></td>
  145. <td class="paramtype">(NSString *)&#160;</td>
  146. <td class="paramname"><em>identifier</em></td>
  147. </tr>
  148. <tr>
  149. <td class="paramkey">withVersion:</td>
  150. <td></td>
  151. <td class="paramtype">(NSString *)&#160;</td>
  152. <td class="paramname"><em>version</em></td>
  153. </tr>
  154. <tr>
  155. <td class="paramkey">andApplicationIconName:</td>
  156. <td></td>
  157. <td class="paramtype">(NSString *)&#160;</td>
  158. <td class="paramname"><em>icon</em>&#160;</td>
  159. </tr>
  160. <tr>
  161. <td></td>
  162. <td></td>
  163. <td></td><td></td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Sets some meta-information about the application.</p>
  168. <dl class="params"><dt>Parameters</dt><dd>
  169. <table class="params">
  170. <tr><td class="paramname">identifier</td><td>Java-style application identifier, e.g. "com.acme.foobar" </td></tr>
  171. <tr><td class="paramname">version</td><td>application version numbers, e.g. "1.2.3" </td></tr>
  172. <tr><td class="paramname">icon</td><td>application icon name, e.g. "foobar" </td></tr>
  173. </table>
  174. </dd>
  175. </dl>
  176. </div>
  177. </div>
  178. <a id="af5b1c9572d7eaa15c575215b14df148a"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#af5b1c9572d7eaa15c575215b14df148a">&#9670;&nbsp;</a></span>setHumanReadableName:withHTTPUserAgent:()</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">- (void) setHumanReadableName: </td>
  185. <td></td>
  186. <td class="paramtype">(NSString *)&#160;</td>
  187. <td class="paramname"><em>readableName</em></td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey">withHTTPUserAgent:</td>
  191. <td></td>
  192. <td class="paramtype">(NSString *)&#160;</td>
  193. <td class="paramname"><em>userAgent</em>&#160;</td>
  194. </tr>
  195. <tr>
  196. <td></td>
  197. <td></td>
  198. <td></td><td></td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>sets the application name and HTTP User Agend libvlc will pass it to servers when required by protocol </p><dl class="params"><dt>Parameters</dt><dd>
  203. <table class="params">
  204. <tr><td class="paramname">readableName</td><td>human-readable application name, e.g. "FooBar player 1.2.3" </td></tr>
  205. <tr><td class="paramname">userAgent</td><td>HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0" </td></tr>
  206. </table>
  207. </dd>
  208. </dl>
  209. </div>
  210. </div>
  211. <a id="a7eddfd69ce66ffc5603bc68a5777187e"></a>
  212. <h2 class="memtitle"><span class="permalink"><a href="#a7eddfd69ce66ffc5603bc68a5777187e">&#9670;&nbsp;</a></span>sharedLibrary()</h2>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">+ (<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *) sharedLibrary </td>
  218. <td></td>
  219. <td class="paramname"></td>
  220. <td></td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <p>Returns the library's shared instance. </p><dl class="section return"><dt>Returns</dt><dd>The library's shared instance. </dd></dl>
  225. </div>
  226. </div>
  227. <h2 class="groupheader">Property Documentation</h2>
  228. <a id="a9201c5f4b1ee745e31e3875835914124"></a>
  229. <h2 class="memtitle"><span class="permalink"><a href="#a9201c5f4b1ee745e31e3875835914124">&#9670;&nbsp;</a></span>changeset</h2>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="mlabels">
  233. <tr>
  234. <td class="mlabels-left">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">- (NSString*) changeset</td>
  238. </tr>
  239. </table>
  240. </td>
  241. <td class="mlabels-right">
  242. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Returns the library's changeset </p><dl class="section return"><dt>Returns</dt><dd>The library version example "adfee99". </dd></dl>
  247. </div>
  248. </div>
  249. <a id="a91485a448eb7b18c7b5c36bba4c56184"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#a91485a448eb7b18c7b5c36bba4c56184">&#9670;&nbsp;</a></span>compiler</h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="mlabels">
  254. <tr>
  255. <td class="mlabels-left">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">- (NSString*) compiler</td>
  259. </tr>
  260. </table>
  261. </td>
  262. <td class="mlabels-right">
  263. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Returns the compiler used to build the libvlc binary </p><dl class="section return"><dt>Returns</dt><dd>The compiler version string. </dd></dl>
  268. </div>
  269. </div>
  270. <a id="a30523c86de4b6a2fbc86f1d6a8274b59"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#a30523c86de4b6a2fbc86f1d6a8274b59">&#9670;&nbsp;</a></span>debugLogging</h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="mlabels">
  275. <tr>
  276. <td class="mlabels-left">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">- (BOOL) debugLogging</td>
  280. </tr>
  281. </table>
  282. </td>
  283. <td class="mlabels-right">
  284. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">nonatomic</span><span class="mlabel">assign</span></span> </td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>enables/disables debug logging param: debugLogging BOOL value to enable/disable </p><dl class="section note"><dt>Note</dt><dd>we will always log using NSLog </dd></dl>
  289. <dl class="section return"><dt>Returns</dt><dd>debug logging state </dd></dl>
  290. </div>
  291. </div>
  292. <a id="a0b0d7e806f3c1c49243873f99c3608fa"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#a0b0d7e806f3c1c49243873f99c3608fa">&#9670;&nbsp;</a></span>debugLoggingLevel</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="mlabels">
  297. <tr>
  298. <td class="mlabels-left">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">- (int) debugLoggingLevel</td>
  302. </tr>
  303. </table>
  304. </td>
  305. <td class="mlabels-right">
  306. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">nonatomic</span><span class="mlabel">assign</span></span> </td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. <p>gets/sets the debug logging level param: debugLoggingLevel set level from 0 (all) to 4 (just error messages) </p><dl class="section return"><dt>Returns</dt><dd>int debug level </dd></dl>
  311. </div>
  312. </div>
  313. <a id="abb375a92ef38f3cacab3d1d501b747d3"></a>
  314. <h2 class="memtitle"><span class="permalink"><a href="#abb375a92ef38f3cacab3d1d501b747d3">&#9670;&nbsp;</a></span>instance</h2>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="mlabels">
  318. <tr>
  319. <td class="mlabels-left">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">- (void*) instance</td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">nonatomic</span><span class="mlabel">assign</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>the libvlc instance wrapped by the <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> instance </p><dl class="section note"><dt>Note</dt><dd>if you want to use it, you are most likely wrong (or want to add a proper ObjC API) </dd></dl>
  332. </div>
  333. </div>
  334. <a id="a99403afc6373f5f0ca5b89b6c64d3f32"></a>
  335. <h2 class="memtitle"><span class="permalink"><a href="#a99403afc6373f5f0ca5b89b6c64d3f32">&#9670;&nbsp;</a></span>version</h2>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <table class="mlabels">
  339. <tr>
  340. <td class="mlabels-left">
  341. <table class="memname">
  342. <tr>
  343. <td class="memname">- (NSString*) version</td>
  344. </tr>
  345. </table>
  346. </td>
  347. <td class="mlabels-right">
  348. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>Returns the library's version </p><dl class="section return"><dt>Returns</dt><dd>The library version example "0.9.0-git Grishenko". </dd></dl>
  353. </div>
  354. </div>
  355. <hr/>The documentation for this class was generated from the following file:<ul>
  356. <li>Headers/Public/<a class="el" href="_v_l_c_library_8h_source.html">VLCLibrary.h</a></li>
  357. </ul>
  358. </div><!-- contents -->
  359. <!-- start footer part -->
  360. <hr class="footer"/><address class="footer"><small>
  361. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  362. <img class="footer" src="doxygen.png" alt="doxygen"/>
  363. </a> 1.8.14
  364. </small></address>
  365. </body>
  366. </html>