Skip to content
v2.274.0

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.

Example ​

ts
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'),
    ],
  }],
});

Properties ​

adMarkersoptionalRtmpAdMarkers[]ad_markersoptionaltyping.List[RtmpAdMarkers]adMarkersoptionalList<RtmpAdMarkers>AdMarkersoptionalRtmpAdMarkers[]AdMarkersoptional*[]RtmpAdMarkers#
Choose the ad marker type for this output group.

Default: no ad markers

authenticationSchemeoptionalRtmpAuthenticationSchemeauthentication_schemeoptionalRtmpAuthenticationSchemeauthenticationSchemeoptionalRtmpAuthenticationSchemeAuthenticationSchemeoptionalRtmpAuthenticationSchemeAuthenticationSchemeoptionalRtmpAuthenticationScheme= RtmpAuthenticationScheme.COMMON#
The authentication scheme for the RTMP connection.
cacheFullBehavioroptionalRtmpCacheFullBehaviorcache_full_behavioroptionalRtmpCacheFullBehaviorcacheFullBehavioroptionalRtmpCacheFullBehaviorCacheFullBehavioroptionalRtmpCacheFullBehaviorCacheFullBehavioroptionalRtmpCacheFullBehavior#
Controls behavior when the content cache fills up.

Default: service default

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

Default: service default

captionDataoptionalRtmpCaptionDatacaption_dataoptionalRtmpCaptionDatacaptionDataoptionalRtmpCaptionDataCaptionDataoptionalRtmpCaptionDataCaptionDataoptionalRtmpCaptionData#
Controls the types of data that pass to onCaptionInfo outputs.

Default: service default

includeFillerNalUnitsoptionalRtmpIncludeFillerNalUnitsinclude_filler_nal_unitsoptionalRtmpIncludeFillerNalUnitsincludeFillerNalUnitsoptionalRtmpIncludeFillerNalUnitsIncludeFillerNalUnitsoptionalRtmpIncludeFillerNalUnitsIncludeFillerNalUnitsoptionalRtmpIncludeFillerNalUnits#
Controls whether filler NAL units are included in the output.

Default: service default

inputLossActionoptionalRtmpInputLossActioninput_loss_actionoptionalRtmpInputLossActioninputLossActionoptionalRtmpInputLossActionInputLossActionoptionalRtmpInputLossActionInputLossActionoptionalRtmpInputLossAction#
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.

restartDelayoptionalDurationrestart_delayoptionalDurationrestartDelayoptionalDurationRestartDelayoptionalDurationRestartDelayoptionalDuration= Duration.seconds(1)#
The delay before restarting after a streaming output failure.

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