06. Setting up your project
CloudRT user portal - Getting Started
For setting up your project, browse to the project you want to edit in your project list and select it or press the "Details" button. In the project's overview page you will find the button for "Settings", see Image 1.
Image 1: Project overview page
In the settings, currently you will find two tabs, "General" and "Stream"
Image 2: General settings tab
- 1.Enable / Disable - Enables / disables your project from streaming. Turning it off will prevent the project from creating costs and from streaming.
- 2.Project name - A friendly name under which your project will be available. Setting up a proper name can be helpful in communication with Arcware support. For using your project in streaming, only the automatically generated GUID is used.
- 3.Unreal Engine Version - Here you can select which version of Unreal Engine the project was build with.
- 4.Project URL - This URL is used on the project list quick action button to navigate to your stream. If left empty it will direct to the preview section of your stream
- 5.Public / Private switch (deprecated feature. All projects are now Private but can be distributed via a shareID)
- 6.Extra arguments - Extra command line arguments being used to start you package. This is controlled by Arcware. If you need extra arguments, please contact Arcware support
- 7.Display settings - Maximum resolution supported and being used by WebRTC player. Currently we limit the resolution to FullHD. If you need higher resolutions or DLSS support, please contact Arcware support.
- 8.Touch capability - Enable this option if your Unreal package has touch inputs set up correctly and can be used on touch devices.
- 9.Mouse Lock - To be used if you want the mouse to be locked inside the stream window (this also hides the mouse cursor from the browser, and means you can not click external UI until you press escape)
There is hidden settings for allowing dynamic resolution and aspect ratio changes. These two options will be unlocked soon in accordance with this documentation as those settings need to be treated with care. These two settings tell our WebRTC player the expected behaviour of Unreal. This needs to be configured properly in Unreal. See also 01.3. Resolutionand 01.4. Camera Aspect Ratio
There is also a hidden setting on auto play which should tell the WebRTC player when the stream is ready and if it should automatically start the stream. The default behaviour is autoplay option being turned on. Turning it off might only be worth in some edge cases => coming soon
Image 3: Stream settings
- 1.Maximum streams - This is the maximum number of concurrent streams you are willing to sustain and to pay. There is no guarantee, that Arcware can always scale out to this number. If there is a requirement for guarantess => please contact Arcware Sales for individual solutions. There is also a hidden option for so-called pre-warmed Streams. These are also an option for guaranteed streams
- 2.Reconnection Threshold - This is a threshold on how long an instance is kept alive to reconnect. E.g. on an unwanted refresh of the browser page with F5 or on short connectivity loss of your device, you will return to that same session within that time period. Please note, that this time is subject to streaming costs. (Currently this setting is only changeable via request from Arcware [email protected])
- 3.Maximum instance run-time - The maximum time an instance of your stream can run in total, before it gets automatically disconnected. (this feature has priority over the AFK timeout)
- 4.Overwrite afk-module - The AFK module is used to automatically disconnect inactive streams. This will help you keep your streaming costs down, to avoid your stream being left open/running by inactive users. Enable this setting if you want to overwrite the standard 'Timeout' values used for the AFK module.
- 5.Enable Timeouts (Editing the timeout values is possible if the 'Overwrite afk-module' is enabled) 5.1. Warn Timeouts - Count down until AFK Warning appears. 5.2. Error Timeouts - Count down until the 'Error Event' is triggered, after AFK warning. 5.3. Action Timeouts - Count down until the session will be ended, after 'Error Event'. Please read the following page for a deeper explanation of the AFK / Timeout feature...
Hidden feature of pre-warmed streams: Prewarmed streams are instances running 24/7 and always being ready to get connected to, reducing connection time to almost zero. Since the stream is running 24/7 it is subject to full price of a single stream per month. Currently only Arcware Admins can set up prewarmed streams for you. Also note: if a client of yours connects a pre-warmed stream, the system automatically ramps up the next instance until it hits the limit of "Maximum streams" to always keep the number of pre-warmed streams ready to get connected by your clients. Prewarmed streams are always guaranteed resources in Arcware CloudRT
Queue: there is a queuing feature available in Arcware CloudRT which is currently disabled per default in all projects. The queue will only work for projects directly hosted via the Share ID link of the platform or it needs a dedicated implementation in the WebRTC player. With release of the respective documentation of implementing the queue in the WebRTC SDK, we will also unlock this setting and feature.