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:
ID3v2 / file identifier
ID3v2 version
ID3v2 flags
ID3v2 size
Frame type (i.e. TXXX)
Frame size
Frame flags
Frame encoding
Frame description
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.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe \u003ccode\u003ecast.framework.events.Id3Event\u003c/code\u003e class provides data for ID3 metadata events within the Cast framework, delivering information frame by frame.\u003c/p\u003e\n"],["\u003cp\u003eThis event includes the frame type, description, and data but excludes the raw ID3 message structure like headers and flags.\u003c/p\u003e\n"],["\u003cp\u003eID3 frame details like \u003ccode\u003eframeType\u003c/code\u003e, \u003ccode\u003eframeDescription\u003c/code\u003e, and \u003ccode\u003esegmentData\u003c/code\u003e are accessible via corresponding properties of the \u003ccode\u003eId3Event\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this event to access and utilize ID3 metadata, such as song titles or artist information, during media playback.\u003c/p\u003e\n"]]],[],null,["# Class: Id3Event\n\ncast.[framework](/cast/docs/reference/web_receiver/cast.framework).[events](/cast/docs/reference/web_receiver/cast.framework.events).Id3Event\n=============================================================================================================================================\n\nclass static\n\nEvent data for a `cast.framework.events.EventType.ID3` event.\nThe ID3 metadata provided here follows the ID3 v2 formatting.\nOne event is fired per frame within the ID3 message.\nThis event does NOT contain the entire, raw ID3 message. Given the following\nsubsections of an ID3 message:\n\n1. ID3v2 / file identifier\n2. ID3v2 version\n3. ID3v2 flags\n4. ID3v2 size\n5. Frame type (i.e. `TXXX`)\n6. Frame size\n7. Frame flags\n8. Frame encoding\n9. Frame description\n10. Frame data\n\nOnly items `5` (`frameType`), `9` (`frameDescription`), and `10`\n(`segmentData`) are provided in this event.\n\nConstructor\n-----------\n\n### Id3Event\n\nnew\nId3Event(segmentData, timestamp, frameDescription, frameType)\n\n| #### Parameter ||\n|------------------|---------------------------------------------|\n| segmentData | Uint8Array Value must not be null. |\n| timestamp | number |\n| frameDescription | Optional Uint8Array Value must not be null. |\n| frameType | Optional string |\n\nProperties\n----------\n\n### frameDescription\n\nconstant\n\n(non-null Uint8Array or undefined)\n\nThe ID3 frame's description.\n\n### frameType\n\nconstant\n\n(string or undefined)\n\nThe ID3 frame tag. A full list of possible tags are listed in\nhttps://exiftool.org/TagNames/ID3.html.\n\n### segmentData\n\nconstant\n\nnon-null Uint8Array\n\nThe ID3 frame's data.\n\n### timestamp\n\nconstant\n\nnumber\n\nThe media start time of the ID3 message in seconds."]]