software.amazon.awscdk.services.medialive

Interface CfnChannel.RtmpGroupSettingsProperty

All Known Implementing Classes:

CfnChannel.RtmpGroupSettingsProperty.Jsii$Proxy

Enclosing class:

CfnChannel

public static interface CfnChannel.RtmpGroupSettingsProperty

The configuration of an RTMP output group.

The parent of this entity is OutputGroupSettings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.*;
 RtmpGroupSettingsProperty rtmpGroupSettingsProperty = RtmpGroupSettingsProperty.builder()
         .adMarkers(List.of("adMarkers"))
         .authenticationScheme("authenticationScheme")
         .cacheFullBehavior("cacheFullBehavior")
         .cacheLength(123)
         .captionData("captionData")
         .inputLossAction("inputLossAction")
         .restartDelay(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnChannel.RtmpGroupSettingsProperty.Builder	builder()
default java.util.List<java.lang.String>	getAdMarkers() Choose the ad marker type for this output group.
default java.lang.String	getAuthenticationScheme() An authentication scheme to use when connecting with a CDN.
default java.lang.String	getCacheFullBehavior() Controls behavior when the content cache fills up.
default java.lang.Number	getCacheLength() The cache length, in seconds, that is used to calculate buffer size.
default java.lang.String	getCaptionData() Controls the types of data that pass to onCaptionInfo outputs.
default java.lang.String	getInputLossAction() Controls the behavior of this RTMP group if the input becomes unavailable.
default java.lang.Number	getRestartDelay() If a streaming output fails, the number of seconds to wait until a restart is initiated.

Method Detail

getAdMarkers

default java.util.List<java.lang.String> getAdMarkers()

Choose the ad marker type for this output group.

MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.

getAuthenticationScheme

default java.lang.String getAuthenticationScheme()

An authentication scheme to use when connecting with a CDN.

getCacheFullBehavior

default java.lang.String getCacheFullBehavior()

Controls behavior when the content cache fills up.

If a remote origin server stalls the RTMP connection and doesn't accept content fast enough, the media cache fills up. When the cache reaches the duration specified by cacheLength, the cache stops accepting new content. If set to disconnectImmediately, the RTMP output forces a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output waits up to 5 minutes to allow the origin server to begin accepting data again.

getCacheLength

default java.lang.Number getCacheLength()

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

getCaptionData

default java.lang.String getCaptionData()

Controls the types of data that pass to onCaptionInfo outputs.

If set to all, 608 and 708 carried DTVCC data is passed. If set to field1AndField2608, DTVCC data is stripped out, but 608 data from both fields is passed. If set to field1608, only the data carried in 608 from field 1 video is passed.

getInputLossAction

default java.lang.String getInputLossAction()

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

emitOutput: Emit a slate until the input returns. pauseOutput: Stop transmitting data until the input returns. This does not close the underlying RTMP connection.

getRestartDelay

default java.lang.Number getRestartDelay()

If a streaming output fails, the number of seconds to wait until a restart is initiated.

A value of 0 means never restart.

builder

static CfnChannel.RtmpGroupSettingsProperty.Builder builder()

Returns:

a CfnChannel.RtmpGroupSettingsProperty.Builder of CfnChannel.RtmpGroupSettingsProperty