Skip to content

Commit f3a8113

Browse files
authoredMar 17, 2025
feat: Added MetadataAdded event (#8282)
1 parent 1f336dd commit f3a8113

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed
 

‎lib/player.js

+26
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,25 @@ goog.requireType('shaka.media.PresentationTimeline');
385385
*/
386386

387387

388+
/**
389+
* @event shaka.Player.MetadataAddedEvent
390+
* @description Triggers when metadata associated with the stream is added.
391+
* @property {string} type
392+
* 'metadataadded'
393+
* @property {number} startTime
394+
* The time that describes the beginning of the range of the metadata to
395+
* which the cue applies.
396+
* @property {?number} endTime
397+
* The time that describes the end of the range of the metadata to which
398+
* the cue applies.
399+
* @property {string} metadataType
400+
* Type of metadata. Eg: 'org.id3' or 'com.apple.quicktime.HLS'
401+
* @property {shaka.extern.MetadataFrame} payload
402+
* The metadata itself
403+
* @exportDoc
404+
*/
405+
406+
388407
/**
389408
* @event shaka.Player.MetadataEvent
390409
* @description Triggers after metadata associated with the stream is found.
@@ -3494,6 +3513,13 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
34943513
// JSON stringify produces a good ID in this case.
34953514
region.id = JSON.stringify(region);
34963515
this.metadataRegionTimeline_.addRegion(region);
3516+
const data = new Map()
3517+
.set('startTime', region.startTime)
3518+
.set('endTime', region.endTime)
3519+
.set('metadataType', region.schemeIdUri)
3520+
.set('payload', region.payload);
3521+
this.dispatchEvent(shaka.Player.makeEvent_(
3522+
shaka.util.FakeEvent.EventName.MetadataAdded, data));
34973523
}
34983524

34993525
/**

‎lib/util/fake_event.js

+1
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ shaka.util.FakeEvent.EventName = {
177177
ManifestUpdated: 'manifestupdated',
178178
MediaQualityChanged: 'mediaqualitychanged',
179179
MediaSourceRecovered: 'mediasourcerecovered',
180+
MetadataAdded: 'metadataadded',
180181
Metadata: 'metadata',
181182
Midpoint: 'midpoint',
182183
NoSpatialVideoInfoEvent: 'nospatialvideoinfo',

‎project-words.txt

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ manifestparsed
3434
manifestupdated
3535
mediaqualitychanged
3636
mediasourcerecovered
37+
metadataadded
3738
mozfullscreenchange
3839
mozfullscreenerror
3940
nativecontrols

0 commit comments

Comments
 (0)
Please sign in to comment.