Contains HLS-specific timed metadata properties found in the #EXT-X-DATERANGE
property.
https://tools.ietf.org/html/draft-pantos-hls-rfc8216bis-06#section-4.4.5.1
Constructor
HlsTimedMetadata
new
HlsTimedMetadata()
Properties
clientAttributes
(non-null Object or undefined)
The "X-" prefix defines a namespace reserved for client-defined
attributes. The client-attribute MUST be a legal AttributeName. Clients
SHOULD use a reverse-DNS syntax when defining their own attribute names
to avoid collisions. The attribute value MUST be a string, a
hexadecimal-sequence, or a decimal-floating-point. An example of a
client-defined attribute is X-COM-EXAMPLE-AD-ID="XYZ123". These
attributes are OPTIONAL.
duration
(number or undefined)
The duration of the Date Range expressed as a decimal-floating-point
number of seconds. It MUST NOT be negative. A single instant in time
(e.g., crossing a finish line) SHOULD be represented with a duration of
0. This attribute is OPTIONAL.
endDate
(string or undefined)
A string containing the ISO-8601 date at which the Date Range ends. It
MUST be equal to or later than the value of the START-DATE attribute.
This attribute is OPTIONAL.
endOnNext
(boolean or undefined)
A boolean indicating the end of the range containing it is equal to the
START-DATE of its Following Range. The Following Range is the Date Range
of the same CLASS that has the earliest START-DATE after the START-DATE
of the range in question. This attribute is OPTIONAL and defaults to
false.
plannedDuration
(number or undefined)
The expected duration of the Date Range expressed as a
decimal-floating-point number of seconds. It MUST NOT be negative. This
attribute SHOULD be used to indicate the expected duration of a Date
Range whose actual duration is not yet known. This attribute is OPTIONAL.
rangeClass
(string or undefined)
A client-defined string that specifies some set of attributes and their
associated value semantics. All Date Ranges with the same CLASS
attribute value MUST adhere to these semantics. This attribute is
OPTIONAL.
scte35Cmd
(string or undefined)
Carries SCTE-35 splice_info_section() data. This attribute is OPTIONAL.
scte35In
(string or undefined)
Carries SCTE-35 data splice in data. This attribute is OPTIONAL.
scte35Out
(string or undefined)
Carries SCTE-35 data splice out data. This attribute is OPTIONAL.
startDate
(string or undefined)
A string containing the ISO-8601 date at which the Date Range begins.
This attribute is REQUIRED.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003ecast.framework.HlsTimedMetadata\u003c/code\u003e handles HLS timed metadata, specifically properties within the \u003ccode\u003e#EXT-X-DATERANGE\u003c/code\u003e tag, as defined in the HLS RFC.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties like \u003ccode\u003estartDate\u003c/code\u003e, \u003ccode\u003eendDate\u003c/code\u003e, \u003ccode\u003eduration\u003c/code\u003e, and various SCTE-35 related attributes for managing date ranges and content signaling.\u003c/p\u003e\n"],["\u003cp\u003eClient-defined attributes, prefixed with "X-", allow for custom metadata to be included within the timed metadata.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erangeClass\u003c/code\u003e property enables grouping of date ranges with shared semantics for specific functionalities.\u003c/p\u003e\n"]]],["The `HlsTimedMetadata` class manages HLS timed metadata properties from the `#EXT-X-DATERANGE` tag. Key properties include `startDate` (required ISO-8601 start date), `endDate` (optional ISO-8601 end date), `duration` (optional duration in seconds), and `plannedDuration` (optional expected duration). `rangeClass` allows for custom attribute sets. Additional attributes cover client-defined data (`clientAttributes`) and SCTE-35 information (`scte35Cmd`, `scte35In`, `scte35Out`). The `endOnNext` property indicates if the range ends at the start of the next one.\n"],null,["cast.[framework](/cast/docs/reference/web_receiver/cast.framework).HlsTimedMetadata \nclass static\n\nContains HLS-specific timed metadata properties found in the #EXT-X-DATERANGE\nproperty.\nhttps://tools.ietf.org/html/draft-pantos-hls-rfc8216bis-06#section-4.4.5.1\n\nConstructor\n\nHlsTimedMetadata\n\nnew\nHlsTimedMetadata()\n\nProperties\n\nclientAttributes\n\n(non-null Object or undefined)\n\nThe \"X-\" prefix defines a namespace reserved for client-defined\nattributes. The client-attribute MUST be a legal AttributeName. Clients\nSHOULD use a reverse-DNS syntax when defining their own attribute names\nto avoid collisions. The attribute value MUST be a string, a\nhexadecimal-sequence, or a decimal-floating-point. An example of a\nclient-defined attribute is X-COM-EXAMPLE-AD-ID=\"XYZ123\". These\nattributes are OPTIONAL.\n\nduration\n\n(number or undefined)\n\nThe duration of the Date Range expressed as a decimal-floating-point\nnumber of seconds. It MUST NOT be negative. A single instant in time\n(e.g., crossing a finish line) SHOULD be represented with a duration of\n0. This attribute is OPTIONAL.\n\nendDate\n\n(string or undefined)\n\nA string containing the ISO-8601 date at which the Date Range ends. It\nMUST be equal to or later than the value of the START-DATE attribute.\nThis attribute is OPTIONAL.\n\nendOnNext\n\n(boolean or undefined)\n\nA boolean indicating the end of the range containing it is equal to the\nSTART-DATE of its Following Range. The Following Range is the Date Range\nof the same CLASS that has the earliest START-DATE after the START-DATE\nof the range in question. This attribute is OPTIONAL and defaults to\nfalse.\n\nplannedDuration\n\n(number or undefined)\n\nThe expected duration of the Date Range expressed as a\ndecimal-floating-point number of seconds. It MUST NOT be negative. This\nattribute SHOULD be used to indicate the expected duration of a Date\nRange whose actual duration is not yet known. This attribute is OPTIONAL.\n\nrangeClass\n\n(string or undefined)\n\nA client-defined string that specifies some set of attributes and their\nassociated value semantics. All Date Ranges with the same CLASS\nattribute value MUST adhere to these semantics. This attribute is\nOPTIONAL.\n\nscte35Cmd\n\n(string or undefined)\n\nCarries SCTE-35 splice_info_section() data. This attribute is OPTIONAL.\n\nscte35In\n\n(string or undefined)\n\nCarries SCTE-35 data splice in data. This attribute is OPTIONAL.\n\nscte35Out\n\n(string or undefined)\n\nCarries SCTE-35 data splice out data. This attribute is OPTIONAL.\n\nstartDate\n\n(string or undefined)\n\nA string containing the ISO-8601 date at which the Date Range begins.\nThis attribute is REQUIRED."]]