Using the SDK in the TelemetryTV Webapp Editor

TelemetryTV provides a powerful Software Development Kit (SDK) that lets you build interactive and custom applications directly inside the Webapp Editor. The SDK makes it easy to control devices, playlists, and contextual display behavior—all without requiring additional setup or imports.

SDK Availability

When a Webapp or Overlay is running inside the TelemetryTV Player, the SDK is automatically injected globally into the environment.

This means:

• You do not need to install or import the SDK manually.
• All SDK functions are available on the global TelemetryTvSdk object.
• The SDK is ready to use once initialization has completed.

Calling SDK Functions

Because the SDK is globally available, you can call its functions directly:

TelemetryTvSdk.log('Hello from TelemetryTV!');

There’s no need for an import or require statement—just access TelemetryTvSdk anywhere in your Webapp or Overlay code.

Ensuring the SDK is Ready

To avoid errors, you should always wait for the SDK to be initialized before calling its functions. TelemetryTV provides an event called EVENT_READY that fires once the SDK is fully set up.

You can listen for this event using the bindEvent function:

TelemetryTvSdk.bindEvent(TelemetryTvSdk.EVENT_READY, () => {  
  TelemetryTvSdk.log('SDK is ready and globally available');  
});

This guarantees that your code only runs after the SDK is ready.

Example: Full Integration

Here’s a complete example you can copy into a Webapp in the TelemetryTV Webapp Editor:

Best Practices

1. Always wait for EVENT_READY before making SDK calls.
2. Use inline scripts or include your logic in bundled JavaScript.
3. Test in the Player: The SDK only runs when your Webapp/Overlay is launched in a TelemetryTV Player, not in a standalone browser preview.

By following these steps, you can reliably integrate the TelemetryTV SDK into your custom Webapps and Overlays, enabling deeper control and interaction with your digital signage network.