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

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

Overview

Note:

When making an API call, you may pass HlsSettings data as a 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
  descriptive_video_service_flag: "DONT_FLAG", # accepts DONT_FLAG, FLAG
  i_frame_only_manifest: "INCLUDE", # accepts INCLUDE, EXCLUDE
  segment_modifier: "__string",
}

Settings for HLS output groups

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audio_group_idString

Specifies the group to which the audio rendition belongs.

Returns:

  • (String)


10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 10199

class HlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_container,
  :audio_rendition_sets,
  :audio_track_type,
  :descriptive_video_service_flag,
  :i_frame_only_manifest,
  :segment_modifier)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 10199

class HlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_container,
  :audio_rendition_sets,
  :audio_track_type,
  :descriptive_video_service_flag,
  :i_frame_only_manifest,
  :segment_modifier)
  SENSITIVE = []
  include Aws::Structure
end

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


10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 10199

class HlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_container,
  :audio_rendition_sets,
  :audio_track_type,
  :descriptive_video_service_flag,
  :i_frame_only_manifest,
  :segment_modifier)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

  • (String)


10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 10199

class HlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_container,
  :audio_rendition_sets,
  :audio_track_type,
  :descriptive_video_service_flag,
  :i_frame_only_manifest,
  :segment_modifier)
  SENSITIVE = []
  include Aws::Structure
end

#descriptive_video_service_flagString

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

Returns:

  • (String)


10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 10199

class HlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_container,
  :audio_rendition_sets,
  :audio_track_type,
  :descriptive_video_service_flag,
  :i_frame_only_manifest,
  :segment_modifier)
  SENSITIVE = []
  include Aws::Structure
end

#i_frame_only_manifestString

Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

Returns:

  • (String)


10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 10199

class HlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_container,
  :audio_rendition_sets,
  :audio_track_type,
  :descriptive_video_service_flag,
  :i_frame_only_manifest,
  :segment_modifier)
  SENSITIVE = []
  include Aws::Structure
end

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


10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 10199

class HlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_container,
  :audio_rendition_sets,
  :audio_track_type,
  :descriptive_video_service_flag,
  :i_frame_only_manifest,
  :segment_modifier)
  SENSITIVE = []
  include Aws::Structure
end