vlc
/
VLCKit


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
							<!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: VLCMediaDiscoverer 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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> &#124;
<a href="#pub-static-methods">Class Methods</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_v_l_c_media_discoverer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">VLCMediaDiscoverer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#import &lt;<a class="el" href="_v_l_c_media_discoverer_8h_source.html">VLCMediaDiscoverer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VLCMediaDiscoverer:</div>
<div class="dyncontent">
 <div class="center">
  <img src="interface_v_l_c_media_discoverer.png" usemap="#VLCMediaDiscoverer_map" alt=""/>
  <map id="VLCMediaDiscoverer_map" name="VLCMediaDiscoverer_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:a41cd6e81501ef6d0f90788c6dc761cce"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#a41cd6e81501ef6d0f90788c6dc761cce">initWithName:</a></td></tr>
<tr class="separator:a41cd6e81501ef6d0f90788c6dc761cce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4795127962209e66c1b316381177205a"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#a4795127962209e66c1b316381177205a">initWithName:libraryInstance:</a></td></tr>
<tr class="separator:a4795127962209e66c1b316381177205a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae24d8b9250ccead549c829071f7cf184"><td class="memItemLeft" align="right" valign="top">(int)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#ae24d8b9250ccead549c829071f7cf184">startDiscoverer</a></td></tr>
<tr class="separator:ae24d8b9250ccead549c829071f7cf184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedebd3f4b61febe5ca436af1f1ea7508"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#aedebd3f4b61febe5ca436af1f1ea7508">stopDiscoverer</a></td></tr>
<tr class="separator:aedebd3f4b61febe5ca436af1f1ea7508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abefec909660b69a00410cab13c2d9a5b"><td class="memItemLeft" align="right" valign="top">(NSString *localizedName)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_discoverer.html#abefec909660b69a00410cab13c2d9a5b">__attribute__</a></td></tr>
<tr class="separator:abefec909660b69a00410cab13c2d9a5b"><td class="memSeparator" colspan="2">&#160;</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:a57b40dcdb0b650aea2feed95fdd30d83"><td class="memItemLeft" align="right" valign="top">((deprecated)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_media_discoverer.html#a57b40dcdb0b650aea2feed95fdd30d83">__attribute__</a></td></tr>
<tr class="separator:a57b40dcdb0b650aea2feed95fdd30d83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a867e500dc5948bcb63206f814dffc138"><td class="memItemLeft" align="right" valign="top">(NSArray *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_media_discoverer.html#a867e500dc5948bcb63206f814dffc138">availableMediaDiscovererForCategoryType:</a></td></tr>
<tr class="separator:a867e500dc5948bcb63206f814dffc138"><td class="memSeparator" colspan="2">&#160;</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:a7c84bb252d3183d9314b447a16a68b06"><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_media_discoverer.html#a7c84bb252d3183d9314b447a16a68b06">libraryInstance</a></td></tr>
<tr class="separator:a7c84bb252d3183d9314b447a16a68b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace04441c5b6e7b968772a5f9c3da6ce9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_v_l_c_media_list.html">VLCMediaList</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_discoverer.html#ace04441c5b6e7b968772a5f9c3da6ce9">discoveredMedia</a></td></tr>
<tr class="separator:ace04441c5b6e7b968772a5f9c3da6ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbd18cde0dc5c6982ec6a5c356fe9f7e"><td class="memItemLeft" align="right" valign="top">BOOL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_discoverer.html#abbd18cde0dc5c6982ec6a5c356fe9f7e">isRunning</a></td></tr>
<tr class="separator:abbd18cde0dc5c6982ec6a5c356fe9f7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="interface_v_l_c_media_discoverer.html">VLCMediaDiscoverer</a> </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a class="anchor" id="a57b40dcdb0b650aea2feed95fdd30d83"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ ((deprecated) __attribute__ </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The full list of available media discoverers </p><dl class="section return"><dt>Returns</dt><dd>returns an empty array for binary compatibility, will be removed in subsequent releases </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>use availableMediaDiscovererForCategoryType instead </dd></dl>

</div>
</div>
<a class="anchor" id="abefec909660b69a00410cab13c2d9a5b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (NSString* localizedName) __attribute__ </td>
          <td></td>
          <td class="paramtype">((deprecated))&#160;</td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>localized name of the discovery module if available, otherwise in US English </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>Will be removed in the next major release, may return an empty string for binary compatibility </dd></dl>

</div>
</div>
<a class="anchor" id="a867e500dc5948bcb63206f814dffc138"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (NSArray *) availableMediaDiscovererForCategoryType: </td>
          <td></td>
          <td class="paramtype">(VLCMediaDiscovererCategoryType)&#160;</td>
          <td class="paramname"><em>categoryType</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">categoryType</td><td>VLCMediaDiscovererCategory you are looking for </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an array of dictionaries describing the available discoverers for the requested type </dd></dl>

</div>
</div>
<a class="anchor" id="a41cd6e81501ef6d0f90788c6dc761cce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (instancetype) initWithName: </td>
          <td></td>
          <td class="paramtype">(NSString *)&#160;</td>
          <td class="paramname"><em>aServiceName</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initializes new object with specified name. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">aServiceName</td><td>Name of the service for this <a class="el" href="interface_v_l_c_media_discoverer.html">VLCMediaDiscoverer</a> object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Newly created media discoverer. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>with VLCKit 3.0 and above, you need to start the discoverer explicitly after creation </dd></dl>

</div>
</div>
<a class="anchor" id="a4795127962209e66c1b316381177205a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (instancetype) <a class="el" href="interface_v_l_c_media_discoverer.html#a41cd6e81501ef6d0f90788c6dc761cce">initWithName:</a> </td>
          <td></td>
          <td class="paramtype">(NSString *)&#160;</td>
          <td class="paramname"><em>aServiceName</em></td>
        </tr>
        <tr>
          <td class="paramkey">libraryInstance:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *)&#160;</td>
          <td class="paramname"><em>libraryInstance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>same as above but with a custom <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> instance </p><dl class="section note"><dt>Note</dt><dd>Using this mode can lead to a significant performance impact - use only if you know what you are doing </dd></dl>

</div>
</div>
<a class="anchor" id="ae24d8b9250ccead549c829071f7cf184"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (int) startDiscoverer </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>start media discovery </p><dl class="section return"><dt>Returns</dt><dd>-1 if start failed, otherwise 0 </dd></dl>

</div>
</div>
<a class="anchor" id="aedebd3f4b61febe5ca436af1f1ea7508"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) stopDiscoverer </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>stop media discovery </p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ace04441c5b6e7b968772a5f9c3da6ce9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">- (<a class="el" href="interface_v_l_c_media_list.html">VLCMediaList</a>*) discoveredMedia</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">weak</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>a read-only property to retrieve the list of discovered media items </p>

</div>
</div>
<a class="anchor" id="abbd18cde0dc5c6982ec6a5c356fe9f7e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) isRunning</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>read-only property to check if the discovery service is active </p><dl class="section return"><dt>Returns</dt><dd>boolean value </dd></dl>

</div>
</div>
<a class="anchor" id="a7c84bb252d3183d9314b447a16a68b06"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">- (<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a>*) libraryInstance</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">nonatomic</span><span class="mlabel">assign</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The library instance used by the discoverers </p><dl class="section note"><dt>Note</dt><dd>unless for debug, you are wrong if you want to use this selector </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_media_discoverer_8h_source.html">VLCMediaDiscoverer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>