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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb

Overview

Note:

When making an API call, you may pass HlsPackage data as a hash:

{
  ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
  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
      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.

Instance Attribute Summary collapse

Instance Attribute Details

#ad_markersString

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.

Returns:

  • (String)


746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#encryptionTypes::HlsEncryption

An HTTP Live Streaming (HLS) encryption configuration.



746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#include_iframe_only_streamBoolean

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

Returns:

  • (Boolean)


746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#playlist_typeString

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.

Returns:

  • (String)


746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#playlist_window_secondsInteger

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

Returns:

  • (Integer)


746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#program_date_time_interval_secondsInteger

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)


746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#segment_duration_secondsInteger

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

Returns:

  • (Integer)


746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#stream_selectionTypes::StreamSelection

A StreamSelection configuration.



746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end

#use_audio_rendition_groupBoolean

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

Returns:

  • (Boolean)


746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 746

class HlsPackage < Struct.new(
  :ad_markers,
  :encryption,
  :include_iframe_only_stream,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds,
  :segment_duration_seconds,
  :stream_selection,
  :use_audio_rendition_group)
  include Aws::Structure
end