Skip to content

GlobalConfiguration

Source code in docs_src/capo_medialive/types/global_configuration.py
class GlobalConfiguration(TypedDict, closed=True):
    initial_audio_gain: NotRequired[
        "capo_medialive.types.__integer_min_negative60_max60.__integerMinNegative60Max60"
    ]
    """Value to set the initial audio gain for the Live Event."""
    input_end_action: NotRequired[
        "capo_medialive.types.global_configuration_input_end_action.GlobalConfigurationInputEndAction"
    ]
    """Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API)."""
    input_loss_behavior: NotRequired[
        "capo_medialive.types.input_loss_behavior.InputLossBehavior"
    ]
    """Settings for system actions when input is lost."""
    output_locking_mode: NotRequired[
        "capo_medialive.types.global_configuration_output_locking_mode.GlobalConfigurationOutputLockingMode"
    ]
    """Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. DISABLED - MediaLive will not attempt to synchronize the output of pipelines. We advise against disabling output locking because it has negative side effects in most workflows. For more information, see the section about output locking (pipeline locking) in the Medialive user guide."""
    output_timing_source: NotRequired[
        "capo_medialive.types.global_configuration_output_timing_source.GlobalConfigurationOutputTimingSource"
    ]
    """Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream."""
    support_low_framerate_inputs: NotRequired[
        "capo_medialive.types.global_configuration_low_framerate_inputs.GlobalConfigurationLowFramerateInputs"
    ]
    """Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second."""
    output_locking_settings: NotRequired[
        "capo_medialive.types.output_locking_settings.OutputLockingSettings"
    ]
    """Advanced output locking settings"""

initial_audio_gain instance-attribute

initial_audio_gain: NotRequired[__integerMinNegative60Max60]

Value to set the initial audio gain for the Live Event.

input_end_action instance-attribute

input_end_action: NotRequired[GlobalConfigurationInputEndAction]

Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).

input_loss_behavior instance-attribute

input_loss_behavior: NotRequired[InputLossBehavior]

Settings for system actions when input is lost.

output_locking_mode instance-attribute

output_locking_mode: NotRequired[GlobalConfigurationOutputLockingMode]

Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. DISABLED - MediaLive will not attempt to synchronize the output of pipelines. We advise against disabling output locking because it has negative side effects in most workflows. For more information, see the section about output locking (pipeline locking) in the Medialive user guide.

output_locking_settings instance-attribute

output_locking_settings: NotRequired[OutputLockingSettings]

Advanced output locking settings

output_timing_source instance-attribute

output_timing_source: NotRequired[GlobalConfigurationOutputTimingSource]

Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.

support_low_framerate_inputs instance-attribute

support_low_framerate_inputs: NotRequired[GlobalConfigurationLowFramerateInputs]

Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.