Skip to content

Commit 6877c3b

Browse files
author
github-actions
committed
[docs] @Breakthrough: Generate Website
Commit: 006fe37
1 parent f409678 commit 6877c3b

3 files changed

Lines changed: 5 additions & 3 deletions

File tree

changelog/index.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -950,10 +950,12 @@ <h3 id="api-changes">API Changes</h3>
950950
<p><strong>Detector Interface:</strong></p>
951951
<ul>
952952
<li>Replace <code>frame_num</code> parameter (<code>int</code>) with <code>timecode</code> (<code>FrameTimecode</code>) in <code>SceneDetector</code> interface <a href="https://github.com/Breakthrough/PySceneDetect/issues/168">#168</a>:<ul>
953-
<li>The detector interface: <code>SceneDetector.process_frame()</code> and <code>SceneDetector.post_process()</code></li>
954-
<li>Statistics: <code>StatsManager.get_metrics()</code>, <code>StatsManager.set_metrics()</code>, and <code>StatsManager.metrics_exist()</code></li>
953+
<li>The detector interface: <code>SceneDetector.process_frame()</code> and <code>SceneDetector.post_process()</code> (the <code>post_process</code> signature on the abstract base is now consistently typed as <code>FrameTimecode</code> to match its concrete-detector overrides; the prior <code>int</code> annotation did not reflect the actual runtime value)</li>
954+
<li>Statistics: <code>StatsManager.get_metrics()</code>, <code>StatsManager.set_metrics()</code>, and <code>StatsManager.metrics_exist()</code> formally accept either <code>FrameTimecode</code> or <code>int</code> (the <code>int</code> form is retained for compatibility with the deprecated <code>load_from_csv()</code> path, which keys metrics by integer frame number)</li>
955955
</ul>
956956
</li>
957+
<li><code>StatsManager.load_from_csv()</code> and <code>save_images()</code> <code>output_dir</code> now accept <code>os.PathLike</code> (e.g. <code>pathlib.Path</code>) in addition to <code>str</code></li>
958+
<li><code>SceneManager.detect_scenes()</code> <code>duration</code> and <code>end_time</code> formally accept <code>int</code> (frames), <code>float</code> (seconds), <code>str</code> (timecode), or <code>FrameTimecode</code> — matching the documented and runtime-supported behavior</li>
957959
<li><code>SceneDetector</code> is now a <a href="https://docs.python.org/3/library/abc.html">Python abstract class</a></li>
958960
<li><code>SceneDetector</code> instances can now assume they always have frame data to process when <code>process_frame</code> is called</li>
959961
<li>Remove <code>SceneDetector.is_processing_required()</code> method</li>

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

sitemap.xml.gz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)