Hololight Stream for Unity settings

Settings

To configure server-side settings, select Hololight > Hololight Stream > Settings in the Unity project for your application.

Signaling port

Sets the port used for signaling. The port number must be between 1024 and 65535. If unset, the port defaults to 9999. Make sure that the port numbers used with Hololight Stream aren’t used by other applications or programs on your network.

Streaming bandwidth

Specifies the maximum encoder bit rate. A higher value will result in a better image quality but at the cost of network performance. The recommended range is between 10,000 - 100,000 Kbps. If the value is set to "-1", the bit rate will take its value from the settings in the connected client.

Session log

When enabled the application will log connection-specific information during an active connection. This is helpful when trying to diagnose connection issues. Hololight Stream stores the data as a CSV file at "<application_root_dir>/hls-stats/". You can use Excel to easily view the data.

You should only enable the session log when investigating issues since the logging will negatively impact performance. To enable this setting in a build application, specify stats-collector in the diagnostic-options section of the configuration file. The logs have the following data:

Timestamp

The time and date when the session log recorded an entry of data. The timestamp is an epoch.

Frame rate

The rate that the encoder receives frames.

Encoder target bit rate

The bit rate set for the encoder.

Available outgoing bit rate

The estimated bandwidth the network can reach.

Port range

The port range allows the user to specify the ports used for the running connection. The range must be between 1024 and 65535. You can set a single port by setting the minimum and maximum for the range as the same value. By default the port is set to 50100. This port can overlap with the signaling port.

Make sure that the port numbers used with Hololight Stream aren’t used by other applications or programs.

Configuration file

After building the project, you can edit these settings with any text editor. Find the "remoting-config.cfg" file in the "StreamingAssets" folder associated with your application. The configuration file uses standard JSON formatting.

If for some reason there is an error in the configuration file and Hololight Stream can’t parse it, Hololight Stream won’t run correctly.

For more information on working with JSON, check out json.org.