Package software.amazon.awscdk.services.mediaconnect.alpha

Interface NdiConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NdiConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-31T10:49:55.189Z")
@Stability(Experimental)
public interface NdiConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration for NDI Config.

Example:

 Stack stack;
 VpcInterfaceConfig ndiVpcInterface;
 VpcInterfaceConfig efaInterface;
 MediaStream videoStream;
 // NDI requires LARGE, an encoding profile, and at least one discovery server
 // NDI requires LARGE, an encoding profile, and at least one discovery server
 Flow.Builder.create(stack, "NdiFlow")
         .flowSize(FlowSize.LARGE)
         .ndiConfig(NdiConfig.builder()
                 .ndiState(State.ENABLED)
                 .ndiDiscoveryServers(List.of(NdiDiscoveryServerConfig.builder()
                         .discoveryServerAddress("10.0.0.10")
                         .vpcInterface(ndiVpcInterface)
                         .build()))
                 .build())
         .encodingConfig(EncodingConfig.builder()
                 .encodingProfile(EncodingProfile.CONTRIBUTION_H264_DEFAULT)
                 .build())
         .source(SourceConfiguration.ndi(SourceNdi.builder()
                 .flowSourceName("ndi-source")
                 .build()))
         .build();
 // CDI and JPEG XS require LARGE_4X
 // CDI and JPEG XS require LARGE_4X
 Flow.Builder.create(stack, "CdiFlow")
         .flowSize(FlowSize.LARGE_4X)
         .vpcInterfaces(List.of(efaInterface))
         .mediaStreams(List.of(videoStream))
         .source(SourceConfiguration.cdi(SourceCdi.builder()
                 .flowSourceName("cdi-source")
                 .vpcInterface(efaInterface)
                 .port(5000)
                 .maxSyncBuffer(100)
                 .mediaStreamSourceConfigurations(List.of(MediaStreamSourceConfigurationCdi.builder()
                         .encoding(Encoding.RAW)
                         .mediaStream(videoStream)
                         .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NdiConfig.Builder	builder()
default String	getMachineName()	(experimental) A prefix for the names of the NDI sources that the flow creates.
default List<NdiDiscoveryServerConfig>	getNdiDiscoveryServers()	(experimental) Specifies the configuration settings for individual NDI discovery servers.
default State	getNdiState()	(experimental) A setting that controls whether NDI sources or outputs can be used in the flow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMachineName

@Stability(Experimental)
@Nullable
default String getMachineName()

(experimental) A prefix for the names of the NDI sources that the flow creates.

If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.

Default: - MediaConnect generates a unique 12-character ID

getNdiDiscoveryServers

@Stability(Experimental)
@Nullable
default List<NdiDiscoveryServerConfig> getNdiDiscoveryServers()

(experimental) Specifies the configuration settings for individual NDI discovery servers.

A maximum of 3 servers is allowed.

Default: - no NDI discovery servers

getNdiState

@Stability(Experimental)
@Nullable
default State getNdiState()

(experimental) A setting that controls whether NDI sources or outputs can be used in the flow.

Must be ENABLED for the flow to support NDI sources or outputs.

Default: State.DISABLED

builder

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

Returns:

a NdiConfig.Builder of NdiConfig