AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RtmpGroupSettings as input to an Aws::Client method, you can use a vanilla 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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_schemeString

Authentication scheme to use when connecting with CDN

Possible values:

  • AKAMAI
  • COMMON

Returns:

  • (String)

    Authentication scheme to use when connecting with CDN.

#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.

Possible values:

  • DISCONNECT_IMMEDIATELY
  • WAIT_FOR_SERVER

Returns:

  • (String)

    Controls behavior when content cache fills up.

#cache_lengthInteger

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

Returns:

  • (Integer)

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

#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.

Possible values:

  • ALL
  • FIELD1_608
  • FIELD1_AND_FIELD2_608

Returns:

  • (String)

    Controls the types of data that passes to onCaptionInfo outputs.

#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.

Possible values:

  • EMIT_OUTPUT
  • PAUSE_OUTPUT

Returns:

  • (String)

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

#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)

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