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

Interface SourceNdi

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SourceNdi.Jsii$Proxy

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

(experimental) Configuration for NDI (SpeedHQ) source.

NDI sources are ingested from NDI senders inside your VPC. The flow must be configured with flowSize: FlowSize.LARGE and ndiConfig.ndiState = ENABLED with at least one NDI discovery server. The VPC connectivity for NDI is configured on the discovery server entries in NdiConfig, not on the source itself.

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	SourceNdi.Builder	A builder for SourceNdi
static final class	SourceNdi.Jsii$Proxy	An implementation for SourceNdi

Method Summary

Modifier and Type	Method	Description
static SourceNdi.Builder	builder()
default String	getDescription()	(experimental) A description of the source.
default String	getFlowSourceName()	(experimental) The name of the source.
default String	getSourceName()	(experimental) The exact name of an existing NDI sender that's registered with your discovery server.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

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

(experimental) A description of the source.

This description appears only on the MediaConnect console and will not be seen by the end user.

Default: - no description

getFlowSourceName

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

(experimental) The name of the source.

Default: - a name is generated automatically

getSourceName

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

(experimental) The exact name of an existing NDI sender that's registered with your discovery server.

If included, the format of this name must be MACHINENAME (ProgramName).

If not specified, you can select the upstream NDI sender from the console after starting the flow.

Default: - select the NDI sender after starting the flow

builder

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

Returns:

a SourceNdi.Builder of SourceNdi