Skip to main content

Configuration Settings

The Configuration tab exposes all the SDK runtime parameters in a set of collapsible sections. All values are read from and written to config.json in StreamingAssets. Click Save at the bottom of the tab to apply any changes.

Configuration tab overview
note

For a full reference of the underlying JSON structure, see Configuration File.


General​

Basic application settings.

FieldTypeDefaultDescription
Application Target FPSInteger90Target frame rate for the application. 90 fps is recommended for XR headsets.
Non-HMD HeightFloat1.5Default camera height (metres) when no headset is connected.

Networking​

FieldTypeDefaultDescription
Orchestrator URLTexthttps://holoconfsdk.i2cat.net:8080URL of the session index server. If left empty, the default value is restored automatically on the next repaint.

Automatic Login Credentials​

Fields used when performing an automatic login without any user interaction at runtime.

FieldTypeDefaultDescription
User NameText—Username sent to the orchestrator during automatic login.
User PasswordText—Password for the automatic login user.
Session PrefixText—String prepended to the session name when creating or joining a session automatically.
MicrophoneCombo—Name of the microphone device to use. The dropdown lists all devices detected by Unity; free text is also accepted for custom device names. Click ↺ to refresh the device list.
WebcamCombo—Name of the webcam device to use. Same combo-field behaviour as Microphone.
Representation TypeDropdownAvatarHow the local user is represented to remote participants. Options: Avatar, RGBD, Spectator, None.

Volums​

Encoding and rendering settings for the volumetric video (RGBPM) pipeline.

FieldTypeDefaultDescription
CodecDropdownh265Video codec used to compress the volumetric stream.
GPU EncodingTogglefalseEnables hardware-accelerated encoding. Requires a compatible GPU and driver.
FPSDropdown30Capture and streaming frame rate. Options: 15, 24, 30.
GOPInteger5Group of Pictures size. Controls how often keyframes are inserted.
CRF ColorInteger17Constant Rate Factor for the colour stream. Lower values = higher quality, larger file size.
CRF PositionInteger0Constant Rate Factor for the depth/position stream.
Pixel FormatDropdownYUV444pPixel format used for encoding. Options: YUV444p, YUV420p.

Render​

Sub-settings that control how the decoded point cloud is rendered in the scene.

FieldTypeDefaultDescription
Cell SizeFloat0.0012Size of each rendered point cloud cell. Smaller values increase visual resolution but reduce performance.
Use NormalsTogglefalseWhen enabled, normals are used for shading and back-face culling of the point cloud.
Normal Culling ThresholdFloat-90Dot-product threshold used when culling back-facing cells. Only active when Use Normals is enabled.

Audio​

FieldTypeDefaultDescription
CodecDropdownOpusAudio codec for microphone capture and transmission. Opus is recommended for low-latency network audio; Speex is a lighter fallback.

WebCam​

Encoding settings for the 2D webcam stream.

FieldTypeDefaultDescription
CodecDropdownh264Video codec used to compress the webcam stream.
GPU EncodingTogglefalseEnables hardware-accelerated encoding for the webcam stream.
FPSInteger15Webcam capture frame rate.
GOPInteger15Group of Pictures size for the webcam stream.
CRFInteger27Constant Rate Factor for the webcam stream quality.
Pixel FormatDropdownYUV420pPixel format used for webcam encoding.

Streaming​

Settings for the screen-capture streaming output (e.g. for RTSP broadcast or Spout output).

FieldTypeDefaultDescription
Enable Streaming BuildTogglefalseActivates the streaming pipeline in the build.
ProtocolDropdown—Streaming transport protocol. Options depend on build target.
WidthInteger—Output stream resolution width in pixels.
HeightInteger—Output stream resolution height in pixels.
FPSInteger—Output stream frame rate.
Video Bitrate (kbps)Integer—Target video bitrate in kilobits per second.
Audio Bitrate (kbps)Integer—Target audio bitrate in kilobits per second.

RTSP​

FieldTypeDefaultDescription
URLText—Full RTSP endpoint URL where the stream is published (e.g. rtsp://server:8554/stream).

Spout​

FieldTypeDefaultDescription
Sender NameText—Name of the Spout sender exposed to other applications on the same machine.
Keep AlphaTogglefalsePreserves the alpha channel in the Spout output texture.

Metrics System​

Settings for the performance statistics collector.

FieldTypeDefaultDescription
Interval (s)Double2How often (in seconds) performance metrics are sampled and logged.
Output FileText—Path to the file where metrics are written. Leave empty to disable file output.
Debug MetricsDropdownBothSelects which metric categories are collected and displayed.

Logger​

Controls the in-app logging overlay.

FieldTypeDefaultDescription
Log DetailFlagsVerbose (7)Bitmask of log levels shown. Combine levels freely: Log (1), Warning (2), Error (4), Verbose (7 = all). Use Warning | Error in production builds to reduce overhead.
Font SizeInteger12Font size of the in-app log overlay text.

For more detail on the logging system, see Logging System.


Saving changes​

When you are done editing, click the Save button at the bottom of the tab. This writes all values back to config.json and triggers an AssetDatabase.Refresh() so Unity picks up the changes immediately.

warning

Changes made in the Configuration Window are only persisted when you explicitly click Save. Closing the window or switching tabs without saving will discard any unsaved edits.