Skip to content

MsSmoothGroupSettings

Source code in docs_src/capo_medialive/types/ms_smooth_group_settings.py
class MsSmoothGroupSettings(TypedDict, closed=True):
    acquisition_point_id: NotRequired["capo_medialive.types.__string.__string"]
    """The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE."""
    audio_only_timecode_control: NotRequired[
        "capo_medialive.types.smooth_group_audio_only_timecode_control.SmoothGroupAudioOnlyTimecodeControl"
    ]
    """If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream."""
    certificate_mode: NotRequired[
        "capo_medialive.types.smooth_group_certificate_mode.SmoothGroupCertificateMode"
    ]
    """If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail."""
    connection_retry_interval: NotRequired[
        "capo_medialive.types.__integer_min0.__integerMin0"
    ]
    """Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established."""
    destination: NotRequired[
        "capo_medialive.types.output_location_ref.OutputLocationRef"
    ]
    """Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS."""
    event_id: NotRequired["capo_medialive.types.__string.__string"]
    """MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured."""
    event_id_mode: NotRequired[
        "capo_medialive.types.smooth_group_event_id_mode.SmoothGroupEventIdMode"
    ]
    """Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server."""
    event_stop_behavior: NotRequired[
        "capo_medialive.types.smooth_group_event_stop_behavior.SmoothGroupEventStopBehavior"
    ]
    """When set to sendEos, send EOS signal to IIS server when stopping the event"""
    filecache_duration: NotRequired["capo_medialive.types.__integer_min0.__integerMin0"]
    """Size in seconds of file cache for streaming outputs."""
    fragment_length: NotRequired["capo_medialive.types.__integer_min1.__integerMin1"]
    """Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate."""
    input_loss_action: NotRequired[
        "capo_medialive.types.input_loss_action_for_ms_smooth_out.InputLossActionForMsSmoothOut"
    ]
    """Parameter that control output group behavior on input loss."""
    num_retries: NotRequired["capo_medialive.types.__integer_min0.__integerMin0"]
    """Number of retry attempts."""
    restart_delay: NotRequired["capo_medialive.types.__integer_min0.__integerMin0"]
    """Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration."""
    segmentation_mode: NotRequired[
        "capo_medialive.types.smooth_group_segmentation_mode.SmoothGroupSegmentationMode"
    ]
    """useInputSegmentation has been deprecated. The configured segment size is always used."""
    send_delay_ms: NotRequired[
        "capo_medialive.types.__integer_min0_max10000.__integerMin0Max10000"
    ]
    """Number of milliseconds to delay the output from the second pipeline."""
    sparse_track_type: NotRequired[
        "capo_medialive.types.smooth_group_sparse_track_type.SmoothGroupSparseTrackType"
    ]
    """Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group."""
    stream_manifest_behavior: NotRequired[
        "capo_medialive.types.smooth_group_stream_manifest_behavior.SmoothGroupStreamManifestBehavior"
    ]
    """When set to send, send stream manifest so publishing point doesn't start until all streams start."""
    timestamp_offset: NotRequired["capo_medialive.types.__string.__string"]
    """Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset."""
    timestamp_offset_mode: NotRequired[
        "capo_medialive.types.smooth_group_timestamp_offset_mode.SmoothGroupTimestampOffsetMode"
    ]
    """Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset"""

acquisition_point_id instance-attribute

acquisition_point_id: NotRequired[__string]

The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.

audio_only_timecode_control instance-attribute

audio_only_timecode_control: NotRequired[SmoothGroupAudioOnlyTimecodeControl]

If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.

certificate_mode instance-attribute

certificate_mode: NotRequired[SmoothGroupCertificateMode]

If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.

connection_retry_interval instance-attribute

connection_retry_interval: NotRequired[__integerMin0]

Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.

destination instance-attribute

destination: NotRequired[OutputLocationRef]

Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.

event_id instance-attribute

event_id: NotRequired[__string]

MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.

event_id_mode instance-attribute

event_id_mode: NotRequired[SmoothGroupEventIdMode]

Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.

event_stop_behavior instance-attribute

event_stop_behavior: NotRequired[SmoothGroupEventStopBehavior]

When set to sendEos, send EOS signal to IIS server when stopping the event

filecache_duration instance-attribute

filecache_duration: NotRequired[__integerMin0]

Size in seconds of file cache for streaming outputs.

fragment_length instance-attribute

fragment_length: NotRequired[__integerMin1]

Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.

input_loss_action instance-attribute

input_loss_action: NotRequired[InputLossActionForMsSmoothOut]

Parameter that control output group behavior on input loss.

num_retries instance-attribute

num_retries: NotRequired[__integerMin0]

Number of retry attempts.

restart_delay instance-attribute

restart_delay: NotRequired[__integerMin0]

Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

segmentation_mode instance-attribute

segmentation_mode: NotRequired[SmoothGroupSegmentationMode]

useInputSegmentation has been deprecated. The configured segment size is always used.

send_delay_ms instance-attribute

send_delay_ms: NotRequired[__integerMin0Max10000]

Number of milliseconds to delay the output from the second pipeline.

sparse_track_type instance-attribute

sparse_track_type: NotRequired[SmoothGroupSparseTrackType]

Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group.

stream_manifest_behavior instance-attribute

stream_manifest_behavior: NotRequired[SmoothGroupStreamManifestBehavior]

When set to send, send stream manifest so publishing point doesn't start until all streams start.

timestamp_offset instance-attribute

timestamp_offset: NotRequired[__string]

Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.

timestamp_offset_mode instance-attribute

timestamp_offset_mode: NotRequired[SmoothGroupTimestampOffsetMode]

Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset