To configure the server side settings, click Hololight -> Stream -> Configure Settings. A settings windows as illustrated below will be shown.
The signaling port allows the user to specify the port to be used for the signaling process. The number must be between 1024 and 65535 and if unset, is default to 9999. If desired, this value can be set to the same as that specified in Port Range, limiting the number of ports required to be exposes from the firewall.
The encoder bandwidth specifies the maximum bitrate which the encoder will be ran at. A higher number will provide better image quality, however too high can effect network performance. It is recommended to keep this value in the range of 10,000 - 100,000 Kbps for optimum quality/performance. If a value of -1 is specified, the bandwidth will be taken from the client settings, see Client Bandwidth Setting.
When enabled, a number of statisics will be logged to a CSV file to aid networking investigations. The file will be stored in <application_root_dir>/hls-stats/ and can be analysed within excel.
It is recommended to only enable this setting when investigating potential issues as it may have a performance impact. To enable this setting in a build application, specify stats-collector in the diagnostic-options section of the config file, see Configuration File.
| Statistic | Description |
|---|---|
| Timestamp | The timestamp since epoch the stats were gathered |
| Frame Rate | The rate frames are being received at the encoder |
| Encoder Target Bitrate | The bitrate which has been configured for the encoder. This usually corresponds to the bitrate set in Encoder Bandwidth |
| Available Outgoing Bitrate | The estimated bandwidth the network is capable of achieving |
The port range allows the user to specify the ports which can be used for the running connection. The range must be between 1024 and 65535 and it is possible to set a single port by specifying the minimum and maximum as the same value. By default, the port is set to 50100. If desired, this value can be set to the same as that specified in Signaling Port.
After building the project, the settings above can be edited, with any text editor, through the remoting-config.cfg file in the StreamingAssets folder. The configuration file is in standard JSON format, more information can be found at JSON.org.
To configure the client side settings, see the settings tab of the client UI.
NOTE: Not all settings are available on every client. The below described settings are the combined settings from all clients.
The default port specifies the port which will be used for signaling. This port must be the same as was specified in Server Signaling Port.
The timeout specifies the the amount of time a connection will be attempted. If this time is reached and no connection has been extablished, the connection will be aborted.
The maximum bandwidth which will be used during the connection. A scale of low, medium and high is provided with suggested values for optimal quality, however the a custom value can also be provided. If a server bandwidth is set, see Server Bandwidth, this value will be ignored.
On devices which support passthrough, enabling this setting will render the object in the real world. For more information, see Device Passthrough Documentation.
Specifies the codec which would be preferred to be used. The preference will only be used if both sides support the codec type.
Specifies the color space which is used for rendering. This should be the same as specified in Unity.
NOTE: For Unity servers using the Universal Render Pipeline (URP), client color space selection must be Gamma, regardless of the server color space setting.
Enable logging of latency information to a CSV file stored on the client device to aid with networking investigations. You can find the log files for the supported devices in following locations:
-
HoloLens 2, through the device portal interface of HoloLens 2:
User Folders\LocalAppData\Holo-LightGmBH.ISARClient_2024.0.0.0_arm64__vd04nf0pw2njt\LocalState\ -
Quest, after succesfully connecting Quest device to computer:
(COMPUTER NAME)\Quest 3\Internal shared storage\Android\media\com.holo_light.isar_client.config\log\latency -
iOS, via Files application you can find it in following the path:
Files/On My iPhone/Stream Client/Hololight Stream Log_(DATETIME).csv
Enables sending of the depth buffer from server to client to make use of depth reprojection. For more information, see Depth Reprojection.