@vizbeetv/sdk-qa
v7.8.52
Published
Vizbee TV SDK — platform builds
Readme
@vizbeetv/sdk-qa
Vizbee TV SDK — pre-built platform bundles distributed as a single npm package with subpath exports.
Installation
npm install @vizbeetv/sdk-qaUsage
Import the subpath that matches your target platform. Each subpath resolves to a self-contained, minified ESM bundle.
Samsung (Tizen)
// ES5 — Tizen 2.x / Chrome 38+ (default)
import vizbee from '@vizbeetv/sdk-qa/samsung';
// ES6 — Tizen 5.5+ / Chrome 72+
import vizbee from '@vizbeetv/sdk-qa/samsung/es6';LG (WebOS)
// ES5 — WebOS 3.x / Chrome 38+ (default)
import vizbee from '@vizbeetv/sdk-qa/lg';
// ES6 — WebOS 6+ / Chrome 72+
import vizbee from '@vizbeetv/sdk-qa/lg/es6';Vizio SmartCast
import vizbee from '@vizbeetv/sdk-qa/vizio';Xbox
// ES5 (default)
import vizbee from '@vizbeetv/sdk-qa/xbox';
// ES6
import vizbee from '@vizbeetv/sdk-qa/xbox/es6';Chromecast v2 (MediaManager)
// ES5 (default)
import vizbee from '@vizbeetv/sdk-qa/chromecast-v2';
// ES6
import vizbee from '@vizbeetv/sdk-qa/chromecast-v2/es6';Platform reference
| Subpath | Platform | JS Target |
|---|---|---|
| /samsung, /samsung/es5 | Samsung (Tizen) | ES5 / Chrome 38+ |
| /samsung/es6 | Samsung (Tizen 5.5+) | ES6 / Chrome 72+ |
| /lg, /lg/es5 | LG (WebOS) | ES5 / Chrome 38+ |
| /lg/es6 | LG (WebOS 6+) | ES6 / Chrome 72+ |
| /vizio | Vizio SmartCast | ES5 |
| /xbox, /xbox/es5 | Xbox | ES5 |
| /xbox/es6 | Xbox | ES6 |
| /chromecast-v2, /chromecast-v2/es5 | Chromecast v2 (MediaManager) | ES5 |
| /chromecast-v2/es6 | Chromecast v2 (MediaManager) | ES6 |
TypeScript
The package ships TypeScript declarations. The default export is the typed SDK
instance — its continuity API (context, adapters, messages) is fully typed —
and the SDK's public types are also importable as named exports for use in
annotations:
import vizbee, {
VideoInfo,
PlayerAdapter,
SessionState,
VizbeeMessagingClient,
} from '@vizbeetv/sdk-qa/samsung';
// Default export: the SDK instance. Its continuity API is typed end-to-end.
const ctx = vizbee.continuity.ContinuityContext.getInstance();
ctx.start('vzb1234567');
ctx.getAppAdapter().setDeeplinkHandler((video: VideoInfo) => {
/* deeplink into video.guid / video.videoUrl … */
});
// Named exports: use the SDK's types in your own signatures.
function onSessionState(state: SessionState) { /* ... */ }The same type surface is exposed from every platform subpath.
Requires
moduleResolutionset tobundler,node16, ornodenextin yourtsconfig.json(the same requirement as resolving the platform subpaths).
Window globals
Each bundle also sets window.VizbeeSDK and window.vizbee on load for backward compatibility with existing script-tag consumers. The default export and the window global point to the same object.
