[docs] @Breakthrough: Generate Documentation

Source: main (1dc1dea)

Destination: head

Author: github-actions

docs/head/.doctrees/api/detector.doctree

@@ -54,7 +54,8 @@
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>mode</strong> (<a class="reference internal" href="#scenedetect.detector.FlashFilter.Mode" title="scenedetect.detector.FlashFilter.Mode"><em>Mode</em></a>) – The mode to use when enforcing <cite>length</cite>.</p></li>
-<li><p><strong>length</strong> (<em>int</em>) – Number of frames to use when filtering cuts.</p></li>
+<li><p><strong>length</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em>) – Minimum scene length. Accepts an <cite>int</cite> (number of frames), <cite>float</cite> (seconds),
+or <cite>str</cite> (timecode, e.g. <code class="docutils literal notranslate"><span class="pre">&quot;0.6s&quot;</span></code> or <code class="docutils literal notranslate"><span class="pre">&quot;00:00:00.600&quot;</span></code>).</p></li>
 </ul>
 </dd>
 </dl>

docs/head/.doctrees/api/detectors.doctree

@@ -71,8 +71,9 @@
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>adaptive_threshold</strong> (<em>float</em>) – Threshold (float) that score ratio must exceed to trigger a
 new scene (see frame metric adaptive_ratio in stats file).</p></li>
-<li><p><strong>min_scene_len</strong> (<em>int</em>) – Once a cut is detected, this many frames must pass before a new one can
-be added to the scene list. Can be an int or FrameTimecode type.</p></li>
+<li><p><strong>min_scene_len</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em>) – Once a cut is detected, this much time must pass before a new one can
+be added to the scene list. Accepts an int (frames), float (seconds), or
+str (e.g. <code class="docutils literal notranslate"><span class="pre">&quot;0.6s&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;00:00:00.600&quot;</span></code>).</p></li>
 <li><p><strong>window_width</strong> (<em>int</em>) – Size of window (number of frames) before and after each frame to
 average together in order to detect deviations from the mean. Must be at least 1.</p></li>
 <li><p><strong>min_content_val</strong> (<em>float</em>) – Minimum threshold (float) that the content_val must exceed in order to
@@ -152,8 +153,9 @@
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>threshold</strong> (<em>float</em>) – Threshold the average change in pixel intensity must exceed to trigger a cut.</p></li>
-<li><p><strong>min_scene_len</strong> (<em>int</em>) – Once a cut is detected, this many frames must pass before a new one can
-be added to the scene list. Can be an int or FrameTimecode type.</p></li>
+<li><p><strong>min_scene_len</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em>) – Once a cut is detected, this much time must pass before a new one can
+be added to the scene list. Accepts an int (frames), float (seconds), or
+str (e.g. <code class="docutils literal notranslate"><span class="pre">&quot;0.6s&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;00:00:00.600&quot;</span></code>).</p></li>
 <li><p><strong>weights</strong> (<a class="reference internal" href="#scenedetect.detectors.content_detector.ContentDetector.Components" title="scenedetect.detectors.content_detector.ContentDetector.Components"><em>ContentDetector.Components</em></a>) – Weight to place on each component when calculating frame score
 (<cite>content_val</cite> in a statsfile, the value <cite>threshold</cite> is compared against).</p></li>
 <li><p><strong>luma_only</strong> (<em>bool</em>) – If True, only considers changes in the luminance channel of the video.
@@ -304,8 +306,9 @@
 <li><p><strong>size</strong> (<em>int</em>) – Size of square of low frequency data to use for the DCT</p></li>
 <li><p><strong>lowpass</strong> (<em>int</em>) – How much high frequency information to filter from the DCT. A value of 2 means
 keep lower 1/2 of the frequency data, 4 means only keep 1/4, etc…</p></li>
-<li><p><strong>min_scene_len</strong> (<em>int</em>) – Once a cut is detected, this many frames must pass before a new one can
-be added to the scene list. Can be an int or FrameTimecode type.</p></li>
+<li><p><strong>min_scene_len</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em>) – Once a cut is detected, this much time must pass before a new one can
+be added to the scene list. Accepts an int (frames), float (seconds), or
+str (e.g. <code class="docutils literal notranslate"><span class="pre">&quot;0.6s&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;00:00:00.600&quot;</span></code>).</p></li>
 </ul>
 </dd>
 </dl>
@@ -370,8 +373,9 @@
 YUV, and normalized based on the number of bins. Higher dicfferences imply greater
 change in content, so larger threshold values are less sensitive to cuts.</p></li>
 <li><p><strong>bins</strong> (<em>int</em>) – Number of bins to use for the histogram.</p></li>
-<li><p><strong>min_scene_len</strong> (<em>int</em>) – Once a cut is detected, this many frames must pass before a new one can
-be added to the scene list. Can be an int or FrameTimecode type.</p></li>
+<li><p><strong>min_scene_len</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em>) – Once a cut is detected, this much time must pass before a new one can
+be added to the scene list. Accepts an int (frames), float (seconds), or
+str (e.g. <code class="docutils literal notranslate"><span class="pre">&quot;0.6s&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;00:00:00.600&quot;</span></code>).</p></li>
 </ul>
 </dd>
 </dl>
@@ -485,8 +489,9 @@ <h2>Examples:<a class="headerlink" href="#examples" title="Permalink to this hea
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>threshold</strong> (<em>float</em>) – 8-bit intensity value that each pixel value (R, G, and B)
 must be &lt;= to in order to trigger a fade in/out.</p></li>
-<li><p><strong>min_scene_len</strong> (<em>int</em>) – Once a cut is detected, this many frames must pass before a new one can
-be added to the scene list. Can be an int or FrameTimecode type.</p></li>
+<li><p><strong>min_scene_len</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em>) – Once a cut is detected, this much time must pass before a new one can
+be added to the scene list. Accepts an int (frames), float (seconds), or
+str (e.g. <code class="docutils literal notranslate"><span class="pre">&quot;0.6s&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;00:00:00.600&quot;</span></code>).</p></li>
 <li><p><strong>fade_bias</strong> (<em>float</em>) – Float between -1.0 and +1.0 representing the percentage of
 timecode skew for the start of a scene (-1.0 causing a cut at the
 fade-to-black, 0.0 in the middle, and +1.0 causing the cut to be

docs/head/.doctrees/api/output.doctree

@@ -48,10 +48,10 @@
 <li><p><strong>video</strong> (<a class="reference internal" href="video_stream.html#scenedetect.video_stream.VideoStream" title="scenedetect.video_stream.VideoStream"><em>VideoStream</em></a>) – A VideoStream object corresponding to the scene list.
 Note that the video will be closed/re-opened and seeked through.</p></li>
 <li><p><strong>num_images</strong> (<em>int</em>) – Number of images to generate for each scene.  Minimum is 1.</p></li>
-<li><p><strong>frame_margin</strong> (<em>int</em>) – Number of frames to pad each scene around the beginning
-and end (e.g. moves the first/last image into the scene by N frames).
-Can set to 0, but will result in some video files failing to extract
-the very last frame.</p></li>
+<li><p><strong>frame_margin</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em>) – Padding around the beginning and end of each scene used when
+selecting which frames to extract. Accepts an int (frames), float (seconds),
+or str (e.g. <code class="docutils literal notranslate"><span class="pre">&quot;0.1s&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;00:00:00.100&quot;</span></code>). Can be 0, but some video files
+may then fail to extract the very last frame.</p></li>
 <li><p><strong>image_extension</strong> (<em>str</em>) – Type of image to save (must be one of ‘jpg’, ‘png’, or ‘webp’).</p></li>
 <li><p><strong>encoder_param</strong> (<em>int</em>) – Quality/compression efficiency, based on type of image:
 ‘jpg’ / ‘webp’:  Quality 0-100, higher is better quality.  100 is lossless for webp.

docs/head/.doctrees/cli/config_file.doctree

@@ -323,7 +323,8 @@ <h2>Example<a class="headerlink" href="#example" title="Permalink to this headin
 <span class="c1"># Compression amount for png images (0 to 9). Only affects size, not quality.</span>
 <span class="c1">#compression = 3</span>
 
-<span class="c1"># Number of frames to ignore around each scene cut when selecting frames.</span>
+<span class="c1"># Padding around each scene cut when selecting frames. Accepts a number of frames (1),</span>
+<span class="c1"># seconds with `s` suffix (0.1s), or timecode (00:00:00.100).</span>
 <span class="c1">#frame-margin = 1</span>
 
 <span class="c1"># Resize by scale factor (0.5 = half, 1.0 = same, 2.0 = double).</span>