vlc
/
VLCKit


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
							<!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: VLCDialogProvider 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="#properties">Properties</a> &#124;
<a href="class_v_l_c_dialog_provider-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">VLCDialogProvider Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#import &lt;<a class="el" href="_v_l_c_dialog_provider_8h_source.html">VLCDialogProvider.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VLCDialogProvider:</div>
<div class="dyncontent">
 <div class="center">
  <img src="interface_v_l_c_dialog_provider.png" usemap="#VLCDialogProvider_map" alt=""/>
  <map id="VLCDialogProvider_map" name="VLCDialogProvider_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:a51bf3d3c491d976761a78ac431f9e986"><td class="memItemLeft" align="right" valign="top">(instancetype _Nullable)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a51bf3d3c491d976761a78ac431f9e986">initWithLibrary:customUI:</a></td></tr>
<tr class="separator:a51bf3d3c491d976761a78ac431f9e986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75004021734803d0acbd1043dfcb59de"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a75004021734803d0acbd1043dfcb59de">postUsername:andPassword:forDialogReference:store:</a></td></tr>
<tr class="separator:a75004021734803d0acbd1043dfcb59de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a0eefde74fa37648c5362bc864a3492"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a8a0eefde74fa37648c5362bc864a3492">postAction:forDialogReference:</a></td></tr>
<tr class="separator:a8a0eefde74fa37648c5362bc864a3492"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a067cfa85cd47a387ccccba06b6a14b3e"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a067cfa85cd47a387ccccba06b6a14b3e">dismissDialogWithReference:</a></td></tr>
<tr class="separator:a067cfa85cd47a387ccccba06b6a14b3e"><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:a15847411703d3b120abb0a9b4b7e8ed2"><td class="memItemLeft" align="right" valign="top">id&lt; <a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html">VLCCustomDialogRendererProtocol</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_dialog_provider.html#a15847411703d3b120abb0a9b4b7e8ed2">customRenderer</a></td></tr>
<tr class="separator:a15847411703d3b120abb0a9b4b7e8ed2"><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>dialog provider base class </p><dl class="section note"><dt>Note</dt><dd>For iOS and tvOS, there are useable implementations available which don't require the use of a custom renderer </dd></dl>
</div><h2 class="groupheader">Method Documentation</h2>
<a class="anchor" id="a067cfa85cd47a387ccccba06b6a14b3e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) dismissDialogWithReference: </td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>dialogReference</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>if you requested custom UI mode for dialogs, use this method to cancel a progress dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dialogReference</td><td>reference to the dialog you want to cancel </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method does not have any effect if you don't use custom UI mode </dd></dl>

</div>
</div>
<a class="anchor" id="a51bf3d3c491d976761a78ac431f9e986"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (instancetype _Nullable) initWithLibrary: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *_Nullable)&#160;</td>
          <td class="paramname"><em>library</em></td>
        </tr>
        <tr>
          <td class="paramkey">customUI:</td>
          <td></td>
          <td class="paramtype">(BOOL)&#160;</td>
          <td class="paramname"><em>customUI</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>initializer method to run the dialog provider instance on a specific library instance</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">library</td><td>the <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> instance </td></tr>
    <tr><td class="paramname">customUI</td><td>enable custom UI mode </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>if library param is NULL, [<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> sharedLibrary] will be used </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>the dialog provider instance, can be NULL on malloc failures </dd></dl>

</div>
</div>
<a class="anchor" id="a8a0eefde74fa37648c5362bc864a3492"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) postAction: </td>
          <td></td>
          <td class="paramtype">(int)&#160;</td>
          <td class="paramname"><em>buttonNumber</em></td>
        </tr>
        <tr>
          <td class="paramkey">forDialogReference:</td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>dialogReference</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>if you requested custom UI mode for dialogs, use this method respond to a question dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buttonNumber</td><td>the button number the user pressed, use 3 if s/he cancelled, otherwise respectively 1 or 2 depending on the selected action </td></tr>
    <tr><td class="paramname">dialogReference</td><td>reference to the dialog you respond to </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method does not have any effect if you don't use custom UI mode </dd></dl>

</div>
</div>
<a class="anchor" id="a75004021734803d0acbd1043dfcb59de"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) postUsername: </td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>username</em></td>
        </tr>
        <tr>
          <td class="paramkey">andPassword:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>password</em></td>
        </tr>
        <tr>
          <td class="paramkey">forDialogReference:</td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>dialogReference</em></td>
        </tr>
        <tr>
          <td class="paramkey">store:</td>
          <td></td>
          <td class="paramtype">(BOOL)&#160;</td>
          <td class="paramname"><em>store</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>if you requested custom UI mode for dialogs, use this method respond to a login dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">username</td><td>or NULL if cancelled </td></tr>
    <tr><td class="paramname">password</td><td>or NULL if cancelled </td></tr>
    <tr><td class="paramname">dialogReference</td><td>reference to the dialog you respond to </td></tr>
    <tr><td class="paramname">store</td><td>shall VLC store the login securely? </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method does not have any effect if you don't use custom UI mode </dd></dl>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a15847411703d3b120abb0a9b4b7e8ed2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">- (id&lt;<a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html">VLCCustomDialogRendererProtocol</a>&gt;) customRenderer</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">weak</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>initializer method to run the dialog provider instance on a specific library instance</p>
<dl class="section return"><dt>Returns</dt><dd>the object set </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_dialog_provider_8h_source.html">VLCDialogProvider.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>