OutputGroupConfiguration

class aws_cdk.aws_medialive_alpha.OutputGroupConfiguration

Bases: object

(experimental) Configuration for an output group.

Use the static factory methods to create.

Stability:: experimental
ExampleMetadata:: infused

Example:

# stack: Stack
# input: medialive.IInput
# bucket: s3.IBucket
# video: medialive.EncodeConfiguration


medialive.Channel(stack, "Channel",
    inputs=[medialive.InputAttachment(
        input=input,
        network_input_settings=medialive.NetworkInputSettings(
            server_validation=medialive.ServerValidation.CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME,
            hls_input_settings=medialive.HlsInputSettings(
                bandwidth=Bitrate.mbps(5),
                scte35_source=medialive.HlsScte35Source.MANIFEST
            )
        ),
        logical_interface_names=["eth0", "eth1"]
    )],
    output_groups=[
        medialive.OutputGroupConfiguration.hls(
            name="hls",
            destinations=[medialive.OutputDestination.to_bucket(bucket, "live/stream")],
            outputs=[medialive.HlsOutputDefinition(encodes=[video], output_name="hls_out")]
        )
    ]
)

Stability:: experimental

Static Methods

classmethod archive(*, destinations, name, archive_s3_canned_acl=None, outputs=None, rollover_interval=None)

(experimental) Create an Archive (S3) output group configuration.

Parameters:

destinations (Sequence[S3OutputDestination]) – (experimental) The destinations for this output group — one per pipeline. Array position determines the pipeline mapping: - destinations[0] → Pipeline 0 - destinations[1] → Pipeline 1 (STANDARD channels only) For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
archive_s3_canned_acl (Optional[S3CannedAcl]) – (experimental) The S3 canned ACL to apply to each archive output. Default: - no canned ACL
outputs (Optional[Sequence[Union[ArchiveOutputDefinition, Dict[str, Any]]]]) – (experimental) The outputs for this Archive output group. Default: - no initial outputs
rollover_interval (Optional[Duration]) – (experimental) The duration of each archive file (rollover interval). Default: Duration.seconds(300)

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod cmaf_ingest(*, destinations, name, outputs, additional_destinations=None, caption_language_mappings=None, id3_behavior=None, id3_name_modifier=None, klv_behavior=None, klv_name_modifier=None, nielsen_id3_behavior=None, nielsen_id3_name_modifier=None, scte35_name_modifier=None, scte35_type=None, segment=None, send_delay_ms=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None, timed_metadata_passthrough=None)

(experimental) Create a CMAF Ingest output group configuration.

Parameters:

destinations (Sequence[OutputDestination]) – (experimental) The primary CMAF ingest destinations — one per pipeline. Array position determines the pipeline mapping: - destinations[0] → Pipeline 0 - destinations[1] → Pipeline 1 (STANDARD channels only) For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations to utilise both pipelines for redundancy.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
outputs (Sequence[Union[CmafIngestOutputDefinition, Dict[str, Any]]]) – (experimental) The outputs for this CMAF Ingest output group. Each output should contain a single encode.
additional_destinations (Optional[Sequence[OutputDestination]]) – (experimental) Configure additional destinations to fan out the CMAF ingest output to extra endpoints, for example for cross-region delivery or backup packaging. Standard channels support up to 2 additional destinations. Single pipeline channels support 1 additional destination. Default: - no additional destinations
caption_language_mappings (Optional[Sequence[Union[CmafCaptionLanguageMapping, Dict[str, Any]]]]) – (experimental) Maps captions channels to languages for this CMAF Ingest output group. Default: - no caption language mappings
id3_behavior (Optional[Id3Behavior]) – (experimental) The ID3 behavior for the CMAF ingest output. Default: Id3Behavior.DISABLED
id3_name_modifier (Optional[str]) – (experimental) The name modifier for ID3 metadata. Default: - service default
klv_behavior (Optional[KlvBehavior]) – (experimental) The KLV behavior for the CMAF ingest output. Default: KlvBehavior.NO_PASSTHROUGH
klv_name_modifier (Optional[str]) – (experimental) The name modifier for KLV metadata. Default: - service default
nielsen_id3_behavior (Optional[NielsenId3Behavior]) – (experimental) The Nielsen ID3 behavior for the CMAF ingest output. Default: NielsenId3Behavior.NO_PASSTHROUGH
nielsen_id3_name_modifier (Optional[str]) – (experimental) The name modifier for Nielsen ID3 metadata. Default: - service default
scte35_name_modifier (Optional[str]) – (experimental) The name modifier for SCTE-35 messages. Default: - service default
scte35_type (Optional[Scte35Type]) – (experimental) The SCTE-35 type for the CMAF ingest output. Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION
segment (Optional[Segment]) – (experimental) The length of each media segment. Default: - Segment.seconds(1)
send_delay_ms (Union[int, float, None]) – (experimental) The number of milliseconds to delay the output from the second pipeline. Default: - service default
timed_metadata_id3_frame (Optional[TimedMetadataId3Frame]) – (experimental) Indicates the ID3 frame that has the timecode. Default: TimedMetadataId3Frame.NONE
timed_metadata_id3_period (Optional[Duration]) – (experimental) The timed metadata interval. Default: - Duration.seconds(10)
timed_metadata_passthrough (Optional[TimedMetadataPassthrough]) – (experimental) Whether timed metadata is passed through. Default: TimedMetadataPassthrough.DISABLED

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod frame_capture(*, destinations, name, frame_capture_s3_canned_acl=None, outputs=None)

(experimental) Create a Frame Capture output group configuration.

A channel that includes a Frame Capture output group must also include a separate video output group (e.g. Archive, HLS, UDP). Frame Capture cannot be the channel’s only output group.

Parameters:

destinations (Sequence[S3OutputDestination]) – (experimental) The destinations for this output group — one per pipeline. Array position determines the pipeline mapping: - destinations[0] → Pipeline 0 - destinations[1] → Pipeline 1 (STANDARD channels only) For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
frame_capture_s3_canned_acl (Optional[S3CannedAcl]) – (experimental) The S3 canned ACL to apply to each frame capture output. Default: - no canned ACL
outputs (Optional[Sequence[Union[FrameCaptureOutputDefinition, Dict[str, Any]]]]) – (experimental) The outputs for this Frame Capture output group. Default: - no initial outputs

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod hls(*, destinations, name, ad_markers=None, base_url_content=None, base_url_content1=None, base_url_manifest=None, base_url_manifest1=None, caption_language_mappings=None, caption_language_setting=None, client_cache=None, codec_specification=None, constant_iv=None, directory_structure=None, discontinuity_tags=None, encryption_type=None, hls_cdn_settings=None, hls_id3_segment_tagging=None, i_frame_only_playlists=None, incomplete_segment_behavior=None, index_n_segments=None, input_loss_action=None, iv_in_manifest=None, iv_source=None, keep_segments=None, key_format=None, key_format_versions=None, key_provider_settings=None, manifest_compression=None, manifest_duration_format=None, min_segment=None, mode=None, outputs=None, output_selection=None, program_date_time=None, program_date_time_clock=None, program_date_time_period=None, redundant_manifest=None, segment=None, segmentation_mode=None, segments_per_subdirectory=None, stream_inf_resolution=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None, timestamp_delta=None, ts_file_mode=None)

(experimental) Create an HLS output group configuration.

Parameters:

destinations (Sequence[OutputDestination]) – (experimental) The destinations for this output group — one per pipeline. Array position determines the pipeline mapping: - destinations[0] → Pipeline 0 - destinations[1] → Pipeline 1 (STANDARD channels only) For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
ad_markers (Optional[Sequence[HlsAdMarkers]]) – (experimental) Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. Default: - no ad markers
base_url_content (Optional[str]) – (experimental) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Default: - no base URL content prefix
base_url_content1 (Optional[str]) – (experimental) Optional base URL content for pipeline 1 if different from pipeline 0. Default: - no base URL content 1
base_url_manifest (Optional[str]) – (experimental) A partial URI prefix that will be prepended to each output in the media .m3u8 file for the manifest. Default: - no base URL manifest prefix
base_url_manifest1 (Optional[str]) – (experimental) Optional base URL manifest for pipeline 1 if different from pipeline 0. Default: - no base URL manifest 1
caption_language_mappings (Optional[Sequence[Union[CaptionLanguageMapping, Dict[str, Any]]]]) – (experimental) A mapping of up to 4 captions channels to captions languages. Meaningful only if captionLanguageSetting is set to INSERT. Default: - no caption language mappings
caption_language_setting (Optional[HlsCaptionLanguageSetting]) – (experimental) Applies only to 608 embedded output captions. Default: - service default
client_cache (Optional[HlsClientCache]) – (experimental) When set to DISABLED, sets the #EXT-X-ALLOW-CACHE:no tag in the manifest. Default: HlsClientCache.ENABLED
codec_specification (Optional[HlsCodecSpecification]) – (experimental) The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Default: HlsCodecSpecification.RFC_4281
constant_iv (Optional[str]) – (experimental) A 128-bit, 16-byte hex value represented by a 32-character text string used as the IV for encryption. Used with encryptionType when ivSource is set to EXPLICIT. Default: - no constant IV
directory_structure (Optional[HlsDirectoryStructure]) – (experimental) Places segments in subdirectories. Default: HlsDirectoryStructure.SINGLE_DIRECTORY
discontinuity_tags (Optional[HlsDiscontinuityTags]) – (experimental) Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests. Default: HlsDiscontinuityTags.INSERT
encryption_type (Optional[HlsEncryptionType]) – (experimental) Encrypts the segments with the specified encryption scheme. Default: - no encryption
hls_cdn_settings (Optional[HlsCdnSettings]) – (experimental) Settings to configure the CDN for the HLS output. Default: - service default
hls_id3_segment_tagging (Optional[HlsId3SegmentTaggingState]) – (experimental) State of HLS ID3 Segment Tagging. Default: HlsId3SegmentTaggingState.DISABLED
i_frame_only_playlists (Optional[HlsIFrameOnlyPlaylists]) – (experimental) Whether to create an I-frame-only manifest. Default: HlsIFrameOnlyPlaylists.DISABLED
incomplete_segment_behavior (Optional[HlsIncompleteSegmentBehavior]) – (experimental) Specifies whether to include the final (incomplete) segment in the media output. Default: HlsIncompleteSegmentBehavior.AUTO
index_n_segments (Union[int, float, None]) – (experimental) The maximum number of segments in the media manifest (LIVE mode only). Default: 10
input_loss_action (Optional[HlsInputLossAction]) – (experimental) Action to take when the input is lost. Default: HlsInputLossAction.EMIT_OUTPUT
iv_in_manifest (Optional[HlsIvInManifest]) – (experimental) Whether the IV is listed in the manifest. Default: - service default
iv_source (Optional[HlsIvSource]) – (experimental) Whether the IV follows the segment number or is explicit. Default: - service default
keep_segments (Union[int, float, None]) – (experimental) The number of segments to retain in the destination directory (LIVE mode only). Default: 21
key_format (Optional[str]) – (experimental) Specifies how the key is represented in the resource identified by the URI. Default: - service default
key_format_versions (Optional[str]) – (experimental) Either a single positive integer version value or a slash-delimited list of version values (1/2/3). Default: - service default
key_provider_settings (Optional[HlsKeyProviderSettings]) – (experimental) The key provider settings for HLS encryption. Default: - no key provider settings
manifest_compression (Optional[HlsManifestCompression]) – (experimental) When set to GZIP, compresses HLS playlist. Default: HlsManifestCompression.NONE
manifest_duration_format (Optional[HlsManifestDurationFormat]) – (experimental) Indicates whether the output manifest should use floating point or integer values for segment duration. Default: HlsManifestDurationFormat.FLOATING_POINT
min_segment (Optional[Segment]) – (experimental) The minimum segment length. HLS supports whole-second segments only. Default: - service default
mode (Optional[HlsMode]) – (experimental) The output mode — LIVE or VOD. Default: HlsMode.LIVE
outputs (Optional[Sequence[Union[HlsOutputDefinition, Dict[str, Any]]]]) – (experimental) The outputs for this HLS output group. Default: - no initial outputs
output_selection (Optional[HlsOutputSelection]) – (experimental) Controls which manifests and segments are generated. Default: HlsOutputSelection.MANIFESTS_AND_SEGMENTS
program_date_time (Optional[HlsProgramDateTime]) – (experimental) Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. Default: HlsProgramDateTime.INCLUDE
program_date_time_clock (Optional[HlsProgramDateTimeClock]) – (experimental) Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Default: - HlsProgramDateTimeClock.SYSTEM_CLOCK, or INITIALIZE_FROM_OUTPUT_TIMECODE with epoch locking
program_date_time_period (Optional[Duration]) – (experimental) The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry. Default: Duration.minutes(10)
redundant_manifest (Optional[HlsRedundantManifest]) – (experimental) Whether the master manifest includes information about both pipelines. Default: HlsRedundantManifest.DISABLED
segment (Optional[Segment]) – (experimental) The length of each media segment. HLS supports whole-second segments only. Default: - Segment.seconds(2)
segmentation_mode (Optional[HlsSegmentationMode]) – (experimental) The segmentation mode. Default: HlsSegmentationMode.USE_SEGMENT_DURATION
segments_per_subdirectory (Union[int, float, None]) – (experimental) The number of segments to write to a subdirectory before starting a new one. Default: 10000
stream_inf_resolution (Optional[HlsStreamInfResolution]) – (experimental) Whether to include or exclude the RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag. Default: HlsStreamInfResolution.INCLUDE
timed_metadata_id3_frame (Optional[HlsTimedMetadataId3Frame]) – (experimental) Indicates the ID3 frame that has the timecode. Default: HlsTimedMetadataId3Frame.PRIV
timed_metadata_id3_period (Optional[Duration]) – (experimental) The timed metadata interval. Default: Duration.seconds(10)
timestamp_delta (Optional[Duration]) – (experimental) Provides an extra delta offset to fine tune the timestamps. Default: - service default
ts_file_mode (Optional[HlsTsFileMode]) – (experimental) Whether to emit segmented files or a single file. Default: HlsTsFileMode.SEGMENTED_FILES

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod media_connect_router(*, availability_zones, name, outputs, router_settings=None)

(experimental) Create a MediaConnect Router output group, delivering each channel pipeline to a MediaConnect Router.

Transit encryption defaults to AUTOMATIC; override per pipeline via routerSettings.

The downstream wiring (which router input each pipeline feeds) is configured on the MediaConnect side, referencing this output group by name and the pipeline id.

Parameters:

availability_zones (Sequence[str]) – (experimental) The Availability Zones in which to write output to the MediaConnect Router. Provide exactly one AZ for a SINGLE_PIPELINE channel, or two (one per pipeline) for a STANDARD channel.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
outputs (Sequence[Union[MediaConnectRouterOutputDefinition, Dict[str, Any]]]) – (experimental) The outputs for this output group. MediaConnect Router outputs use an MPEG-TS container, so each output may multiplex one video encode and one or more audio encodes (as with UDP).
router_settings (Optional[MediaConnectRouterSettings]) – (experimental) Transit-encryption settings, applied per channel pipeline. Default: - AUTOMATIC (service-managed) transit encryption on every pipeline

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod media_package_v2(*, channel, name, outputs, additional_destinations=None, caption_language_mappings=None, id3_behavior=None, klv_behavior=None, nielsen_id3_behavior=None, scte35_type=None, segment=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None, timed_metadata_passthrough=None)

(experimental) Create a MediaPackage V2 output group that delivers to a single channel, auto-mapping each pipeline to a MediaPackage ingest endpoint based on the channel class.

Parameters:

channel (IChannel) – (experimental) The MediaPackage V2 channel to deliver to. MediaLive maps the channel pipelines to the channel’s ingest endpoints automatically based on the channel class.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
outputs (Sequence[Union[MediaPackageV2OutputDefinition, Dict[str, Any]]]) – (experimental) The outputs for this output group. MediaPackage V2 uses CMAF ingest which requires one track per output. Create a separate output for each encode (e.g. one for HD video, one for SD video, one for audio). Do NOT put multiple encodes in a single output.
additional_destinations (Optional[Sequence[MediaPackageV2Destination]]) – (experimental) Configure additional destinations to fan out the output to extra MediaPackage V2 channels, for example for cross-region delivery or backup packaging. These correspond to Destination 3/4 in the AWS console. Each additional destination is a single, explicit entry (channel + endpoint), independent of the channel class. Default: - no additional destinations
caption_language_mappings (Optional[Sequence[Union[CaptionLanguageMapping, Dict[str, Any]]]]) – (experimental) Caption language mappings for the MediaPackage V2 output. Default: - no caption language mappings
id3_behavior (Optional[Id3Behavior]) – (experimental) The ID3 behavior. Default: Id3Behavior.DISABLED
klv_behavior (Optional[KlvBehavior]) – (experimental) The KLV behavior. Default: KlvBehavior.NO_PASSTHROUGH
nielsen_id3_behavior (Optional[NielsenId3Behavior]) – (experimental) The Nielsen ID3 behavior. Default: NielsenId3Behavior.NO_PASSTHROUGH
scte35_type (Optional[Scte35Type]) – (experimental) The SCTE-35 type. Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION
segment (Optional[Segment]) – (experimental) The length of each media segment. Default: - Segment.seconds(1)
timed_metadata_id3_frame (Optional[TimedMetadataId3Frame]) – (experimental) The timed metadata ID3 frame. Default: TimedMetadataId3Frame.NONE
timed_metadata_id3_period (Optional[Duration]) – (experimental) The timed metadata interval. Default: Duration.seconds(10)
timed_metadata_passthrough (Optional[TimedMetadataPassthrough]) – (experimental) Whether timed metadata is passed through. Default: TimedMetadataPassthrough.DISABLED

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod media_package_v2_per_pipeline(*, destinations, name, outputs, additional_destinations=None, caption_language_mappings=None, id3_behavior=None, klv_behavior=None, nielsen_id3_behavior=None, scte35_type=None, segment=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None, timed_metadata_passthrough=None)

(experimental) Create a MediaPackage V2 output group with explicit per-pipeline destinations (channel + endpoint per pipeline).

Use for cross-region delivery or pinning a pipeline to an endpoint.

Parameters:

destinations (Sequence[MediaPackageV2Destination]) – (experimental) The primary MediaPackage V2 destinations — one per pipeline. Array position determines the pipeline mapping: - destinations[0] → Pipeline 0 - destinations[1] → Pipeline 1 (STANDARD channels only) For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
outputs (Sequence[Union[MediaPackageV2OutputDefinition, Dict[str, Any]]]) – (experimental) The outputs for this output group. MediaPackage V2 uses CMAF ingest which requires one track per output. Create a separate output for each encode (e.g. one for HD video, one for SD video, one for audio). Do NOT put multiple encodes in a single output.
additional_destinations (Optional[Sequence[MediaPackageV2Destination]]) – (experimental) Configure additional destinations to fan out the output to extra MediaPackage V2 channels, for example for cross-region delivery or backup packaging. These correspond to Destination 3/4 in the AWS console. Each additional destination is a single, explicit entry (channel + endpoint), independent of the channel class. Default: - no additional destinations
caption_language_mappings (Optional[Sequence[Union[CaptionLanguageMapping, Dict[str, Any]]]]) – (experimental) Caption language mappings for the MediaPackage V2 output. Default: - no caption language mappings
id3_behavior (Optional[Id3Behavior]) – (experimental) The ID3 behavior. Default: Id3Behavior.DISABLED
klv_behavior (Optional[KlvBehavior]) – (experimental) The KLV behavior. Default: KlvBehavior.NO_PASSTHROUGH
nielsen_id3_behavior (Optional[NielsenId3Behavior]) – (experimental) The Nielsen ID3 behavior. Default: NielsenId3Behavior.NO_PASSTHROUGH
scte35_type (Optional[Scte35Type]) – (experimental) The SCTE-35 type. Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION
segment (Optional[Segment]) – (experimental) The length of each media segment. Default: - Segment.seconds(1)
timed_metadata_id3_frame (Optional[TimedMetadataId3Frame]) – (experimental) The timed metadata ID3 frame. Default: TimedMetadataId3Frame.NONE
timed_metadata_id3_period (Optional[Duration]) – (experimental) The timed metadata interval. Default: Duration.seconds(10)
timed_metadata_passthrough (Optional[TimedMetadataPassthrough]) – (experimental) Whether timed metadata is passed through. Default: TimedMetadataPassthrough.DISABLED

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod ms_smooth(*, destinations, name, acquisition_point_id=None, audio_only_timecode_control=None, certificate_mode=None, connection_retry_interval=None, event_id=None, event_id_mode=None, event_stop_behavior=None, filecache_duration=None, fragment_length=None, input_loss_action=None, num_retries=None, outputs=None, restart_delay=None, segmentation_mode=None, send_delay_ms=None, sparse_track_type=None, stream_manifest_behavior=None, timestamp_offset=None, timestamp_offset_mode=None)

(experimental) Create an MS Smooth output group configuration.

Parameters:

destinations (Sequence[OutputDestination]) – (experimental) The destinations for this output group — one per pipeline. Array position determines the pipeline mapping: - destinations[0] → Pipeline 0 - destinations[1] → Pipeline 1 (STANDARD channels only) For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
acquisition_point_id (Optional[str]) – (experimental) The value of the Acquisition Point Identity element used in each message placed in the sparse track. Default: - service default
audio_only_timecode_control (Optional[MsSmoothAudioOnlyTimecodeControl]) – (experimental) If set to passthrough for an audio-only output, the fragment absolute time is set to the current timecode. Default: - service default
certificate_mode (Optional[MsSmoothCertificateMode]) – (experimental) If set to VERIFY_AUTHENTICITY, verifies the HTTPS certificate chain to a trusted CA. Default: - service default
connection_retry_interval (Optional[Duration]) – (experimental) The number of seconds to wait before retrying the connection to the IIS server if the connection is lost. Default: - service default
event_id (Optional[str]) – (experimental) The Microsoft Smooth channel ID that is sent to the IIS server. Default: - service default
event_id_mode (Optional[MsSmoothEventIdMode]) – (experimental) Specifies whether to send a channel ID to the IIS server. Default: - service default
event_stop_behavior (Optional[MsSmoothEventStopBehavior]) – (experimental) When set to SEND_EOS, sends an EOS signal to an IIS server when stopping the channel. Default: - service default
filecache_duration (Optional[Duration]) – (experimental) The size, in seconds, of the file cache for streaming outputs. Default: - service default
fragment_length (Optional[Duration]) – (experimental) The length, in seconds, of mp4 fragments to generate. Default: - service default
input_loss_action (Optional[MsSmoothInputLossAction]) – (experimental) A parameter that controls output group behavior on an input loss. Default: - service default
num_retries (Union[int, float, None]) – (experimental) The number of retry attempts. Default: 10
outputs (Optional[Sequence[Union[MsSmoothOutputDefinition, Dict[str, Any]]]]) – (experimental) The outputs for this MS Smooth output group. Default: - no initial outputs
restart_delay (Optional[Duration]) – (experimental) The number of seconds before initiating a restart due to output failure. Default: - Duration.seconds(1)
segmentation_mode (Optional[MsSmoothSegmentationMode]) – (experimental) The segmentation mode. Default: - service default
send_delay_ms (Union[int, float, None]) – (experimental) The number of milliseconds to delay the output from the second pipeline. Default: - service default
sparse_track_type (Optional[MsSmoothSparseTrackType]) – (experimental) If set to SCTE_35, uses incoming SCTE-35 messages to generate a sparse track. Default: - service default
stream_manifest_behavior (Optional[MsSmoothStreamManifestBehavior]) – (experimental) When set to SEND, sends a stream manifest so that the publishing point doesn’t start until all streams start. Default: - service default
timestamp_offset (Optional[str]) – (experimental) The timestamp offset for the channel. Used only if timestampOffsetMode is set to USE_CONFIGURED_OFFSET. Default: - service default
timestamp_offset_mode (Optional[MsSmoothTimestampOffsetMode]) – (experimental) The type of timestamp date offset to use. Default: - service default

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod rtmp(*, name, outputs, ad_markers=None, authentication_scheme=None, cache_full_behavior=None, cache_length=None, caption_data=None, include_filler_nal_units=None, input_loss_action=None, restart_delay=None)

(experimental) Create an RTMP output group configuration.

Parameters:

name (str) – (experimental) The name of this output group.
outputs (Sequence[Union[RtmpOutputDefinition, Dict[str, Any]]]) – (experimental) The outputs for this RTMP output group. Each output includes its own RTMP destination.
ad_markers (Optional[Sequence[RtmpAdMarkers]]) – (experimental) Choose the ad marker type for this output group. Default: - no ad markers
authentication_scheme (Optional[RtmpAuthenticationScheme]) – (experimental) The authentication scheme for the RTMP connection. Default: RtmpAuthenticationScheme.COMMON
cache_full_behavior (Optional[RtmpCacheFullBehavior]) – (experimental) Controls behavior when the content cache fills up. Default: - service default
cache_length (Optional[Duration]) – (experimental) The cache length, in seconds, that is used to calculate buffer size. Default: - service default
caption_data (Optional[RtmpCaptionData]) – (experimental) Controls the types of data that pass to onCaptionInfo outputs. Default: - service default
include_filler_nal_units (Optional[RtmpIncludeFillerNalUnits]) – (experimental) Controls whether filler NAL units are included in the output. Default: - service default
input_loss_action (Optional[RtmpInputLossAction]) – (experimental) Controls the behavior of this RTMP group if the input becomes unavailable. Default: - service default
restart_delay (Optional[Duration]) – (experimental) The delay before restarting after a streaming output failure. A value of Duration.seconds(0) means never restart. Default: Duration.seconds(1)

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod srt(*, name, outputs, input_loss_action=None)

(experimental) Create an SRT output group configuration.

Parameters:

name (str) – (experimental) The name of this output group.
outputs (Sequence[Union[SrtOutputDefinition, Dict[str, Any]]]) – (experimental) The outputs for this SRT output group. Each output includes its own SRT destination.
input_loss_action (Optional[SrtInputLossAction]) – (experimental) Controls the behavior of this SRT group if the input becomes unavailable. Default: SrtInputLossAction.EMIT_PROGRAM

Stability:

experimental

Return type:

OutputGroupConfiguration

classmethod udp(*, destinations, name, buffer=None, input_loss_action=None, outputs=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None)

(experimental) Create a UDP output group configuration.

Parameters:

destinations (Sequence[UdpOutputDestination]) – (experimental) The destinations for this output group — one per pipeline. Array position determines the pipeline mapping: - destinations[0] → Pipeline 0 - destinations[1] → Pipeline 1 (STANDARD channels only) For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
buffer (Optional[Duration]) – (experimental) The output buffering. Applied at millisecond granularity. Default: - service default
input_loss_action (Optional[UdpInputLossAction]) – (experimental) Action to take when the input is lost. Default: UdpInputLossAction.EMIT_PROGRAM
outputs (Optional[Sequence[Union[UdpOutputDefinition, Dict[str, Any]]]]) – (experimental) The outputs for this UDP output group. Default: - no initial outputs
timed_metadata_id3_frame (Optional[UdpTimedMetadataId3Frame]) – (experimental) Indicates the ID3 frame that has the timecode. Default: UdpTimedMetadataId3Frame.PRIV
timed_metadata_id3_period (Optional[Duration]) – (experimental) The timed metadata interval. Default: - Duration.seconds(10)

Stability:

experimental

Return type:

OutputGroupConfiguration