Class: M3u8::MediaItem

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

Overview

MediaItem represents a set of EXT-X-MEDIA attributes

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 = {}) ⇒ MediaItem

Returns a new instance of MediaItem.

Parameters:

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

    attribute key-value pairs



31
32
33
34
35
 
# File 'lib/m3u8/media_item.rb', line 31

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

Instance Attribute Details

#assoc_language ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def assoc_language
  @assoc_language
end

#autoselect ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def autoselect
  @autoselect
end

#bit_depth ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def bit_depth
  @bit_depth
end

#channels ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def channels
  @channels
end

#characteristics ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def characteristics
  @characteristics
end

#default ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def default
  @default
end

#forced ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def forced
  @forced
end

#group_id ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def group_id
  @group_id
end

#instream_id ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def instream_id
  @instream_id
end

#language ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def language
  @language
end

#name ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def name
  @name
end

#sample_rate ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def sample_rate
  @sample_rate
end

#stable_rendition_id ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def stable_rendition_id
  @stable_rendition_id
end

#type ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def type
  @type
end

#uri ⇒ String, ...

Returns:

  • (String, nil) —

    media type (AUDIO, VIDEO, etc.)

  • (String, nil) —

    group ID

  • (String, nil) —

    language tag (RFC 5646)

  • (String, nil) —

    associated language tag

  • (String, nil) —

    rendition name

  • (Boolean, nil) —

    AUTOSELECT flag

  • (Boolean, nil) —

    DEFAULT flag

  • (String, nil) —

    rendition URI

  • (Boolean, nil) —

    FORCED flag

  • (String, nil) —

    instream ID for CC

  • (String, nil) —

    media characteristics

  • (String, nil) —

    audio channels

  • (String, nil) —

    stable rendition ID

  • (Integer, nil) —

    audio bit depth

  • (Integer, nil) —

    audio sample rate



25
26
27
 
# File 'lib/m3u8/media_item.rb', line 25

def uri
  @uri
end

Class Method Details

.parse(text) ⇒ MediaItem

Parse an EXT-X-MEDIA tag.

Parameters:

  • text (String) —

    raw tag line

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/m3u8/media_item.rb', line 40

def self.parse(text)
  attributes = parse_attributes(text)
  options = { type: attributes['TYPE'],
              group_id: attributes['GROUP-ID'],
              language: attributes['LANGUAGE'],
              assoc_language: attributes['ASSOC-LANGUAGE'],
              name: attributes['NAME'],
              autoselect: parse_yes_no(attributes['AUTOSELECT']),
              default: parse_yes_no(attributes['DEFAULT']),
              forced: parse_yes_no(attributes['FORCED']),
              uri: attributes['URI'],
              instream_id: attributes['INSTREAM-ID'],
              characteristics: attributes['CHARACTERISTICS'],
              channels: attributes['CHANNELS'],
              stable_rendition_id:
                attributes['STABLE-RENDITION-ID'],
              bit_depth: parse_int(attributes['BIT-DEPTH']),
              sample_rate: parse_int(attributes['SAMPLE-RATE']) }
  MediaItem.new(options)
end

Instance Method Details

#to_s ⇒ String

Render as an m3u8 EXT-X-MEDIA tag.

Returns:

  • (String) 


63
64
65
 
# File 'lib/m3u8/media_item.rb', line 63

def to_s
  "#EXT-X-MEDIA:#{formatted_attributes.join(',')}"
end