Class: M3u8::RenditionReportItem

Inherits:
Object
  • Object
show all
Extended by:
M3u8
Includes:
AttributeFormatter, Serializable
Defined in:
lib/m3u8/rendition_report_item.rb

Overview

RenditionReportItem represents an EXT-X-RENDITION-REPORT tag which carries information about associated renditions in LL-HLS.

Constant Summary

Constants included from M3u8

VERSION

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from M3u8

initialize_with_byterange, parse_attributes, parse_float, parse_int, parse_yes_no, to_yes_no

Methods included from AttributeFormatter

#boolean_format, #decimal_format, #quoted_format, #unquoted_format

Methods included from Serializable

#as_json, serialize, #to_h, #to_json

Constructor Details

#initialize(params = {}) ⇒ RenditionReportItem

Returns a new instance of RenditionReportItem.

Parameters:

  • params (Hash) (defaults to: {}) —

    attribute key-value pairs



17
18
19
20
21
 
# File 'lib/m3u8/rendition_report_item.rb', line 17

def initialize(params = {})
  params.each do |key, value|
    instance_variable_set("@#{key}", value)
  end
end

Instance Attribute Details

#last_msn ⇒ String, ...

Returns:

  • (String, nil) —

    rendition URI

  • (Integer, nil) —

    last media sequence number

  • (Integer, nil) —

    last partial segment index



14
15
16
 
# File 'lib/m3u8/rendition_report_item.rb', line 14

def last_msn
  @last_msn
end

#last_part ⇒ String, ...

Returns:

  • (String, nil) —

    rendition URI

  • (Integer, nil) —

    last media sequence number

  • (Integer, nil) —

    last partial segment index



14
15
16
 
# File 'lib/m3u8/rendition_report_item.rb', line 14

def last_part
  @last_part
end

#uri ⇒ String, ...

Returns:

  • (String, nil) —

    rendition URI

  • (Integer, nil) —

    last media sequence number

  • (Integer, nil) —

    last partial segment index



14
15
16
 
# File 'lib/m3u8/rendition_report_item.rb', line 14

def uri
  @uri
end

Class Method Details

.parse(text) ⇒ RenditionReportItem

Parse an EXT-X-RENDITION-REPORT tag.

Parameters:

  • text (String) —

    raw tag line

Returns:



26
27
28
29
30
31
32
33
 
# File 'lib/m3u8/rendition_report_item.rb', line 26

def self.parse(text)
  attributes = parse_attributes(text)
  RenditionReportItem.new(
    uri: attributes['URI'],
    last_msn: parse_int(attributes['LAST-MSN']),
    last_part: parse_int(attributes['LAST-PART'])
  )
end

Instance Method Details

#to_s ⇒ String

Render as an m3u8 EXT-X-RENDITION-REPORT tag.

Returns:

  • (String) 


37
38
39
 
# File 'lib/m3u8/rendition_report_item.rb', line 37

def to_s
  "#EXT-X-RENDITION-REPORT:#{formatted_attributes}"
end