class M3U8::KeyItem

Overview

KeyItem represents a set of EXT-X-KEY attributes used for specifying the encryption parameters of Media Segments in an HLS playlist.

In HLS, as defined in RFC 8216, Section 4.3.2.4, the EXT-X-KEY tag specifies how Media Segments are encrypted. It includes attributes such as METHOD, URI, IV, KEYFORMAT, and KEYFORMATVERSIONS.

Example of a key tag:

#EXT-X-KEY:METHOD=AES-128,URI="http://test.key",IV=D512BBF,KEYFORMAT="identity",KEYFORMATVERSIONS="1/3"

This class combines the functionality provided by the Concern and Encryptable modules to parse and format these encryption key attributes.

Included Modules

Extended Modules

Defined in:

m3u8/key_item.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from module M3U8::Encryptable

attributes_to_s attributes_to_s, iv : String | Nil iv, iv=(iv : String | Nil) iv=, key_format : String | Nil key_format, key_format=(key_format : String | Nil) key_format=, key_format_versions : String | Nil key_format_versions, key_format_versions=(key_format_versions : String | Nil) key_format_versions=, method : String method, method=(method : String) method=, uri : String | Nil uri, uri=(uri : String | Nil) uri=

Constructor methods inherited from module M3U8::Encryptable

new(params : NamedTuple = NamedTuple.new)
new(method = "", uri = nil, iv = nil, key_format = nil, key_format_versions = nil) new

Class methods inherited from module M3U8::Encryptable

convert_key(params) convert_key

Class Method Detail

def self.parse(text) #

Parses a text line representing an EXT-X-KEY tag and returns a new KeyItem.

The method extracts the attribute list from the tag line, converts the keys using Encryptable.convert_key, and initializes a new instance.

Example:

text = %(#EXT-X-KEY:METHOD=AES-128,URI="http://test.key",IV=D512BBF,KEYFORMAT="identity",KEYFORMATVERSIONS="1/3")
KeyItem.parse(text)
# => #<M3U8::KeyItem:0x7f5ceff07a80
      @iv="D512BBF",
      @key_format="identity",
      @key_format_versions="1/3",
      @method="AES-128",
      @uri="http://test.key">

[View source]

Instance Method Detail

def to_s #

Returns the string representation of the EXT-X-KEY tag.

It prefixes the formatted key attributes with #EXT-X-KEY:.

Example:

options = {
  method:              "AES-128",
  uri:                 "http://test.key",
  iv:                  "D512BBF",
  key_format:          "identity",
  key_format_versions: "1/3",
}
KeyItem.new(options).to_s
# => "#EXT-X-KEY:METHOD=AES-128,URI=\"http://test.key\",IV=D512BBF,KEYFORMAT=\"identity\",KEYFORMATVERSIONS=\"1/3\""

[View source]