cutcutcodec.core.analysis.video.properties.rate.get_rate_video

cutcutcodec.core.analysis.video.properties.rate.get_rate_video(filename: Path | str | bytes, index: int = 0, *, backend: str | None = None) Fraction[source]

Read in the metadata, the average frequency of the frames.

Parameters

filenamepathlike

The pathlike of the file containing a video stream.

indexint

The relative index of the video stream being considered, by default the first stream encountered is selected.

backendstr, optional
  • None (default) : Try to read the stream by trying differents backends.

  • ‘ffmpeg’Uses the modules pip install ffmpeg-python

    which are using the ffmpeg program in the background.

  • ‘cv2’ : Uses the module pip install opencv-contrib-python-headless.

Returns

fpsFraction

The average frequency of the frames in hz.

Raises

MissingStreamError

If the file does not contain a playable video stream.

MissingInformation

If the information is unavailable.

Examples

>>> from cutcutcodec.core.analysis.video.properties.rate import get_rate_video
>>> get_rate_video("cutcutcodec/examples/video.mp4")
Fraction(25, 1)
>>> get_rate_video("cutcutcodec/examples/intro.webm")
Fraction(30000, 1001)
>>>