VideoDescription ¶

class VideoDescription(TypedDict, closed=True):
    codec_settings: NotRequired[
        "capo_medialive.types.video_codec_settings.VideoCodecSettings"
    ]
    """Video codec settings."""
    height: NotRequired["capo_medialive.types.__integer.__integer"]
    """Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required."""
    name: NotRequired["capo_medialive.types.__string.__string"]
    """The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event."""
    respond_to_afd: NotRequired[
        "capo_medialive.types.video_description_respond_to_afd.VideoDescriptionRespondToAfd"
    ]
    """Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output"""
    scaling_behavior: NotRequired[
        "capo_medialive.types.video_description_scaling_behavior.VideoDescriptionScalingBehavior"
    ]
    """Configures how MediaLive transforms the video picture to match the output frame. Use STRETCH_TO_OUTPUT to stretch the video to fill the output frame. The video might get distorted. Use DEFAULT to insert pillar boxes or letter boxes around the video to fill the output frame. The video won't get distorted. Use SMART_CROP to enable the smart crop feature that uses the Elemental Inference service to crop the frame using AI - see the MediaLive User Guide for more information."""
    sharpness: NotRequired[
        "capo_medialive.types.__integer_min0_max100.__integerMin0Max100"
    ]
    """Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content."""
    width: NotRequired["capo_medialive.types.__integer.__integer"]
    """Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required."""
    crop_rectangle: NotRequired[
        "capo_medialive.types.video_position_rectangle.VideoPositionRectangle"
    ]
    """Region of the input video to crop before scaling. If not specified, the entire input frame is used. Note: Unlike {@link outputPositionRectangle}, the bounds of cropRectangle are validated at ingest time by the encoder/scaler rather than at the API level, because the input resolution is not known until the source is probed. Field-level constraints on (x, y, width, height) defined on {@link VideoPositionRectangle} still apply."""
    output_position_rectangle: NotRequired[
        "capo_medialive.types.video_position_rectangle.VideoPositionRectangle"
    ]
    """Position of the encoded video within the output frame. The area outside the rectangle is filled with black. If not specified, the video fills the entire output frame. When used, both {@link width} and {@link height} of the VideoDescription must be explicitly specified so that the rectangle can be validated against the output frame."""
    border: NotRequired[
        "capo_medialive.types.__integer_min0_max100.__integerMin0Max100"
    ]
    """Specifies the number of pixels of black border that will be inserted around the edge of the encoded picture. Must be an even integer from 0 (no border, the default) up to 100. The width and height of the VideoDescription must each be greater than twice this value. Cannot be used together with {@link outputPositionRectangle} -- both govern the position of the encoded content within the output frame."""