123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.11"/>
- <title>VLCKit: VLCLibrary Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { init_search(); });
- </script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">VLCKit
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.11 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Instance Methods</a> |
- <a href="#pub-static-methods">Class Methods</a> |
- <a href="#properties">Properties</a> |
- <a href="class_v_l_c_library-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">VLCLibrary Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p><code>#import <<a class="el" href="_v_l_c_library_8h_source.html">VLCLibrary.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for VLCLibrary:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="interface_v_l_c_library.png" usemap="#VLCLibrary_map" alt=""/>
- <map id="VLCLibrary_map" name="VLCLibrary_map">
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Instance Methods</h2></td></tr>
- <tr class="memitem:ab029c774c0b133dc9c15b9f4446de8c5"><td class="memItemLeft" align="right" valign="top">(instancetype) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_library.html#ab029c774c0b133dc9c15b9f4446de8c5">initWithOptions:</a></td></tr>
- <tr class="separator:ab029c774c0b133dc9c15b9f4446de8c5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae91040ee78413a160918871e1e9475ff"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_library.html#ae91040ee78413a160918871e1e9475ff">setHumanReadableName:withHTTPUserAgent:</a></td></tr>
- <tr class="separator:ae91040ee78413a160918871e1e9475ff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afe1e5231b6bc4b9b12e0fd2c44862dbb"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_library.html#afe1e5231b6bc4b9b12e0fd2c44862dbb">setApplicationIdentifier:withVersion:andApplicationIconName:</a></td></tr>
- <tr class="separator:afe1e5231b6bc4b9b12e0fd2c44862dbb"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Class Methods</h2></td></tr>
- <tr class="memitem:a7eddfd69ce66ffc5603bc68a5777187e"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_library.html#a7eddfd69ce66ffc5603bc68a5777187e">sharedLibrary</a></td></tr>
- <tr class="separator:a7eddfd69ce66ffc5603bc68a5777187e"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
- Properties</h2></td></tr>
- <tr class="memitem:a30523c86de4b6a2fbc86f1d6a8274b59"><td class="memItemLeft" align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a30523c86de4b6a2fbc86f1d6a8274b59">debugLogging</a></td></tr>
- <tr class="separator:a30523c86de4b6a2fbc86f1d6a8274b59"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0b0d7e806f3c1c49243873f99c3608fa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a0b0d7e806f3c1c49243873f99c3608fa">debugLoggingLevel</a></td></tr>
- <tr class="separator:a0b0d7e806f3c1c49243873f99c3608fa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a99403afc6373f5f0ca5b89b6c64d3f32"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a99403afc6373f5f0ca5b89b6c64d3f32">version</a></td></tr>
- <tr class="separator:a99403afc6373f5f0ca5b89b6c64d3f32"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a91485a448eb7b18c7b5c36bba4c56184"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a91485a448eb7b18c7b5c36bba4c56184">compiler</a></td></tr>
- <tr class="separator:a91485a448eb7b18c7b5c36bba4c56184"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9201c5f4b1ee745e31e3875835914124"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#a9201c5f4b1ee745e31e3875835914124">changeset</a></td></tr>
- <tr class="separator:a9201c5f4b1ee745e31e3875835914124"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abb375a92ef38f3cacab3d1d501b747d3"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_library.html#abb375a92ef38f3cacab3d1d501b747d3">instance</a></td></tr>
- <tr class="separator:abb375a92ef38f3cacab3d1d501b747d3"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <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>
- <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>
- </div><h2 class="groupheader">Method Documentation</h2>
- <a class="anchor" id="ab029c774c0b133dc9c15b9f4446de8c5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (instancetype) initWithOptions: </td>
- <td></td>
- <td class="paramtype">(NSArray *) </td>
- <td class="paramname"><em>options</em></td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>returns an individual instance which can be customized with options </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">options</td><td>a NSArray with NSString instance containing the options </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>the individual library instance </dd></dl>
- </div>
- </div>
- <a class="anchor" id="afe1e5231b6bc4b9b12e0fd2c44862dbb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (void) setApplicationIdentifier: </td>
- <td></td>
- <td class="paramtype">(NSString *) </td>
- <td class="paramname"><em>identifier</em></td>
- </tr>
- <tr>
- <td class="paramkey">withVersion:</td>
- <td></td>
- <td class="paramtype">(NSString *) </td>
- <td class="paramname"><em>version</em></td>
- </tr>
- <tr>
- <td class="paramkey">andApplicationIconName:</td>
- <td></td>
- <td class="paramtype">(NSString *) </td>
- <td class="paramname"><em>icon</em> </td>
- </tr>
- <tr>
- <td></td>
- <td></td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets some meta-information about the application.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">identifier</td><td>Java-style application identifier, e.g. "com.acme.foobar" </td></tr>
- <tr><td class="paramname">version</td><td>application version numbers, e.g. "1.2.3" </td></tr>
- <tr><td class="paramname">icon</td><td>application icon name, e.g. "foobar" </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ae91040ee78413a160918871e1e9475ff"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (void) setHumanReadableName: </td>
- <td></td>
- <td class="paramtype">(NSString *) </td>
- <td class="paramname"><em>readableName</em></td>
- </tr>
- <tr>
- <td class="paramkey">withHTTPUserAgent:</td>
- <td></td>
- <td class="paramtype">(NSString *) </td>
- <td class="paramname"><em>userAgent</em> </td>
- </tr>
- <tr>
- <td></td>
- <td></td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">readableName</td><td>human-readable application name, e.g. "FooBar player 1.2.3" </td></tr>
- <tr><td class="paramname">userAgent</td><td>HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0" </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a7eddfd69ce66ffc5603bc68a5777187e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">+ (<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *) sharedLibrary </td>
- <td></td>
- <td class="paramname"></td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the library's shared instance. </p><dl class="section return"><dt>Returns</dt><dd>The library's shared instance. </dd></dl>
- </div>
- </div>
- <h2 class="groupheader">Property Documentation</h2>
- <a class="anchor" id="a9201c5f4b1ee745e31e3875835914124"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) changeset</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the library's changeset </p><dl class="section return"><dt>Returns</dt><dd>The library version example "adfee99". </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a91485a448eb7b18c7b5c36bba4c56184"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) compiler</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a30523c86de4b6a2fbc86f1d6a8274b59"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (BOOL) debugLogging</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <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>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="section return"><dt>Returns</dt><dd>debug logging state </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0b0d7e806f3c1c49243873f99c3608fa"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (int) debugLoggingLevel</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <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>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="abb375a92ef38f3cacab3d1d501b747d3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (void*) instance</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <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>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a99403afc6373f5f0ca5b89b6c64d3f32"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) version</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>Headers/Public/<a class="el" href="_v_l_c_library_8h_source.html">VLCLibrary.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.11
- </small></address>
- </body>
- </html>
|