Package software.amazon.awscdk.services.medialive.alpha

Interface UdpOutputGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UdpOutputGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:41.393Z")
@Stability(Experimental)
public interface UdpOutputGroupProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a UDP output group.

Example:

 EncodeConfiguration video;
 OutputGroupConfiguration.udp(UdpOutputGroupProps.builder()
         .name("udp")
         .destinations(List.of(UdpOutputDestination.rtp(TransportOutputDestinationProps.builder().address("203.0.113.5").port(5000).build())))
         .outputs(List.of(UdpOutputDefinition.builder()
                 .encodes(List.of(video))
                 .outputName("ts")
                 .fec(FecOutputSettings.builder().mode(FecMode.COLUMN_AND_ROW).columnDepth(10).rowLength(10).build())
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UdpOutputGroupProps.Builder	A builder for UdpOutputGroupProps
static final class	UdpOutputGroupProps.Jsii$Proxy	An implementation for UdpOutputGroupProps

Method Summary

Modifier and Type	Method	Description
static UdpOutputGroupProps.Builder	builder()
default Duration	getBuffer()	(experimental) The output buffering.
List<UdpOutputDestination>	getDestinations()	(experimental) The destinations for this output group — one per pipeline.
default UdpInputLossAction	getInputLossAction()	(experimental) Action to take when the input is lost.
String	getName()	(experimental) The name of this output group.
default List<UdpOutputDefinition>	getOutputs()	(experimental) The outputs for this UDP output group.
default UdpTimedMetadataId3Frame	getTimedMetadataId3Frame()	(experimental) Indicates the ID3 frame that has the timecode.
default Duration	getTimedMetadataId3Period()	(experimental) The timed metadata interval.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinations

@Stability(Experimental)
@NotNull
List<UdpOutputDestination> getDestinations()

(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.

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) The name of this output group.

Used as the destination reference ID. Underscores are normalised to hyphens internally.

getBuffer

@Stability(Experimental)
@Nullable
default Duration getBuffer()

(experimental) The output buffering.

Applied at millisecond granularity.

Default: - service default

getInputLossAction

@Stability(Experimental)
@Nullable
default UdpInputLossAction getInputLossAction()

(experimental) Action to take when the input is lost.

Default: UdpInputLossAction.EMIT_PROGRAM

getOutputs

@Stability(Experimental)
@Nullable
default List<UdpOutputDefinition> getOutputs()

(experimental) The outputs for this UDP output group.

Default: - no initial outputs

getTimedMetadataId3Frame

@Stability(Experimental)
@Nullable
default UdpTimedMetadataId3Frame getTimedMetadataId3Frame()

(experimental) Indicates the ID3 frame that has the timecode.

Default: UdpTimedMetadataId3Frame.PRIV

getTimedMetadataId3Period

@Stability(Experimental)
@Nullable
default Duration getTimedMetadataId3Period()

(experimental) The timed metadata interval.

Default: - Duration.seconds(10)

builder

@Stability(Experimental)
static UdpOutputGroupProps.Builder builder()

Returns:

a UdpOutputGroupProps.Builder of UdpOutputGroupProps