Skip to content

RtmpGroupSettings

Source code in docs_src/capo_medialive/types/rtmp_group_settings.py
class RtmpGroupSettings(TypedDict, closed=True):
    ad_markers: NotRequired[
        "capo_medialive.types.__list_of_rtmp_ad_markers.__listOfRtmpAdMarkers"
    ]
    """Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream."""
    authentication_scheme: NotRequired[
        "capo_medialive.types.authentication_scheme.AuthenticationScheme"
    ]
    """Authentication scheme to use when connecting with CDN"""
    cache_full_behavior: NotRequired[
        "capo_medialive.types.rtmp_cache_full_behavior.RtmpCacheFullBehavior"
    ]
    """Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again."""
    cache_length: NotRequired["capo_medialive.types.__integer_min30.__integerMin30"]
    """Cache length, in seconds, is used to calculate buffer size."""
    caption_data: NotRequired["capo_medialive.types.rtmp_caption_data.RtmpCaptionData"]
    """Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed."""
    input_loss_action: NotRequired[
        "capo_medialive.types.input_loss_action_for_rtmp_out.InputLossActionForRtmpOut"
    ]
    """Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection."""
    restart_delay: NotRequired["capo_medialive.types.__integer_min0.__integerMin0"]
    """If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart."""
    include_filler_nal_units: NotRequired[
        "capo_medialive.types.include_filler_nal_units.IncludeFillerNalUnits"
    ]
    """Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto."""

ad_markers instance-attribute

ad_markers: NotRequired[__listOfRtmpAdMarkers]

Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

authentication_scheme instance-attribute

authentication_scheme: NotRequired[AuthenticationScheme]

Authentication scheme to use when connecting with CDN

cache_full_behavior instance-attribute

cache_full_behavior: NotRequired[RtmpCacheFullBehavior]

Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.

cache_length instance-attribute

cache_length: NotRequired[__integerMin30]

Cache length, in seconds, is used to calculate buffer size.

caption_data instance-attribute

caption_data: NotRequired[RtmpCaptionData]

Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.

include_filler_nal_units instance-attribute

include_filler_nal_units: NotRequired[IncludeFillerNalUnits]

Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

input_loss_action instance-attribute

input_loss_action: NotRequired[InputLossActionForRtmpOut]

Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.

restart_delay instance-attribute

restart_delay: NotRequired[__integerMin0]

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.