class M3U8::TimeItem

• M3U8::TimeItem
• Reference
• Object

Overview

TimeItem represents an EXT-X-PROGRAM-DATE-TIME tag in an HLS playlist.

The EXT-X-PROGRAM-DATE-TIME tag (as defined in RFC 8216, Section 4.3.2.6) is used to associate the first sample of a Media Segment with an absolute date and time. The time is formatted in ISO 8601, ensuring a consistent representation across clients.

For example:

# EXT-X-PROGRAM-DATE-TIME:2010-02-19T14:54:23.031Z

This class encapsulates a Time value and provides methods for parsing, formatting, and checking whether a TimeItem is "empty" (i.e. represents the Unix epoch).

Examples:

Parsing various inputs:

# Passing a TimeItem returns the same instance
TimeItem.parse(TimeItem.new("2010-02-19T14:54:23Z"))

# Parsing a Time value directly
TimeItem.parse(Time.iso8601("2010-02-19T14:54:23.031Z"))

# Parsing a time string in ISO8601 format
TimeItem.parse("2010-02-19T14:54:23.031Z")

# Calling parse with no argument returns a default TimeItem (Unix epoch)
TimeItem.parse

Creating a new TimeItem:

TimeItem.new("2010-02-19T14:54:23Z")
# => #<M3U8::TimeItem:0x10581b920 @time=2010-02-19 14:54:23 UTC>

TimeItem.new(Time.iso8601("2010-02-19T14:54:23.031Z"))
# => #<M3U8::TimeItem:0x10581b920 @time=2010-02-19 14:54:23 UTC>

TimeItem.new
# => #<M3U8::TimeItem:0x10581b880 @time=1970-01-01 00:00:00 UTC>

Checking if a TimeItem is empty (i.e. represents the Unix epoch):

item = TimeItem.new
item.empty? # => true

item = TimeItem.new("2010-02-19T14:54:23Z")
item.empty? # => false

Converting a TimeItem to a string:

TimeItem.new("2010-02-19T14:54:23Z").to_s
# => "#EXT-X-PROGRAM-DATE-TIME:2010-02-19T14:54:23.031Z"

TimeItem.new(Time.iso8601("2010-02-19T14:54:23.031Z")).to_s
# => "#EXT-X-PROGRAM-DATE-TIME:2010-02-19T14:54:23.031Z"

Included Modules

• M3U8::Concern

Extended Modules

• M3U8::Concern

Defined in:

Constructors

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

  Constructs a new TimeItem using a NamedTuple with a :time key.

• .new(time = nil)

  Initializes a new TimeItem.

Class Method Summary

• .parse(item = nil)

  Parses an input item into a TimeItem.

Instance Method Summary

• #empty?

  Returns true if the TimeItem's time represents the Unix epoch.

• #time : Time

  The EXT-X-PROGRAM-DATE-TIME tag associates the first sample of a Media Segment with an absolute date and/or time.

• #time=(time : Time)

  The EXT-X-PROGRAM-DATE-TIME tag associates the first sample of a Media Segment with an absolute date and/or time.

• #to_s

  Returns the string representation of the EXT-X-PROGRAM-DATE-TIME tag.

Constructor Detail

TimeItem.new({time: Time.iso8601("2010-02-19T14:54:23.031Z")})
# => #<M3U8::TimeItem:0x7e461bbd8ba0 @time=2010-02-19 14:54:23.031000000 UTC>

TimeItem.new({time: Time.iso8601("2010-02-19T14:54:23.031Z")})
# => #<M3U8::TimeItem:0x7bb643931a80 @time=1970-01-01 00:00:00.0 UTC>

TimeItem.new("2010-02-19T14:54:23Z")
# => #<M3U8::TimeItem:0x79134e1fd960 @time=2010-02-19 14:54:23.0 UTC>

TimeItem.new(Time.iso8601("2010-02-19T14:54:23.031Z"))
# => #<M3U8::TimeItem:0x79134e1fd840 @time=2010-02-19 14:54:23.031000000 UTC>

TimeItem.new
# => #<M3U8::TimeItem:0x79134e1fd720 @time=1970-01-01 00:00:00.0 UTC>

Class Method Detail

TimeItem.parse(TimeItem.new("2010-02-19T14:54:23Z"))
# => #<M3U8::TimeItem:0x783c78510c60 @time=2010-02-19 14:54:23.0 UTC>

TimeItem.parse(Time.iso8601("2010-02-19T14:54:23.031Z"))
# => #<M3U8::TimeItem:0x783c78517f00 @time=2010-02-19 14:54:23.031000000 UTC>

TimeItem.parse("2010-02-19T14:54:23.031Z")
# => #<M3U8::TimeItem:0x783c78517de0 @time=2010-02-19 14:54:23.031000000 UTC>

TimeItem.parse
# => #<M3U8::TimeItem:0x783c78517cc0 @time=1970-01-01 00:00:00.0 UTC>

Instance Method Detail

item = TimeItem.new
item.empty? # => true

item = TimeItem.new("2010-02-19T14:54:23Z")
item.empty? # => false

TimeItem.new("2010-02-19T14:54:23Z").to_s
# => "#EXT-X-PROGRAM-DATE-TIME:2010-02-19T14:54:23Z"

TimeItem.new(Time.iso8601("2010-02-19T14:54:23.031Z")).to_s
# => "#EXT-X-PROGRAM-DATE-TIME:2010-02-19T14:54:23.031Z"