_v_l_c_library_8h_source.html 17 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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: Headers/Public/VLCLibrary.h Source File</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 id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="dir_692516b589a32b3bfce781ca9f6d1534.html">Headers</a></li><li class="navelem"><a class="el" href="dir_28c64fbfc9a6ab228413a335a5a957f9.html">Public</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="headertitle">
  67. <div class="title">VLCLibrary.h</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*****************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * VLCLibrary.h: VLCKit.framework VLCLibrary header</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *****************************************************************************</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Copyright (C) 2007 Pierre d&#39;Herbemont</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Copyright (C) 2007-2019 VLC authors and VideoLAN</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * $Id$</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * Authors: Pierre d&#39;Herbemont &lt;pdherbemont # videolan.org&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * Felix Paul Kühne &lt;fkuehne # videolan.org&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * This program is free software; you can redistribute it and/or modify it</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * under the terms of the GNU Lesser General Public License as published by</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * (at your option) any later version.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * GNU Lesser General Public License for more details.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * along with this program; if not, write to the Free Software Foundation,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> *****************************************************************************/</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#import &lt;Foundation/Foundation.h&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;NS_ASSUME_NONNULL_BEGIN</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">@protocol </span><a class="code" href="protocol_v_l_c_library_log_receiver_protocol-p.html">VLCLibraryLogReceiverProtocol</a>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html"> 41</a></span>&#160;<span class="keyword">@interface </span><a class="code" href="interface_v_l_c_library.html">VLCLibrary</a> : NSObject</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;+ (<a class="code" href="interface_v_l_c_library.html">VLCLibrary</a> *)<a class="code" href="interface_v_l_c_library.html#a7eddfd69ce66ffc5603bc68a5777187e">sharedLibrary</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; - (instancetype)initWithOptions:(NSArray *)options;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html#a30523c86de4b6a2fbc86f1d6a8274b59"> 60</a></span>&#160;<span class="keyword">@property</span> (readwrite, nonatomic) BOOL <a class="code" href="interface_v_l_c_library.html#a30523c86de4b6a2fbc86f1d6a8274b59">debugLogging</a>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html#a0b0d7e806f3c1c49243873f99c3608fa"> 68</a></span>&#160;<span class="keyword">@property</span> (readwrite, nonatomic) <span class="keywordtype">int</span> <a class="code" href="interface_v_l_c_library.html#a0b0d7e806f3c1c49243873f99c3608fa">debugLoggingLevel</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;- (BOOL)setDebugLoggingToFile:(NSString *)filePath;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html#a7194d31353ddeef7273dd9d9c394841a"> 85</a></span>&#160;<span class="keyword">@property</span> (readwrite, nonatomic) id&lt;VLCLibraryLogReceiverProtocol&gt; <a class="code" href="interface_v_l_c_library.html#a7194d31353ddeef7273dd9d9c394841a">debugLoggingTarget</a>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html#a99403afc6373f5f0ca5b89b6c64d3f32"> 91</a></span>&#160;<span class="keyword">@property</span> (readonly, copy) NSString *<a class="code" href="interface_v_l_c_library.html#a99403afc6373f5f0ca5b89b6c64d3f32">version</a>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html#a91485a448eb7b18c7b5c36bba4c56184"> 97</a></span>&#160;<span class="keyword">@property</span> (readonly, copy) NSString *<a class="code" href="interface_v_l_c_library.html#a91485a448eb7b18c7b5c36bba4c56184">compiler</a>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html#a9201c5f4b1ee745e31e3875835914124"> 103</a></span>&#160;<span class="keyword">@property</span> (readonly, copy) NSString *<a class="code" href="interface_v_l_c_library.html#a9201c5f4b1ee745e31e3875835914124">changeset</a>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;- (void)setHumanReadableName:(NSString *)readableName withHTTPUserAgent:(NSString *)userAgent;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;- (void)setApplicationIdentifier:(NSString *)identifier withVersion:(NSString *)version andApplicationIconName:(NSString *)icon;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="interface_v_l_c_library.html#abb375a92ef38f3cacab3d1d501b747d3"> 125</a></span>&#160;<span class="keyword">@property</span> (nonatomic, assign) <span class="keywordtype">void</span> *<a class="code" href="interface_v_l_c_library.html#abb375a92ef38f3cacab3d1d501b747d3">instance</a>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="keyword">@end</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="protocol_v_l_c_library_log_receiver_protocol-p.html"> 129</a></span>&#160;<span class="keyword">@protocol </span><a class="code" href="protocol_v_l_c_library_log_receiver_protocol-p.html">VLCLibraryLogReceiverProtocol</a> &lt;NSObject&gt;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="keyword">@required</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;- (void)handleMessage:(NSString *)message</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; debugLevel:(<span class="keywordtype">int</span>)level;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="keyword">@end</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;NS_ASSUME_NONNULL_END</div><div class="ttc" id="protocol_v_l_c_library_log_receiver_protocol-p_html"><div class="ttname"><a href="protocol_v_l_c_library_log_receiver_protocol-p.html">VLCLibraryLogReceiverProtocol-p</a></div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:129</div></div>
  71. <div class="ttc" id="interface_v_l_c_library_html_abb375a92ef38f3cacab3d1d501b747d3"><div class="ttname"><a href="interface_v_l_c_library.html#abb375a92ef38f3cacab3d1d501b747d3">VLCLibrary::instance</a></div><div class="ttdeci">void * instance</div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:125</div></div>
  72. <div class="ttc" id="interface_v_l_c_library_html_a91485a448eb7b18c7b5c36bba4c56184"><div class="ttname"><a href="interface_v_l_c_library.html#a91485a448eb7b18c7b5c36bba4c56184">VLCLibrary::compiler</a></div><div class="ttdeci">NSString * compiler</div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:97</div></div>
  73. <div class="ttc" id="interface_v_l_c_library_html"><div class="ttname"><a href="interface_v_l_c_library.html">VLCLibrary</a></div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:41</div></div>
  74. <div class="ttc" id="interface_v_l_c_library_html_a7194d31353ddeef7273dd9d9c394841a"><div class="ttname"><a href="interface_v_l_c_library.html#a7194d31353ddeef7273dd9d9c394841a">VLCLibrary::debugLoggingTarget</a></div><div class="ttdeci">id&lt; VLCLibraryLogReceiverProtocol &gt; debugLoggingTarget</div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:85</div></div>
  75. <div class="ttc" id="interface_v_l_c_library_html_a99403afc6373f5f0ca5b89b6c64d3f32"><div class="ttname"><a href="interface_v_l_c_library.html#a99403afc6373f5f0ca5b89b6c64d3f32">VLCLibrary::version</a></div><div class="ttdeci">NSString * version</div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:91</div></div>
  76. <div class="ttc" id="interface_v_l_c_library_html_a30523c86de4b6a2fbc86f1d6a8274b59"><div class="ttname"><a href="interface_v_l_c_library.html#a30523c86de4b6a2fbc86f1d6a8274b59">VLCLibrary::debugLogging</a></div><div class="ttdeci">BOOL debugLogging</div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:60</div></div>
  77. <div class="ttc" id="interface_v_l_c_library_html_a0b0d7e806f3c1c49243873f99c3608fa"><div class="ttname"><a href="interface_v_l_c_library.html#a0b0d7e806f3c1c49243873f99c3608fa">VLCLibrary::debugLoggingLevel</a></div><div class="ttdeci">int debugLoggingLevel</div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:68</div></div>
  78. <div class="ttc" id="interface_v_l_c_library_html_a7eddfd69ce66ffc5603bc68a5777187e"><div class="ttname"><a href="interface_v_l_c_library.html#a7eddfd69ce66ffc5603bc68a5777187e">+[VLCLibrary sharedLibrary]</a></div><div class="ttdeci">VLCLibrary * sharedLibrary()</div></div>
  79. <div class="ttc" id="interface_v_l_c_library_html_a9201c5f4b1ee745e31e3875835914124"><div class="ttname"><a href="interface_v_l_c_library.html#a9201c5f4b1ee745e31e3875835914124">VLCLibrary::changeset</a></div><div class="ttdeci">NSString * changeset</div><div class="ttdef"><b>Definition:</b> VLCLibrary.h:103</div></div>
  80. </div><!-- fragment --></div><!-- contents -->
  81. <!-- start footer part -->
  82. <hr class="footer"/><address class="footer"><small>
  83. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  84. <img class="footer" src="doxygen.png" alt="doxygen"/>
  85. </a> 1.8.15
  86. </small></address>
  87. </body>
  88. </html>