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

Properties

adMarkersRtmpAdMarkers[]ad_markerstyping.List[RtmpAdMarkers]adMarkersList<RtmpAdMarkers>AdMarkersRtmpAdMarkers[]AdMarkers*[]RtmpAdMarkers= no ad markers#

Choose the ad marker type for this output group.

authenticationSchemeRtmpAuthenticationSchemeauthentication_schemeRtmpAuthenticationSchemeauthenticationSchemeRtmpAuthenticationSchemeAuthenticationSchemeRtmpAuthenticationSchemeAuthenticationSchemeRtmpAuthenticationScheme= RtmpAuthenticationScheme.COMMON#

The authentication scheme for the RTMP connection.

cacheFullBehaviorRtmpCacheFullBehaviorcache_full_behaviorRtmpCacheFullBehaviorcacheFullBehaviorRtmpCacheFullBehaviorCacheFullBehaviorRtmpCacheFullBehaviorCacheFullBehaviorRtmpCacheFullBehavior= service default#

Controls behavior when the content cache fills up.

cacheLengthDurationcache_lengthDurationcacheLengthDurationCacheLengthDurationCacheLengthDuration= service default#

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

captionDataRtmpCaptionDatacaption_dataRtmpCaptionDatacaptionDataRtmpCaptionDataCaptionDataRtmpCaptionDataCaptionDataRtmpCaptionData= service default#

Controls the types of data that pass to onCaptionInfo outputs.

includeFillerNalUnitsRtmpIncludeFillerNalUnitsinclude_filler_nal_unitsRtmpIncludeFillerNalUnitsincludeFillerNalUnitsRtmpIncludeFillerNalUnitsIncludeFillerNalUnitsRtmpIncludeFillerNalUnitsIncludeFillerNalUnitsRtmpIncludeFillerNalUnits= service default#

Controls whether filler NAL units are included in the output.

inputLossActionRtmpInputLossActioninput_loss_actionRtmpInputLossActioninputLossActionRtmpInputLossActionInputLossActionRtmpInputLossActionInputLossActionRtmpInputLossAction= service default#

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

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.

restartDelayDurationrestart_delayDurationrestartDelayDurationRestartDelayDurationRestartDelayDuration= Duration.seconds(1)#

The delay before restarting after a streaming output failure.

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