Class: Id3Event

  • Id3Event is event data for a cast.framework.events.EventType.ID3 event following the ID3 v2 formatting, with one event fired per frame within the ID3 message.

  • This event provides the frame type, frame description, and frame data but not the entire raw ID3 message.

  • The Id3Event constructor takes segment data, timestamp, and optional frame description and frame type as parameters.

  • Key properties of Id3Event include the ID3 frame's description (frameDescription), the ID3 frame tag (frameType), the ID3 frame's data (segmentData), and the media start time of the ID3 message in seconds (timestamp).

cast.framework.events.Id3Event

class   static

Event data for a cast.framework.events.EventType.ID3 event. The ID3 metadata provided here follows the ID3 v2 formatting. One event is fired per frame within the ID3 message. This event does NOT contain the entire, raw ID3 message. Given the following subsections of an ID3 message:

  1. ID3v2 / file identifier
  2. ID3v2 version
  3. ID3v2 flags
  4. ID3v2 size
  5. Frame type (i.e. TXXX)
  6. Frame size
  7. Frame flags
  8. Frame encoding
  9. Frame description
  10. Frame data

Only items 5 (frameType), 9 (frameDescription), and 10 (segmentData) are provided in this event.

Constructor

Id3Event

new Id3Event(segmentData, timestamp, frameDescription, frameType)

Parameter

segmentData

Uint8Array

Value must not be null.

timestamp

number

frameDescription

Optional

Uint8Array

Value must not be null.

frameType

Optional

string

Properties

frameDescription

constant

(non-null Uint8Array or undefined)

The ID3 frame's description.

frameType

constant

(string or undefined)

The ID3 frame tag. A full list of possible tags are listed in https://exiftool.org/TagNames/ID3.html.

segmentData

constant

non-null Uint8Array

The ID3 frame's data.

timestamp

constant

number

The media start time of the ID3 message in seconds.