# Vagon Documentation This page has been prepared to provide detailed guidance for Vagon services: * [Vagon Streams](#vagon-streams-documentation) * [Vagon Cloud Computer](#vagon-cloud-computer-documentation) * [Vagon Teams](#vagon-teams-documentation) ## Vagon Streams Documentation Vagon Streams provides scalable application streaming for Unreal Engine and Unity applications with RTX-ready NVIDIA GPUs globally. Check out the documentation to learn how to create scalable application streaming, native pixel streaming, and native render streaming experiences in minutes with Vagon Streams, and how you can use Streams APIs and SDKs. For further assistance, you can contact us via .


Streams Documentation	/files/ANzIV3wh3P2CUiurqyjp	/spaces/aBZSLkY0LBQ4VmKzrByg
Streams Features	/files/024tnxQpkoMQOXUK0H93	https://vagon.io/streams

*** ## Vagon Cloud Computer Documentation Vagon Cloud Computer provides high-performance cloud computers for creative professionals with performance flexibility and integrated features to enhance their creative workflow. Check out the documentation page below to get further assistance for your Vagon Cloud Computer experience. For further assistance, you can contact us via .


Cloud Computer Help Center	/files/PTexP7SwpZwNvrYUFd8B	/spaces/Ik5pU0cI7R3ijTTHUx6M
Cloud Computer Features	/files/fIuHYCG4xlH44eXsfNN9	https://vagon.io/cloud-computer

*** ## Vagon Teams Documentation Vagon Teams allows companies to leverage cloud computers for their teams with an easy-to-use dashboard and Teams APIs for custom machine and team orchestration. Create projects & work on your tasks without hardware limits, share files, and collaborate seamlessly with Vagon Teams computers. Check out the documentation page to learn how you can utilize cloud workstations for your company with Vagon Teams, and Vagon Teams APIs. For further assistance, you can contact us via .


Teams Documentation	/files/pNQjuqXQ7CHLtwbDM5kI	/spaces/qzIIXvR8ySP07f6jrVdc
Teams Features	/files/BkUNCOQ0y6QbeGXyDpdB	https://vagon.io/teams

# Introduction This documentation provides detailed information about Vagon Streams, and its solutions on Unreal Engine Pixel Streaming, Unity Render Streaming, and Application Streaming. {% embed url="" %} Vagon Streams - Introduction {% endembed %} ## Vagon Streams Vagon Streams allows you to stream applications on any device with no code. Make any application accessible on any device globally, including but not limited to Unreal Engine and Unity applications. ![Stream your applications from any device with Vagon Streams](/files/PsxT4fYz7y6H52cWWHci) In this documentation, you will find information about how to stream your application from a browser window and how you can customize your application streaming experience with the advanced features of Vagon Streams. ### Unreal Engine Pixel Streaming Documentation {% content-ref url="/pages/bDCGKqkY7JDFepmMJIvc" %} [Unreal Engine Pixel Streaming](/streams/unreal-engine-pixel-streaming) {% endcontent-ref %} ### Unity Render Streaming Documentation {% content-ref url="/pages/iFQAhGqToYBwxGQlaMY6" %} [Unity Render Streaming](/streams/unity-render-streaming) {% endcontent-ref %} ### Vagon Application Streaming Documentation {% content-ref url="/pages/Gi7cQEEfhbZtJ4snJFKp" %} [Vagon Application Streaming](/streams/vagon-application-streaming) {% endcontent-ref %} ### Definitions * **`Application` -** Compiled & portable (dependencies included) software build containing an executable file. * **`Pixel Streaming`** - Technology to allow Unreal Engine developers to stream compiled `Application's` video and audio from a remote GPU-enabled computer. * **`Vagon Streams`** - Technology to allow anyone to stream any kind of `Application` (including but not limited to Unreal Engine and Unity apps) with microphone, audio, gamepad, and advanced features as a fully customizable experience for any device with no code. * **`Developer`** - An application developer who uses Vagon Streams. * **`Visitor`** - Application users who use the streamed application through Vagon Streams. The audience of the **`Developer`**. * **`Stream Machine`** - Vagon Streams machine, which runs & streams the selected application on the cloud. Can be accessed via **`Stream Link`** or via API integration. * **`Stream Session`** - The**`Stream Machine`** lifetime that starts with the **`waiting`** state and ends with the **`terminated`** state for each Stream. * **`Visitor Session`** - The timespan that starts when a visitor connects to the **`Stream Machine`** and ends when the visitor leaves the session. * **`Stream Status`** - Status of the remote Vagon Streams machine, updates are instant. * **`Stream`** - Orchestrator to manage capacity & provision for the **`Stream Machine`**s of **`Developer`** . * **`Stream Link`** - Single and unique link to access and distribute **`Stream`**. * **`Region`** - Selected service locations for **`Stream Machine`**s to stream an **`Application`**. * **`Capacity`** - A maximum number of concurrently running **`Stream Machine`**s per region according to **`Stream`** settings. {% hint style="info" %} **Good to know:** Besides using the dashboard, you can also upload & update your app via the [Streams CLI](/streams/tools-and-services/vagon-streams-cli), and customize & manage your streams via the [Streams API](/streams/integrations/streams-api-services). {% endhint %} # Unreal Engine Pixel Streaming Scalable & Native Unreal Engine Pixel Streaming solution with no-code integration ## What is Unreal Engine Pixel Streaming? Unreal Engine Pixel Streaming is a solution that enables real-time rendering on a cloud server, streaming fully rendered graphics to a client device. This eliminates intensive computations on the client, reducing processing demands and revolutionizing high-performance graphics industries. To learn more about its applicable usage areas, you can check our further Pixel Streaming guide for a [detailed explanation of Unreal Engine Pixel Streaming](https://vagon.io/blog/what-is-pixel-streaming). ## How to use Unreal Engine Pixel Streaming? [Vagon Streams](https://vagon.io/streams/features/unreal-engine-pixel-streaming) allows Unreal Engine developers to set up a scalable Pixel Streaming infrastructure, enabling them to share their applications globally. While it is possible to deploy Pixel Streaming-enabled Unreal Engine applications on public and private cloud services for interactive streaming, this process requires advanced expertise in cloud infrastructure and a manual integration process for each remote machine used for streaming. Unreal Engine Pixel Streaming support on Vagon Streams leverages the full functionality of Pixel Streaming, including audio and microphone support, as well as Unreal Engine/JS SDK integrations.

Scalable Pixel Streaming on Vagon Streams

### #1 - Enable Pixel Streaming Plugin Add Pixel Streaming plugin to your Unreal Engine project, and create your application build. You don't need to manually manage any pixel streaming plugin configuration. System will handle the whole TURN and WebRTC configurations on behalf of you to set up Pixel Streaming experience with your application. ### #2 - Upload Your Application and Create a Stream Link Now, you can upload your application build folder in .zip format to Vagon Streams dashboard. Our system will automatically check the Unreal Engine version of your application, and its Pixel Streaming support and optimize it for the best experience. In case you need further instructions, you can check [How to Start Streaming](/streams/guides/how-to-start-streaming) page for a step-by-step guide.

{% hint style="info" %} Pixel Streaming support is only available for the Unreal Engine experiences built for Windows operating system. {% endhint %} ### #3 - Activate Pixel Streaming from Dashboard After adding Pixel Streaming plugin, packaging your project, and uploading your build to your Vagon Dashboard; you only need to activate Pixel Streaming on the Stream Configurations page. Navigate to the **Stream Configurations** page from the gear icon next to your Stream link and activate the Pixel Streaming toggle.

Pixel Streaming Configuration from Dashboard

### #4 - Start Streaming Your App with Pixel Streaming Then, you will only need to click on the Stream link, and the system will automatically stream your application with Pixel Streaming technology. You can use the Stream link on any device, and configure the Stream settings from your dashboard easily. {% hint style="info" %} Additional feature support can vary depending on the selected streaming protocol, please check the related feature page to ensure the coverage. {% endhint %} # Unity Render Streaming Scalable & Verified Unity Render Streaming solution with no-code integration ## What is Unity Render Streaming? Unity Render Streaming is a breakthrough technology that enables high-quality 3D content to be interactively streamed directly to web browsers and mobile devices without requiring downloads or installations. This allows real-time interactive streaming with complex models and environments.

To learn more about Unity Render Streaming, you can check our [Unity Render Streaming Complete Guide](https://vagon.io/blog/unity-render-streaming-overcome-limitations-with-vagon-streams) for a detailed explanation. ## Unity Verified Streaming Solution - Vagon Streams As [Vagon Streams](https://vagon.io/streams/features/unity-streaming), we are proud to announce that [**Vagon Streams is an official Unity Verified Solution**](https://vagon.io/blog/vagon-streams-becomes-a-unity-verified-solution), and Vagon Streams official plugin is also accessible from [Unity Asset Store](https://assetstore.unity.com/packages/add-ons/vagon-streams-application-streaming-248734). {% embed url="" %} Vagon Streams - Unity Verified Solution {% endembed %} ## How to use Unity Render Streaming? ### Preparing Application for Unity Render Streaming Instead of the complicated configurations, you can easily use Unity Render Streaming by enabling the official Unity Render Streaming Plugin in your project, however, it does not allow users to set custom bitrate and FPS rates and it can cause streaming quality issues. So, as Vagon Streams, we developed an extended version of Unity Render Streaming plugin which has support for high-quality streaming quality preferences. {% hint style="info" %} Both Vagon Unity Render Streaming Plugin, and official Unity Render Streaming Plugin can be used to enable Render Streaming on your project, however, **we highly recommend you use Vagon Render Streaming Plugin** for better streaming quality. {% endhint %} ### #1 - Enable Render Streaming Plugin in Unity 1. Select **Window > Package Manager** from the menu bar in the **Unity Editor**. ![Install Package Manager from menu bar](https://docs.unity3d.com/Packages/com.unity.renderstreaming@3.1/manual/images/install_select_packman_menu.png) 2. If you would like to use Vagon Render Streaming Plugin for a better streaming quality, follow the steps below. Or, if you would like to use Unity Render Streaming plugin, jump to the 3rd step. a. Click **+** button and select **Add package from git URL**. b. Type the git URL below to activate Vagon Render Streaming plugin in your project. ``` https://github.com/vagonhq/VagonUnityRenderStreaming.git ``` {% hint style="info" %} If you would like to get the git URL manually, you can visit the [Github project page](https://github.com/vagonhq/VagonUnityRenderStreaming), and copy the HTTPS link by clicking on the **Code** button on the page. {% endhint %}

3. If you would like to use official Unity Render Streaming plugin, follow the steps below. a. Click **+** button and select **Add package by Name**. ![Select add package by name](https://docs.unity3d.com/Packages/com.unity.renderstreaming@3.1/manual/images/install_select_add_package_by_name.png) b. Type the package name below to activate Render Streaming plugin in your project. ``` com.unity.renderstreaming ``` 4. After you activate the plugin **Render Streaming Wizard** window will appear automatically. Click on **Fix All** button. ![Input system backend](https://docs.unity3d.com/Packages/com.unity.renderstreaming@3.1/manual/images/wizard_fixall.png) ### #2 - Upload Your Application and Create a Stream link Upload your build in .zip format to Vagon Streams dashboard. In case you need further instructions, you can check \[[How to Start Streaming](/streams/guides/how-to-start-streaming)]\(guides/how-to-start-streaming.md) page for a step-by-step guide.

{% hint style="info" %} Unity Render Streaming support is only available for the Unity experiences built for Windows operating system. {% endhint %} ### #3 - Activate Unity Render Streaming After activating Render Streaming inside your project, creating your build, and [uploading it to your Vagon Dashboard](broken://pages/2JPXJUAt3oOW3t7UHlfR); you only need to activate Unity Render Streaming on the Stream Configurations page.

### #4 - Start Streaming Your App with Render Streaming Then, you will only need to click on the Stream link, and the system will automatically stream your application with Render Streaming technology. You can use the Stream link on any device, and configure the Stream settings from your dashboard easily. {% hint style="info" %} Additional feature support can vary depending on the selected streaming protocol, please check the related feature page to ensure the coverage. {% endhint %} ## Unity Render Streaming Troubleshooting #### Unity Render Streaming Low Streaming Quality When you face streaming quality issues on Render Streaming-enabled Unity projects, it might be because of Unity Render Streaming plugin. We highly recommend you use the Vagon Render Streaming plugin which provides high-quality streaming experience. #### Unity Render Streaming Inputs Not Working Unity Render Streaming only supports **Unity New Input System**, if your project supports Old Input System or Both configurations, it won't work properly. You can solve the Inputs Not Working problem by activating Unity New Input System in your project. # Vagon Application Streaming Scalable application streaming for all kinds of applications globally. With Vagon's own interactive streaming protocol, any application can be streamed on any device in minutes. ## What is Application Streaming? [Application Streaming](https://vagon.io/streams/features/application-streaming) is an on-demand software distribution method where the application itself is streamed inside the browser with no need to install the application locally. With this method, applications can be accessible on any device, without any hardware limitations real time. In addition to well-known interactive streaming solutions like Unreal Engine Pixel Streaming and Unity Render Streaming, all legacy applications can be streamed with [application streaming technology](https://vagon.io/blog/what-is-application-streaming) and make accessible without limitations. ## How to use Application Streaming? Application Streaming is the default protocol for interactive streaming on Vagon Streams, and no additional steps or integration is needed to stream your app with Application Streaming. The streaming quality of Application Streaming technology adapts itself according to the user's network condition by ensuring 30FPS streaming quality in any network condition. It also supports 4K, 60FPS streaming quality which can be configured from Vagon Dashboard. Both **Windows** and **Linux** applications can utilize [Application Streaming](https://vagon.io/streams/features/application-streaming) technology with the same feature capabilities. ### #1 - Upload Your Application and Create a Stream link Start by uploading the application build folder in .zip format to the Vagon Streams dashboard. In case you need any assistance, you can check [How to Start Streaming](/streams/guides/how-to-start-streaming) page for a step-by-step guide.

### #2 - Start Streaming Your Application Then, you will only need to click on the Stream link, and the system will automatically stream your application with application streaming technology. You can use the Stream link on any device, and configure the Stream settings from your dashboard easily. {% hint style="info" %} Additional feature support can vary depending on the selected streaming protocol, please check the related feature page to ensure the coverage. {% endhint %} # Application Bundles Application Bundles allows you to serve multiple applications from a single Stream Machine. With this method, you can create a bundle of your existing applications, and create a Stream link for each of your applications, but use a single capacity method for those applications because all are bundled in one package.

## **Application Bundles Example Scenario** Let's say you have 10 different applications and Stream links, and you are using the [Instant Installation](/streams/guides/connection-optimizations#instant-installation) + [Balanced Method](/streams/guides/setup-types#balanced-capacity-management) for each of them to optimize connection times. When you bundle those 10 applications and create a Stream for this bundle, you will have a separate link for each application, but you will keep only one Stream reserve in the Balanced mode, which will be more cost-efficient. # How to Start Streaming Check the step-by-step video guide below to learn how to upload an application and create your first Stream. {% embed url="" %} Vagon Streams: Create Your First Stream {% endembed %} You can also follow the steps below to upload your first application to start streaming your application. ## How to Upload Application to Vagon Streams Let's walk through the application together and explore the features of Vagon Streams.

### #1 - Application Type Selection

### **#2 - Upload Application Folder** You can simply start by dragging and dropping to upload your application file to your Vagon Streams dashboard. *The upload process will depend on your local connection speed, but we are doing our best to make this process faster for you.*

{% hint style="success" %} **Preparing a Compressed File** While uploading your project to Vagon Streams, **you must consider the important points listed below**. * The compressed file must be in .zip format. * The compressed file must include all necessary project components and the main executable file in .exe format. * The main executable file must be inside the compressed file root directory. {% endhint %} ### **#3 - Application Executable & Details** After uploading your compressed file, the initial modal window will appear on the screen. The system will list the executable files inside your compressed build, and you can choose the file you would like to run automatically for your Streams.

Following the executable file selection, you can give a name to your application and upload an application logo for it. {% hint style="info" %} Application Name will only be used inside the dashboard, and it won't be visible to your visitors. {% endhint %} {% hint style="info" %} For the Basic and Pro plans, the application logo will only be displayed on the dashboard, however, for the Enterprise plan, the Vagon Streams logo will be replaced with the uploaded application logo on the application connection page. {% endhint %} ### **#4 - Choose a Performance to Run** According to your application requirements, you can choose the best performance for it. If you need more performance options, contact us.

### **#5 - Set Up Controls** After setting the general settings and performance selection, you have to choose the cursor control preferences for your application. ### **Mouse Control** If your application is optimized and developed for the mouse cursor inputs, you can choose the Mouse Control mode. ### **360**° **View Control** If your application is optimized and developed for 360° view control like first-person shooter games, you can choose the 360° View Control mode.

### **#6 - Application is Ready!** Your application is ready to create Streams now! Let's move forward with the Stream Link creation process.

{% hint style="info" %} All your application content and components must be archived in a .zip format with the portable executable (.exe) of your application build. {% endhint %} ## How to Create Streams Link to Stream Apps After uploading your application, it's time to create your Stream Link to share your application with your users! Here is how you can create your first Stream link. ### #1 - Choose the Application If you haven't created a Stream yet, you can directly start by choosing the application you would like to stream from the Streams tab. Otherwise, use the **`+ New Stream`** button to start. Then, you can create multiple Stream links for your applications.

### #2 - Set Coverage Depending on the location of your visitors, you can choose available service locations for your Streams between the 20 different regions Vagon Streams can be used. When your visitors try to connect to your Stream, the nearest location will be assigned for them to provide the best experience.

### #3 - Select Capacity Management Method Capacity Management Methods allow you to manage visitor load and experience according to your use case. They will ease the integration process for you and manage your `Stream Machines` on behalf of you based on your selection. Depending on your needs, you can choose the Capacity Management Method and then proceed to finalize the Stream creation process.

### #4 - Stream Your Application All set! Now you are ready to share your application with a single link with no code integration. Just copy the Single Link, and share it with your users, that's all! Do you need to embed it on your website or your platform? Just use the iframe code we created for you.

# Performance Types You can find detailed information about the hardware specs of the performance options that your application is launched with. ### DLSS 3 & RTX Enabled Performances The latest generation performance options have DLSS 3 Frame Generation feature enabled NVIDIA L4 GPUs. | | Starter - G2 | Pro - G2 | | --------- | ----------------------- | ----------------------- | | Core | 4 cores | 8 cores | | Memory | 16GB RAM | 32GB RAM | | GPU | 24GB NVIDIA L4 GPUs | 24GB NVIDIA L4 GPUs | | Processor | AMD EPYC 7R13 Processor | AMD EPYC 7R13 Processor | ### RTX Enabled Performances The latest generation performance options have RTX-enabled NVIDIA A10G GPUs and AMD processors inside. | | Starter - G2 | Pro - G2 | | --------- | ---------------------------------- | ---------------------------------- | | Core | 4 cores | 8 cores | | Memory | 16GB RAM | 32GB RAM | | GPU | 24GB NVIDIA A10G GPUs | 24GB NVIDIA A10G GPUs | | Processor | 2nd generation AMD EPYC Processors | 2nd generation AMD EPYC Processors | ### OptiX & CUDA Enabled Performances The first-generation performance options have OptiX & CUDA-enabled NVIDIA Tesla T4 GPUs and Intel processors inside. | | Starter | Pro | | --------- | ------------------------------- | ------------------------------- | | Core | 4 cores | 8 cores | | Memory | 16GB RAM | 32GB RAM | | GPU | 16GB NVIDIA Tesla T4 GPUs | 16GB NVIDIA Tesla T4 GPUs | | Processor | 3.1GHz Intel Cascade Processors | 3.1GHz Intel Cascade Processors | ### Performance Region Availability Performance type availability can vary depending on the region selections. You can see the performance availability for each region from the table below. {% hint style="danger" %} When provisioning Stream Machines via APIs, VagonPinger results must be filtered by regions according to the selected performance type availability, and then request a machine by the related endpoint. {% endhint %} {% hint style="info" %} The performance selection may limit the region coverage selection according to the performance availability in selected regions. Please check the [Coverage](/streams/guides/worldwide-coverage) page to learn more about region coverage. {% endhint %}


Region	G1 Performance	G2 Performance	G3 Performance
Dublin	✅	✅	⛔
Frankfurt	✅	✅	✅
Stockholm	✅	✅	✅
North Virginia	✅	✅	✅
Oregon	✅	✅	✅
California	✅	⛔	⛔
Ohio	✅	✅	✅
Montreal	✅	✅	✅
Sao Paulo	✅	✅	✅
Cape Town	✅	⛔	⛔
Mumbai	✅	✅	✅
Bahrain	✅	⛔	⛔
Dubai	⛔	✅	✅
Singapore	✅	✅	⛔
Jakarta	⛔	✅	⛔
Tokyo	✅	✅	✅
Hong Kong	✅	⛔	⛔
Seoul	✅	✅	✅
Sydney	✅	✅	✅
Paris*	✅	⛔	✅
Milan*	✅	⛔	⛔
London*	✅	✅	✅

\*Regions are not publicly available for now. # Streams Streams let you share your uploaded application with your audience as a single link. `Streams` are the automated orchestrators that manage the `Stream Machine` provisioning for your application streaming experiences. Each `Stream` has its own `Stream Link` to enable `Developers` to embed application streaming experiences into their platform or website. `Streams` can manage the capacity with three different approaches according to your use case in the regions you choose to serve your applications. {% embed url="" %} Vagon Streams: Run & Connect to Your Stream {% endembed %} Streams can be managed from the dashboard by following [How to Start Streaming](/streams/guides/how-to-start-streaming) guide, or using [Streams API Services](/streams/integrations/streams-api-services)to create custom flows. # Setup Types While creating a `Stream`, you have to choose the setup type for your `Stream`. Setup types allow you to manage your Stream coverage & capacity without any coding requirements. According to your setup selection, the system will automatically orchestrate Stream Machines. {% embed url="" %} ## Automated Setup Automated Setup is the **recommended** setup type by Vagon. It allows you to stream your applications **worldwide** with a **few seconds of connection time** in the **most cost-efficient** way. * **Faster connection** via globally pre‑warmed Vagon pool servers. * **On‑demand billing,** since you are charged only for your active stream usage. * **Single data center fee** for the whole global coverage of Vagon pool. **Usage Areas:** Online apps, Showcases, Product Configurators, and all medium traffic use cases {% hint style="info" %} Automated Setup is only available for Enterprise Plan users. You can request a weekly Enterprise Plan Trial from your dashboard. {% endhint %} ## Advanced Setup Advanced Setup offers you full control over regional coverage and capacity management details of your stream by allowing you to choose between different management methods listed below. #### Cost Optimized Method Cost Optimized method will manage your Stream Machines in a cost-efficient way. The system will only start a Stream Machine when a visitor connects to your Stream, and terminate the Stream Machine based on the limitation settings after a visitor session. As the system will start a new Stream Machine for each new visitor, connection times will be around 2 minutes for your visitors. **Usage Areas:** Internally Developed Application Demo #### Balanced Method Balanced method will manage your Stream Machines to keep the balance between both cost efficiency and availability perspectives. The system will keep a defined number of idle Reserved Stream Machines and keep them active for your visitors as long as the stream is running. When a visitor connects to an idle Reserved Stream Machine or leaves a Stream Machine, the system will scale up and down to maintain the number of idle Reserved Stream Machines to balance your budget and availability. **Usage Areas:** Showcase & Product Configurator Applications for Sales Teams, Online Product Demos #### Availability Optimized Method Availability Optimized method will automatically run all your available capacities in each region and keep them ready for your visitors to provide less than 10 seconds of connection times. **Usage Areas:** Live Events, Virtual Exhibitions # Worldwide Coverage Vagon Streams is available in 19 regions globally, and we are continuously adding new regions. While creating `Streams`, you must choose the location of your `Stream Machines`.

According to your selection, `Streams` will orchestrate your `Stream Machines`. Choose the nearest available region for your visitors, and stream your application in the selected region according to your capacity management selection up to your capacity limits. {% hint style="warning" %} Region Coverage selection is important to provide a low latency experience for your visitors. Please be sure that you choose the closest regions according to the physical location of your visitors. {% endhint %} {% hint style="info" %} If you are integrating Streams via Streams API, you can use VagonPinger.js to determine the best region for your users on the client side. {% endhint %} ### Performance Region Availability Performance type availability can vary depending on the region selections. You can see the performance availability for each region from the table below. {% hint style="danger" %} When provisioning Stream Machines via APIs, VagonPinger results must be filtered by regions according to the selected performance type availability, and then request a machine by the related endpoint. {% endhint %} {% hint style="info" %} The performance selection may limit the region coverage selection according to the performance availability in selected regions. Please check the [Coverage](/streams/guides/worldwide-coverage) page to learn more about region coverage. {% endhint %}


Region	G1 Performance	G2 Performance	G3 Performance
Dublin	✅	✅	⛔
Frankfurt	✅	✅	✅
Stockholm	✅	✅	✅
North Virginia	✅	✅	✅
Oregon	✅	✅	✅
California	✅	⛔	⛔
Ohio	✅	✅	✅
Montreal	✅	✅	✅
Sao Paulo	✅	✅	✅
Cape Town	✅	⛔	⛔
Mumbai	✅	✅	✅
Bahrain	✅	⛔	⛔
Dubai	⛔	✅	✅
Singapore	✅	✅	⛔
Jakarta	⛔	✅	⛔
Tokyo	✅	✅	✅
Hong Kong	✅	⛔	⛔
Seoul	✅	✅	✅
Sydney	✅	✅	✅
Paris*	✅	⛔	✅
Milan*	✅	⛔	⛔
London*	✅	✅	✅

\*Regions are not publicly available for now. # Connection Optimizations ## Instant Installation :zap: Stream initialization process is composed of two main steps: Stream Machine boot and application installation. Regardless of your project file size, **Instant Installation** eliminates the application installation process. **Instant Installation** will reduce your connection times by up to 60% depending on your project size. Regardless of your application size, performance or regions you’ve selected, your audience will be able to connect to your experience immediately, from anywhere.

Imagine you have a 50 GB of application build, which generally takes 2-3 minutes to connect with the Cost Optimized capacity method. When you enable **Instant Installation** option for your stream, regardless of its massive size, **the application installation process will be eliminated entirely** and take no time similar to lightweight projects. {% hint style="info" %} Instant Installation :zap: gives the best results when it's used with Balanced and Availability Optimized [Capacity Methods](/streams/guides/setup-types). {% endhint %} {% hint style="warning" %} When Instant Installation is enabled for the first time, the system will take a few minutes to optimize your application. {% endhint %} # Application Cache Memory Vagon Streams is designed to collect continuous feedback on the application performance and optimize it according to performance selection. Each time you upload a new build to the Vagon Dashboard or switch performance groups (different GPU series), the system generates a virtual cache memory for the application. After each visitor session, the system automatically collects application-generated shader & asset files and uses them for future sessions to optimize the application connectivity. If the cache files are ready for an application, an "Optimized" badge will appear on its card.

# Region Optimization Vagon maintains a pool of pre-warmed machines in high-traffic regions to minimize connection times for all users, regardless of whether they use the Cost Optimized method. These pre-warmed resources are available to all Vagon users without requiring a [Premium Feature Plan](/streams/configurations/premium-feature-plans). When Region Optimization is enabled, the system prioritizes assigning a pre-warmed machine based on the user's physical location. It first checks for available pre-warmed machines in the selected main region(s). If a pre-warmed machine is available in the user's primary region, it is immediately assigned to the user. If no pre-warmed machines are available in the primary region(s), Vagon checks predefined satellite regions. If a pre-warmed machine is available in a nearby satellite region, it is immediately assigned to minimize connection time for the user. If no pre-warmed machines are available in either the main or satellite regions, Vagon automatically provisions a regular machine in the user's main region.

{% hint style="info" %} A daily data center fee will be applied if the system assigns a Stream Machine from a satellite region. {% endhint %} # Configurations Stream Configurations allow you to configure & customize your experience from your dashboard according to your unique requirements.

{% content-ref url="/pages/WMtUDsWLH3BJXfZm2OwW" %} [Premium Feature Plans](/streams/configurations/premium-feature-plans) {% endcontent-ref %} {% content-ref url="/pages/kxUwYYFLMeEzVXsR5Lnk" %} [Application Versioning](/streams/configurations/application-versioning) {% endcontent-ref %} {% content-ref url="/pages/U2NJuy5AwtxzPaSzl8Lj" %} [Basics](/streams/configurations/basics) {% endcontent-ref %} {% content-ref url="/pages/DNLcuwQpjy4nIjyipEpE" %} [Limitations](/streams/configurations/limitations) {% endcontent-ref %} {% content-ref url="/pages/uKlZbWWdyGycA5MGvcsW" %} [Accessibility](/streams/configurations/accessibility) {% endcontent-ref %} {% content-ref url="/pages/EArVH6yixMQTM6hfAlek" %} [Availability](/streams/configurations/availability) {% endcontent-ref %} {% content-ref url="/pages/WKYltoYlZLa5wMub4uZb" %} [Launch Parameters](/streams/configurations/launch-parameters) {% endcontent-ref %} {% content-ref url="/pages/CeG3rQgqEUwvm96aRIOS" %} [Visitor Data Collection](/streams/configurations/visitor-data-collection) {% endcontent-ref %} {% content-ref url="/pages/O8oTXtYjPx36akMLKozF" %} [Customize - Connection Page](/streams/configurations/customize-connection-page) {% endcontent-ref %} {% content-ref url="/pages/YkobbWilJ2H9nFUEuOTo" %} [Stream Files](/streams/configurations/stream-files) {% endcontent-ref %} {% content-ref url="/pages/0lsDupZkFEpfSuGeBYpx" %} [Advanced](/streams/configurations/advanced) {% endcontent-ref %} # Premium Feature Plans Premium features include white labeling, application versioning, custom stream URLs, visitor stats, port access, budget limits, password protection, and many more. You can manage your Streams plan straight from your dashboard. Explore the complete feature comparison table [here](https://app.vagon.io/stream/settings), and activate your plan to access premium features.

## Feature Comparison List

Feature	Basic	Pro	Enterprise
Application Count	25 Apps	50 Apps	Custom
Single Application Size	25 GB per app	50 GB per app	125 GB per app
Application Versioning	-	✅	✅
Instant Installation	✅	✅	✅
Machine Pool Utilization	✅	✅	✅
Custom Stream URL	-	✅	✅
White Labeled Streams	-	-	✅
Dark Mode	✅	✅	✅
Custom Connection Messages	-	-	✅
API Integration	✅	✅	✅
Multiple Administrators	-	Up to 5 Users	20+ Users
Application Bundle	2 Apps / Bundle	5 Apps / Bundle	Unlimited
Concurrent Capacity per Stream Link	25 per Region	50 per Region	Custom
Region Coverage	20+ Regions	20+ Regions	25+ Regions
Port Access	-	-	✅
Stream Budget Limiting	-	-	✅
Application Budget Limiting	-	-	✅
Visitor Email Collection	-	✅	✅
Visitor Device Stats	-	✅	✅
Scheduled Stream Availability	✅	✅	✅
Audio / Microphone Support	✅	✅	✅
Stream Auto Turn Off	✅	✅	✅
Session Duration Limit	✅	✅	✅
Streams Files	✅	✅	✅
Premium Support	-	-	✅
Roadmap Contribution	-	-	✅

# Application Versioning

When you need to update your previously uploaded Application build version by keeping your Stream link and application configurations the same without the need to create a new Stream link each time, you can use the Application Versions feature to upload new versions for an existing application.

You can easily switch between the versions you've uploaded with just a few clicks, and upload new versions for an existing app. When you upload a new build, it will be automatically assigned as the **Active** version and all your existing Streams will be updated to use this version. If you need to switch back to a previous version, you can also activate it from the same window. # Basics ## Coverage You can update the available regions for your Stream link. {% content-ref url="/pages/L0KN8jeGmoF6FHc9JEw5" %} [Worldwide Coverage](/streams/guides/worldwide-coverage) {% endcontent-ref %} ## Capacity Management You can update the Capacity Management Method of your Stream link, to determine how to orchestrate Stream Machine provisioning process. {% content-ref url="/pages/egr31no4at0lYs6fI1RS" %} [Setup Types](/streams/guides/setup-types) {% endcontent-ref %} ### Reserved Capacity The number of idle Stream Machines that will be kept running for your visitors. Defines the number of Stream Machines for each selected region. Reserved Capacity selection is only available for the **Balanced** Method. ### Concurrent Capacity Maximum number of Stream Machines that can be started concurrently. Defines the number of Stream Machines for each selected region. ### Independent Capacities When capacities are needed to be configured for each region, both Reserved and Concurrent Capacities can be managed separately.

## Instant Installation :zap: Instant Installation feature creates a ready-to-use version of your application and entirely eliminates the installation time of your application. Check out the detailed guide in [Connection Optimizations](/streams/guides/connection-optimizations#instant-installation)section. When the toggle is first enabled, a blinking grey lightning icon will appear next to the Stream link representing the preparation process, which can take up to 5 minutes. When it's completed it will turn into a permanent green lightning icon to represent it's ready. ## Unreal Engine Pixel Streaming This toggle will only be visible for Pixel Streaming plugin added Unreal Engine applications. When the toggle is enabled, the system will use [Unreal Engine Pixel Streaming](/streams/unreal-engine-pixel-streaming)technology to interactively stream applications. ## Multitenant Pixel Streaming This toggle will only be visible when the Pixel Streaming toggle is enabled. When it's enabled, the system will create a selected number of virtual tenants inside a Stream Machine, divide the total performance of the host machine into tenants, and serve apps from those tenants. [Multitenant Pixel Streaming](/streams/custom-flows/multi-tenant-streaming) feature allows you to serve your app to multiple users from a single Stream Machine. ## Unity Render Streaming As a Unity Verified Solution, Vagon also supports native Unity Render Streaming technology. This toggle will be only visible for Unity Render Streaming plugin added Unity applications. When the toggle is enabled, the system will use [Unity Render Streaming](/streams/unity-render-streaming) technology to interactively stream applications. # Limitations

## Session Duration Limit After creating your `Stream`, you can set a session duration limit for your `Visitor Sessions`. Session Duration Limit allows you to limit visitor session durations. According to your preference, the system will inform the visitor 1 minute before the expiration, and then redirect them to another page when the session is expired to make your Stream available for the next users. ## Auto Turn-Off Duration Auto Turn-Off Duration allows you to automatically turn off `Stream Machines` after the configured span of an idle period. Auto Turn Off Duration provides you with the flexibility to manage your `Streams` by preventing unexpected usages. According to your selection, the system will monitor your Stream Machines, and after the selected time of availability of the `Stream Machine,` it will be terminated. {% hint style="warning" %} Auto Turn Off Duration is not available for Availability Optimized Streams, and the reserved Streams Machines in Balanced Streams. {% endhint %} ## Idle Time Duration You can set an **Idle Duration Limit** for your stream to kill an idle visitor session automatically if there is no user action within a specified time. Depending on your duration selection, visitor sessions will be terminated if users don't interact with your stream for the specified time period. That way, you'll be able to prevent unintentional usages caused by forgotten tabs or web pages. ## Stream Budget Limit

Stream Budget Limit gives you the opportunity to budget for your Streams. When a stream hits the budget limit, the system will automatically pause the related Streams to prevent unexpected expenses. # Accessibility

Accessibility features can be configured from `Streams Dashboard` for each Stream. Selection will be automatically applied to Stream Sessions according to your selections. ## Audio `Audio ON` - Stream Session starts in audio-enabled mode, and visitors can turn it off from the dock menu. `Audio OFF` - Stream Session starts in audio-disabled mode, and visitors cannot turn it on. `Users Can Select` - Stream Session starts in audio-disabled mode, and visitors can configure the selection from the dock menu in their Stream Sessions. ## Microphone `Microphone ON` - Stream Session starts in microphone-enabled mode, and visitors can't turn it off. `Microphone OFF` - Stream Session starts in microphone-disabled mode, and visitors can't turn it on. `Users Can Select` - Stream Session starts in microphone-disabled mode, and visitors can configure the selection from the dock menu in their Stream Sessions. ## Custom Screen Resolution `Scale to Screen Resolution` - Stream experience will be scaled up/down according to the window/screen resolution of the visitor's device. If the visitors don't use the experience in full-screen mode, it can cause scaling issues because this selection won't keep the aspect ratio for the Stream. `720p Resolution` - Stream experience will be set for 720p screen resolution and scaled up/down by keeping the 16:9 aspect ratio. `1080p Resolution` - Stream experience will be set for 1080p screen resolution and scaled up/down by keeping the 16:9 aspect ratio. `4K Resolution` - Stream experience will be set for 4K screen resolution and scaled up/down by keeping the 16:9 aspect ratio. {% hint style="info" %} Higher Screen Resolution selections may cause high bandwidth usage for your visitors. {% endhint %} ## Keyboard Layout If your app requires a unique keyboard layout for your visitors, you can set a custom keyboard layout for your `Stream Machines`. Available keyboard layouts are listed below: * `English - US - QWERTY` * `English - UK - QWERTY` * `Dutch - QWERTY` * `French - AZERTY` * `German - QWERTY` * `Spanish - QWERTY` * `Turkish - QWERTY` * `Norwegian - QWERTY` * `Italian - QWERTY` * `Japanese - QWERTY` ## On Screen Game Controller You can add on-screen game controllers on top of your experience, and let your users control your experience with them. This feature will provide you the opportunity to make your experience ready for mobile/tablet devices without any additional integration, you just need to map the required keys to PS4 Game Controller Stick keys in your application. You can set the visibility of the game controller according to your needs from configuration settings. {% hint style="warning" %} While configuring the application key mappings for game controller support please apply the following Product ID and Device ID. **Vendor ID:** 0x054C **Product ID:** 0x05C4 {% endhint %}

## Enable Port Access

You can activate ports within your Stream Machines for advanced communication and enabling Port Access inside Stream Machines will give you the opportunity to set up unique experiences like [Multiplayer Experiences](https://vagon.io/blog/how-to-create-multiplayer-unreal-engine-experiences/) and more. Imagine using a Vagon Streams machine as the host for your multiplayer adventures or effortlessly sending data to a separate application via ports. Check out our latest blog post to learn [how to start multiplayer session by using the Unreal Engine Collab Viewer](https://vagon.io/blog/how-to-create-multiplayer-unreal-engine-experiences/) project template and Vagon Streams.

When you need to get the Stream Machine IP address, you can get this information from the Stats page in your dashboard.

# Availability Schedule Availability feature enables Vendors to manage their Stream availability. Hierarchically, Stream Status is above the Schedule Availability feature and overwrites the Stream schedule. Stream Link status must be active to apply scheduled availability. When your Stream status is active, according to your Schedule Availablity preference, your visitors will access your Stream or be redirected to the Stream is Expired page. When your Stream status is paused, visitors will be redirected to the Steam is Expired page independently from your Schedule Availability preference. ### Always Available Streams Streams Link will be accessible according to your Stream Link status.

### Start & End Date Defined Streams Streams Link will be accessible between the selected dates and hours if your stream status is active.

### Working Hours Streams Link will be accessible between the defined hours on the selected days if your stream status is active.

# Launch Parameters

You can set launch parameters for your Streams from Stream Configurations and also via URL Parameters. URL Parameters will allow you to apply Launch Parameters for each Stream Session. If you are looking for a solution to push parameters for each Visitor (Stream Session), it will be a good fit for you. If you need to push static parameters for your application (connection port values, screen mode, screen size, etc.), you can directly set those launch parameters via Streams Configurations. The launch parameters you configured will be applied while your application is running on Vagon Streams. {% hint style="danger" %} Launch Parameters may cause initialization issues when they are configured wrong. Be sure that your configuration has been tested locally before applying those parameters to your Vagon Streams experience. {% endhint %} # Visitor Data Collection

## Collect Visitor Data

When the **Collect Visitor Data** is enabled, your visitors will be asked to share their email addresses before joining the Stream. You will be able to collect visitor data and track connected user data from the Stats > Visitor tab inside your Streams Dashboard. ![](/files/CwxhTlpJZMmBB8tb6p7x) ### Visitor Data Collection via URL Parameters In addition to the Visitor Data Collection page, you can collect user information by sending user email addresses via URL Parameters. After your Streams URL, you just need to add `visitor_email` parameter and send the user email as the parameter value at the end of your URL. You can find the sample URL below. `https://streams.vagon.io/streams/?visitor_email=streams@vagon.io` {% hint style="info" %} If you are using both URL Parameters and Visitor Data inside your URL, be sure that you separated them via `&` sign to prevent issues. {% endhint %} ## Connections Stats

When you enable **Connection Stats**, you will be able to monitor your visitor device and connection performance information on your Stats page. **Visitor Stats** are also available through our Streams API which gives you the option to embed your streaming data to your own dashboard or system.

## Password Protection

When you enable **Password Protection** for your Streams, your users will be asked for a password to join your Stream, and visitors without the password will not be able to connect to your experience.

## Visitor Authentication (SSO) When you enable **Visitor Authentication (SSO)**, visitors must sign in with your identity provider — **Microsoft Entra**, **Auth0**, or **Google** — before they can connect to your Stream. This limits access to authenticated visitors only. Visitor Authentication is an **Enterprise** feature available on individual Streams. For the full setup and per-provider integration steps, see the dedicated guide. {% content-ref url="/pages/ZLISCWZgzuAFGhxGouvr" %} [Visitor Authentication](/streams/custom-flows/visitor-authentication) {% endcontent-ref %} # Customize - Connection Page Vagon Streams allows you to customize the connection pages for Unreal Engine Pixel Streaming, Unity Render Streaming and Vagon Application Streaming experiences from Streams Dashboard.

There are two modes of Connection Pages for Basic Plans, dark mode and light mode. ### Light Mode ![](/files/cDBLIeS3GcO1rPSbRHMo) ### Dark Mode ![](/files/xfpKQulCK49gBi0hnHvR) ### Show Play Page Play Page is required for the Pixel Streaming and Render Streaming enabled Streams as default. Also, because modern browsers require at least a user interaction to start audio/microphone, we automatically activate this page before initialization of a Stream when audio or microphone is enabled for a Stream. Even though we highly recommend keeping this page active before the Stream, this page can be disabled from the Stream Configurations. {% hint style="info" %} Disabling Play Page can cause audio and microphone initialization issues on some browsers. {% endhint %} ### Accessibility Dock Position Dock Menu is the tiny menu area that is visible bottom-center of your Streaming area to manage audio \µphone settings and enable full screen. The place of this menu can be set from the Stream Configurations page. ## Branded Connection Page

In addition to default connection page alternatives, Enterprise users can customize the Connection Page background, and add their company/product logo to the connection page via Streams Dashboard. ![](/files/iGPy0m9kp6eGbPxTtQxP) ### Connection Messages Each connection message can be updated from the Stream Configurations page with Enterprise Plan. # Stream Files Stream Files gives the ability to add extra storage to your Stream Machines. You can, * upload files to your Stream Machine directly and let your application to use them internally without needing any cloud storage integration. * let your users import their files to your application, work on it, and finally let them download files from your application without any additional requirements. ## Preloaded Stream Files Uploaded files will be transferred to Stream Machine after installing your application inside. Preloaded files will be stored under the `T:\PreloadedFiles` folder, and your application will access them from this folder. Preloaded Files will be uploaded automatically and stored for all your Stream Sessions. they won't be deleted as long as you keep them uploaded in your Stream Configurations page. System will trigger Preloaded Files Uploaded message with the following returned object when the transfer is completed. ```json { "$type": "22" } ``` ## Let Users Upload & Download Files When this feature is enabled, your users will be able to transfer their files to the `Visitor Session` via drag and drop, and download the files that are saved in the `T:\Temp Files` directory.

Streams Files offers a complete experience for design apps and all others. If you need a custom workflow or want to learn more about it, don’t hesitate to contact us. ## File & Content Management via AWS, Azure, or Google Cloud If your application requires a custom file integration like uploading an in-Stream created file and letting users download them, or periodically uploading saved project/game files to a cloud storage, you can do this with Vagon Streams as well. Because Vagon Streams machines have a public internet connection inside, you can upload created files to AWS (or other CSPs), get a download link for the uploaded files, and then [open this link in a new tab with our Unreal Engine / Unity SDKs](#how-to-setup-a-file-pipeline-using-a-cloud-service-provider-inside-application-via-aws-azure-or-goog) to initiate the download. Because this flow will be maintained on your application side, it will be a more convenient approach for both you and your users. However, of course, it requires additional integration and custom development. # Advanced ## Auto Start Application System will wait for a visitor connection to launch the application when it's disabled. When enabled, the application will be started automatically as soon as the stream machine is initiated without waiting for any user to connect to the Stream Machine. Enabling this setting may result in missing the initial scenes of the application for the connected user because it's already initiated. This configuration is disabled as default. ## Restart Application for Each Visitor Application will be restarted for each unique visitor when it's enabled. When disabled, the application and its data won't be reset between visitor sessions and the application will keep running even if a new user connects to the Stream. Disabling this may lead to session data being shared across sessions, this configuration is enabled as default. ## Collect Application Logs System will collect application logs for debug (logging) enabled Unreal Engine and Unity builds, and make them accessible after each Visitor Session from the Stats page. When the Auto Collection is enabled, the system will try to auto-detect the log path to collect the application logs. If you set a different application log, you can set a custom path by disabling the Auto Collect toggle as well.

# Application Budget Limit

Application Budget Limit gives you the opportunity to set application level budgets for your Streams. When a stream or application hits its limit, the system will automatically pause all running Streams to prevent unexpected expenses. You can set application-level budgets from your application card and stream-level budgets through the Stream Configurations page. # Client-side Communication Establish real-time communication pipeline between Unity and Unreal Engine apps and the web pages. Vagon Streams allows the establish end-to-end message communication between applications and the client side with custom UI interactions. By using the events and functions listed in [Javascript SDK](/streams/integrations/client-side-communication/javascript-sdk) page, you can create custom web UIs on top of your application and easily send custom messages for your project requirements. In addition to the client-side messages, you can send messages from the application to a custom web UI with [Unreal Engine SDK](/streams/integrations/client-side-communication/unreal-engine-sdk)and [Unity SDK](/streams/integrations/client-side-communication/unity-sdk) functionalities. Besides the predefined message types for specific actions, it's possible to transmit any custom message between the client side and the application side as well. ## Unreal Engine Pixel Streaming Client-side Communication 1. Integrate [Unreal Engine SDK](/streams/integrations/client-side-communication/unreal-engine-sdk) inside the project, and map the events by using Pixel Streaming messaging functionalities. 2. Embed your Vagon Streams link into a web page as an iframe. 3. Add Vagon Javascript SDK to your web page by [following the guide](/streams/integrations/client-side-communication/javascript-sdk). 4. Send and receive messages between the client side and your application. ## Unity Render Streaming Client-side Communication * Integrate [Unity SDK](/streams/integrations/client-side-communication/unity-sdk) depending on your engine inside the project, and map the events by using Pixel Streaming messaging functionalities. * Embed your Vagon Streams link into a web page as an iframe. * Add Vagon Javascript SDK to your web page by [following the guide](/streams/integrations/client-side-communication/javascript-sdk). * Send and receive messages between the client side and your application. ## Vagon Application Streaming Client-side Communication * Integrate [Unreal Engine SDK](/streams/integrations/client-side-communication/unreal-engine-sdk) or [Unity SDK](/streams/integrations/client-side-communication/unity-sdk) depending on your engine inside the project, and map the events by using Pixel Streaming messaging functionalities. * Embed your Vagon Streams link into a web page as an iframe. * Add Vagon Javascript SDK to your web page by [following the guide](/streams/integrations/client-side-communication/javascript-sdk). * Send and receive messages between the client side and your application. # Javascript SDK You can use Streams JS SDK to send messages from the client side to your application. Embed the script code between the ` ` tags inside the page you embedded your Streams Link via iframe. ```html ``` {% hint style="info" %} Despite you added the JS SDK script between the tags in your client code, if you can not establish a connection, please be sure that you copied the iFrame tag from the Vagon Streams dashboard. If you manually created your iFrame code by adding your Streams Link, please check that you applied the id tag and other required iFrame properties correctly from the sample code below. ```html

Streams Documentation

Streams Features

Cloud Computer Help Center

Cloud Computer Features

Teams Documentation

Teams Features