Skip to content

Commit 6f1ba3b

Browse files
committed
[api] Add comments to guide future API changes.
1 parent 22ff352 commit 6f1ba3b

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

scenedetect/scene_detector.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,13 @@
3131

3232
from scenedetect.stats_manager import StatsManager
3333

34-
34+
# TODO(v0.7): Add a new base class called just "Detector" to eventually replace SceneDetector.
35+
#
36+
# class Detector:
37+
# def process(buffer: ty.List[ty.Tuple[numpy.ndarray, FrameTimecode]]):
38+
# # Return EventType.CUT, FADE_IN, FADE_OUT, etc...
39+
# pass
40+
#
3541
class SceneDetector:
3642
"""Base class to inherit from when implementing a scene detection algorithm.
3743
@@ -125,6 +131,7 @@ def event_buffer_length(self) -> int:
125131
return 0
126132

127133

134+
# TODO(v0.7): Remove this early, no point in keeping it around.
128135
class SparseSceneDetector(SceneDetector):
129136
"""Base class to inherit from when implementing a sparse scene detection algorithm.
130137

0 commit comments

Comments
 (0)