Class: AWSCDK::MediaLive::CfnChannel::RtmpGroupSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The configuration of an RTMP output group.

The parent of this entity is OutputGroupSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ad_markers: nil, authentication_scheme: nil, cache_full_behavior: nil, cache_length: nil, caption_data: nil, include_filler_nal_units: nil, input_loss_action: nil, restart_delay: nil) ⇒ RtmpGroupSettingsProperty

Returns a new instance of RtmpGroupSettingsProperty.

Parameters:

  • ad_markers (Array<String>, nil) (defaults to: nil) —

    Choose the ad marker type for this output group.

  • authentication_scheme (String, nil) (defaults to: nil) —

    An authentication scheme to use when connecting with a CDN.

  • cache_full_behavior (String, nil) (defaults to: nil) —

    Controls behavior when the content cache fills up.

  • cache_length (Numeric, nil) (defaults to: nil) —

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

  • caption_data (String, nil) (defaults to: nil) —

    Controls the types of data that pass to onCaptionInfo outputs.

  • include_filler_nal_units (String, nil) (defaults to: nil)
  • input_loss_action (String, nil) (defaults to: nil) —

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

  • restart_delay (Numeric, nil) (defaults to: nil) —

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



12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
 
# File 'media_live/cfn_channel.rb', line 12658

def initialize(ad_markers: nil, authentication_scheme: nil, cache_full_behavior: nil, cache_length: nil, caption_data: nil, include_filler_nal_units: nil, input_loss_action: nil, restart_delay: nil)
  @ad_markers = ad_markers
  Jsii::Type.check_type(@ad_markers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "adMarkers") unless @ad_markers.nil?
  @authentication_scheme = authentication_scheme
  Jsii::Type.check_type(@authentication_scheme, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authenticationScheme") unless @authentication_scheme.nil?
  @cache_full_behavior = cache_full_behavior
  Jsii::Type.check_type(@cache_full_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheFullBehavior") unless @cache_full_behavior.nil?
  @cache_length = cache_length
  Jsii::Type.check_type(@cache_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cacheLength") unless @cache_length.nil?
  @caption_data = caption_data
  Jsii::Type.check_type(@caption_data, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "captionData") unless @caption_data.nil?
  @include_filler_nal_units = include_filler_nal_units
  Jsii::Type.check_type(@include_filler_nal_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "includeFillerNalUnits") unless @include_filler_nal_units.nil?
  @input_loss_action = input_loss_action
  Jsii::Type.check_type(@input_loss_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputLossAction") unless @input_loss_action.nil?
  @restart_delay = restart_delay
  Jsii::Type.check_type(@restart_delay, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "restartDelay") unless @restart_delay.nil?
end

Instance Attribute Details

#ad_markers ⇒ Array<String>? (readonly)

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.

Returns:

  • (Array<String>, nil)

See Also:



12683
12684
12685
 
# File 'media_live/cfn_channel.rb', line 12683

def ad_markers
  @ad_markers
end

#authentication_scheme ⇒ String? (readonly)

An authentication scheme to use when connecting with a CDN.

Returns:

  • (String, nil)

See Also:



12688
12689
12690
 
# File 'media_live/cfn_channel.rb', line 12688

def authentication_scheme
  @authentication_scheme
end

#cache_full_behavior ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



12695
12696
12697
 
# File 'media_live/cfn_channel.rb', line 12695

def cache_full_behavior
  @cache_full_behavior
end

#cache_length ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



12700
12701
12702
 
# File 'media_live/cfn_channel.rb', line 12700

def cache_length
  @cache_length
end

#caption_data ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



12707
12708
12709
 
# File 'media_live/cfn_channel.rb', line 12707

def caption_data
  @caption_data
end

#include_filler_nal_units ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



12710
12711
12712
 
# File 'media_live/cfn_channel.rb', line 12710

def include_filler_nal_units
  @include_filler_nal_units
end

#input_loss_action ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



12717
12718
12719
 
# File 'media_live/cfn_channel.rb', line 12717

def input_loss_action
  @input_loss_action
end

#restart_delay ⇒ Numeric? (readonly)

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

A value of 0 means never restart.

Returns:

  • (Numeric, nil)

See Also:



12724
12725
12726
 
# File 'media_live/cfn_channel.rb', line 12724

def restart_delay
  @restart_delay
end

Class Method Details

.jsii_properties ⇒ Object 



12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
 
# File 'media_live/cfn_channel.rb', line 12726

def self.jsii_properties
  {
    :ad_markers => "adMarkers",
    :authentication_scheme => "authenticationScheme",
    :cache_full_behavior => "cacheFullBehavior",
    :cache_length => "cacheLength",
    :caption_data => "captionData",
    :include_filler_nal_units => "includeFillerNalUnits",
    :input_loss_action => "inputLossAction",
    :restart_delay => "restartDelay",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
 
# File 'media_live/cfn_channel.rb', line 12739

def to_jsii
  result = {}
  result.merge!({
    "adMarkers" => @ad_markers,
    "authenticationScheme" => @authentication_scheme,
    "cacheFullBehavior" => @cache_full_behavior,
    "cacheLength" => @cache_length,
    "captionData" => @caption_data,
    "includeFillerNalUnits" => @include_filler_nal_units,
    "inputLossAction" => @input_loss_action,
    "restartDelay" => @restart_delay,
  })
  result.compact
end