Migrating from Legacy SDK

This document explains why the transition is required, what has changed, and how to move from the old SDK to the new Eagle 3D Streaming (E3DS) Frontend SDK.

The new SDK is now the only supported integration method for embedding Unreal Engine Pixel Streaming applications with Eagle 3D Streaming.

Why Transition?

We have upgraded our streaming infrastructure.

As a result of these upgrades, the old SDK is no longer compatible with the current Eagle 3D Streaming system. As a result, applications using the old SDK will no longer function correctly.

To ensure uninterrupted streaming, improved security, and access to ongoing platform improvements, all users must transition to the new E3DS Frontend SDK.

Impact on Existing Integrations

• The old SDK will no longer work with the current system

• Existing web integrations must be updated to continue streaming

• No changes are required to Unreal Engine applications

• Only the frontend integration layer needs to be updated

Old SDK Overview

The old SDK required users to:

• Run a custom Node.js token server

• Manually configure token generation logic

• Maintain backend scripts such as:

  • tokenServer.js

  • setup.bat

  • startTokenServer.bat

• Expose a local endpoint to generate tokens

• Manually manage authentication and session startup

While functional at the time, this approach added operational complexity and required continuous backend maintenance.

New SDK Overview

The new E3DS Frontend SDK provides a modern, simplified, and secure integration workflow that:

• Eliminates the need for a custom token server

• Automatically manages token generation and authentication

• Uses a clean JavaScript-based SDK

• Simplifies setup and deployment

• Aligns with modern web and security best practices

The new SDK is designed specifically for the upgraded Eagle 3D Streaming platform and will continue to receive updates and new features.

Old SDK vs New SDK

What You Need to Change

No Longer Required

• Node.js token server

• tokenServer.js

• .bat setup and startup scripts

• Manual Token API calls

• Local test endpoints (e.g. /testToken)

Now Required

• E3DS Frontend SDK

• SDK demo project (recommended starting point)

• Configuration via tokenManager.js

• Frontend-based stream initialization

Migration Steps

To migrate from the old SDK to the new E3DS Frontend SDK, follow the official integration guide provided below.

Step 1. Follow the New SDK Integration Guide

All setup, configuration, and usage instructions for the new SDK are maintained in a single, up-to-date document:

Embed Stream using E3DS SDK

This guide covers:

• SDK setup

• Authentication configuration

• Streaming configuration

• Running and validating your first Pixel Streaming session

We strongly recommend following this guide step by step to ensure a correct and supported integration.

Step 2. Replace the Old SDK Integration

After successfully validating the new SDK setup:

• Remove the old SDK implementation

• Stop using any Node.js token server or related scripts

• Update your frontend to use the E3DS Frontend SDK

• Ensure all streaming sessions are initialized through the new SDK

No changes are required to your Unreal Engine application.

Step 3. Test and Deploy

Once the new SDK integration is complete:

• Test streaming in your local and staging environments

• Verify authentication and stream startup behavior

• Deploy your updated frontend to production

Important Notes

• The old SDK is not compatible with the current Eagle 3D Streaming system

• Only the new SDK is supported going forward

• Future platform features and improvements will be available exclusively through the new SDK

Need help?

If you need any assistance, feel free to reach out through any of the following channels:

🛠️ Support Portal: Contact Our Support Team

💬 Discord Community (Faster Support): Join Our Discord Community

📧 Email Support: support@eagle3dstreaming.com

🆓 Get Started for free

Follow us on:

Facebook | GitHub | LinkedIn | YouTube