Settings

These are all the settings that can be configured through Thinfinity® Remote Desktop Server SDK.

If you are using Access Profiles, you should set the parameter 'overrideDefaults' to true, in order to have these settings considered on the connection, otherwise the profile's predetermined settings will be used.

Parameter

What it means

Type/format

Default

showOnStart

Set to false in order hide the Windows start up and logon process. In this case you will have to call the div 'show' method on the startSession event. A "wait" message will be shown until the session starts.

boolean

true,false

true

showToolbar

Set to false to hide the Thinfinity® Remote Desktop Server toolbar

boolean

true,false

true

centered

Configures whether the connection should be centered on the browser window or not. On certain cases, this parameter set to false might prevent flickering.

boolean

true,false

true

bpp

Color Depth: sets the number of bits per pixel. Set 8 for 256 colors; 15 for True Color (15 bit); 16 for True Color (16 bit) ; 24 for True Color (24 bit)

integer

8,15,16 or 24

16

resolution

"fittobrowser", "fittoscreen", "fixed". When fixed, the width and height parameters will be considered.

string

toolbar size

"fittobrowser"

width

Remote desktop screen width.

It will only be considered when the 'resolution' parameter is set to "fixed".

integer

pixels

$("#deskdiv").width()

height

Remote desktop screen height.

It will only be considered when the 'resolution' parameter is set to "fixed"

integer

pixels

$("#deskdiv").height()

imagequality

Specifies the image quality/compression. Set 0 for "Highest!; 1 for "Optimal"; 2 for "Good"; 3 for "Faster"

integer

0,1,2 or 3

1

clientAck

This parameter sets the number of images sent from the server to the client at a time. It can prevent slow connections from timing out. The faster the connection is, the higher clientAck parameter should be set.

The default value (0) does not control the number of images, sending the images all together.

integer

0

unicodekeyboard

Allows for using full unicode keyboard charsets. Set to false to connect to xRDP servers.

boolean

true,false

true

console

Forces the connection to the remote console session.

boolean

true,false

false

wscompression

Set to true to enable the compression for the exchanged Websocket data and have the application performance improved.

boolean

true,false

true

relativetouch

Set to false in order to disable this behaviour in mobile devices.

boolean

true,false

true

disableExtKeys

Set to true if you do not want the Thinfinity® Remote Desktop Server extra keys to appear on mobile interfaces.

boolean

true,false

false

tbSize

Configure the size of the mobile right side toolbar. The possible values are 'small', 'medium' and 'large'.

string

toolbar size

'medium'

hidePointer

Hides the mouse pointer

boolean

true,false

false

kbdControl

Enables control of the keyboard

boolean

true,false

true

mouseControl

Enables control of the mouse

boolean

true,false

true

touchCOntrol

Enables or disable touch capabilities.

boolean

true,false

true

kbdLayout

Sets the keyboard layout for the remote desktop. When it is not completed, the default keyboard layout is English. Read a reference of accepted values.

string

Keyboard code.

"1033"

tcpReadCount

Number of operation cycles before sending the commands to the browser. Adjust this, together with tcpReadWait, according to your environment to reach maximum effectivity.

integer

cycles

1

tcpReadWait

Waiting time between operation cycles before sending the commands to the browser. Adjust this, together with tcpReadCount, according to your environment to reach maximum effectivity.

integer

miliseconds

20

savesession

Enable this setting to record the remote desktop session.

boolean

true,false

false

checkBeforeWindowClose

Set to false to skips the user confirmation popup of the onBeforeUnload event

boolean

true,false

true

Experience settings:

Parameter

What it means

Type/format

Default

experience.desktopbackground

Set to true to show the original remote desktop background.

boolean

true,false

false

experience.visualstyles

Set to true to change the start menu and other Windows style features.

boolean

true,false

false

experience.menuwindowanimation

Set to true to show an animation on the Windows start menu.

boolean

true,false

false

experience.fontsmoothing

Set to true to make text easier to read, specially the magnified text.

boolean

true,false

false

experience.showwindowcontent

Set to true to show windows contents while dragging them.

boolean

true,false

false

experience.desktopcomposition

Set to true to configure the DWM to redirected the desktop drawing to off-screen surfaces in video memory. The desktop will also present many visual effects.

boolean

true,false

false

experience.enableRemoteFx

Set to false to disable Remote FX. Remote FX is the most efficient data transmision mode, but it might interact badly with other configurations. Warning: this setting affects other experience settings. Learn more about Remote FX.

boolean

true,false

true

Last updated