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

Inherits:

Struct

Object
Struct
Aws::MediaLive::Types::MsSmoothGroupSettings

show all

Includes:: Structure

Defined in:: 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: { # required
    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, SCTE_35_WITHOUT_SEGMENTATION
  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
}

Ms Smooth Group Settings

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#acquisition_point_id ⇒ String

The ID to include in each message in the sparse track.
#audio_only_timecode_control ⇒ String

If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode.
#certificate_mode ⇒ String

If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA).
#connection_retry_interval ⇒ Integer

Number of seconds to wait before retrying connection to the IIS server if the connection is lost.
#destination ⇒ Types::OutputLocationRef

Smooth Streaming publish point on an IIS server.
#event_id ⇒ String

MS Smooth event ID to be sent to the IIS server.
#event_id_mode ⇒ String

Specifies whether or not to send an event ID to the IIS server.
#event_stop_behavior ⇒ String

When set to sendEos, send EOS signal to IIS server when stopping the event.
#filecache_duration ⇒ Integer

Size in seconds of file cache for streaming outputs.
#fragment_length ⇒ Integer

Length of mp4 fragments to generate (in seconds).
#input_loss_action ⇒ String

Parameter that control output group behavior on input loss.
#num_retries ⇒ Integer

Number of retry attempts.
#restart_delay ⇒ Integer

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

useInputSegmentation has been deprecated.
#send_delay_ms ⇒ Integer

Number of milliseconds to delay the output from the second pipeline.
#sparse_track_type ⇒ String

Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content.
#stream_manifest_behavior ⇒ String

When set to send, send stream manifest so publishing point doesn’t start until all streams start.
#timestamp_offset ⇒ String

Timestamp offset for the event.
#timestamp_offset_mode ⇒ String

Type of timestamp date offset to use.

Instance Attribute Details

#acquisition_point_id ⇒ `String`

The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#audio_only_timecode_control ⇒ `String`

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)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_mode ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#connection_retry_interval ⇒ `Integer`

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)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ `Types::OutputLocationRef`

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

Returns:

(Types::OutputLocationRef)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#event_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#event_id_mode ⇒ `String`

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)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#event_stop_behavior ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#filecache_duration ⇒ `Integer`

Size in seconds of file cache for streaming outputs.

Returns:

(Integer)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#fragment_length ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_loss_action ⇒ `String`

Parameter that control output group behavior on input loss.

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#num_retries ⇒ `Integer`

Number of retry attempts.

Returns:

(Integer)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#restart_delay ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#segmentation_mode ⇒ `String`

useInputSegmentation has been deprecated. The configured segment size is always used.

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#send_delay_ms ⇒ `Integer`

Number of milliseconds to delay the output from the second pipeline.

Returns:

(Integer)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#sparse_track_type ⇒ `String`

Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don’t start a new segment. - NONE: Don’t generate a sparse track for any outputs in this output group.

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#stream_manifest_behavior ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp_offset ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp_offset_mode ⇒ `String`

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)

# File 'lib/aws-sdk-medialive/types.rb', line 12746

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#acquisition_point_id ⇒ String

#audio_only_timecode_control ⇒ String

#certificate_mode ⇒ String

#connection_retry_interval ⇒ Integer

#destination ⇒ Types::OutputLocationRef

#event_id ⇒ String

#event_id_mode ⇒ String

#event_stop_behavior ⇒ String

#filecache_duration ⇒ Integer

#fragment_length ⇒ Integer

#input_loss_action ⇒ String

#num_retries ⇒ Integer

#restart_delay ⇒ Integer

#segmentation_mode ⇒ String

#send_delay_ms ⇒ Integer

#sparse_track_type ⇒ String

#stream_manifest_behavior ⇒ String

#timestamp_offset ⇒ String

#timestamp_offset_mode ⇒ String

#acquisition_point_id ⇒ `String`

#audio_only_timecode_control ⇒ `String`

#certificate_mode ⇒ `String`

#connection_retry_interval ⇒ `Integer`

#destination ⇒ `Types::OutputLocationRef`

#event_id ⇒ `String`

#event_id_mode ⇒ `String`

#event_stop_behavior ⇒ `String`

#filecache_duration ⇒ `Integer`

#fragment_length ⇒ `Integer`

#input_loss_action ⇒ `String`

#num_retries ⇒ `Integer`

#restart_delay ⇒ `Integer`

#segmentation_mode ⇒ `String`

#send_delay_ms ⇒ `Integer`

#sparse_track_type ⇒ `String`

#stream_manifest_behavior ⇒ `String`

#timestamp_offset ⇒ `String`

#timestamp_offset_mode ⇒ `String`