Class: M3u8::SkipItem

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

Overview

SkipItem represents an EXT-X-SKIP tag used in Playlist Delta Updates for Low-Latency 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 = {}) ⇒ SkipItem

Returns a new instance of SkipItem.

Parameters:

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

    attribute key-value pairs



16
17
18
19
20
 
# File 'lib/m3u8/skip_item.rb', line 16

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

Instance Attribute Details

#recently_removed_dateranges ⇒ Integer, ...

Returns:

  • (Integer, nil) —

    number of skipped segments

  • (String, nil) —

    recently removed dateranges



13
14
15
 
# File 'lib/m3u8/skip_item.rb', line 13

def recently_removed_dateranges
  @recently_removed_dateranges
end

#skipped_segments ⇒ Integer, ...

Returns:

  • (Integer, nil) —

    number of skipped segments

  • (String, nil) —

    recently removed dateranges



13
14
15
 
# File 'lib/m3u8/skip_item.rb', line 13

def skipped_segments
  @skipped_segments
end

Class Method Details

.parse(text) ⇒ SkipItem

Parse an EXT-X-SKIP tag.

Parameters:

  • text (String) —

    raw tag line

Returns:



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

def self.parse(text)
  attributes = parse_attributes(text)
  SkipItem.new(
    skipped_segments:
      attributes['SKIPPED-SEGMENTS'].to_i,
    recently_removed_dateranges:
      attributes['RECENTLY-REMOVED-DATERANGES']
  )
end

Instance Method Details

#to_s ⇒ String

Render as an m3u8 EXT-X-SKIP tag.

Returns:

  • (String) 


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

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