Class: shaka.util.Scte35

Constructor

new Scte35()

Source:

Members

MSF_EVENT_TYPES_ :Map<string, string>

The MSF event timeline types carrying SCTE-35, and whether their payload is base64 binary or XML. draft-wilaw-moq-scte35-event-timeline defines the 2022 names; the MSF draft's own catalog example uses the 2013 one. These are kept apart from SCHEMES_ so that recognizing them in MSF does not change what DASH and emsg recognize.
Type:
  • Map<string, string>
Source:

SCHEMES_ :Array<string>

@const
Type:
  • Array<string>
Source:

Methods

binaryPayload_(nodenon-null) → {Uint8Array}

Finds the base64 section, ignoring the producer's namespace prefix and how deeply it nested the element.
Parameters:
Name Type Description
node shaka.extern.xml.Node
Source:
Returns:
Type
Uint8Array

fromBase64_(textnullable) → {Uint8Array}

Parameters:
Name Type Attributes Description
text string <nullable>
Source:
Returns:
Type
Uint8Array

fromEmsg(emsg) → {shaka.extern.Scte35Event}

Parameters:
Name Type Description
emsg shaka.extern.EmsgInfo
Source:
Returns:
Type
shaka.extern.Scte35Event

fromHex(textnullable) → {Uint8Array}

Parameters:
Name Type Attributes Description
text string <nullable>
Source:
Returns:
Type
Uint8Array

fromMsf(eventType, payload, startTime, id) → {shaka.extern.Scte35Event}

Reads one record of an MSF event timeline track carrying SCTE-35 (draft-wilaw-moq-scte35-event-timeline), once the caller has placed it on the presentation timeline.
Parameters:
Name Type Description
eventType string The track's catalog `eventType`.
payload string The record's `scte35_payload`: base64 for binary carriage, the XML itself for XML carriage.
startTime number
id string
Source:
Returns:
Null when the event type is not an SCTE-35 one, or the payload cannot be decoded.
Type
shaka.extern.Scte35Event

fromRegion(region) → {shaka.extern.Scte35Event}

Parameters:
Name Type Description
region shaka.extern.TimelineRegionInfo
Source:
Returns:
Type
shaka.extern.Scte35Event

isMsfEventType(eventType) → {boolean}

Whether an MSF event timeline `eventType` is one fromMsf() reads.
Parameters:
Name Type Description
eventType string
Source:
Returns:
Type
boolean

isScheme(scheme) → {boolean}

Parameters:
Name Type Description
scheme string
Source:
Returns:
Type
boolean

parseXml_(text) → {shaka.extern.xml.Node}

The first element of an XML message, or null when there is none. TXml.parseXmlString() answers the first node it finds, which for text that is not XML at all is the text itself rather than an element, and for a document with an XML declaration is the declaration.
Parameters:
Name Type Description
text string
Source:
Returns:
Type
shaka.extern.xml.Node