interface_v_l_c_transcoder.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  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: VLCTranscoder Class Reference</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><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Instance Methods</a> &#124;
  64. <a href="#properties">Properties</a> &#124;
  65. <a href="interface_v_l_c_transcoder-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">VLCTranscoder Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#import &lt;<a class="el" href="_v_l_c_transcoder_8h_source.html">VLCTranscoder.h</a>&gt;</code></p>
  71. <div class="dynheader">
  72. Inheritance diagram for VLCTranscoder:</div>
  73. <div class="dyncontent">
  74. <div class="center">
  75. <img src="interface_v_l_c_transcoder.png" alt=""/>
  76. </div></div>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Instance Methods</h2></td></tr>
  80. <tr class="memitem:a079c51b9dad4206aae2043ce6f83671b"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_transcoder.html#a079c51b9dad4206aae2043ce6f83671b">reencodeAndMuxSRTFile:toMP4File:outputPath:</a></td></tr>
  81. <tr class="separator:a079c51b9dad4206aae2043ce6f83671b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. </table><table class="memberdecls">
  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  84. Properties</h2></td></tr>
  85. <tr class="memitem:a66e9bdba467fe831193fc8633b11dfe2"><td class="memItemLeft" align="right" valign="top">id&lt; <a class="el" href="protocol_v_l_c_transcoder_delegate-p.html">VLCTranscoderDelegate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_transcoder.html#a66e9bdba467fe831193fc8633b11dfe2">delegate</a></td></tr>
  86. <tr class="separator:a66e9bdba467fe831193fc8633b11dfe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table>
  88. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  89. <div class="textblock"><p>Provides an object to convert a subtitle file and moviefile into one. </p>
  90. </div><h2 class="groupheader">Method Documentation</h2>
  91. <a id="a079c51b9dad4206aae2043ce6f83671b"></a>
  92. <h2 class="memtitle"><span class="permalink"><a href="#a079c51b9dad4206aae2043ce6f83671b">&#9670;&nbsp;</a></span>reencodeAndMuxSRTFile:toMP4File:outputPath:()</h2>
  93. <div class="memitem">
  94. <div class="memproto">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname">- (BOOL) reencodeAndMuxSRTFile: </td>
  98. <td></td>
  99. <td class="paramtype">(NSString *)&#160;</td>
  100. <td class="paramname"><em>srtPath</em></td>
  101. </tr>
  102. <tr>
  103. <td class="paramkey">toMP4File:</td>
  104. <td></td>
  105. <td class="paramtype">(NSString *)&#160;</td>
  106. <td class="paramname"><em>mp4Path</em></td>
  107. </tr>
  108. <tr>
  109. <td class="paramkey">outputPath:</td>
  110. <td></td>
  111. <td class="paramtype">(NSString *)&#160;</td>
  112. <td class="paramname"><em>outPath</em>&#160;</td>
  113. </tr>
  114. <tr>
  115. <td></td>
  116. <td></td>
  117. <td></td><td></td>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>Reencode and remuxes an srt and mp4 file to an mkv file with embedded subtitles either with VideoToolbox-based H264 encoding or VP80 is Videotoolbox is not available </p><dl class="params"><dt>Parameters</dt><dd>
  122. <table class="params">
  123. <tr><td class="paramname">srtPath</td><td>path to srt file </td></tr>
  124. <tr><td class="paramname">mp4Path</td><td>path to mp4 file </td></tr>
  125. <tr><td class="paramname">outPath</td><td>path where the new file should be written to </td></tr>
  126. </table>
  127. </dd>
  128. </dl>
  129. <dl class="section return"><dt>Returns</dt><dd>an BOOL with the success status, returns NO if the subtitle file is not an srt or mp4File is not an mp4 file or the files don't exist at that path or transcoding failed for other reasons </dd></dl>
  130. </div>
  131. </div>
  132. <h2 class="groupheader">Property Documentation</h2>
  133. <a id="a66e9bdba467fe831193fc8633b11dfe2"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#a66e9bdba467fe831193fc8633b11dfe2">&#9670;&nbsp;</a></span>delegate</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="mlabels">
  138. <tr>
  139. <td class="mlabels-left">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">- (id&lt;<a class="el" href="protocol_v_l_c_transcoder_delegate-p.html">VLCTranscoderDelegate</a>&gt;) delegate</td>
  143. </tr>
  144. </table>
  145. </td>
  146. <td class="mlabels-right">
  147. <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>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>the delegate object implementing the optional protocol </p>
  152. </div>
  153. </div>
  154. <hr/>The documentation for this class was generated from the following file:<ul>
  155. <li>Headers/Public/<a class="el" href="_v_l_c_transcoder_8h_source.html">VLCTranscoder.h</a></li>
  156. </ul>
  157. </div><!-- contents -->
  158. <!-- start footer part -->
  159. <hr class="footer"/><address class="footer"><small>
  160. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  161. <img class="footer" src="doxygen.png" alt="doxygen"/>
  162. </a> 1.8.15
  163. </small></address>
  164. </body>
  165. </html>