Skip to content

FrameCaptureSettings

Source code in docs_src/capo_mediaconvert/types/frame_capture_settings.py
class FrameCaptureSettings(TypedDict, closed=True):
    framerate_denominator: NotRequired[
        "capo_mediaconvert.types.__integer_min1_max2147483647.__integerMin1Max2147483647"
    ]
    """Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture."""
    framerate_numerator: NotRequired[
        "capo_mediaconvert.types.__integer_min1_max2147483647.__integerMin1Max2147483647"
    ]
    """Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places."""
    max_captures: NotRequired[
        "capo_mediaconvert.types.__integer_min1_max10000000.__integerMin1Max10000000"
    ]
    """Maximum number of captures (encoded jpg output files)."""
    quality: NotRequired[
        "capo_mediaconvert.types.__integer_min1_max100.__integerMin1Max100"
    ]
    """JPEG Quality - a higher value equals higher quality."""

framerate_denominator instance-attribute

framerate_denominator: NotRequired[__integerMin1Max2147483647]

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of ⅓ frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

framerate_numerator instance-attribute

framerate_numerator: NotRequired[__integerMin1Max2147483647]

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of ⅓ frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

max_captures instance-attribute

max_captures: NotRequired[__integerMin1Max10000000]

Maximum number of captures (encoded jpg output files).

quality instance-attribute

quality: NotRequired[__integerMin1Max100]

JPEG Quality - a higher value equals higher quality.