Method get_scene_list

scenedetect/scene_manager.py:348–373

Return a list of tuples of start/end FrameTimecodes for each detected scene. Arguments: start_in_scene: Assume the video begins in a scene. This means that when detecting fast cuts with `ContentDetector`, if no cuts are found, the resulting scene list

(self, start_in_scene: bool = False)

        self._detector_list.clear()

    def get_scene_list(self, start_in_scene: bool = False) -> SceneList:
        """Return a list of tuples of start/end FrameTimecodes for each detected scene.

        Arguments:
            start_in_scene: Assume the video begins in a scene. This means that when detecting
                fast cuts with `ContentDetector`, if no cuts are found, the resulting scene list
                will contain a single scene spanning the entire video (instead of no scenes).
                When detecting fades with `ThresholdDetector`, the beginning portion of the video
                will always be included until the first fade-out event is detected.

        Returns:
            List of tuples in the form (start_time, end_time), where both start_time and
            end_time are FrameTimecode objects representing the exact time/frame where each
            detected scene in the video begins and ends.
        """
        if self._base_timecode is None or self._start_pos is None or self._last_pos is None:
            return []
        cut_list = self._get_cutting_list()
        scene_list = get_scenes_from_cuts(
            cut_list=cut_list, start_pos=self._start_pos, end_pos=self._last_pos + 1
        )
        # If we didn't actually detect any cuts, make sure the resulting scene_list is empty
        # unless start_in_scene is True.
        if not cut_list and not start_in_scene:
            scene_list = []
        return sorted(scene_list)

    def _get_cutting_list(self) -> list[FrameTimecode]:
        """Return a sorted list of unique frame numbers of any detected scene cuts."""