Skip to content

CmafIngestGroupSettings

Source code in docs_src/capo_medialive/types/cmaf_ingest_group_settings.py
class CmafIngestGroupSettings(TypedDict, closed=True):
    destination: NotRequired[
        "capo_medialive.types.output_location_ref.OutputLocationRef"
    ]
    """A HTTP destination for the tracks"""
    nielsen_id3_behavior: NotRequired[
        "capo_medialive.types.cmaf_nielsen_id3_behavior.CmafNielsenId3Behavior"
    ]
    """If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output."""
    scte35_type: NotRequired["capo_medialive.types.scte35_type.Scte35Type"]
    """SCTE-35 insertion type. Option "none" indicates that a SCTE-35 marker will not be inserted, nor will an IDR be inserted at the SCTE-35 cue point, nor will the segment be segmented. Option "scte35WithoutIdr" indicates that a SCTE-35 marker will be inserted to indicate the cue point, but MediaLive will not insert an IDR on that frame nor will it introduce a new segment boundary there if it wasn't already going to be one (this option is required for use with downstream multiview bitstream stitching workflows). Option "scte35WithoutSegmentation" indicates that a SCTE-35 marker will be inserted to indicate the cue point, and an IDR will be inserted on that frame so that a downstream re-packager might split the segment there, but MediaLive itself will not introduce a new segment boundary there."""
    segment_length: NotRequired["capo_medialive.types.__integer_min1.__integerMin1"]
    """The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units."""
    segment_length_units: NotRequired[
        "capo_medialive.types.cmaf_ingest_segment_length_units.CmafIngestSegmentLengthUnits"
    ]
    """Time unit for segment length parameter."""
    send_delay_ms: NotRequired[
        "capo_medialive.types.__integer_min0_max2000.__integerMin0Max2000"
    ]
    """Number of milliseconds to delay the output from the second pipeline."""
    klv_behavior: NotRequired["capo_medialive.types.cmaf_klv_behavior.CmafKLVBehavior"]
    """If set to passthrough, passes any KLV data from the input source to this output."""
    klv_name_modifier: NotRequired[
        "capo_medialive.types.__string_max100.__stringMax100"
    ]
    r"""Change the modifier that MediaLive automatically adds to the Streams() name that identifies a KLV track. The default is "klv", which means the default name will be Streams(klv.cmfm). Any string you enter here will replace the "klv" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters."""
    nielsen_id3_name_modifier: NotRequired[
        "capo_medialive.types.__string_max100.__stringMax100"
    ]
    r"""Change the modifier that MediaLive automatically adds to the Streams() name that identifies a Nielsen ID3 track. The default is "nid3", which means the default name will be Streams(nid3.cmfm). Any string you enter here will replace the "nid3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters."""
    scte35_name_modifier: NotRequired[
        "capo_medialive.types.__string_max100.__stringMax100"
    ]
    r"""Change the modifier that MediaLive automatically adds to the Streams() name for a SCTE 35 track. The default is "scte", which means the default name will be Streams(scte.cmfm). Any string you enter here will replace the "scte" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters."""
    id3_behavior: NotRequired["capo_medialive.types.cmaf_id3_behavior.CmafId3Behavior"]
    """Set to ENABLED to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group, or you add an ID3 action to the channel schedule."""
    id3_name_modifier: NotRequired[
        "capo_medialive.types.__string_max100.__stringMax100"
    ]
    r"""Change the modifier that MediaLive automatically adds to the Streams() name that identifies an ID3 track. The default is "id3", which means the default name will be Streams(id3.cmfm). Any string you enter here will replace the "id3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters."""
    caption_language_mappings: NotRequired[
        "capo_medialive.types.__list_of_cmaf_ingest_caption_language_mapping.__listOfCmafIngestCaptionLanguageMapping"
    ]
    """An array that identifies the languages in the four caption channels in the embedded captions."""
    timed_metadata_id3_frame: NotRequired[
        "capo_medialive.types.cmaf_timed_metadata_id3_frame.CmafTimedMetadataId3Frame"
    ]
    """Set to none if you don't want to insert a timecode in the output. Otherwise choose the frame type for the timecode."""
    timed_metadata_id3_period: NotRequired[
        "capo_medialive.types.__integer_min0_max10000.__integerMin0Max10000"
    ]
    """If you set up to insert a timecode in the output, specify the frequency for the frame, in seconds."""
    timed_metadata_passthrough: NotRequired[
        "capo_medialive.types.cmaf_timed_metadata_passthrough.CmafTimedMetadataPassthrough"
    ]
    """Set to enabled to pass through ID3 metadata from the input sources."""
    additional_destinations: NotRequired[
        "capo_medialive.types.__list_of_additional_destinations.__listOfAdditionalDestinations"
    ]
    """Optional an array of additional destinational HTTP destinations for the OutputGroup outputs"""
    watermarking_settings: NotRequired[
        "capo_medialive.types.cmaf_ingest_watermarking_settings.CmafIngestWatermarkingSettings"
    ]
    """Specifies the type of watermarking technology to use."""

additional_destinations instance-attribute

additional_destinations: NotRequired[__listOfAdditionalDestinations]

Optional an array of additional destinational HTTP destinations for the OutputGroup outputs

caption_language_mappings instance-attribute

caption_language_mappings: NotRequired[__listOfCmafIngestCaptionLanguageMapping]

An array that identifies the languages in the four caption channels in the embedded captions.

destination instance-attribute

destination: NotRequired[OutputLocationRef]

A HTTP destination for the tracks

id3_behavior instance-attribute

id3_behavior: NotRequired[CmafId3Behavior]

Set to ENABLED to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group, or you add an ID3 action to the channel schedule.

id3_name_modifier instance-attribute

id3_name_modifier: NotRequired[__stringMax100]

Change the modifier that MediaLive automatically adds to the Streams() name that identifies an ID3 track. The default is "id3", which means the default name will be Streams(id3.cmfm). Any string you enter here will replace the "id3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

klv_behavior instance-attribute

klv_behavior: NotRequired[CmafKLVBehavior]

If set to passthrough, passes any KLV data from the input source to this output.

klv_name_modifier instance-attribute

klv_name_modifier: NotRequired[__stringMax100]

Change the modifier that MediaLive automatically adds to the Streams() name that identifies a KLV track. The default is "klv", which means the default name will be Streams(klv.cmfm). Any string you enter here will replace the "klv" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

nielsen_id3_behavior instance-attribute

nielsen_id3_behavior: NotRequired[CmafNielsenId3Behavior]

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

nielsen_id3_name_modifier instance-attribute

nielsen_id3_name_modifier: NotRequired[__stringMax100]

Change the modifier that MediaLive automatically adds to the Streams() name that identifies a Nielsen ID3 track. The default is "nid3", which means the default name will be Streams(nid3.cmfm). Any string you enter here will replace the "nid3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

scte35_name_modifier instance-attribute

scte35_name_modifier: NotRequired[__stringMax100]

Change the modifier that MediaLive automatically adds to the Streams() name for a SCTE 35 track. The default is "scte", which means the default name will be Streams(scte.cmfm). Any string you enter here will replace the "scte" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

scte35_type instance-attribute

scte35_type: NotRequired[Scte35Type]

SCTE-35 insertion type. Option "none" indicates that a SCTE-35 marker will not be inserted, nor will an IDR be inserted at the SCTE-35 cue point, nor will the segment be segmented. Option "scte35WithoutIdr" indicates that a SCTE-35 marker will be inserted to indicate the cue point, but MediaLive will not insert an IDR on that frame nor will it introduce a new segment boundary there if it wasn't already going to be one (this option is required for use with downstream multiview bitstream stitching workflows). Option "scte35WithoutSegmentation" indicates that a SCTE-35 marker will be inserted to indicate the cue point, and an IDR will be inserted on that frame so that a downstream re-packager might split the segment there, but MediaLive itself will not introduce a new segment boundary there.

segment_length instance-attribute

segment_length: NotRequired[__integerMin1]

The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units.

segment_length_units instance-attribute

segment_length_units: NotRequired[CmafIngestSegmentLengthUnits]

Time unit for segment length parameter.

send_delay_ms instance-attribute

send_delay_ms: NotRequired[__integerMin0Max2000]

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

timed_metadata_id3_frame instance-attribute

timed_metadata_id3_frame: NotRequired[CmafTimedMetadataId3Frame]

Set to none if you don't want to insert a timecode in the output. Otherwise choose the frame type for the timecode.

timed_metadata_id3_period instance-attribute

timed_metadata_id3_period: NotRequired[__integerMin0Max10000]

If you set up to insert a timecode in the output, specify the frequency for the frame, in seconds.

timed_metadata_passthrough instance-attribute

timed_metadata_passthrough: NotRequired[CmafTimedMetadataPassthrough]

Set to enabled to pass through ID3 metadata from the input sources.

watermarking_settings instance-attribute

watermarking_settings: NotRequired[CmafIngestWatermarkingSettings]

Specifies the type of watermarking technology to use.