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

Class: Aws::MediaPackage::Types::HlsPackage

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

Overview

Note:

When passing HlsPackage as input to an Aws::Client method, you can use a vanilla Hash:

{
  ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH, DATERANGE
  ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
  ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
  encryption: {
    constant_initialization_vector: "__string",
    encryption_method: "AES_128", # accepts AES_128, SAMPLE_AES
    key_rotation_interval_seconds: 1,
    repeat_ext_x_key: false,
    speke_key_provider: { # required
      certificate_arn: "__string",
      resource_id: "__string", # required
      role_arn: "__string", # required
      system_ids: ["__string"], # required
      url: "__string", # required
    },
  },
  include_iframe_only_stream: false,
  playlist_type: "NONE", # accepts NONE, EVENT, VOD
  playlist_window_seconds: 1,
  program_date_time_interval_seconds: 1,
  segment_duration_seconds: 1,
  stream_selection: {
    max_video_bits_per_second: 1,
    min_video_bits_per_second: 1,
    stream_order: "ORIGINAL", # accepts ORIGINAL, VIDEO_BITRATE_ASCENDING, VIDEO_BITRATE_DESCENDING
  },
  use_audio_rendition_group: false,
}

An HTTP Live Streaming (HLS) packaging configuration.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#ad_markers ⇒ String

This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

Possible values:

  • NONE
  • SCTE35_ENHANCED
  • PASSTHROUGH
  • DATERANGE

Returns:

  • (String) —

    This setting controls how ad markers are included in the packaged OriginEndpoint.

#ad_triggers ⇒ Array<String>

A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.

Returns:

  • (Array<String>) —

    A list of SCTE-35 message types that are treated as ad markers in the output.

#ads_on_delivery_restrictions ⇒ String

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.

Possible values:

  • NONE
  • RESTRICTED
  • UNRESTRICTED
  • BOTH

Returns:

  • (String) —

    This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad.

#encryption ⇒ Types::HlsEncryption

An HTTP Live Streaming (HLS) encryption configuration.

Returns:

#include_iframe_only_stream ⇒ Boolean

When enabled, an I-Frame only stream will be included in the output.

Returns:

  • (Boolean) —

    When enabled, an I-Frame only stream will be included in the output.

#playlist_type ⇒ String

The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Possible values:

  • NONE
  • EVENT
  • VOD

Returns:

  • (String) —

    The HTTP Live Streaming (HLS) playlist type.

#playlist_window_seconds ⇒ Integer

Time window (in seconds) contained in each parent manifest.

Returns:

  • (Integer) —

    Time window (in seconds) contained in each parent manifest.

#program_date_time_interval_seconds ⇒ Integer

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

Returns:

  • (Integer) —

    The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests.

#segment_duration_seconds ⇒ Integer

Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

Returns:

  • (Integer) —

    Duration (in seconds) of each fragment.

#stream_selection ⇒ Types::StreamSelection

A StreamSelection configuration.

Returns:

#use_audio_rendition_group ⇒ Boolean

When enabled, audio streams will be placed in rendition groups in the output.

Returns:

  • (Boolean) —

    When enabled, audio streams will be placed in rendition groups in the output.