- A high-resolution screenshot or render of the current scene.
- A generated document, such as a quote, a specification sheet or a report.
- An exported configuration or save file.
Before you start
- The Pixel Streaming or Pixel Streaming 2 plugin is enabled in your project. Enable only one of them. The node on this page has the same name in both.
- The viewer is connected and the stream has started. A file sent earlier is not delivered.
- You know where your application can write files at runtime. See File paths on a streaming server.
How it works
Your application calls Send File
The plugin sends the file in pieces
The browser puts the file back together
Node reference
Send File
Sends a file that exists on disk.Send File as Byte Array
Sends data that is in memory and has not been written to disk. It takes a byte array in place of Filepath, with the same Mime Type and File Extension.Common types
Send an existing file
Check that the file exists, then send it.
Send a text file when it exists, and report the path when it does not
Create a custom event with a File Path input
Check the file with File Exists
On True, call Send File
On False, report the problem
Send a file your application creates
A file that is still being written cannot be sent. Start the work, wait until the file exists, then send it. This example takes a high-resolution screenshot and sends it to the viewer.Start the capture
HighResShot console command with that path, and start a looping timer that checks for the file.
Build the path, run HighResShot, and start the timer
Wait for the file, then send it
- The file exists: clear the timer, wait about a second so the write finishes, then call Send File with
image/pngand.png. - The file does not exist yet: let the timer fire again.
- Too many attempts: clear the timer and reset Busy, so the application never waits for ever.

Poll for the file, send it, and stop after 40 attempts
What the viewer sees
On the Streampixel player, including when it is embedded in an iframe:capture-<date>-<time> followed by your extension, for example capture-20261116-143005.png. Pixel Streaming sends the type and the extension of a file, not its name.
File paths on a streaming server
On Streampixel your application runs on a streaming server, not on your computer.- Files are temporary. A file your application writes on a streaming server is not kept between sessions and is not available on other servers.
- Sessions move between servers. The next session may run on a different server.
- Persistent data belongs in your own storage. Send it to your backend or to cloud storage, keyed by your own user or account ID.
Limits and performance
- Files share the connection with the stream and are sent in small pieces. Screenshots and documents arrive within moments.
- A large file takes longer and competes with the video for bandwidth while it is being sent. For large files, give the viewer a link to download from your own storage.
- Send one file at a time. Wait for a transfer to finish before starting the next.
Troubleshooting
Nothing is downloaded
Nothing is downloaded
- The path. Print the path and the result of File Exists before calling Send File. A path that works on your computer may not exist on the streaming server.
- The timing. The viewer must be connected and the stream started before the file is sent.
- The file is complete. If your application has just created the file, wait until it has finished writing. See Send a file your application creates.
The file is empty or cannot be opened
The file is empty or cannot be opened
The file has the wrong type or no extension
The file has the wrong type or no extension
The file name is not the one I used
The file name is not the one I used
capture-<date>-<time> with your extension, because Pixel Streaming does not send a file name.On iPhone or iPad the file does not download by itself
On iPhone or iPad the file does not download by itself
It works in the editor but not on Streampixel
It works in the editor but not on Streampixel