Skip to content

Commit 06502f9

Browse files
github-actions[bot]github-actions[bot]
committed
Publish mmstudio/latest
1 parent 862a79a commit 06502f9

3 files changed

Lines changed: 53 additions & 10 deletions

File tree

‎index-all.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5605,6 +5605,10 @@ <h2 class="title">S</h2>
56055605
<dd>
56065606
<div class="block">Set the exposure time for the current channel (if any).</div>
56075607
</dd>
5608+
<dt><span class="memberNameLink"><a href="org/micromanager/display/ImageExporter.html#setFfmpegPath-java.lang.String-">setFfmpegPath(String)</a></span> - Method in interface org.micromanager.display.<a href="org/micromanager/display/ImageExporter.html" title="interface in org.micromanager.display">ImageExporter</a></dt>
5609+
<dd>
5610+
<div class="block">Set the path to the ffmpeg executable.</div>
5611+
</dd>
56085612
<dt><span class="memberNameLink"><a href="org/micromanager/display/DisplayWindow.html#setFullScreen-boolean-">setFullScreen(boolean)</a></span> - Method in interface org.micromanager.display.<a href="org/micromanager/display/DisplayWindow.html" title="interface in org.micromanager.display">DisplayWindow</a></dt>
56095613
<dd>
56105614
<div class="block">Enable or disable full screen mode.</div>

‎org/micromanager/display/ImageExporter.OutputFormat.html‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,11 @@ <h3>Enum Constant Summary</h3>
168168
</td>
169169
</tr>
170170
<tr class="rowColor">
171+
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.OutputFormat.html#OUTPUT_MOVIE">OUTPUT_MOVIE</a></span></code>
172+
<div class="block">Output as an MP4 video using ffmpeg.</div>
173+
</td>
174+
</tr>
175+
<tr class="altColor">
171176
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.OutputFormat.html#OUTPUT_PNG">OUTPUT_PNG</a></span></code>
172177
<div class="block">Output as a sequence of Portable Network Graphics (PNG) files.</div>
173178
</td>
@@ -283,13 +288,23 @@ <h4>OUTPUT_IMAGEJ</h4>
283288
<a name="OUTPUT_CLIPBOARD">
284289
<!-- -->
285290
</a>
286-
<ul class="blockListLast">
291+
<ul class="blockList">
287292
<li class="blockList">
288293
<h4>OUTPUT_CLIPBOARD</h4>
289294
<pre>public static final&nbsp;<a href="../../../org/micromanager/display/ImageExporter.OutputFormat.html" title="enum in org.micromanager.display">ImageExporter.OutputFormat</a> OUTPUT_CLIPBOARD</pre>
290295
<div class="block">Output to the System Clipboard, will only work for a single image.</div>
291296
</li>
292297
</ul>
298+
<a name="OUTPUT_MOVIE">
299+
<!-- -->
300+
</a>
301+
<ul class="blockListLast">
302+
<li class="blockList">
303+
<h4>OUTPUT_MOVIE</h4>
304+
<pre>public static final&nbsp;<a href="../../../org/micromanager/display/ImageExporter.OutputFormat.html" title="enum in org.micromanager.display">ImageExporter.OutputFormat</a> OUTPUT_MOVIE</pre>
305+
<div class="block">Output as an MP4 video using ffmpeg.</div>
306+
</li>
307+
</ul>
293308
</li>
294309
</ul>
295310
<!-- ============ METHOD DETAIL ========== -->

‎org/micromanager/display/ImageExporter.html‎

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
catch(err) {
1818
}
1919
//-->
20-
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
21-
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
20+
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":18,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
21+
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
2222
var altColor = "altColor";
2323
var rowColor = "rowColor";
2424
var tableTab = "tableTab";
@@ -138,7 +138,7 @@ <h3>Nested Class Summary</h3>
138138
</a>
139139
<h3>Method Summary</h3>
140140
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
141-
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
141+
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
142142
<tr>
143143
<th class="colFirst" scope="col">Modifier and Type</th>
144144
<th class="colLast" scope="col">Method and Description</th>
@@ -170,40 +170,46 @@ <h3>Method Summary</h3>
170170
</td>
171171
</tr>
172172
<tr id="i4" class="altColor">
173+
<td class="colFirst"><code>default void</code></td>
174+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.html#setFfmpegPath-java.lang.String-">setFfmpegPath</a></span>(java.lang.String&nbsp;ffmpegPath)</code>
175+
<div class="block">Set the path to the ffmpeg executable.</div>
176+
</td>
177+
</tr>
178+
<tr id="i5" class="rowColor">
173179
<td class="colFirst"><code>void</code></td>
174180
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.html#setImageJName-java.lang.String-">setImageJName</a></span>(java.lang.String&nbsp;imageJName)</code>
175181
<div class="block">Sets the name to be used for the ImageJ Stack Window (if this was
176182
used as the output format).</div>
177183
</td>
178184
</tr>
179-
<tr id="i5" class="rowColor">
185+
<tr id="i6" class="altColor">
180186
<td class="colFirst"><code>void</code></td>
181187
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.html#setOutputFormat-org.micromanager.display.ImageExporter.OutputFormat-">setOutputFormat</a></span>(<a href="../../../org/micromanager/display/ImageExporter.OutputFormat.html" title="enum in org.micromanager.display">ImageExporter.OutputFormat</a>&nbsp;format)</code>
182188
<div class="block">Set the output format to use.</div>
183189
</td>
184190
</tr>
185-
<tr id="i6" class="altColor">
191+
<tr id="i7" class="rowColor">
186192
<td class="colFirst"><code>void</code></td>
187193
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.html#setOutputQuality-int-">setOutputQuality</a></span>(int&nbsp;quality)</code>
188194
<div class="block">Set the image quality.</div>
189195
</td>
190196
</tr>
191-
<tr id="i7" class="rowColor">
197+
<tr id="i8" class="altColor">
192198
<td class="colFirst"><code>void</code></td>
193199
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.html#setSaveInfo-java.lang.String-java.lang.String-">setSaveInfo</a></span>(java.lang.String&nbsp;path,
194200
java.lang.String&nbsp;prefix)</code>
195201
<div class="block">Set the path to save images to, and the filename prefix to use when
196202
saving images.</div>
197203
</td>
198204
</tr>
199-
<tr id="i8" class="altColor">
205+
<tr id="i9" class="rowColor">
200206
<td class="colFirst"><code>void</code></td>
201207
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.html#setUseLabel-boolean-">setUseLabel</a></span>(boolean&nbsp;label)</code>
202208
<div class="block">Whether to use labels indicating position, channel, time point and z position
203209
(where) appropriate or to sequentially number output files.</div>
204210
</td>
205211
</tr>
206-
<tr id="i9" class="rowColor">
212+
<tr id="i10" class="altColor">
207213
<td class="colFirst"><code>void</code></td>
208214
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/micromanager/display/ImageExporter.html#waitForExport--">waitForExport</a></span>()</code>
209215
<div class="block">Block until a prior call to export() returns.</div>
@@ -277,14 +283,32 @@ <h4>setUseLabel</h4>
277283
<h4>setOutputQuality</h4>
278284
<pre>void&nbsp;setOutputQuality(int&nbsp;quality)</pre>
279285
<div class="block">Set the image quality. This is currently only relevant if the output
280-
format is OUTPUT_JPG.</div>
286+
format is OUTPUT_JPG or OUTPUT_MOVIE.</div>
281287
<dl>
282288
<dt><span class="paramLabel">Parameters:</span></dt>
283289
<dd><code>quality</code> - An integer quality ranging from 1 through 100. The default
284290
value is 90.</dd>
285291
</dl>
286292
</li>
287293
</ul>
294+
<a name="setFfmpegPath-java.lang.String-">
295+
<!-- -->
296+
</a>
297+
<ul class="blockList">
298+
<li class="blockList">
299+
<h4>setFfmpegPath</h4>
300+
<pre>default&nbsp;void&nbsp;setFfmpegPath(java.lang.String&nbsp;ffmpegPath)</pre>
301+
<div class="block">Set the path to the ffmpeg executable. Required when the output format is
302+
OUTPUT_MOVIE. Ignored for other formats.
303+
304+
<p>This method has a default no-op implementation so that existing
305+
implementations of this interface remain source- and binary-compatible.</div>
306+
<dl>
307+
<dt><span class="paramLabel">Parameters:</span></dt>
308+
<dd><code>ffmpegPath</code> - Absolute path to the ffmpeg binary.</dd>
309+
</dl>
310+
</li>
311+
</ul>
288312
<a name="setSaveInfo-java.lang.String-java.lang.String-">
289313
<!-- -->
290314
</a>

0 commit comments

Comments
 (0)