Show / Hide Table of Contents

Class CfnChannelPropsMixin.RtmpGroupSettingsProperty

The configuration of an RTMP output group.

Inheritance
object
CfnChannelPropsMixin.RtmpGroupSettingsProperty
Implements
CfnChannelPropsMixin.IRtmpGroupSettingsProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.MediaLive
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnChannelPropsMixin.RtmpGroupSettingsProperty : CfnChannelPropsMixin.IRtmpGroupSettingsProperty
Syntax (vb)
Public Class CfnChannelPropsMixin.RtmpGroupSettingsProperty Implements CfnChannelPropsMixin.IRtmpGroupSettingsProperty
Remarks

The parent of this entity is OutputGroupSettings.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.MediaLive;

             var rtmpGroupSettingsProperty = new RtmpGroupSettingsProperty {
                 AdMarkers = new [] { "adMarkers" },
                 AuthenticationScheme = "authenticationScheme",
                 CacheFullBehavior = "cacheFullBehavior",
                 CacheLength = 123,
                 CaptionData = "captionData",
                 IncludeFillerNalUnits = "includeFillerNalUnits",
                 InputLossAction = "inputLossAction",
                 RestartDelay = 123
             };

Synopsis

Constructors

RtmpGroupSettingsProperty()

The configuration of an RTMP output group.

Properties

AdMarkers

Choose the ad marker type for this output group.

AuthenticationScheme

An authentication scheme to use when connecting with a CDN.

CacheFullBehavior

Controls behavior when the content cache fills up.

CacheLength

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

CaptionData

Controls the types of data that pass to onCaptionInfo outputs.

IncludeFillerNalUnits

The configuration of an RTMP output group.

InputLossAction

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

RestartDelay

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

Constructors

RtmpGroupSettingsProperty()

The configuration of an RTMP output group.

public RtmpGroupSettingsProperty()
Remarks

The parent of this entity is OutputGroupSettings.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.MediaLive;

             var rtmpGroupSettingsProperty = new RtmpGroupSettingsProperty {
                 AdMarkers = new [] { "adMarkers" },
                 AuthenticationScheme = "authenticationScheme",
                 CacheFullBehavior = "cacheFullBehavior",
                 CacheLength = 123,
                 CaptionData = "captionData",
                 IncludeFillerNalUnits = "includeFillerNalUnits",
                 InputLossAction = "inputLossAction",
                 RestartDelay = 123
             };

Properties

AdMarkers

Choose the ad marker type for this output group.

public string[]? AdMarkers { get; set; }
Property Value

string[]

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-admarkers

AuthenticationScheme

An authentication scheme to use when connecting with a CDN.

public string? AuthenticationScheme { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-authenticationscheme

CacheFullBehavior

Controls behavior when the content cache fills up.

public string? CacheFullBehavior { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-cachefullbehavior

CacheLength

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

public double? CacheLength { get; set; }
Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-cachelength

CaptionData

Controls the types of data that pass to onCaptionInfo outputs.

public string? CaptionData { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-captiondata

IncludeFillerNalUnits

The configuration of an RTMP output group.

public string? IncludeFillerNalUnits { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-includefillernalunits

InputLossAction

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

public string? InputLossAction { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-inputlossaction

RestartDelay

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

public double? RestartDelay { get; set; }
Property Value

double?

Remarks

A value of 0 means never restart.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-rtmpgroupsettings.html#cfn-medialive-channel-rtmpgroupsettings-restartdelay

Implements

CfnChannelPropsMixin.IRtmpGroupSettingsProperty
Back to top Generated by DocFX