adgent-sdk 0.1.8 → 0.1.9

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.
Files changed (2) hide show
  1. package/README.md +33 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -27,6 +27,7 @@ Lightweight, framework-agnostic VAST Player SDK for Smart TV platforms.
27
27
  - [Configuration Options](#configuration-options)
28
28
  - [Events](#events)
29
29
  - [Platform Support](#platform-support)
30
+ - [Limitations](#limitations)
30
31
  - [Performance](#performance)
31
32
  - [Development](#development)
32
33
  - [License](#license)
@@ -363,6 +364,38 @@ sdk.destroy();
363
364
  - Naver Whale browser support
364
365
  - Whale-specific optimizations
365
366
 
367
+
368
+ ---
369
+
370
+ ## Limitations
371
+
372
+ ### No VPAID Support
373
+
374
+ Adgent SDK explicitly **does not support** VPAID (Video Player-Ad Interface Definition) executables. VPAID is deliberately excluded for Smart TV platforms due to:
375
+
376
+ 1. **Performance**: VPAID requires executing arbitrary JavaScript within the player context, which severely degrades performance on resource-constrained TV hardware.
377
+ 2. **Stability**: Third-party VPAID scripts are a common source of memory leaks and application crashes on long-running TV apps.
378
+ 3. **Security**: Executing unverified external code poses significant security risks.
379
+ 4. **Modern Alternatives**: The industry has moved towards VAST 4.x and OMID (Open Measurement Interface Definition) for measurement, rendering VPAID obsolete for most modern ad serving use cases.
380
+
381
+ The SDK automatically filters out VPAID media files and selects the best compatible video file (MP4/WebM).
382
+
383
+ ### Device Compatibility (Old TVs)
384
+
385
+ Smart TVs, especially older models (2016-2019), have strict hardware limitations. To ensure smooth playback across all devices, we recommend the following constraints:
386
+
387
+ 1. **Video Codec**: H.264 (AVC) Main Profile Level 4.1 or lower.
388
+ - HEVC (H.265) is supported on newer models but may fail on older ones.
389
+ - VP9 is widely supported but less reliable for ad insertion than H.264.
390
+ 2. **Resolution**: 1920x1080 (1080p) maximum.
391
+ - 4K (UHD) ads are **penalized** by the SDK's selection algorithm as they consume excessive memory and can cause UI stuttering or crashes on budget TVs.
392
+ 3. **Bitrate**: 1500-2500 kbps recommended.
393
+ - Bitrates > 4000 kbps may cause buffering on TV WiFi chips.
394
+ 4. **Audio Codec**: AAC-LC (Low Complexity).
395
+ 5. **Container**: MP4 (`video/mp4`) is preferred over all other containers for maximum compatibility.
396
+
397
+ The SDK's selection algorithm actively prioritizes streams matching these criteria to prevent playback failures on legacy hardware.
398
+
366
399
  ---
367
400
 
368
401
  ## Performance
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "adgent-sdk",
3
- "version": "0.1.8",
3
+ "version": "0.1.9",
4
4
  "description": "Lightweight, framework-agnostic VAST Player SDK for Smart TV platforms",
5
5
  "type": "module",
6
6
  "main": "./dist/adgent-sdk.umd.js",
@@ -37,7 +37,7 @@
37
37
  "author": "Asadbek Omonboyev",
38
38
  "license": "MIT",
39
39
  "dependencies": {
40
- "fast-xml-parser": "^4.3.4"
40
+ "fast-xml-parser": "^5.3.4"
41
41
  },
42
42
  "devDependencies": {
43
43
  "@babel/core": "^7.28.6",