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

Class: Aws::MediaConvert::Types::HlsSettings

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

Overview

Note:

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

{
  audio_group_id: "__string",
  audio_only_container: "AUTOMATIC", # accepts AUTOMATIC, M2TS
  audio_rendition_sets: "__string",
  audio_track_type: "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT", # accepts ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT, ALTERNATE_AUDIO_AUTO_SELECT, ALTERNATE_AUDIO_NOT_AUTO_SELECT, AUDIO_ONLY_VARIANT_STREAM
  i_frame_only_manifest: "INCLUDE", # accepts INCLUDE, EXCLUDE
  segment_modifier: "__string",
}

Settings for HLS output groups

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#audio_group_idString

Specifies the group to which the audio Rendition belongs.

Returns:

  • (String)

    Specifies the group to which the audio Rendition belongs.

#audio_only_containerString

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

Possible values:

  • AUTOMATIC
  • M2TS

Returns:

  • (String)

    Use this setting only in audio-only outputs.

#audio_rendition_setsString

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by \',\'.

Returns:

  • (String)

    List all the audio groups that are used with the video output stream.

#audio_track_typeString

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

Possible values:

  • ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT
  • ALTERNATE_AUDIO_AUTO_SELECT
  • ALTERNATE_AUDIO_NOT_AUTO_SELECT
  • AUDIO_ONLY_VARIANT_STREAM

Returns:

  • (String)

    Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios.

#i_frame_only_manifestString

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

Possible values:

  • INCLUDE
  • EXCLUDE

Returns:

  • (String)

    When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest.

#segment_modifierString

Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

Returns:

  • (String)

    Use this setting to add an identifying string to the filename of each segment.