You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaLive::Types::RtmpGroupSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb

Overview

Note:

When making an API call, you may pass RtmpGroupSettings data as a hash:

{
  authentication_scheme: "AKAMAI", # accepts AKAMAI, COMMON
  cache_full_behavior: "DISCONNECT_IMMEDIATELY", # accepts DISCONNECT_IMMEDIATELY, WAIT_FOR_SERVER
  cache_length: 1,
  caption_data: "ALL", # accepts ALL, FIELD1_608, FIELD1_AND_FIELD2_608
  input_loss_action: "EMIT_OUTPUT", # accepts EMIT_OUTPUT, PAUSE_OUTPUT
  restart_delay: 1,
}

Rtmp Group Settings

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_schemeString

Authentication scheme to use when connecting with CDN

Returns:

  • (String)


12023
12024
12025
12026
12027
12028
12029
12030
12031
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 12023

class RtmpGroupSettings < Struct.new(
  :authentication_scheme,
  :cache_full_behavior,
  :cache_length,
  :caption_data,
  :input_loss_action,
  :restart_delay)
  include Aws::Structure
end

#cache_full_behaviorString

Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.

Returns:

  • (String)


12023
12024
12025
12026
12027
12028
12029
12030
12031
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 12023

class RtmpGroupSettings < Struct.new(
  :authentication_scheme,
  :cache_full_behavior,
  :cache_length,
  :caption_data,
  :input_loss_action,
  :restart_delay)
  include Aws::Structure
end

#cache_lengthInteger

Cache length, in seconds, is used to calculate buffer size.

Returns:

  • (Integer)


12023
12024
12025
12026
12027
12028
12029
12030
12031
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 12023

class RtmpGroupSettings < Struct.new(
  :authentication_scheme,
  :cache_full_behavior,
  :cache_length,
  :caption_data,
  :input_loss_action,
  :restart_delay)
  include Aws::Structure
end

#caption_dataString

Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.

Returns:

  • (String)


12023
12024
12025
12026
12027
12028
12029
12030
12031
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 12023

class RtmpGroupSettings < Struct.new(
  :authentication_scheme,
  :cache_full_behavior,
  :cache_length,
  :caption_data,
  :input_loss_action,
  :restart_delay)
  include Aws::Structure
end

#input_loss_actionString

Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection.

Returns:

  • (String)


12023
12024
12025
12026
12027
12028
12029
12030
12031
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 12023

class RtmpGroupSettings < Struct.new(
  :authentication_scheme,
  :cache_full_behavior,
  :cache_length,
  :caption_data,
  :input_loss_action,
  :restart_delay)
  include Aws::Structure
end

#restart_delayInteger

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

Returns:

  • (Integer)


12023
12024
12025
12026
12027
12028
12029
12030
12031
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 12023

class RtmpGroupSettings < Struct.new(
  :authentication_scheme,
  :cache_full_behavior,
  :cache_length,
  :caption_data,
  :input_loss_action,
  :restart_delay)
  include Aws::Structure
end