@dolby-optiview/ads-sdk-adapter-shaka 1.0.0-beta.6 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ShakaAdapter.d.ts +55 -9
- package/dist/ShakaAdapter.js +1 -1
- package/dist/index.d.ts +1 -0
- package/package.json +2 -2
package/dist/ShakaAdapter.d.ts
CHANGED
|
@@ -1,8 +1,4 @@
|
|
|
1
1
|
import type { PlayerAdapter, PlayerAdapterEvent, PlayerAdapterEventHandler, VideoQuality } from '@dolby-optiview/ads-sdk-core';
|
|
2
|
-
/**
|
|
3
|
-
* Minimum surface of shaka.Player that ShakaAdapter depends on.
|
|
4
|
-
* A real shaka.Player from `shaka-player` satisfies this interface.
|
|
5
|
-
*/
|
|
6
2
|
/**
|
|
7
3
|
* Minimal surface of a Shaka variant track. `bandwidth` is bits/s; `active` marks the one
|
|
8
4
|
* currently playing, which is what a restore has to put back when the application had ABR off.
|
|
@@ -12,14 +8,32 @@ export interface ShakaVariantTrackLike {
|
|
|
12
8
|
readonly bandwidth?: number;
|
|
13
9
|
readonly active?: boolean;
|
|
14
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* Minimum surface of `shaka.Player` that {@link ShakaAdapter} depends on.
|
|
13
|
+
* A real `shaka.Player` from `shaka-player` satisfies this interface.
|
|
14
|
+
*
|
|
15
|
+
* @category Player Integration
|
|
16
|
+
*/
|
|
15
17
|
export interface ShakaPlayerLike {
|
|
18
|
+
/** Attach the player to a `<video>` element; the adapter calls this from `load()` when needed. */
|
|
16
19
|
attach(mediaElement: HTMLVideoElement, initializeMediaSource?: boolean): Promise<void>;
|
|
17
20
|
/** The element the player is currently attached to, where the build exposes it. */
|
|
18
21
|
getMediaElement?(): HTMLMediaElement | null;
|
|
19
|
-
|
|
22
|
+
/**
|
|
23
|
+
* Load a stream URL, optionally starting at `startTime`. A number is seconds into the
|
|
24
|
+
* presentation; a `Date` is a wall-clock start for live streams.
|
|
25
|
+
*/
|
|
26
|
+
load(url: string, startTime?: number | Date | null): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* Unload the current stream and release the decoder. `initializeMediaSource=false` keeps
|
|
29
|
+
* the MediaSource closed so re-attach stays cheap. Optional: older builds may not expose it.
|
|
30
|
+
*/
|
|
31
|
+
unload?(initializeMediaSource?: boolean): Promise<void>;
|
|
20
32
|
/** Stop streaming and release the media element. Optional: older builds may not expose it. */
|
|
21
33
|
detach?(): Promise<void>;
|
|
34
|
+
/** Release the player. */
|
|
22
35
|
destroy(): Promise<void>;
|
|
36
|
+
/** The parsed manifest (`shaka.extern.Manifest`), or null before content loads. */
|
|
23
37
|
getManifest(): ShakaManifestLike | null;
|
|
24
38
|
/** The URI Shaka is playing. Optional: older builds may not expose it. */
|
|
25
39
|
getAssetUri?(): string | null;
|
|
@@ -27,21 +41,30 @@ export interface ShakaPlayerLike {
|
|
|
27
41
|
isLive?(): boolean;
|
|
28
42
|
/** The seekable window Shaka will honour, in seconds. Optional. */
|
|
29
43
|
seekRange?(): {
|
|
44
|
+
/** Start of the window, in seconds. */
|
|
30
45
|
start: number;
|
|
46
|
+
/** End of the window, in seconds. */
|
|
31
47
|
end: number;
|
|
32
48
|
};
|
|
33
49
|
/** Live config lives under `streaming`; read defensively, shapes vary by version. */
|
|
34
50
|
getConfiguration?(): {
|
|
51
|
+
/** The `streaming` section of the Shaka configuration. */
|
|
35
52
|
streaming?: {
|
|
53
|
+
/** How far from the live edge Shaka keeps seeks, in seconds. */
|
|
36
54
|
safeSeekEndOffset?: number;
|
|
55
|
+
/** Shaka's live-latency controller settings. */
|
|
37
56
|
liveSync?: {
|
|
57
|
+
/** Whether Shaka adjusts playback rate to hold the target latency. */
|
|
38
58
|
enabled?: boolean;
|
|
59
|
+
/** The latency it holds, in seconds. */
|
|
39
60
|
targetLatency?: number;
|
|
61
|
+
/** How far latency may drift before Shaka corrects it, in seconds. */
|
|
40
62
|
targetLatencyTolerance?: number;
|
|
41
63
|
};
|
|
42
64
|
};
|
|
43
65
|
/** Whether adaptive selection is on — snapshotted so a quality pin can be undone exactly. */
|
|
44
66
|
abr?: {
|
|
67
|
+
/** Whether ABR is enabled. */
|
|
45
68
|
enabled?: boolean;
|
|
46
69
|
};
|
|
47
70
|
};
|
|
@@ -65,6 +88,7 @@ export interface ShakaPlayerLike {
|
|
|
65
88
|
* for in-stream ID3 and `emsg` for DASH event boxes. Optional.
|
|
66
89
|
*/
|
|
67
90
|
addEventListener?(type: string, listener: (event: ShakaMetadataEvent & ShakaEmsgEvent & ShakaErrorEvent) => void): void;
|
|
91
|
+
/** Remove a listener added with `addEventListener`. Optional. */
|
|
68
92
|
removeEventListener?(type: string, listener: (event: ShakaMetadataEvent & ShakaEmsgEvent & ShakaErrorEvent) => void): void;
|
|
69
93
|
}
|
|
70
94
|
/**
|
|
@@ -121,7 +145,8 @@ interface ShakaManifestLike {
|
|
|
121
145
|
};
|
|
122
146
|
}
|
|
123
147
|
/**
|
|
124
|
-
* Shaka Player
|
|
148
|
+
* The {@link PlayerAdapter} for Shaka Player, from the `@dolby-optiview/ads-sdk-adapter-shaka`
|
|
149
|
+
* package (peer dependency: `shaka-player` 4 or 5).
|
|
125
150
|
*
|
|
126
151
|
* Preferred usage — create the Player WITHOUT passing the video element to the
|
|
127
152
|
* constructor (avoids Shaka's deprecated eager-MediaSource-init path which can
|
|
@@ -143,6 +168,8 @@ interface ShakaManifestLike {
|
|
|
143
168
|
* If you pass the video element to the constructor (legacy/deprecated pattern),
|
|
144
169
|
* ShakaAdapter still works — `load()` re-attaches only when the player is attached
|
|
145
170
|
* elsewhere.
|
|
171
|
+
*
|
|
172
|
+
* @category Player Integration
|
|
146
173
|
*/
|
|
147
174
|
export declare class ShakaAdapter implements PlayerAdapter {
|
|
148
175
|
private player;
|
|
@@ -169,6 +196,10 @@ export declare class ShakaAdapter implements PlayerAdapter {
|
|
|
169
196
|
* live session would otherwise grow this without bound.
|
|
170
197
|
*/
|
|
171
198
|
private emittedCueKeys;
|
|
199
|
+
/**
|
|
200
|
+
* @param player The `shaka.Player` (or anything satisfying {@link ShakaPlayerLike}).
|
|
201
|
+
* @param videoElement The `<video>` element the content plays in.
|
|
202
|
+
*/
|
|
172
203
|
constructor(player: ShakaPlayerLike, videoElement: HTMLVideoElement);
|
|
173
204
|
/**
|
|
174
205
|
* Current playback time in seconds.
|
|
@@ -246,14 +277,29 @@ export declare class ShakaAdapter implements PlayerAdapter {
|
|
|
246
277
|
* Let go of the `<video>` so the SDK can play an ad through it (shared-element insertion).
|
|
247
278
|
*
|
|
248
279
|
* Shaka does not tolerate sharing: with the player still attached, its MediaSource and the
|
|
249
|
-
* ad engine's
|
|
250
|
-
* its first segment.
|
|
280
|
+
* ad engine's compete for the same element, and the ad either aborts outright or loops on
|
|
281
|
+
* its first segment.
|
|
251
282
|
*
|
|
252
283
|
* `detach()` rather than `destroy()`: the same player instance takes the element back at
|
|
253
284
|
* break end, when the SDK calls `load()` with the saved content source — and `load()`
|
|
254
|
-
* re-attaches when it finds the element is no longer Shaka's.
|
|
285
|
+
* re-attaches (without an eager MediaSource) when it finds the element is no longer Shaka's.
|
|
255
286
|
*/
|
|
256
287
|
releaseMediaElement(): Promise<void>;
|
|
288
|
+
/**
|
|
289
|
+
* Release the ad stream and decoder at break end. Prefers `player.unload(false)` — no eager
|
|
290
|
+
* MediaSource reopen — and falls back to `detach()` on builds without `unload`.
|
|
291
|
+
*/
|
|
292
|
+
unload(): Promise<void>;
|
|
293
|
+
/**
|
|
294
|
+
* Rebuild the pipeline for the CURRENT source positioned at `startTime` — see
|
|
295
|
+
* `PlayerAdapter.recreateMediaPipeline`. `unload(false)` keeps the MediaSource closed.
|
|
296
|
+
* A full `load()` on a live stream starts a NEW presentation timeline (measured ~20 s
|
|
297
|
+
* rebase on the office Vizio), so the old-timeline `startTime` is re-mapped: the
|
|
298
|
+
* manifest's PDT anchor when present, else distance to the live edge.
|
|
299
|
+
*/
|
|
300
|
+
recreateMediaPipeline(options: {
|
|
301
|
+
startTime: number;
|
|
302
|
+
}): Promise<void>;
|
|
257
303
|
/**
|
|
258
304
|
* Subscribe to player events.
|
|
259
305
|
*/
|
package/dist/ShakaAdapter.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{decodeUtf8 as e,parseId3GeobBody as t}from"@dolby-optiview/ads-sdk-core/id3";function i(e){if(null!=e)return"string"==typeof e?e:
|
|
1
|
+
import{decodeUtf8 as e,parseId3GeobBody as t}from"@dolby-optiview/ads-sdk-core/id3";function i(e){if(null!=e)return"string"==typeof e?e:a(e)?new TextDecoder("utf-8").decode(e):ArrayBuffer.isView(e)?new TextDecoder("utf-8").decode(new Uint8Array(e.buffer,e.byteOffset,e.byteLength)):String(e)}function a(e){return e instanceof ArrayBuffer||"[object ArrayBuffer]"===Object.prototype.toString.call(e)}function r(e){if(a(e))return new Uint8Array(e);const t=e;return new Uint8Array(t.buffer,t.byteOffset,t.byteLength)}export class ShakaAdapter{constructor(e,t){this.eventListeners=new Map,this.boundHandlers=new Map,this.deferredSeekTime=null,this.loadingViaAdapter=!1,this.abrEnabledBeforePin=null,this.variantBeforePin=null,this.emittedCueKeys=new Set,this.player=e,this.video=t;const i=e.load;this.originalPlayerLoad=i,e.load=async(...t)=>{try{return await i.apply(e,t)}catch(e){throw this.loadingViaAdapter||function(e){return"object"==typeof e&&null!==e&&7e3===e.code}(e)||this.emit("error",e),e}},this.setupVideoListeners(),this.setupMetadataListener()}get currentTime(){return this.video.currentTime}get duration(){return this.video.duration}get isLive(){return this.player.isLive?.()??null}get paused(){return this.video.paused}get muted(){return this.video.muted}set muted(e){this.video.muted=e}get volume(){return this.video.volume}set volume(e){this.video.volume=e}get videoElement(){return this.video}get programDateTime(){try{const e=this.player.getManifest();if(!e)return null;const t=e.presentationTimeline.getInitialProgramDateTime();return null==t?null:new Date(1e3*(t+this.video.currentTime))}catch{return null}}pause(){this.video.pause()}async play(){await this.video.play()}seek(e){this.video.seeking?this.deferredSeekTime=e:this.video.currentTime=e}get sourceUrl(){return this.player.getAssetUri?.()??null}async load(e){this.player.getMediaElement?.()!==this.video&&await this.player.attach(this.video,!1),this.loadingViaAdapter=!0;try{await this.player.load(e)}finally{this.loadingViaAdapter=!1}}async releaseMediaElement(){await(this.player.detach?.())}async unload(){"function"==typeof this.player.unload?await this.player.unload(!1):await(this.player.detach?.())}async recreateMediaPipeline(e){const t=this.sourceUrl;if(!t)throw new Error("Shaka pipeline recreate: no asset URI");this.deferredSeekTime=null;const i=e.startTime,a=!0===this.isLive;let r;try{r=this.player.getManifest()?.presentationTimeline.getInitialProgramDateTime()??null}catch{r=null}const s=a&&null!==r?1e3*(r+i):null,n=this.player.seekRange?.()?.end,d=a&&void 0!==n&&Number.isFinite(n)?Math.max(0,n-i):null;await this.unload(),this.player.getMediaElement?.()!==this.video&&await this.player.attach(this.video,!1),this.loadingViaAdapter=!0;try{if(a)if(null!==s)await this.player.load(t,new Date(s));else if(null!==d){await this.player.load(t,null);const e=this.player.seekRange?.()?.end;if(void 0!==e&&Number.isFinite(e)){const t=e-d;Math.abs(t-this.video.currentTime)>.5&&(this.video.currentTime=t)}}else await this.player.load(t,i);else await this.player.load(t,i)}finally{this.loadingViaAdapter=!1}}on(e,t){this.eventListeners.has(e)||this.eventListeners.set(e,new Set),this.eventListeners.get(e).add(t)}off(e,t){const i=this.eventListeners.get(e);i&&i.delete(t)}destroy(){for(const[e,t]of this.boundHandlers)this.video.removeEventListener(e,t);this.boundHandlers.clear(),this.deferredSeekTime=null,this.player.removeEventListener&&(this.presentedMetadataHandler&&(this.player.removeEventListener("metadata",this.presentedMetadataHandler),this.presentedMetadataHandler=void 0),this.parsedMetadataHandler&&(this.player.removeEventListener("metadataadded",this.parsedMetadataHandler),this.parsedMetadataHandler=void 0)),this.emsgHandler&&this.player.removeEventListener&&(this.player.removeEventListener("emsg",this.emsgHandler),this.emsgHandler=void 0),this.shakaErrorHandler&&this.player.removeEventListener&&(this.player.removeEventListener("error",this.shakaErrorHandler),this.shakaErrorHandler=void 0),this.originalPlayerLoad&&(this.player.load=this.originalPlayerLoad,this.originalPlayerLoad=void 0),this.emittedCueKeys.clear(),this.eventListeners.clear(),this.player.destroy()}get playbackRate(){return this.video.playbackRate}set playbackRate(e){this.video.playbackRate=e}setVideoQuality(e){if(null===e){if(null===this.abrEnabledBeforePin)return!1;const e=this.abrEnabledBeforePin,t=this.variantBeforePin;if(e){if(!this.player.configure)return!1;this.player.configure("abr.enabled",!0)}else{if(!t)return!1;if(!this.player.selectVariantTrack)return!1;this.player.selectVariantTrack(t,!1)}return this.abrEnabledBeforePin=null,this.variantBeforePin=null,!0}const t=this.player.getVariantTracks?.();if(!t||!this.player.selectVariantTrack)return!1;const i=t.filter(e=>{const t=e?.bandwidth;return"number"==typeof t&&Number.isFinite(t)&&t>0});if(i.length<2)return!1;let a=i[0];for(let e=1;e<i.length;e++)i[e].bandwidth<a.bandwidth&&(a=i[e]);if(null!==this.abrEnabledBeforePin)return!0;const r=this.player.getConfiguration?.()?.abr?.enabled??!0,s=t.find(e=>e?.active)??null;if(r&&!this.player.configure||!r&&!s)return!1;this.abrEnabledBeforePin=r,this.variantBeforePin=s;try{return this.player.configure?.("abr.enabled",!1),this.player.selectVariantTrack(a,!1),!0}catch{if(r)try{this.player.configure?.("abr.enabled",!0)}catch{this.variantBeforePin=null}return this.abrEnabledBeforePin=null,this.variantBeforePin=null,!1}}get maxLiveSeekPosition(){if(!this.player.isLive?.())return null;const e=this.player.seekRange?.(),t=e?.end;if("number"!=typeof t||!Number.isFinite(t))return null;const i=this.player.getConfiguration?.()?.streaming,a=i?.liveSync;let r;if(a?.enabled){const e=a.targetLatency,t=a.targetLatencyTolerance??0;"number"==typeof e&&(r=e-t)}if(void 0===r&&(r=i?.safeSeekEndOffset),"number"!=typeof r||!Number.isFinite(r))return null;const s=t-r;return Number.isFinite(s)?s:null}setupMetadataListener(){if(!this.player.addEventListener)return;const e=e=>t=>{const i={...this.toCue(t),phase:e};this.isDuplicateCue(i)||this.emit("timedmetadata",i)};this.parsedMetadataHandler=e("parsed"),this.presentedMetadataHandler=e("presented"),this.player.addEventListener("metadata",this.presentedMetadataHandler),this.player.addEventListener("metadataadded",this.parsedMetadataHandler);const t=e=>{const t=e.detail;t&&this.emit("timedmetadata",this.emsgToCue(t))};this.emsgHandler=t,this.player.addEventListener("emsg",t);const i=e=>{2===e.detail?.severity&&this.emit("error",e.detail)};this.shakaErrorHandler=i,this.player.addEventListener("error",i)}isDuplicateCue(e){const t=[e.startTime,e.description??"",e.mimeType??"",e.messageData??"",e.frames?JSON.stringify(e.frames):"",e.phase??""].join("\0");return!!this.emittedCueKeys.has(t)||(this.emittedCueKeys.add(t),this.emittedCueKeys.size>256&&this.emittedCueKeys.delete(this.emittedCueKeys.values().next().value),!1)}toCue(s){const n=(s.metadataType??"").toLowerCase(),d=n.includes("emsg")?"emsg":n.includes("daterange")?"daterange":"id3",l=s.payload?.key??s.key,o=s.payload?.data??s.payload?.value??s.data,h={type:d,startTime:s.startTime??s.cueTime??0,endTime:s.endTime};if(void 0!==s.schemeIdUri&&(h.schemeIdUri=s.schemeIdUri),"emsg"===d){const e=null==o?null:r(o);e&&(h.raw=e)}if("id3"===d&&"GEOB"===l){const n=function(e,t){return(void 0===e||""===e)&&(a(t)||ArrayBuffer.isView(t))}(s.payload?.description,o)?t(r(o)):null;if(n)return h.description=n.description,n.mimeType&&(h.mimeType=n.mimeType),h.messageData=e(n.data),h;void 0!==s.payload?.description&&(h.description=s.payload.description),null!=s.payload?.mimeType&&(h.mimeType=s.payload.mimeType);const d=i(o);return void 0!==d&&(h.messageData=d),h}const u="id3"===d?null==o?void 0:String(o):i(o);return l&&void 0!==u?"id3"===d?h.frames={[l]:u}:h.messageData=u:void 0!==u&&(h.messageData=u),h}emsgToCue(e){const t={type:"emsg",startTime:e.startTime??0,endTime:e.endTime};if(void 0!==e.schemeIdUri&&(t.schemeIdUri=e.schemeIdUri),void 0!==e.id&&(t.id=String(e.id)),null!=e.messageData){const i=r(e.messageData);i&&(t.raw=i)}const a=i(e.messageData);return void 0!==a&&(t.messageData=a),t}setupVideoListeners(){const e=()=>{this.emit("timeupdate")},t=()=>{this.emit("ended")},i=()=>{this.emit("error",this.video.error)},a=()=>{if(this.emit("seeked"),null!==this.deferredSeekTime){const e=this.deferredSeekTime;this.deferredSeekTime=null,this.seek(e)}},r=()=>{this.emit("volumechange")},s=()=>{this.emit("waiting")},n=()=>{this.emit("playing")},d=()=>{this.emit("pause")};this.video.addEventListener("timeupdate",e),this.video.addEventListener("ended",t),this.video.addEventListener("error",i),this.video.addEventListener("seeked",a),this.video.addEventListener("volumechange",r),this.video.addEventListener("waiting",s),this.video.addEventListener("playing",n),this.video.addEventListener("pause",d),this.boundHandlers.set("timeupdate",e),this.boundHandlers.set("ended",t),this.boundHandlers.set("error",i),this.boundHandlers.set("seeked",a),this.boundHandlers.set("volumechange",r),this.boundHandlers.set("waiting",s),this.boundHandlers.set("playing",n),this.boundHandlers.set("pause",d)}emit(e,t){const i=this.eventListeners.get(e);if(i)for(const e of i)try{e(t)}catch(e){console.error("[ShakaAdapter] Event handler error:",e)}}}
|
package/dist/index.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dolby-optiview/ads-sdk-adapter-shaka",
|
|
3
|
-
"version": "1.0.0
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Shaka Player adapter for OptiView Ads SDK",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
},
|
|
39
39
|
"sideEffects": false,
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@dolby-optiview/ads-sdk-core": "1.0.0
|
|
41
|
+
"@dolby-optiview/ads-sdk-core": "^1.0.0"
|
|
42
42
|
},
|
|
43
43
|
"peerDependencies": {
|
|
44
44
|
"shaka-player": "^4.0.0 || ^5.0.0"
|