Skip to content

VideoConfiguration

Source code in docs_src/capo_ivs/types/video_configuration.py
class VideoConfiguration(TypedDict, closed=True):
    avc_profile: NotRequired["capo_ivs.types.string.String"]
    """<p>(Deprecated) Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.</p>"""
    avc_level: NotRequired["capo_ivs.types.string.String"]
    """<p>(Deprecated) Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.</p>"""
    codec: NotRequired["capo_ivs.types.string.String"]
    """<p>Codec used for the video encoding.</p>"""
    encoder: NotRequired["capo_ivs.types.string.String"]
    """<p>Software or hardware used to encode the video.</p>"""
    target_bitrate: "capo_ivs.types.integer.Integer"
    """<p>The expected ingest bitrate (bits per second). This is configured in the encoder.</p>"""
    target_framerate: "capo_ivs.types.integer.Integer"
    """<p>The expected ingest framerate. This is configured in the encoder.</p>"""
    video_height: "capo_ivs.types.integer.Integer"
    """<p>Video-resolution height in pixels.</p>"""
    video_width: "capo_ivs.types.integer.Integer"
    """<p>Video-resolution width in pixels.</p>"""
    level: NotRequired["capo_ivs.types.string.String"]
    """<p>Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. When an AVC codec is used, this field has the same value as <code>avcLevel</code>.</p>"""
    track: NotRequired["capo_ivs.types.string.String"]
    """<p>Name of the video track. If multitrack is not enabled, this is Track0 (the sole track).</p>"""
    profile: NotRequired["capo_ivs.types.string.String"]
    """<p>Indicates to the decoder the requirements for decoding the stream. When an AVC codec is used, this field has the same value as <code>avcProfile</code>.</p>"""

avc_level instance-attribute

avc_level: NotRequired[String]

(Deprecated) Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.

avc_profile instance-attribute

avc_profile: NotRequired[String]

(Deprecated) Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification. This is populated only when VideoConfiguration is part of the deprecated IngestConfiguration; otherwise, this is an empty string.

codec instance-attribute

codec: NotRequired[String]

Codec used for the video encoding.

encoder instance-attribute

encoder: NotRequired[String]

Software or hardware used to encode the video.

level instance-attribute

level: NotRequired[String]

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. When an AVC codec is used, this field has the same value as avcLevel.

profile instance-attribute

profile: NotRequired[String]

Indicates to the decoder the requirements for decoding the stream. When an AVC codec is used, this field has the same value as avcProfile.

target_bitrate instance-attribute

target_bitrate: Integer

The expected ingest bitrate (bits per second). This is configured in the encoder.

target_framerate instance-attribute

target_framerate: Integer

The expected ingest framerate. This is configured in the encoder.

track instance-attribute

track: NotRequired[String]

Name of the video track. If multitrack is not enabled, this is Track0 (the sole track).

video_height instance-attribute

video_height: Integer

Video-resolution height in pixels.

video_width instance-attribute

video_width: Integer

Video-resolution width in pixels.