Method read

scenedetect/video_stream.py:173–185

Read and decode the next frame as a np.ndarray. Returns False when video ends. Arguments: decode: Return the frame image itself. If False, a boolean indicating if the stream was advanced to the next frame or not. This can improve performance by reducing

(self, decode: bool = True)

    @abstractmethod
    def read(self, decode: bool = True) -> np.ndarray | bool:
        """Read and decode the next frame as a np.ndarray. Returns False when video ends.

        Arguments:
            decode: Return the frame image itself. If False, a boolean indicating if the stream
                was advanced to the next frame or not. This can improve performance by reducing
                memory copying and colorspace conversions when a given frame's data is not required.

        Returns:
            If decode = True, the decoded frame (np.ndarray), or False (bool) if end of video.
            If decode = False, a bool indicating if advancing to the the next frame succeeded.
        """
        ...

    @abstractmethod
    def reset(self) -> None: