Class VideoStream

scenedetect/video_stream.py:79–212

Interface which all video backends must implement.

class VideoStream(ABC):
    """Interface which all video backends must implement."""

    #
    # Default Implementations
    #

    @property
    def base_timecode(self) -> FrameTimecode:
        """FrameTimecode object to use as a time base."""
        return FrameTimecode(timecode=0, fps=self.frame_rate)

    #
    # Backend Identification
    #

    BACKEND_NAME: ty.ClassVar[str]
    """Unique name used to identify this backend. Each subclass must set this to a unique str."""

    #
    # Abstract Properties
    #

    @property
    @abstractmethod
    def path(self) -> str:
        """Video or device path."""
        ...

    @property
    @abstractmethod
    def name(self) -> str:
        """Name of the video, without extension, or device."""
        ...

    @property
    @abstractmethod
    def is_seekable(self) -> bool:
        """True if seek() is allowed, False otherwise."""
        ...

    @property
    @abstractmethod
    def frame_rate(self) -> Fraction:
        """Frame rate in frames/sec as a rational Fraction (e.g. Fraction(24000, 1001))."""
        ...

    @property
    @abstractmethod
    def duration(self) -> FrameTimecode | None:
        """Duration of the stream as a FrameTimecode, or None if non terminating."""
        ...

    @property
    @abstractmethod
    def frame_size(self) -> tuple[int, int]:
        """Size of each video frame in pixels as a tuple of (width, height)."""
        ...