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

Class: Aws::ElasticTranscoder::Types::Playlist

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

Overview

Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. We recommend that you create only one master playlist per output format. The maximum number of master playlists in a job is 30.

Instance Attribute Summary collapse

Instance Attribute Details

#formatString

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

Returns:

  • (String)


3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3654

class Playlist < Struct.new(
  :name,
  :format,
  :output_keys,
  :hls_content_protection,
  :play_ready_drm,
  :status,
  :status_detail)
  include Aws::Structure
end

#hls_content_protectionTypes::HlsContentProtection

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.



3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3654

class Playlist < Struct.new(
  :name,
  :format,
  :output_keys,
  :hls_content_protection,
  :play_ready_drm,
  :status,
  :status_detail)
  include Aws::Structure
end

#nameString

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

Returns:

  • (String)


3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3654

class Playlist < Struct.new(
  :name,
  :format,
  :output_keys,
  :hls_content_protection,
  :play_ready_drm,
  :status,
  :status_detail)
  include Aws::Structure
end

#output_keysArray<String>

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.

  • If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:

    OutputKeyPrefixOutputs:Key

  • If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:

    OutputKeyPrefixOutputs:Key.m3u8

    OutputKeyPrefixOutputs:Key00000.ts

  • If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:

    OutputKeyPrefixOutputs:Key_v4.m3u8

    OutputKeyPrefixOutputs:Key_iframe.m3u8

    OutputKeyPrefixOutputs:Key.ts

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.

If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

Returns:

  • (Array<String>)


3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3654

class Playlist < Struct.new(
  :name,
  :format,
  :output_keys,
  :hls_content_protection,
  :play_ready_drm,
  :status,
  :status_detail)
  include Aws::Structure
end

#play_ready_drmTypes::PlayReadyDrm

The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

Returns:



3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3654

class Playlist < Struct.new(
  :name,
  :format,
  :output_keys,
  :hls_content_protection,
  :play_ready_drm,
  :status,
  :status_detail)
  include Aws::Structure
end

#statusString

The status of the job with which the playlist is associated.

Returns:

  • (String)


3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3654

class Playlist < Struct.new(
  :name,
  :format,
  :output_keys,
  :hls_content_protection,
  :play_ready_drm,
  :status,
  :status_detail)
  include Aws::Structure
end

#status_detailString

Information that further explains the status.

Returns:

  • (String)


3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3654

class Playlist < Struct.new(
  :name,
  :format,
  :output_keys,
  :hls_content_protection,
  :play_ready_drm,
  :status,
  :status_detail)
  include Aws::Structure
end