interface_v_l_c_library.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  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.11"/>
  7. <title>VLCKit: VLCLibrary Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">VLCKit
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.11 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-methods">Instance Methods</a> &#124;
  86. <a href="#pub-static-methods">Class Methods</a> &#124;
  87. <a href="#properties">Properties</a> &#124;
  88. <a href="class_v_l_c_library-members.html">List of all members</a> </div>
  89. <div class="headertitle">
  90. <div class="title">VLCLibrary Class Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p><code>#import &lt;<a class="el" href="_v_l_c_library_8h_source.html">VLCLibrary.h</a>&gt;</code></p>
  94. <div class="dynheader">
  95. Inheritance diagram for VLCLibrary:</div>
  96. <div class="dyncontent">
  97. <div class="center">
  98. <img src="interface_v_l_c_library.png" usemap="#VLCLibrary_map" alt=""/>
  99. <map id="VLCLibrary_map" name="VLCLibrary_map">
  100. </map>
  101. </div></div>
  102. <table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  104. Instance Methods</h2></td></tr>
  105. <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>
  106. <tr class="separator:ab029c774c0b133dc9c15b9f4446de8c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ae91040ee78413a160918871e1e9475ff"><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#ae91040ee78413a160918871e1e9475ff">setHumanReadableName:withHTTPUserAgent:</a></td></tr>
  108. <tr class="separator:ae91040ee78413a160918871e1e9475ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:afe1e5231b6bc4b9b12e0fd2c44862dbb"><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#afe1e5231b6bc4b9b12e0fd2c44862dbb">setApplicationIdentifier:withVersion:andApplicationIconName:</a></td></tr>
  110. <tr class="separator:afe1e5231b6bc4b9b12e0fd2c44862dbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table><table class="memberdecls">
  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  113. Class Methods</h2></td></tr>
  114. <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>
  115. <tr class="separator:a7eddfd69ce66ffc5603bc68a5777187e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table><table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  118. Properties</h2></td></tr>
  119. <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>
  120. <tr class="separator:a30523c86de4b6a2fbc86f1d6a8274b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:a0b0d7e806f3c1c49243873f99c3608fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:a99403afc6373f5f0ca5b89b6c64d3f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:a91485a448eb7b18c7b5c36bba4c56184"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:a9201c5f4b1ee745e31e3875835914124"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <tr class="separator:abb375a92ef38f3cacab3d1d501b747d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <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>
  134. <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>
  135. </div><h2 class="groupheader">Method Documentation</h2>
  136. <a class="anchor" id="ab029c774c0b133dc9c15b9f4446de8c5"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">- (instancetype) initWithOptions: </td>
  142. <td></td>
  143. <td class="paramtype">(NSArray *)&#160;</td>
  144. <td class="paramname"><em>options</em></td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>returns an individual instance which can be customized with options </p><dl class="params"><dt>Parameters</dt><dd>
  150. <table class="params">
  151. <tr><td class="paramname">options</td><td>a NSArray with NSString instance containing the options </td></tr>
  152. </table>
  153. </dd>
  154. </dl>
  155. <dl class="section return"><dt>Returns</dt><dd>the individual library instance </dd></dl>
  156. </div>
  157. </div>
  158. <a class="anchor" id="afe1e5231b6bc4b9b12e0fd2c44862dbb"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">- (void) setApplicationIdentifier: </td>
  164. <td></td>
  165. <td class="paramtype">(NSString *)&#160;</td>
  166. <td class="paramname"><em>identifier</em></td>
  167. </tr>
  168. <tr>
  169. <td class="paramkey">withVersion:</td>
  170. <td></td>
  171. <td class="paramtype">(NSString *)&#160;</td>
  172. <td class="paramname"><em>version</em></td>
  173. </tr>
  174. <tr>
  175. <td class="paramkey">andApplicationIconName:</td>
  176. <td></td>
  177. <td class="paramtype">(NSString *)&#160;</td>
  178. <td class="paramname"><em>icon</em>&#160;</td>
  179. </tr>
  180. <tr>
  181. <td></td>
  182. <td></td>
  183. <td></td><td></td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Sets some meta-information about the application.</p>
  188. <dl class="params"><dt>Parameters</dt><dd>
  189. <table class="params">
  190. <tr><td class="paramname">identifier</td><td>Java-style application identifier, e.g. "com.acme.foobar" </td></tr>
  191. <tr><td class="paramname">version</td><td>application version numbers, e.g. "1.2.3" </td></tr>
  192. <tr><td class="paramname">icon</td><td>application icon name, e.g. "foobar" </td></tr>
  193. </table>
  194. </dd>
  195. </dl>
  196. </div>
  197. </div>
  198. <a class="anchor" id="ae91040ee78413a160918871e1e9475ff"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">- (void) setHumanReadableName: </td>
  204. <td></td>
  205. <td class="paramtype">(NSString *)&#160;</td>
  206. <td class="paramname"><em>readableName</em></td>
  207. </tr>
  208. <tr>
  209. <td class="paramkey">withHTTPUserAgent:</td>
  210. <td></td>
  211. <td class="paramtype">(NSString *)&#160;</td>
  212. <td class="paramname"><em>userAgent</em>&#160;</td>
  213. </tr>
  214. <tr>
  215. <td></td>
  216. <td></td>
  217. <td></td><td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <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>
  222. <table class="params">
  223. <tr><td class="paramname">readableName</td><td>human-readable application name, e.g. "FooBar player 1.2.3" </td></tr>
  224. <tr><td class="paramname">userAgent</td><td>HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0" </td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. </div>
  229. </div>
  230. <a class="anchor" id="a7eddfd69ce66ffc5603bc68a5777187e"></a>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">+ (<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *) sharedLibrary </td>
  236. <td></td>
  237. <td class="paramname"></td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Returns the library's shared instance. </p><dl class="section return"><dt>Returns</dt><dd>The library's shared instance. </dd></dl>
  243. </div>
  244. </div>
  245. <h2 class="groupheader">Property Documentation</h2>
  246. <a class="anchor" id="a9201c5f4b1ee745e31e3875835914124"></a>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="mlabels">
  250. <tr>
  251. <td class="mlabels-left">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">- (NSString*) changeset</td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p>Returns the library's changeset </p><dl class="section return"><dt>Returns</dt><dd>The library version example "adfee99". </dd></dl>
  264. </div>
  265. </div>
  266. <a class="anchor" id="a91485a448eb7b18c7b5c36bba4c56184"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="mlabels">
  270. <tr>
  271. <td class="mlabels-left">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">- (NSString*) compiler</td>
  275. </tr>
  276. </table>
  277. </td>
  278. <td class="mlabels-right">
  279. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <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>
  284. </div>
  285. </div>
  286. <a class="anchor" id="a30523c86de4b6a2fbc86f1d6a8274b59"></a>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="mlabels">
  290. <tr>
  291. <td class="mlabels-left">
  292. <table class="memname">
  293. <tr>
  294. <td class="memname">- (BOOL) debugLogging</td>
  295. </tr>
  296. </table>
  297. </td>
  298. <td class="mlabels-right">
  299. <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>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <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>
  304. <dl class="section return"><dt>Returns</dt><dd>debug logging state </dd></dl>
  305. </div>
  306. </div>
  307. <a class="anchor" id="a0b0d7e806f3c1c49243873f99c3608fa"></a>
  308. <div class="memitem">
  309. <div class="memproto">
  310. <table class="mlabels">
  311. <tr>
  312. <td class="mlabels-left">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">- (int) debugLoggingLevel</td>
  316. </tr>
  317. </table>
  318. </td>
  319. <td class="mlabels-right">
  320. <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>
  321. </tr>
  322. </table>
  323. </div><div class="memdoc">
  324. <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>
  325. </div>
  326. </div>
  327. <a class="anchor" id="abb375a92ef38f3cacab3d1d501b747d3"></a>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="mlabels">
  331. <tr>
  332. <td class="mlabels-left">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">- (void*) instance</td>
  336. </tr>
  337. </table>
  338. </td>
  339. <td class="mlabels-right">
  340. <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>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <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>
  345. </div>
  346. </div>
  347. <a class="anchor" id="a99403afc6373f5f0ca5b89b6c64d3f32"></a>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="mlabels">
  351. <tr>
  352. <td class="mlabels-left">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">- (NSString*) version</td>
  356. </tr>
  357. </table>
  358. </td>
  359. <td class="mlabels-right">
  360. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  361. </tr>
  362. </table>
  363. </div><div class="memdoc">
  364. <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>
  365. </div>
  366. </div>
  367. <hr/>The documentation for this class was generated from the following file:<ul>
  368. <li>Headers/Public/<a class="el" href="_v_l_c_library_8h_source.html">VLCLibrary.h</a></li>
  369. </ul>
  370. </div><!-- contents -->
  371. <!-- start footer part -->
  372. <hr class="footer"/><address class="footer"><small>
  373. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  374. <img class="footer" src="doxygen.png" alt="doxygen"/>
  375. </a> 1.8.11
  376. </small></address>
  377. </body>
  378. </html>