@aws-cdk/aws-medialive-alpha.RtmpOutputGroupProps

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

RtmpOutputGroupProps Struct

Properties for an RTMP output group.

Stability

Experimental

Source

lib/output-group.ts

Example

declare const video: medialive.EncodeConfiguration;
declare const audio: medialive.EncodeConfiguration;

medialive.OutputGroupConfiguration.rtmp({
  name: 'social',
  outputs: [{
    encodes: [video, audio],
    outputName: 'live',
    destinations: [
      medialive.RtmpDestination.url('rtmp://rtmp.example.com/live', 'your-stream-key'),
    ],
  }],
});

# video: medialive.EncodeConfiguration
# audio: medialive.EncodeConfiguration


medialive.OutputGroupConfiguration.rtmp(
    name="social",
    outputs=[medialive.RtmpOutputDefinition(
        encodes=[video, audio],
        output_name="live",
        destinations=[
            medialive.RtmpDestination.url("rtmp://rtmp.example.com/live", "your-stream-key")
        ]
    )]
)

EncodeConfiguration video;
EncodeConfiguration audio;


OutputGroupConfiguration.rtmp(RtmpOutputGroupProps.builder()
        .name("social")
        .outputs(List.of(RtmpOutputDefinition.builder()
                .encodes(List.of(video, audio))
                .outputName("live")
                .destinations(List.of(RtmpDestination.url("rtmp://rtmp.example.com/live", "your-stream-key")))
                .build()))
        .build());

// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
EncodeConfiguration video;
EncodeConfiguration audio;


OutputGroupConfiguration.Rtmp(new RtmpOutputGroupProps {
    Name = "social",
    Outputs = new [] { new RtmpOutputDefinition {
        Encodes = new [] { video, audio },
        OutputName = "live",
        Destinations = new [] { RtmpDestination.Url("rtmp://rtmp.example.com/live", "your-stream-key") }
    } }
});

// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
var video EncodeConfiguration
var audio EncodeConfiguration


medialive.OutputGroupConfiguration_Rtmp(&RtmpOutputGroupProps{
	Name: jsii.String("social"),
	Outputs: []RtmpOutputDefinition{
		&RtmpOutputDefinition{
			Encodes: []EncodeConfiguration{
				video,
				audio,
			},
			OutputName: jsii.String("live"),
			Destinations: []RtmpDestination{
				medialive.RtmpDestination_Url(jsii.String("rtmp://rtmp.example.com/live"), jsii.String("your-stream-key")),
			},
		},
	},
})

Properties

adMarkers?optionalRtmpAdMarkers[]ad_markers?optionaltyping.List[RtmpAdMarkers]adMarkers?optionalList<RtmpAdMarkers>AdMarkers?optionalRtmpAdMarkers[]AdMarkers?optional*[]RtmpAdMarkers#

Choose the ad marker type for this output group.

Default: no ad markers

authenticationScheme?optionalRtmpAuthenticationSchemeauthentication_scheme?optionalRtmpAuthenticationSchemeauthenticationScheme?optionalRtmpAuthenticationSchemeAuthenticationScheme?optionalRtmpAuthenticationSchemeAuthenticationScheme?optionalRtmpAuthenticationScheme= RtmpAuthenticationScheme.COMMON#

The authentication scheme for the RTMP connection.

cacheFullBehavior?optionalRtmpCacheFullBehaviorcache_full_behavior?optionalRtmpCacheFullBehaviorcacheFullBehavior?optionalRtmpCacheFullBehaviorCacheFullBehavior?optionalRtmpCacheFullBehaviorCacheFullBehavior?optionalRtmpCacheFullBehavior#

Controls behavior when the content cache fills up.

Default: service default

cacheLength?optionalDurationcache_length?optionalDurationcacheLength?optionalDurationCacheLength?optionalDurationCacheLength?optionalDuration#

The cache length, in seconds, that is used to calculate buffer size.

Default: service default

captionData?optionalRtmpCaptionDatacaption_data?optionalRtmpCaptionDatacaptionData?optionalRtmpCaptionDataCaptionData?optionalRtmpCaptionDataCaptionData?optionalRtmpCaptionData#

Controls the types of data that pass to onCaptionInfo outputs.

Default: service default

includeFillerNalUnits?optionalRtmpIncludeFillerNalUnitsinclude_filler_nal_units?optionalRtmpIncludeFillerNalUnitsincludeFillerNalUnits?optionalRtmpIncludeFillerNalUnitsIncludeFillerNalUnits?optionalRtmpIncludeFillerNalUnitsIncludeFillerNalUnits?optionalRtmpIncludeFillerNalUnits#

Controls whether filler NAL units are included in the output.

Default: service default

inputLossAction?optionalRtmpInputLossActioninput_loss_action?optionalRtmpInputLossActioninputLossAction?optionalRtmpInputLossActionInputLossAction?optionalRtmpInputLossActionInputLossAction?optionalRtmpInputLossAction#

Controls the behavior of this RTMP group if the input becomes unavailable.

Default: service default

namestringnamestrnameStringNamestringName*stringrequired#

The name of this output group.

outputsRtmpOutputDefinition[]outputstyping.List[RtmpOutputDefinition]outputsList<RtmpOutputDefinition>OutputsRtmpOutputDefinition[]Outputs*[]RtmpOutputDefinitionrequired#

The outputs for this RTMP output group.

Each output includes its own RTMP destination.

restartDelay?optionalDurationrestart_delay?optionalDurationrestartDelay?optionalDurationRestartDelay?optionalDurationRestartDelay?optionalDuration= Duration.seconds(1)#

The delay before restarting after a streaming output failure.

A value of Duration.seconds(0) means never restart.