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

Class: Aws::MediaLive::Types::AudioOnlyHlsSettings

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

Overview

Note:

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

{
  audio_group_id: "__string",
  audio_only_image: {
    password_param: "__string",
    uri: "__string", # required
    username: "__string",
  },
  audio_track_type: "ALTERNATE_AUDIO_AUTO_SELECT", # accepts ALTERNATE_AUDIO_AUTO_SELECT, ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT, ALTERNATE_AUDIO_NOT_AUTO_SELECT, AUDIO_ONLY_VARIANT_STREAM
}

Instance Attribute Summary collapse

Instance Attribute Details

#audio_group_idString

Specifies the group to which the audio Rendition belongs.

Returns:

  • (String)


752
753
754
755
756
757
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 752

class AudioOnlyHlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_image,
  :audio_track_type)
  include Aws::Structure
end

#audio_only_imageTypes::InputLocation

For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size\} * {segment count\} * {user count.\}.



752
753
754
755
756
757
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 752

class AudioOnlyHlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_image,
  :audio_track_type)
  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)


752
753
754
755
756
757
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 752

class AudioOnlyHlsSettings < Struct.new(
  :audio_group_id,
  :audio_only_image,
  :audio_track_type)
  include Aws::Structure
end