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

Class: Aws::MediaLive::Types::MsSmoothGroupSettings

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 MsSmoothGroupSettings data as a hash:

{
  acquisition_point_id: "__string",
  audio_only_timecode_control: "PASSTHROUGH", # accepts PASSTHROUGH, USE_CONFIGURED_CLOCK
  certificate_mode: "SELF_SIGNED", # accepts SELF_SIGNED, VERIFY_AUTHENTICITY
  connection_retry_interval: 1,
  destination: {
    destination_ref_id: "__string",
  },
  event_id: "__string",
  event_id_mode: "NO_EVENT_ID", # accepts NO_EVENT_ID, USE_CONFIGURED, USE_TIMESTAMP
  event_stop_behavior: "NONE", # accepts NONE, SEND_EOS
  filecache_duration: 1,
  fragment_length: 1,
  input_loss_action: "EMIT_OUTPUT", # accepts EMIT_OUTPUT, PAUSE_OUTPUT
  num_retries: 1,
  restart_delay: 1,
  segmentation_mode: "USE_INPUT_SEGMENTATION", # accepts USE_INPUT_SEGMENTATION, USE_SEGMENT_DURATION
  send_delay_ms: 1,
  sparse_track_type: "NONE", # accepts NONE, SCTE_35
  stream_manifest_behavior: "DO_NOT_SEND", # accepts DO_NOT_SEND, SEND
  timestamp_offset: "__string",
  timestamp_offset_mode: "USE_CONFIGURED_OFFSET", # accepts USE_CONFIGURED_OFFSET, USE_EVENT_START_DATE
}

Instance Attribute Summary collapse

Instance Attribute Details

#acquisition_point_idString

The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#audio_only_timecode_controlString

If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#certificate_modeString

If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail unless those certificates are manually added to the OS trusted keystore.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#connection_retry_intervalInteger

Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.

Returns:

  • (Integer)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#destinationTypes::OutputLocationRef

Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.



6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#event_idString

MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#event_id_modeString

Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#event_stop_behaviorString

When set to sendEos, send EOS signal to IIS server when stopping the event

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#filecache_durationInteger

Size in seconds of file cache for streaming outputs.

Returns:

  • (Integer)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#fragment_lengthInteger

Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.

Returns:

  • (Integer)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#input_loss_actionString

Parameter that control output group behavior on input loss.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#num_retriesInteger

Number of retry attempts.

Returns:

  • (Integer)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#restart_delayInteger

Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

Returns:

  • (Integer)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#segmentation_modeString

When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#send_delay_msInteger

Outputs that are "output locked" can use this delay. Assign a delay to the output that is "secondary". Do not assign a delay to the "primary" output. The delay means that the primary output will always reach the downstream system before the secondary, which helps ensure that the downstream system always uses the primary output. (If there were no delay, the downstream system might flip-flop between whichever output happens to arrive first.) If the primary fails, the downstream system will switch to the secondary output. When the primary is restarted, the downstream system will switch back to the primary (because once again it is always arriving first)

Returns:

  • (Integer)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#sparse_track_typeString

If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#stream_manifest_behaviorString

When set to send, send stream manifest so publishing point doesn't start until all streams start.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#timestamp_offsetString

Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end

#timestamp_offset_modeString

Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset

Returns:

  • (String)


6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 6648

class MsSmoothGroupSettings < Struct.new(
  :acquisition_point_id,
  :audio_only_timecode_control,
  :certificate_mode,
  :connection_retry_interval,
  :destination,
  :event_id,
  :event_id_mode,
  :event_stop_behavior,
  :filecache_duration,
  :fragment_length,
  :input_loss_action,
  :num_retries,
  :restart_delay,
  :segmentation_mode,
  :send_delay_ms,
  :sparse_track_type,
  :stream_manifest_behavior,
  :timestamp_offset,
  :timestamp_offset_mode)
  include Aws::Structure
end