Capture Screenshot Using SDK

This guide explains how to capture a screenshot from your Pixel Streaming session using the Eagle 3D Streaming SDK.

Live Streaming URL:

Demo Project GitHub Repository:

https://github.com/e3ds/pixelstreaming-sdk

Follow the steps below:

Step 1. Add the Screenshot Function

Add the following function inside your scripts_demo.js file:

JS

function captureStreamScreenshot() {
    console.log("Capturing screenshot");

    e3ds_controller.captureScreenShot();
}

Explanation

Code	Meaning
`function captureStreamScreenshot()`	Creates a function to capture a screenshot from the stream.
`console.log("Capturing screenshot");`	Prints a message in the browser console for testing.
`e3ds_controller.captureScreenShot();`	Calls the SDK function to capture the screenshot from the Pixel Streaming session.

Add the following button in your HTML page:

HTML

<button onclick="captureStreamScreenshot()">Capture Screenshot</button>

Explanation

Code	Meaning
`<button>`	Creates a clickable button on the webpage.
`onclick="captureStreamScreenshot()"`	Calls the screenshot function when the button is clicked.
`Capture Screenshot`	Text shown on the button.

After adding the function and button:

You can also open the browser console and check the log:

CODE

Capturing screenshot

This confirms that the screenshot function is being triggered from the frontend.

Live Streaming URL:

The screenshot should be captured only after the stream is fully connected.

If the stream is not loaded yet, the screenshot may not capture properly.

Make sure the user clicks the button after the video stream is visible.

Issue	Possible Cause	Solution
Screenshot button does nothing	Function name mismatch	Make sure the button calls the correct function name: `captureStreamScreenshot()`
`captureStreamScreenshot is not defined`	Function is not added or not loaded properly	Add the function in `scripts_demo.js` and make sure the file is linked correctly
`e3ds_controller is not defined`	SDK is not loaded yet	Make sure the SDK is loaded before calling `e3ds_controller.captureScreenShot()`
Screenshot is blank or not correct	Stream is not fully loaded	Wait until the stream is fully connected and visible before capturing
Screenshot does not download/show	Browser or SDK behavior may depend on implementation	Check browser console for errors and test again after stream is connected

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

Follow us on:

Facebook | GitHub | LinkedIn | YouTube