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::MsSmoothGroupSettings

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

Overview

Note:

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#acquisition_point_idString

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

Returns:

  • (String)

    The ID to include in each message in the sparse track.

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

Possible values:

  • PASSTHROUGH
  • USE_CONFIGURED_CLOCK

Returns:

  • (String)

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

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

Possible values:

  • SELF_SIGNED
  • VERIFY_AUTHENTICITY

Returns:

  • (String)

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

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

    Number of seconds to wait before retrying connection to the IIS server if the connection is lost.

#destinationTypes::OutputLocationRef

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

Returns:

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

    MS Smooth event ID to be sent to the IIS server.

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

Possible values:

  • NO_EVENT_ID
  • USE_CONFIGURED
  • USE_TIMESTAMP

Returns:

  • (String)

    Specifies whether or not to send an event ID to the IIS server.

#event_stop_behaviorString

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

Possible values:

  • NONE
  • SEND_EOS

Returns:

  • (String)

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

#filecache_durationInteger

Size in seconds of file cache for streaming outputs.

Returns:

  • (Integer)

    Size in seconds of file cache for streaming outputs.

#fragment_lengthInteger

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

Returns:

  • (Integer)

    Length of mp4 fragments to generate (in seconds).

#input_loss_actionString

Parameter that control output group behavior on input loss.

Possible values:

  • EMIT_OUTPUT
  • PAUSE_OUTPUT

Returns:

  • (String)

    Parameter that control output group behavior on input loss.

#num_retriesInteger

Number of retry attempts.

Returns:

  • (Integer)

    Number of retry attempts.

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

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

#segmentation_modeString

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

Possible values:

  • USE_INPUT_SEGMENTATION
  • USE_SEGMENT_DURATION

Returns:

  • (String)

    useInputSegmentation has been deprecated.

#send_delay_msInteger

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

Returns:

  • (Integer)

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

#sparse_track_typeString

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.

Possible values:

  • NONE
  • SCTE_35
  • SCTE_35_WITHOUT_SEGMENTATION

Returns:

  • (String)

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

#stream_manifest_behaviorString

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

Possible values:

  • DO_NOT_SEND
  • SEND

Returns:

  • (String)

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

#timestamp_offsetString

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

Returns:

  • (String)

    Timestamp offset for the event.

#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

Possible values:

  • USE_CONFIGURED_OFFSET
  • USE_EVENT_START_DATE

Returns:

  • (String)

    Type of timestamp date offset to use.