VideoWriter.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_312) on Wed Jun 28 12:47:24 UTC 2023 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>VideoWriter (OpenCV 4.8.0 Java documentation)</title>
  8. <meta name="date" content="2023-06-28">
  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10. <script type="text/javascript" src="../../../script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="VideoWriter (OpenCV 4.8.0 Java documentation)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
  23. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../../../overview-summary.html">Overview</a></li>
  42. <li><a href="package-summary.html">Package</a></li>
  43. <li class="navBarCell1Rev">Class</li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../index-all.html">Index</a></li>
  46. <li><a href="../../../help-doc.html">Help</a></li>
  47. </ul>
  48. <div class="aboutLanguage">
  49. <script>
  50. var url = window.location.href;
  51. var pos = url.lastIndexOf('/javadoc/');
  52. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  53. var script = document.createElement('script');
  54. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  55. document.getElementsByTagName('head')[0].appendChild(script);
  56. </script>
  57. </div>
  58. </div>
  59. <div class="subNav">
  60. <ul class="navList">
  61. <li><a href="../../../org/opencv/videoio/Videoio.html" title="class in org.opencv.videoio"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  62. <li>Next&nbsp;Class</li>
  63. </ul>
  64. <ul class="navList">
  65. <li><a href="../../../index.html?org/opencv/videoio/VideoWriter.html" target="_top">Frames</a></li>
  66. <li><a href="VideoWriter.html" target="_top">No&nbsp;Frames</a></li>
  67. </ul>
  68. <ul class="navList" id="allclasses_navbar_top">
  69. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  70. </ul>
  71. <div>
  72. <script type="text/javascript"><!--
  73. allClassesLink = document.getElementById("allclasses_navbar_top");
  74. if(window==top) {
  75. allClassesLink.style.display = "block";
  76. }
  77. else {
  78. allClassesLink.style.display = "none";
  79. }
  80. //-->
  81. </script>
  82. </div>
  83. <div>
  84. <ul class="subNavList">
  85. <li>Summary:&nbsp;</li>
  86. <li>Nested&nbsp;|&nbsp;</li>
  87. <li>Field&nbsp;|&nbsp;</li>
  88. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  89. <li><a href="#method.summary">Method</a></li>
  90. </ul>
  91. <ul class="subNavList">
  92. <li>Detail:&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  95. <li><a href="#method.detail">Method</a></li>
  96. </ul>
  97. </div>
  98. <a name="skip.navbar.top">
  99. <!-- -->
  100. </a></div>
  101. <!-- ========= END OF TOP NAVBAR ========= -->
  102. <!-- ======== START OF CLASS DATA ======== -->
  103. <div class="header">
  104. <div class="subTitle">org.opencv.videoio</div>
  105. <h2 title="Class VideoWriter" class="title">Class VideoWriter</h2>
  106. </div>
  107. <div class="contentContainer">
  108. <ul class="inheritance">
  109. <li>java.lang.Object</li>
  110. <li>
  111. <ul class="inheritance">
  112. <li>org.opencv.videoio.VideoWriter</li>
  113. </ul>
  114. </li>
  115. </ul>
  116. <div class="description">
  117. <ul class="blockList">
  118. <li class="blockList">
  119. <hr>
  120. <br>
  121. <pre>public class <span class="typeNameLabel">VideoWriter</span>
  122. extends java.lang.Object</pre>
  123. <div class="block">Video writer class.
  124. The class provides C++ API for writing video files or image sequences.</div>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#VideoWriter--">VideoWriter</a></span>()</code>
  144. <div class="block">Default constructors
  145. The constructors/functions initialize video writers.</div>
  146. </td>
  147. </tr>
  148. <tr class="rowColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#VideoWriter-java.lang.String-int-double-org.opencv.core.Size-">VideoWriter</a></span>(java.lang.String&nbsp;filename,
  150. int&nbsp;fourcc,
  151. double&nbsp;fps,
  152. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</code>&nbsp;</td>
  153. </tr>
  154. <tr class="altColor">
  155. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#VideoWriter-java.lang.String-int-double-org.opencv.core.Size-boolean-">VideoWriter</a></span>(java.lang.String&nbsp;filename,
  156. int&nbsp;fourcc,
  157. double&nbsp;fps,
  158. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  159. boolean&nbsp;isColor)</code>&nbsp;</td>
  160. </tr>
  161. <tr class="rowColor">
  162. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#VideoWriter-java.lang.String-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">VideoWriter</a></span>(java.lang.String&nbsp;filename,
  163. int&nbsp;fourcc,
  164. double&nbsp;fps,
  165. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  166. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</code>
  167. <div class="block">The <code>params</code> parameter allows to specify extra encoder parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ...</div>
  168. </td>
  169. </tr>
  170. <tr class="altColor">
  171. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#VideoWriter-java.lang.String-int-int-double-org.opencv.core.Size-">VideoWriter</a></span>(java.lang.String&nbsp;filename,
  172. int&nbsp;apiPreference,
  173. int&nbsp;fourcc,
  174. double&nbsp;fps,
  175. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</code>
  176. <div class="block">The <code>apiPreference</code> parameter allows to specify API backends to use.</div>
  177. </td>
  178. </tr>
  179. <tr class="rowColor">
  180. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#VideoWriter-java.lang.String-int-int-double-org.opencv.core.Size-boolean-">VideoWriter</a></span>(java.lang.String&nbsp;filename,
  181. int&nbsp;apiPreference,
  182. int&nbsp;fourcc,
  183. double&nbsp;fps,
  184. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  185. boolean&nbsp;isColor)</code>
  186. <div class="block">The <code>apiPreference</code> parameter allows to specify API backends to use.</div>
  187. </td>
  188. </tr>
  189. <tr class="altColor">
  190. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#VideoWriter-java.lang.String-int-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">VideoWriter</a></span>(java.lang.String&nbsp;filename,
  191. int&nbsp;apiPreference,
  192. int&nbsp;fourcc,
  193. double&nbsp;fps,
  194. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  195. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</code>&nbsp;</td>
  196. </tr>
  197. </table>
  198. </li>
  199. </ul>
  200. <!-- ========== METHOD SUMMARY =========== -->
  201. <ul class="blockList">
  202. <li class="blockList"><a name="method.summary">
  203. <!-- -->
  204. </a>
  205. <h3>Method Summary</h3>
  206. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  207. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  208. <tr>
  209. <th class="colFirst" scope="col">Modifier and Type</th>
  210. <th class="colLast" scope="col">Method and Description</th>
  211. </tr>
  212. <tr id="i0" class="altColor">
  213. <td class="colFirst"><code>static <a href="../../../org/opencv/videoio/VideoWriter.html" title="class in org.opencv.videoio">VideoWriter</a></code></td>
  214. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#Z:Z__fromPtr__-long-">__fromPtr__</a></span>(long&nbsp;addr)</code>&nbsp;</td>
  215. </tr>
  216. <tr id="i1" class="rowColor">
  217. <td class="colFirst"><code>static int</code></td>
  218. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#fourcc-char-char-char-char-">fourcc</a></span>(char&nbsp;c1,
  219. char&nbsp;c2,
  220. char&nbsp;c3,
  221. char&nbsp;c4)</code>
  222. <div class="block">Concatenates 4 chars to a fourcc code</div>
  223. </td>
  224. </tr>
  225. <tr id="i2" class="altColor">
  226. <td class="colFirst"><code>double</code></td>
  227. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#get-int-">get</a></span>(int&nbsp;propId)</code>
  228. <div class="block">Returns the specified VideoWriter property</div>
  229. </td>
  230. </tr>
  231. <tr id="i3" class="rowColor">
  232. <td class="colFirst"><code>java.lang.String</code></td>
  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#getBackendName--">getBackendName</a></span>()</code>
  234. <div class="block">Returns used backend API name
  235. <b>Note:</b> Stream should be opened.</div>
  236. </td>
  237. </tr>
  238. <tr id="i4" class="altColor">
  239. <td class="colFirst"><code>long</code></td>
  240. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#getNativeObjAddr--">getNativeObjAddr</a></span>()</code>&nbsp;</td>
  241. </tr>
  242. <tr id="i5" class="rowColor">
  243. <td class="colFirst"><code>boolean</code></td>
  244. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#isOpened--">isOpened</a></span>()</code>
  245. <div class="block">Returns true if video writer has been successfully initialized.</div>
  246. </td>
  247. </tr>
  248. <tr id="i6" class="altColor">
  249. <td class="colFirst"><code>boolean</code></td>
  250. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#open-java.lang.String-int-double-org.opencv.core.Size-">open</a></span>(java.lang.String&nbsp;filename,
  251. int&nbsp;fourcc,
  252. double&nbsp;fps,
  253. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</code>
  254. <div class="block">Initializes or reinitializes video writer.</div>
  255. </td>
  256. </tr>
  257. <tr id="i7" class="rowColor">
  258. <td class="colFirst"><code>boolean</code></td>
  259. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#open-java.lang.String-int-double-org.opencv.core.Size-boolean-">open</a></span>(java.lang.String&nbsp;filename,
  260. int&nbsp;fourcc,
  261. double&nbsp;fps,
  262. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  263. boolean&nbsp;isColor)</code>
  264. <div class="block">Initializes or reinitializes video writer.</div>
  265. </td>
  266. </tr>
  267. <tr id="i8" class="altColor">
  268. <td class="colFirst"><code>boolean</code></td>
  269. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#open-java.lang.String-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">open</a></span>(java.lang.String&nbsp;filename,
  270. int&nbsp;fourcc,
  271. double&nbsp;fps,
  272. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  273. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</code>&nbsp;</td>
  274. </tr>
  275. <tr id="i9" class="rowColor">
  276. <td class="colFirst"><code>boolean</code></td>
  277. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#open-java.lang.String-int-int-double-org.opencv.core.Size-">open</a></span>(java.lang.String&nbsp;filename,
  278. int&nbsp;apiPreference,
  279. int&nbsp;fourcc,
  280. double&nbsp;fps,
  281. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</code>&nbsp;</td>
  282. </tr>
  283. <tr id="i10" class="altColor">
  284. <td class="colFirst"><code>boolean</code></td>
  285. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#open-java.lang.String-int-int-double-org.opencv.core.Size-boolean-">open</a></span>(java.lang.String&nbsp;filename,
  286. int&nbsp;apiPreference,
  287. int&nbsp;fourcc,
  288. double&nbsp;fps,
  289. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  290. boolean&nbsp;isColor)</code>&nbsp;</td>
  291. </tr>
  292. <tr id="i11" class="rowColor">
  293. <td class="colFirst"><code>boolean</code></td>
  294. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#open-java.lang.String-int-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">open</a></span>(java.lang.String&nbsp;filename,
  295. int&nbsp;apiPreference,
  296. int&nbsp;fourcc,
  297. double&nbsp;fps,
  298. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  299. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</code>&nbsp;</td>
  300. </tr>
  301. <tr id="i12" class="altColor">
  302. <td class="colFirst"><code>void</code></td>
  303. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#release--">release</a></span>()</code>
  304. <div class="block">Closes the video writer.</div>
  305. </td>
  306. </tr>
  307. <tr id="i13" class="rowColor">
  308. <td class="colFirst"><code>boolean</code></td>
  309. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#set-int-double-">set</a></span>(int&nbsp;propId,
  310. double&nbsp;value)</code>
  311. <div class="block">Sets a property in the VideoWriter.</div>
  312. </td>
  313. </tr>
  314. <tr id="i14" class="altColor">
  315. <td class="colFirst"><code>void</code></td>
  316. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/videoio/VideoWriter.html#write-org.opencv.core.Mat-">write</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;image)</code>
  317. <div class="block">Writes the next video frame</div>
  318. </td>
  319. </tr>
  320. </table>
  321. <ul class="blockList">
  322. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  323. <!-- -->
  324. </a>
  325. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  326. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  327. </ul>
  328. </li>
  329. </ul>
  330. </li>
  331. </ul>
  332. </div>
  333. <div class="details">
  334. <ul class="blockList">
  335. <li class="blockList">
  336. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  337. <ul class="blockList">
  338. <li class="blockList"><a name="constructor.detail">
  339. <!-- -->
  340. </a>
  341. <h3>Constructor Detail</h3>
  342. <a name="VideoWriter--">
  343. <!-- -->
  344. </a>
  345. <ul class="blockList">
  346. <li class="blockList">
  347. <h4>VideoWriter</h4>
  348. <pre>public&nbsp;VideoWriter()</pre>
  349. <div class="block">Default constructors
  350. The constructors/functions initialize video writers.
  351. <ul>
  352. <li>
  353. On Linux FFMPEG is used to write videos;
  354. </li>
  355. <li>
  356. On Windows FFMPEG or MSWF or DSHOW is used;
  357. </li>
  358. <li>
  359. On MacOSX AVFoundation is used.
  360. </li>
  361. </ul></div>
  362. </li>
  363. </ul>
  364. <a name="VideoWriter-java.lang.String-int-double-org.opencv.core.Size-">
  365. <!-- -->
  366. </a>
  367. <ul class="blockList">
  368. <li class="blockList">
  369. <h4>VideoWriter</h4>
  370. <pre>public&nbsp;VideoWriter(java.lang.String&nbsp;filename,
  371. int&nbsp;fourcc,
  372. double&nbsp;fps,
  373. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</pre>
  374. <dl>
  375. <dt><span class="paramLabel">Parameters:</span></dt>
  376. <dd><code>filename</code> - Name of the output video file.</dd>
  377. <dd><code>fourcc</code> - 4-character code of codec used to compress the frames. For example,
  378. VideoWriter::fourcc('P','I','M','1') is a MPEG-1 codec, VideoWriter::fourcc('M','J','P','G')
  379. is a motion-jpeg codec etc. List of codes can be obtained at
  380. [MSDN](https://docs.microsoft.com/en-us/windows/win32/medfound/video-fourccs) page
  381. or with this [archived page](https://web.archive.org/web/20220316062600/http://www.fourcc.org/codecs.php)
  382. of the fourcc site for a more complete list). FFMPEG backend with MP4 container natively uses
  383. other values as fourcc code: see [ObjectType](http://mp4ra.org/#/codecs),
  384. so you may receive a warning message from OpenCV about fourcc code conversion.</dd>
  385. <dd><code>fps</code> - Framerate of the created video stream.</dd>
  386. <dd><code>frameSize</code> - Size of the video frames.
  387. will work with grayscale frames.
  388. <b>Tips</b>:
  389. <ul>
  390. <li>
  391. With some backends <code>fourcc=-1</code> pops up the codec selection dialog from the system.
  392. </li>
  393. <li>
  394. To save image sequence use a proper filename (eg. <code>img_%02d.jpg</code>) and <code>fourcc=0</code>
  395. OR <code>fps=0</code>. Use uncompressed image format (eg. <code>img_%02d.BMP</code>) to save raw frames.
  396. </li>
  397. <li>
  398. Most codecs are lossy. If you want lossless video file you need to use a lossless codecs
  399. (eg. FFMPEG FFV1, Huffman HFYU, Lagarith LAGS, etc...)
  400. </li>
  401. <li>
  402. If FFMPEG is enabled, using <code>codec=0; fps=0;</code> you can create an uncompressed (raw) video file.
  403. </li>
  404. </ul></dd>
  405. </dl>
  406. </li>
  407. </ul>
  408. <a name="VideoWriter-java.lang.String-int-double-org.opencv.core.Size-boolean-">
  409. <!-- -->
  410. </a>
  411. <ul class="blockList">
  412. <li class="blockList">
  413. <h4>VideoWriter</h4>
  414. <pre>public&nbsp;VideoWriter(java.lang.String&nbsp;filename,
  415. int&nbsp;fourcc,
  416. double&nbsp;fps,
  417. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  418. boolean&nbsp;isColor)</pre>
  419. <dl>
  420. <dt><span class="paramLabel">Parameters:</span></dt>
  421. <dd><code>filename</code> - Name of the output video file.</dd>
  422. <dd><code>fourcc</code> - 4-character code of codec used to compress the frames. For example,
  423. VideoWriter::fourcc('P','I','M','1') is a MPEG-1 codec, VideoWriter::fourcc('M','J','P','G')
  424. is a motion-jpeg codec etc. List of codes can be obtained at
  425. [MSDN](https://docs.microsoft.com/en-us/windows/win32/medfound/video-fourccs) page
  426. or with this [archived page](https://web.archive.org/web/20220316062600/http://www.fourcc.org/codecs.php)
  427. of the fourcc site for a more complete list). FFMPEG backend with MP4 container natively uses
  428. other values as fourcc code: see [ObjectType](http://mp4ra.org/#/codecs),
  429. so you may receive a warning message from OpenCV about fourcc code conversion.</dd>
  430. <dd><code>fps</code> - Framerate of the created video stream.</dd>
  431. <dd><code>frameSize</code> - Size of the video frames.</dd>
  432. <dd><code>isColor</code> - If it is not zero, the encoder will expect and encode color frames, otherwise it
  433. will work with grayscale frames.
  434. <b>Tips</b>:
  435. <ul>
  436. <li>
  437. With some backends <code>fourcc=-1</code> pops up the codec selection dialog from the system.
  438. </li>
  439. <li>
  440. To save image sequence use a proper filename (eg. <code>img_%02d.jpg</code>) and <code>fourcc=0</code>
  441. OR <code>fps=0</code>. Use uncompressed image format (eg. <code>img_%02d.BMP</code>) to save raw frames.
  442. </li>
  443. <li>
  444. Most codecs are lossy. If you want lossless video file you need to use a lossless codecs
  445. (eg. FFMPEG FFV1, Huffman HFYU, Lagarith LAGS, etc...)
  446. </li>
  447. <li>
  448. If FFMPEG is enabled, using <code>codec=0; fps=0;</code> you can create an uncompressed (raw) video file.
  449. </li>
  450. </ul></dd>
  451. </dl>
  452. </li>
  453. </ul>
  454. <a name="VideoWriter-java.lang.String-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">
  455. <!-- -->
  456. </a>
  457. <ul class="blockList">
  458. <li class="blockList">
  459. <h4>VideoWriter</h4>
  460. <pre>public&nbsp;VideoWriter(java.lang.String&nbsp;filename,
  461. int&nbsp;fourcc,
  462. double&nbsp;fps,
  463. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  464. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</pre>
  465. <div class="block">The <code>params</code> parameter allows to specify extra encoder parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ... .)
  466. see cv::VideoWriterProperties</div>
  467. <dl>
  468. <dt><span class="paramLabel">Parameters:</span></dt>
  469. <dd><code>filename</code> - automatically generated</dd>
  470. <dd><code>fourcc</code> - automatically generated</dd>
  471. <dd><code>fps</code> - automatically generated</dd>
  472. <dd><code>frameSize</code> - automatically generated</dd>
  473. <dd><code>params</code> - automatically generated</dd>
  474. </dl>
  475. </li>
  476. </ul>
  477. <a name="VideoWriter-java.lang.String-int-int-double-org.opencv.core.Size-">
  478. <!-- -->
  479. </a>
  480. <ul class="blockList">
  481. <li class="blockList">
  482. <h4>VideoWriter</h4>
  483. <pre>public&nbsp;VideoWriter(java.lang.String&nbsp;filename,
  484. int&nbsp;apiPreference,
  485. int&nbsp;fourcc,
  486. double&nbsp;fps,
  487. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</pre>
  488. <div class="block">The <code>apiPreference</code> parameter allows to specify API backends to use. Can be used to enforce a specific reader implementation
  489. if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_GSTREAMER.</div>
  490. <dl>
  491. <dt><span class="paramLabel">Parameters:</span></dt>
  492. <dd><code>filename</code> - automatically generated</dd>
  493. <dd><code>apiPreference</code> - automatically generated</dd>
  494. <dd><code>fourcc</code> - automatically generated</dd>
  495. <dd><code>fps</code> - automatically generated</dd>
  496. <dd><code>frameSize</code> - automatically generated</dd>
  497. </dl>
  498. </li>
  499. </ul>
  500. <a name="VideoWriter-java.lang.String-int-int-double-org.opencv.core.Size-boolean-">
  501. <!-- -->
  502. </a>
  503. <ul class="blockList">
  504. <li class="blockList">
  505. <h4>VideoWriter</h4>
  506. <pre>public&nbsp;VideoWriter(java.lang.String&nbsp;filename,
  507. int&nbsp;apiPreference,
  508. int&nbsp;fourcc,
  509. double&nbsp;fps,
  510. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  511. boolean&nbsp;isColor)</pre>
  512. <div class="block">The <code>apiPreference</code> parameter allows to specify API backends to use. Can be used to enforce a specific reader implementation
  513. if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_GSTREAMER.</div>
  514. <dl>
  515. <dt><span class="paramLabel">Parameters:</span></dt>
  516. <dd><code>filename</code> - automatically generated</dd>
  517. <dd><code>apiPreference</code> - automatically generated</dd>
  518. <dd><code>fourcc</code> - automatically generated</dd>
  519. <dd><code>fps</code> - automatically generated</dd>
  520. <dd><code>frameSize</code> - automatically generated</dd>
  521. <dd><code>isColor</code> - automatically generated</dd>
  522. </dl>
  523. </li>
  524. </ul>
  525. <a name="VideoWriter-java.lang.String-int-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">
  526. <!-- -->
  527. </a>
  528. <ul class="blockListLast">
  529. <li class="blockList">
  530. <h4>VideoWriter</h4>
  531. <pre>public&nbsp;VideoWriter(java.lang.String&nbsp;filename,
  532. int&nbsp;apiPreference,
  533. int&nbsp;fourcc,
  534. double&nbsp;fps,
  535. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  536. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</pre>
  537. </li>
  538. </ul>
  539. </li>
  540. </ul>
  541. <!-- ============ METHOD DETAIL ========== -->
  542. <ul class="blockList">
  543. <li class="blockList"><a name="method.detail">
  544. <!-- -->
  545. </a>
  546. <h3>Method Detail</h3>
  547. <a name="Z:Z__fromPtr__-long-">
  548. <!-- -->
  549. </a>
  550. <ul class="blockList">
  551. <li class="blockList">
  552. <h4>__fromPtr__</h4>
  553. <pre>public static&nbsp;<a href="../../../org/opencv/videoio/VideoWriter.html" title="class in org.opencv.videoio">VideoWriter</a>&nbsp;__fromPtr__(long&nbsp;addr)</pre>
  554. </li>
  555. </ul>
  556. <a name="fourcc-char-char-char-char-">
  557. <!-- -->
  558. </a>
  559. <ul class="blockList">
  560. <li class="blockList">
  561. <h4>fourcc</h4>
  562. <pre>public static&nbsp;int&nbsp;fourcc(char&nbsp;c1,
  563. char&nbsp;c2,
  564. char&nbsp;c3,
  565. char&nbsp;c4)</pre>
  566. <div class="block">Concatenates 4 chars to a fourcc code</div>
  567. <dl>
  568. <dt><span class="paramLabel">Parameters:</span></dt>
  569. <dd><code>c1</code> - automatically generated</dd>
  570. <dd><code>c2</code> - automatically generated</dd>
  571. <dd><code>c3</code> - automatically generated</dd>
  572. <dd><code>c4</code> - automatically generated</dd>
  573. <dt><span class="returnLabel">Returns:</span></dt>
  574. <dd>a fourcc code
  575. This static method constructs the fourcc code of the codec to be used in the constructor
  576. VideoWriter::VideoWriter or VideoWriter::open.</dd>
  577. </dl>
  578. </li>
  579. </ul>
  580. <a name="get-int-">
  581. <!-- -->
  582. </a>
  583. <ul class="blockList">
  584. <li class="blockList">
  585. <h4>get</h4>
  586. <pre>public&nbsp;double&nbsp;get(int&nbsp;propId)</pre>
  587. <div class="block">Returns the specified VideoWriter property</div>
  588. <dl>
  589. <dt><span class="paramLabel">Parameters:</span></dt>
  590. <dd><code>propId</code> - Property identifier from cv::VideoWriterProperties (eg. cv::VIDEOWRITER_PROP_QUALITY)
  591. or one of REF: videoio_flags_others</dd>
  592. <dt><span class="returnLabel">Returns:</span></dt>
  593. <dd>Value for the specified property. Value 0 is returned when querying a property that is
  594. not supported by the backend used by the VideoWriter instance.</dd>
  595. </dl>
  596. </li>
  597. </ul>
  598. <a name="getBackendName--">
  599. <!-- -->
  600. </a>
  601. <ul class="blockList">
  602. <li class="blockList">
  603. <h4>getBackendName</h4>
  604. <pre>public&nbsp;java.lang.String&nbsp;getBackendName()</pre>
  605. <div class="block">Returns used backend API name
  606. <b>Note:</b> Stream should be opened.</div>
  607. <dl>
  608. <dt><span class="returnLabel">Returns:</span></dt>
  609. <dd>automatically generated</dd>
  610. </dl>
  611. </li>
  612. </ul>
  613. <a name="getNativeObjAddr--">
  614. <!-- -->
  615. </a>
  616. <ul class="blockList">
  617. <li class="blockList">
  618. <h4>getNativeObjAddr</h4>
  619. <pre>public&nbsp;long&nbsp;getNativeObjAddr()</pre>
  620. </li>
  621. </ul>
  622. <a name="isOpened--">
  623. <!-- -->
  624. </a>
  625. <ul class="blockList">
  626. <li class="blockList">
  627. <h4>isOpened</h4>
  628. <pre>public&nbsp;boolean&nbsp;isOpened()</pre>
  629. <div class="block">Returns true if video writer has been successfully initialized.</div>
  630. <dl>
  631. <dt><span class="returnLabel">Returns:</span></dt>
  632. <dd>automatically generated</dd>
  633. </dl>
  634. </li>
  635. </ul>
  636. <a name="open-java.lang.String-int-double-org.opencv.core.Size-">
  637. <!-- -->
  638. </a>
  639. <ul class="blockList">
  640. <li class="blockList">
  641. <h4>open</h4>
  642. <pre>public&nbsp;boolean&nbsp;open(java.lang.String&nbsp;filename,
  643. int&nbsp;fourcc,
  644. double&nbsp;fps,
  645. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</pre>
  646. <div class="block">Initializes or reinitializes video writer.
  647. The method opens video writer. Parameters are the same as in the constructor
  648. VideoWriter::VideoWriter.</div>
  649. <dl>
  650. <dt><span class="paramLabel">Parameters:</span></dt>
  651. <dd><code>filename</code> - automatically generated</dd>
  652. <dd><code>fourcc</code> - automatically generated</dd>
  653. <dd><code>fps</code> - automatically generated</dd>
  654. <dd><code>frameSize</code> - automatically generated</dd>
  655. <dt><span class="returnLabel">Returns:</span></dt>
  656. <dd><code>true</code> if video writer has been successfully initialized
  657. The method first calls VideoWriter::release to close the already opened file.</dd>
  658. </dl>
  659. </li>
  660. </ul>
  661. <a name="open-java.lang.String-int-double-org.opencv.core.Size-boolean-">
  662. <!-- -->
  663. </a>
  664. <ul class="blockList">
  665. <li class="blockList">
  666. <h4>open</h4>
  667. <pre>public&nbsp;boolean&nbsp;open(java.lang.String&nbsp;filename,
  668. int&nbsp;fourcc,
  669. double&nbsp;fps,
  670. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  671. boolean&nbsp;isColor)</pre>
  672. <div class="block">Initializes or reinitializes video writer.
  673. The method opens video writer. Parameters are the same as in the constructor
  674. VideoWriter::VideoWriter.</div>
  675. <dl>
  676. <dt><span class="paramLabel">Parameters:</span></dt>
  677. <dd><code>filename</code> - automatically generated</dd>
  678. <dd><code>fourcc</code> - automatically generated</dd>
  679. <dd><code>fps</code> - automatically generated</dd>
  680. <dd><code>frameSize</code> - automatically generated</dd>
  681. <dd><code>isColor</code> - automatically generated</dd>
  682. <dt><span class="returnLabel">Returns:</span></dt>
  683. <dd><code>true</code> if video writer has been successfully initialized
  684. The method first calls VideoWriter::release to close the already opened file.</dd>
  685. </dl>
  686. </li>
  687. </ul>
  688. <a name="open-java.lang.String-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">
  689. <!-- -->
  690. </a>
  691. <ul class="blockList">
  692. <li class="blockList">
  693. <h4>open</h4>
  694. <pre>public&nbsp;boolean&nbsp;open(java.lang.String&nbsp;filename,
  695. int&nbsp;fourcc,
  696. double&nbsp;fps,
  697. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  698. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</pre>
  699. </li>
  700. </ul>
  701. <a name="open-java.lang.String-int-int-double-org.opencv.core.Size-">
  702. <!-- -->
  703. </a>
  704. <ul class="blockList">
  705. <li class="blockList">
  706. <h4>open</h4>
  707. <pre>public&nbsp;boolean&nbsp;open(java.lang.String&nbsp;filename,
  708. int&nbsp;apiPreference,
  709. int&nbsp;fourcc,
  710. double&nbsp;fps,
  711. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize)</pre>
  712. </li>
  713. </ul>
  714. <a name="open-java.lang.String-int-int-double-org.opencv.core.Size-boolean-">
  715. <!-- -->
  716. </a>
  717. <ul class="blockList">
  718. <li class="blockList">
  719. <h4>open</h4>
  720. <pre>public&nbsp;boolean&nbsp;open(java.lang.String&nbsp;filename,
  721. int&nbsp;apiPreference,
  722. int&nbsp;fourcc,
  723. double&nbsp;fps,
  724. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  725. boolean&nbsp;isColor)</pre>
  726. </li>
  727. </ul>
  728. <a name="open-java.lang.String-int-int-double-org.opencv.core.Size-org.opencv.core.MatOfInt-">
  729. <!-- -->
  730. </a>
  731. <ul class="blockList">
  732. <li class="blockList">
  733. <h4>open</h4>
  734. <pre>public&nbsp;boolean&nbsp;open(java.lang.String&nbsp;filename,
  735. int&nbsp;apiPreference,
  736. int&nbsp;fourcc,
  737. double&nbsp;fps,
  738. <a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;frameSize,
  739. <a href="../../../org/opencv/core/MatOfInt.html" title="class in org.opencv.core">MatOfInt</a>&nbsp;params)</pre>
  740. </li>
  741. </ul>
  742. <a name="release--">
  743. <!-- -->
  744. </a>
  745. <ul class="blockList">
  746. <li class="blockList">
  747. <h4>release</h4>
  748. <pre>public&nbsp;void&nbsp;release()</pre>
  749. <div class="block">Closes the video writer.
  750. The method is automatically called by subsequent VideoWriter::open and by the VideoWriter
  751. destructor.</div>
  752. </li>
  753. </ul>
  754. <a name="set-int-double-">
  755. <!-- -->
  756. </a>
  757. <ul class="blockList">
  758. <li class="blockList">
  759. <h4>set</h4>
  760. <pre>public&nbsp;boolean&nbsp;set(int&nbsp;propId,
  761. double&nbsp;value)</pre>
  762. <div class="block">Sets a property in the VideoWriter.</div>
  763. <dl>
  764. <dt><span class="paramLabel">Parameters:</span></dt>
  765. <dd><code>propId</code> - Property identifier from cv::VideoWriterProperties (eg. cv::VIDEOWRITER_PROP_QUALITY)
  766. or one of REF: videoio_flags_others</dd>
  767. <dd><code>value</code> - Value of the property.</dd>
  768. <dt><span class="returnLabel">Returns:</span></dt>
  769. <dd><code>true</code> if the property is supported by the backend used by the VideoWriter instance.</dd>
  770. </dl>
  771. </li>
  772. </ul>
  773. <a name="write-org.opencv.core.Mat-">
  774. <!-- -->
  775. </a>
  776. <ul class="blockListLast">
  777. <li class="blockList">
  778. <h4>write</h4>
  779. <pre>public&nbsp;void&nbsp;write(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;image)</pre>
  780. <div class="block">Writes the next video frame</div>
  781. <dl>
  782. <dt><span class="paramLabel">Parameters:</span></dt>
  783. <dd><code>image</code> - The written frame. In general, color images are expected in BGR format.
  784. The function/method writes the specified image to video file. It must have the same size as has
  785. been specified when opening the video writer.</dd>
  786. </dl>
  787. </li>
  788. </ul>
  789. </li>
  790. </ul>
  791. </li>
  792. </ul>
  793. </div>
  794. </div>
  795. <!-- ========= END OF CLASS DATA ========= -->
  796. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  797. <div class="bottomNav"><a name="navbar.bottom">
  798. <!-- -->
  799. </a>
  800. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  801. <a name="navbar.bottom.firstrow">
  802. <!-- -->
  803. </a>
  804. <ul class="navList" title="Navigation">
  805. <li><a href="../../../overview-summary.html">Overview</a></li>
  806. <li><a href="package-summary.html">Package</a></li>
  807. <li class="navBarCell1Rev">Class</li>
  808. <li><a href="package-tree.html">Tree</a></li>
  809. <li><a href="../../../index-all.html">Index</a></li>
  810. <li><a href="../../../help-doc.html">Help</a></li>
  811. </ul>
  812. <div class="aboutLanguage">
  813. <script>
  814. var url = window.location.href;
  815. var pos = url.lastIndexOf('/javadoc/');
  816. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  817. var script = document.createElement('script');
  818. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  819. document.getElementsByTagName('head')[0].appendChild(script);
  820. </script>
  821. </div>
  822. </div>
  823. <div class="subNav">
  824. <ul class="navList">
  825. <li><a href="../../../org/opencv/videoio/Videoio.html" title="class in org.opencv.videoio"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  826. <li>Next&nbsp;Class</li>
  827. </ul>
  828. <ul class="navList">
  829. <li><a href="../../../index.html?org/opencv/videoio/VideoWriter.html" target="_top">Frames</a></li>
  830. <li><a href="VideoWriter.html" target="_top">No&nbsp;Frames</a></li>
  831. </ul>
  832. <ul class="navList" id="allclasses_navbar_bottom">
  833. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  834. </ul>
  835. <div>
  836. <script type="text/javascript"><!--
  837. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  838. if(window==top) {
  839. allClassesLink.style.display = "block";
  840. }
  841. else {
  842. allClassesLink.style.display = "none";
  843. }
  844. //-->
  845. </script>
  846. </div>
  847. <div>
  848. <ul class="subNavList">
  849. <li>Summary:&nbsp;</li>
  850. <li>Nested&nbsp;|&nbsp;</li>
  851. <li>Field&nbsp;|&nbsp;</li>
  852. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  853. <li><a href="#method.summary">Method</a></li>
  854. </ul>
  855. <ul class="subNavList">
  856. <li>Detail:&nbsp;</li>
  857. <li>Field&nbsp;|&nbsp;</li>
  858. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  859. <li><a href="#method.detail">Method</a></li>
  860. </ul>
  861. </div>
  862. <a name="skip.navbar.bottom">
  863. <!-- -->
  864. </a></div>
  865. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  866. <p class="legalCopy"><small>Generated on 2023-06-28 12:47:21 / OpenCV 4.8.0</small></p>
  867. </body>
  868. </html>