class M3U8::PlaylistItem

• M3U8::PlaylistItem
• Reference
• Object

Overview

PlaylistItem represents a set of EXT-X-STREAM-INF or EXT-X-I-FRAME-STREAM-INF attributes

Included Modules

• M3U8::Concern

Extended Modules

• M3U8::Concern

Defined in:

Constructors

• .new(params : NamedTuple = NamedTuple.new)

  ` options = { program_id: 1, width: 1920, height: 1080, bandwidth: 540, video: "test_video", audio: "test_a", uri: "test.url", average_bandwidth: 500, subtitles: "subs", closed_captions: "cc", iframe: true, frame_rate: 24.6, name: "test_name", hdcp_level: "TYPE-0", codecs: "avc", audio_codec: "mp3", level: "2", profile: "baseline", } PlaylistItem.new(options) `

• .new(program_id = nil, width = nil, height = nil, bandwidth = nil, video = nil, audio = nil, uri = nil, average_bandwidth = nil, subtitles = nil, closed_captions = nil, iframe = nil, frame_rate = nil, name = nil, hdcp_level = nil, codecs = nil, audio_codec = nil, level = nil, profile = nil)

  ` PlaylistItem.new `

Class Method Summary

• .parse(value)

  ` text = %(#EXT-X-I-FRAME-STREAM-INF:PROGRAM-ID=1,RESOLUTION=1920x1080,) \ %(CODECS="avc",BANDWIDTH=540,AVERAGE-BANDWIDTH=500,) \ %(FRAME-RATE=24.600,HDCP-LEVEL=TYPE-0,AUDIO="test_a",) \ %(VIDEO="test_video",SUBTITLES="subs",CLOSED-CAPTIONS="cc",) \ %(NAME="test_name",URI="test.url") PlaylistItem.parse(text) # => #<M3U8::PlaylistItem......> `

Instance Method Summary

• #audio : String?
• #audio=(audio : String?)
• #average_bandwidth : Int32?
• #average_bandwidth=(average_bandwidth : Int32?)
• #bandwidth : Int32?
• #bandwidth=(bandwidth : Int32?)
• #closed_captions : String?
• #closed_captions=(closed_captions : String?)
• #codecs : Codecs
• #codecs=(codecs : Codecs)
• #frame_rate : Float64?
• #frame_rate=(frame_rate : Float64?)
• #hdcp_level : String?
• #hdcp_level=(hdcp_level : String?)
• #height : Int32?
• #height=(height : Int32?)
• #iframe : Bool
• #iframe=(iframe : Bool)
• #name : String?
• #name=(name : String?)
• #program_id : Int32?
• #program_id=(program_id : Int32?)
• #resolution

  ` options = { width: 1920, height: 1080, } item = PlaylistItem.new(options) item.resolution # => 1920x1080 `

• #subtitles : String?
• #subtitles=(subtitles : String?)
• #to_s

   #EXT-X-I-FRAME-STREAM-INF:PROGRAM-ID=1,RESOLUTION=1920x1080, \      CODECS="avc",BANDWIDTH=540,AVERAGE-BANDWIDTH=500, \      FRAME-RATE=24.600,HDCP-LEVEL=TYPE-0,AUDIO="test_a", \      VIDEO="test_video",SUBTITLES="subs",CLOSED-CAPTIONS="cc", \      NAME="test_name",URI="test.url"">

• #uri : String?
• #uri=(uri : String?)
• #video : String?
• #video=(video : String?)
• #width : Int32?
• #width=(width : Int32?)

Constructor Detail

options = {
  program_id:        1,
  width:             1920,
  height:            1080,
  bandwidth:         540,
  video:             "test_video",
  audio:             "test_a",
  uri:               "test.url",
  average_bandwidth: 500,
  subtitles:         "subs",
  closed_captions:   "cc",
  iframe:            true,
  frame_rate:        24.6,
  name:              "test_name",
  hdcp_level:        "TYPE-0",
  codecs:            "avc",
  audio_codec:       "mp3",
  level:             "2",
  profile:           "baseline",
}
PlaylistItem.new(options)

PlaylistItem.new

Class Method Detail

text = %(#EXT-X-I-FRAME-STREAM-INF:PROGRAM-ID=1,RESOLUTION=1920x1080,) \
       %(CODECS="avc",BANDWIDTH=540,AVERAGE-BANDWIDTH=500,) \
       %(FRAME-RATE=24.600,HDCP-LEVEL=TYPE-0,AUDIO="test_a",) \
       %(VIDEO="test_video",SUBTITLES="subs",CLOSED-CAPTIONS="cc",) \
       %(NAME="test_name",URI="test.url")
PlaylistItem.parse(text) # => #<M3U8::PlaylistItem......>

Instance Method Detail

options = {
  width:  1920,
  height: 1080,
}
item = PlaylistItem.new(options)
item.resolution # => 1920x1080

options = {
  program_id: 1,
  width: 1920,
  height: 1080,
  bandwidth: 540,
  video: "test_video",
  audio: "test_a",
  uri: "test.url",
  average_bandwidth: 500,
  subtitles: "subs",
  closed_captions: "cc",
  iframe: true,
  frame_rate: 24.6,
  name: "test_name",
  hdcp_level: "TYPE-0",
  codecs: "avc",
  audio_codec: "mp3",
  level: "2",
  profile: "baseline",
}
PlaylistItem.new(options).to_s
# => #EXT-X-I-FRAME-STREAM-INF:PROGRAM-ID=1,RESOLUTION=1920x1080, \
     CODECS="avc",BANDWIDTH=540,AVERAGE-BANDWIDTH=500, \
     FRAME-RATE=24.600,HDCP-LEVEL=TYPE-0,AUDIO="test_a", \
     VIDEO="test_video",SUBTITLES="subs",CLOSED-CAPTIONS="cc", \
     NAME="test_name",URI="test.url"