interface_v_l_c_media_thumbnailer.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  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: VLCMediaThumbnailer 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_media_thumbnailer-members.html">List of all members</a> </div>
  89. <div class="headertitle">
  90. <div class="title">VLCMediaThumbnailer Class Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p><code>#import &lt;<a class="el" href="_v_l_c_media_thumbnailer_8h_source.html">VLCMediaThumbnailer.h</a>&gt;</code></p>
  94. <div class="dynheader">
  95. Inheritance diagram for VLCMediaThumbnailer:</div>
  96. <div class="dyncontent">
  97. <div class="center">
  98. <img src="interface_v_l_c_media_thumbnailer.png" usemap="#VLCMediaThumbnailer_map" alt=""/>
  99. <map id="VLCMediaThumbnailer_map" name="VLCMediaThumbnailer_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:a8c0bce3c2eef22eae4d8b046ce37761b"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_media_thumbnailer.html#a8c0bce3c2eef22eae4d8b046ce37761b">fetchThumbnail</a></td></tr>
  106. <tr class="separator:a8c0bce3c2eef22eae4d8b046ce37761b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table><table class="memberdecls">
  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  109. Class Methods</h2></td></tr>
  110. <tr class="memitem:a364d20f11c696b300c42fd5eb404c3f9"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_v_l_c_media_thumbnailer.html">VLCMediaThumbnailer</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_media_thumbnailer.html#a364d20f11c696b300c42fd5eb404c3f9">thumbnailerWithMedia:andDelegate:</a></td></tr>
  111. <tr class="separator:a364d20f11c696b300c42fd5eb404c3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a8b4b7e2a8aa3b3c51146916ef33dc043"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_v_l_c_media_thumbnailer.html">VLCMediaThumbnailer</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_v_l_c_media_thumbnailer.html#a8b4b7e2a8aa3b3c51146916ef33dc043">thumbnailerWithMedia:delegate:andVLCLibrary:</a></td></tr>
  113. <tr class="separator:a8b4b7e2a8aa3b3c51146916ef33dc043"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table><table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  116. Properties</h2></td></tr>
  117. <tr class="memitem:a48ad5cbc29377c223ed35eb92097d4ac"><td class="memItemLeft" align="right" valign="top">id&lt; <a class="el" href="protocol_v_l_c_media_thumbnailer_delegate-p.html">VLCMediaThumbnailerDelegate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_thumbnailer.html#a48ad5cbc29377c223ed35eb92097d4ac">delegate</a></td></tr>
  118. <tr class="separator:a48ad5cbc29377c223ed35eb92097d4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:aecc4d4aeea24bd960190a0d1a47a5a56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_v_l_c_media.html">VLCMedia</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_thumbnailer.html#aecc4d4aeea24bd960190a0d1a47a5a56">media</a></td></tr>
  120. <tr class="separator:aecc4d4aeea24bd960190a0d1a47a5a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a2cc0a6c7836be7d967858c67e51a5f50"><td class="memItemLeft" align="right" valign="top">CGImageRef&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_thumbnailer.html#a2cc0a6c7836be7d967858c67e51a5f50">thumbnail</a></td></tr>
  122. <tr class="separator:a2cc0a6c7836be7d967858c67e51a5f50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a14051a6f88fd60fb723c6de3aa5a7321"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_thumbnailer.html#a14051a6f88fd60fb723c6de3aa5a7321">libVLCinstance</a></td></tr>
  124. <tr class="separator:a14051a6f88fd60fb723c6de3aa5a7321"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ad183c5b8990465157f049c61c2e188a0"><td class="memItemLeft" align="right" valign="top">CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_thumbnailer.html#ad183c5b8990465157f049c61c2e188a0">thumbnailHeight</a></td></tr>
  126. <tr class="separator:ad183c5b8990465157f049c61c2e188a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a8c71e4fc706ae741252eecb95d33a055"><td class="memItemLeft" align="right" valign="top">CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_thumbnailer.html#a8c71e4fc706ae741252eecb95d33a055">thumbnailWidth</a></td></tr>
  128. <tr class="separator:a8c71e4fc706ae741252eecb95d33a055"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ab6c36054a654a28cc678082d0a1e02fa"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_media_thumbnailer.html#ab6c36054a654a28cc678082d0a1e02fa">snapshotPosition</a></td></tr>
  130. <tr class="separator:ab6c36054a654a28cc678082d0a1e02fa"><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>a facility allowing you to do thumbnails in an efficient manner </p>
  134. </div><h2 class="groupheader">Method Documentation</h2>
  135. <a class="anchor" id="a8c0bce3c2eef22eae4d8b046ce37761b"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">- (void) fetchThumbnail </td>
  141. <td></td>
  142. <td class="paramname"></td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>Starts the thumbnailing process </p>
  148. </div>
  149. </div>
  150. <a class="anchor" id="a364d20f11c696b300c42fd5eb404c3f9"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">+ (<a class="el" href="interface_v_l_c_media_thumbnailer.html">VLCMediaThumbnailer</a> *) thumbnailerWithMedia: </td>
  156. <td></td>
  157. <td class="paramtype">(<a class="el" href="interface_v_l_c_media.html">VLCMedia</a> *)&#160;</td>
  158. <td class="paramname"><em>media</em></td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey">andDelegate:</td>
  162. <td></td>
  163. <td class="paramtype">(id&lt; <a class="el" href="protocol_v_l_c_media_thumbnailer_delegate-p.html">VLCMediaThumbnailerDelegate</a> &gt;)&#160;</td>
  164. <td class="paramname"><em>delegate</em>&#160;</td>
  165. </tr>
  166. <tr>
  167. <td></td>
  168. <td></td>
  169. <td></td><td></td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>initializer </p><dl class="params"><dt>Parameters</dt><dd>
  174. <table class="params">
  175. <tr><td class="paramname">media</td><td>the media item to thumbnail </td></tr>
  176. <tr><td class="paramname">delegate</td><td>the delegate implementing the required protocol </td></tr>
  177. </table>
  178. </dd>
  179. </dl>
  180. <dl class="section return"><dt>Returns</dt><dd>the thumbnailer instance </dd></dl>
  181. <dl class="section note"><dt>Note</dt><dd>This will use the default shared library instance </dd></dl>
  182. </div>
  183. </div>
  184. <a class="anchor" id="a8b4b7e2a8aa3b3c51146916ef33dc043"></a>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">+ (<a class="el" href="interface_v_l_c_media_thumbnailer.html">VLCMediaThumbnailer</a> *) thumbnailerWithMedia: </td>
  190. <td></td>
  191. <td class="paramtype">(<a class="el" href="interface_v_l_c_media.html">VLCMedia</a> *)&#160;</td>
  192. <td class="paramname"><em>media</em></td>
  193. </tr>
  194. <tr>
  195. <td class="paramkey">delegate:</td>
  196. <td></td>
  197. <td class="paramtype">(id&lt; <a class="el" href="protocol_v_l_c_media_thumbnailer_delegate-p.html">VLCMediaThumbnailerDelegate</a> &gt;)&#160;</td>
  198. <td class="paramname"><em>delegate</em></td>
  199. </tr>
  200. <tr>
  201. <td class="paramkey">andVLCLibrary:</td>
  202. <td></td>
  203. <td class="paramtype">(<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *)&#160;</td>
  204. <td class="paramname"><em>library</em>&#160;</td>
  205. </tr>
  206. <tr>
  207. <td></td>
  208. <td></td>
  209. <td></td><td></td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>initializer </p><dl class="params"><dt>Parameters</dt><dd>
  214. <table class="params">
  215. <tr><td class="paramname">media</td><td>the media item to thumbnail </td></tr>
  216. <tr><td class="paramname">delegate</td><td>the delegate implementing the required protocol </td></tr>
  217. <tr><td class="paramname">library</td><td>a library instance, potentially configured by you in a special way </td></tr>
  218. </table>
  219. </dd>
  220. </dl>
  221. <dl class="section return"><dt>Returns</dt><dd>the thumbnailer instance </dd></dl>
  222. </div>
  223. </div>
  224. <h2 class="groupheader">Property Documentation</h2>
  225. <a class="anchor" id="a48ad5cbc29377c223ed35eb92097d4ac"></a>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="mlabels">
  229. <tr>
  230. <td class="mlabels-left">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">- (id&lt;<a class="el" href="protocol_v_l_c_media_thumbnailer_delegate-p.html">VLCMediaThumbnailerDelegate</a>&gt;) delegate</td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <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>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>delegate object associated with the thumbnailer instance implementing the required protocol </p>
  243. </div>
  244. </div>
  245. <a class="anchor" id="a14051a6f88fd60fb723c6de3aa5a7321"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">- (void*) libVLCinstance</td>
  254. </tr>
  255. </table>
  256. </td>
  257. <td class="mlabels-right">
  258. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>the libvlc instance used for thumbnailing </p><dl class="section note"><dt>Note</dt><dd>Whatever you do, using this instance is most likely wrong </dd></dl>
  263. </div>
  264. </div>
  265. <a class="anchor" id="aecc4d4aeea24bd960190a0d1a47a5a56"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="mlabels">
  269. <tr>
  270. <td class="mlabels-left">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">- (<a class="el" href="interface_v_l_c_media.html">VLCMedia</a>*) media</td>
  274. </tr>
  275. </table>
  276. </td>
  277. <td class="mlabels-right">
  278. <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>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>the media object that is being thumbnailed </p>
  283. </div>
  284. </div>
  285. <a class="anchor" id="ab6c36054a654a28cc678082d0a1e02fa"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">- (float) snapshotPosition</td>
  294. </tr>
  295. </table>
  296. </td>
  297. <td class="mlabels-right">
  298. <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>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>Snapshot Position You shouldn't change this after -fetchThumbnail has been called. </p><dl class="section return"><dt>Returns</dt><dd>snapshot position. Default value 0.5 </dd></dl>
  303. </div>
  304. </div>
  305. <a class="anchor" id="a2cc0a6c7836be7d967858c67e51a5f50"></a>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="mlabels">
  309. <tr>
  310. <td class="mlabels-left">
  311. <table class="memname">
  312. <tr>
  313. <td class="memname">- (CGImageRef) thumbnail</td>
  314. </tr>
  315. </table>
  316. </td>
  317. <td class="mlabels-right">
  318. <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>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. <p>The thumbnail created for the media object </p>
  323. </div>
  324. </div>
  325. <a class="anchor" id="ad183c5b8990465157f049c61c2e188a0"></a>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">- (CGFloat) thumbnailHeight</td>
  334. </tr>
  335. </table>
  336. </td>
  337. <td class="mlabels-right">
  338. <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>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Thumbnail Height You shouldn't change this after -fetchThumbnail has been called. </p><dl class="section return"><dt>Returns</dt><dd>thumbnail height. Default value 240. </dd></dl>
  343. </div>
  344. </div>
  345. <a class="anchor" id="a8c71e4fc706ae741252eecb95d33a055"></a>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="mlabels">
  349. <tr>
  350. <td class="mlabels-left">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">- (CGFloat) thumbnailWidth</td>
  354. </tr>
  355. </table>
  356. </td>
  357. <td class="mlabels-right">
  358. <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>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Thumbnail Width You shouldn't change this after -fetchThumbnail has been called. </p><dl class="section return"><dt>Returns</dt><dd>thumbnail height. Default value 320 </dd></dl>
  363. </div>
  364. </div>
  365. <hr/>The documentation for this class was generated from the following file:<ul>
  366. <li>Headers/Public/<a class="el" href="_v_l_c_media_thumbnailer_8h_source.html">VLCMediaThumbnailer.h</a></li>
  367. </ul>
  368. </div><!-- contents -->
  369. <!-- start footer part -->
  370. <hr class="footer"/><address class="footer"><small>
  371. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  372. <img class="footer" src="doxygen.png" alt="doxygen"/>
  373. </a> 1.8.11
  374. </small></address>
  375. </body>
  376. </html>