context Default value Description
web-url-path string server '/' URL path for the embedded
web server — Specifies the URL path for the embedded web server, must start with '/'. For example, setting it to /test/foo means that the web server is reachable at https://host:port/
test/foo. — Available since version 2017.0-4100 (p. 151).
web-use-hsts true or false -DWORD (32-bit)
server Linux: true
-Windows: 1 Whether to use HSTS — Enables this to force browsers to prevent any communication being sent over HTTP. All transfer to the webpage (and all subdomains) will be done using HTTPS instead.
— Available since version 2017.0-4100 (p. 151).
ws-keepalive-interval integer
-DWORD (32-bit)
server 10 Websocket keepalive interval
— Specifies the interval (in seconds) after which to send a keepalive message. If set to 0, the keepalive message is disabled. — Available since version 2017.0-4100 (p. 151).
display Parameters
The following table describes the configuration parameters in the [display] section of the /etc/dcv/
dcv.conf file for Linux NICE DCV servers, and the display registry key for Windows NICE DCV servers.
Parameter Type
-Windows registry type
Reload
context Default value Description
console-session-default-layout string session [] Default screen resolution and
position for console sessions
— Specifies the default screen resolution and position for console sessions. If this is set, DCV sets the requested layout at startup. Each monitor can be configured with resolution (w,h) and position (x,y). All specified monitors are enabled.
Default layout example value: [{'w':<800>, 'h':<600>,
display Parameters
context Default value Description
'x':<0>, 'y': <0>}, {'w':<1024>, 'h':<768>, 'x':<800>,'y':<0>}]
— Available since version 2017.0-5600 (p. 150).
cuda-devices string connection [] CUDA devices used for stream
encoding — Specifies the list of local CUDA devices which DCV uses to distribute encoding and CUDA workloads. Each device is identified by a number that can be retrieved from the nvidia-smi command. For example, cuda-devices=['0', '2'] indicates that DCV uses two GPUs, with IDs 0 and 2. This setting is similar to the CUDA_VISIBLE_DEVICES environment variable, but it only applies to DCV. If the option is not set, DCV uses an incremental session index starting from 0 to pick the next device to use. — Available since version 2017.2-6182 (p. 148).
enable-client-resize true or false -DWORD (32-bit)
session Linux: true
-Windows: 1 Whether to allow clients to set the display layout — Specifies whether clients are allowed to set the display layout.
— Available since version 2017.0-4100 (p. 151).
enable-qu true or
false -DWORD (32-bit)
session Linux: true
-Windows: 1 Whether to send quality updates — Specifies whether to send quality updates.
— Available since version 2017.0-4100 (p. 151).
grabber-target-fps integer -DWORD (32-bit)
session 0 Target frames per second of
frame grabber — Sets the upper limit to grab frames per second. A value of 0 defaults to target-fps. Not all frame capture backends honor this setting.
— Available since version 2017.1-5870 (p. 149).
max-compressor-threads integer
-DWORD (32-bit)
session 4 Max compressor threads
— Specifies the maximum number of compressor threads.
— Available since version 2017.0-4100 (p. 151).
display Parameters
context Default value Description
max-head-resolution string custom (4096, 2160) Max head resolution — Sets the maximum resolution of a display head requestable by the client.
A display head is equivalent to a host monitor. The setting is reloaded at each client layout request. When a bigger head resolution is requested by a client, the server adjusts the resolution to make sure that it matches the maximum width and height values set by this option. — Available since version 2017.0-4100 (p. 151).
max-layout-area integer -DWORD (32-bit)
custom 0 Max layout area in pixels —
Sets the maximum area in pixels of a display layout requestable by the client. Layouts that are larger than this limit will be ignored. This maximum is meant to provide an upper bound to the amount of display data that must be sent, without providing constraints on the display layout geometry. If set to 0, no limit is applied to layout area. The setting is reloaded at each client layout request.
— Available since version 2019.1-7423 (p. 145).
max-num-heads integer -DWORD (32-bit)
custom 4 Max number of heads —
Specifies the maximum number of display heads requestable by the client. A display head is equivalent to a host monitor.
The setting is reloaded at each client layout request. When a greater number of heads is requested by a client, the server adjusts the number of heads so that the value does not exceed the value set by this option.
— Available since version 2017.0-4100 (p. 151).
display Parameters
context Default value Description
min-head-resolution string custom (640, 480) Min head resolution — Sets the minimum resolution of a display head requestable by the client. A display head is equivalent to a host monitor.
The setting is reloaded at each client layout request. When a smaller resolution is requested by a client, the server adjusts the resolution to make sure that it matches the minimum width and height values set by this option. — Available since version 2017.0-4100 (p. 151).
target-fps integer
-DWORD (32-bit)
session -1 Target frames per second —
Specifies the maximum allowed frames per second. A value of 0 means no limit. A value of -1 means that the target-fps value will be determined according to the server characteristics and the session type. With versions
< 2020.2, the -1 value is not recognized and the default value is 25. — Available since version 2017.0-4100 (p. 151).
session Linux: true
-Windows: 1 Whether to use dirty regions
— Specifies whether to use dirty screen regions. If enabled, the grabber tries to compute new frames out of the dirty regions from the screen.
— Available since version 2017.0-4100 (p. 151).