@titan-os/sdk

@titan-os/sdk

Titan SDK for TV platforms - Device info, accessibility, and app management.

📖 Official Documentation | 🚀 Getting Started Guide

Note: This is the NPM package for integrating Titan SDK into your applications. For comprehensive guides, examples, and API reference, visit the official documentation.

Installation

npm install @titan-os/sdk

Usage

ES Modules (Recommended)

import { getTitanSDK } from '@titan-os/sdk';

const sdk = getTitanSDK();

// Wait for SDK to initialize
await sdk.isReady;

// Get device information
const deviceInfo = await sdk.deviceInfo.getDeviceInfo();
console.log('Device:', deviceInfo);

CommonJS

const { getTitanSDK } = require('@titan-os/sdk');

const sdk = getTitanSDK();

// Wait for SDK to initialize
await sdk.isReady;

// Get device information
const deviceInfo = await sdk.deviceInfo.getDeviceInfo();
console.log('Device:', deviceInfo);

UMD (Browser)

<script src="https://sdk.titanos.tv/sdk/sdk.js"></script>
<script>
  const sdk = TitanSDK.getTitanSDK();

  sdk.isReady.then(async () => {
    const deviceInfo = await sdk.deviceInfo.getDeviceInfo();
    console.log('Device:', deviceInfo);
  });
</script>

Note: For CDN usage, see the official documentation.

Features

• Device Information: Get detailed device capabilities and information
• Accessibility: Screen reader and accessibility features
• App Management: Launch and manage TV applications
• Platform Support: Philips, Vestel, and browser platforms
• TypeScript: Full TypeScript support with type definitions

API Reference

getTitanSDK(options?)

Creates a new SDK instance.

Options:

• gatewayUrl (string): Custom gateway URL for API calls (optional)

Returns: TitanSDK instance

SDK Instance

Properties

• isReady (Promise): Promise that resolves when SDK is ready
• VERSION (string): SDK version

Methods

• deviceInfo.getDeviceInfo(): Get device information
• accessibility.*: Accessibility features
• apps.*: App management features

Platform Support

• Philips TV: Full support for Philips Smart TV platform
• Vestel TV: Support for Vestel TV platform
• Browser: Fallback for web browsers and unsupported platforms

TypeScript

This package includes full TypeScript definitions:

import { getTitanSDK, DeviceInfo } from '@titan-os/sdk';

const sdk = getTitanSDK();
const deviceInfo: DeviceInfo = await sdk.deviceInfo.getDeviceInfo();

Migration from CDN

If you're migrating from the CDN version to NPM:

// CDN way (for direct HTML integration)
<script src="https://sdk.titanos.tv/sdk/sdk.js"></script>
<script>
  const sdk = TitanSDK.getTitanSDK();
</script>

// NPM way (for bundling in your app)
import { getTitanSDK } from '@titan-os/sdk';
const sdk = getTitanSDK();

Note: CDN version is still available and recommended for direct HTML integration. Use NPM package when you need to bundle the SDK with your application.

License

Apache-2.0