Video

Interface to support treating videos like arrays using OpenCV

class VideoProxy(path: Path | None = None, video: VideoCapture | None = None)

Passthrough proxy class to interact with videos as arrays

property video: VideoCapture

Opened video capture object

close() → None

Close the opened VideoCapture object

property sample_frame: ndarray

A stored frame from the video to use when calculating shape and dtype

property shape: Tuple[int, ...]

Shape of video like (n_frames, height, width, channels)

Note that this order flips the order of height and width from typical resolution specifications: eg. 1080p video is typically 1920x1080, but here it would be 1080x1920. This follows opencv’s ordering, which matches expectations when eg. an image is read and plotted with matplotlib: the first index is the position in the 0th dimension - the height, or “y” axis - and the second is the width/x.

property dtype: dtype

Numpy dtype (from sample_frame )

property n_frames: int

Try to get number of frames using opencv metadata, and manually count if no t

class VideoInterface(shape: Tuple[int, ...] | Any, dtype: str | type | Any | generic)

OpenCV interface to treat videos as arrays.

return_type

alias of VideoProxy

classmethod enabled() → bool

Check if opencv-python is available in the environment

classmethod check(array: Any) → bool

Check if array is a string or Path with a supported video extension, or an opened VideoCapture object

before_validation(array: Any) → VideoProxy

Get a VideoProxy object for this video