This guide provides a list of command-line arguments related to a specific event and target. This allows users to customize ISL Light Client behavior on specific event.
- Desktop Sharing Commands
- File Transfer Commands
- Audio Call Commands
- Video Call Commands
- Video Background Commands
- Recording Commands
-
Customization Commands
Syntax:
Command-lines listed below are associated with "<event>, <target>?<command>".
Simple Example:
ISLLightClient.exe <event> <target>?<command>
Advanced Example:
ISLLightClient.exe <event_1> <target_1>?<command_1>&<command_2> <target_2>?<command_3> <event_2> <target_1>?<command_4>&<command_5>
The commands using same events or targets must be written in URL query format.
Example:
Simple Example:
ISL_Light_Client.exe --on-connect "recording?record=silent&location=C:\Recordings&allow_stop=false"
Start ISL Light Client and automatically start recording to C:\recordings on connect - client is unable to stop session recording once it is started:
Event:
Each command line option is related to a specific event:
- --on-load (Triggered when ISL Light Client is loaded into memory and started.)
- --on-connect (Triggered when a connection is established.)
-
--on-disconnect (Triggered when a session is finished.)
Target:
Each command line option is related to a specific target:
- desktop (commands for the desktop sharing)
- file_transfer (commands for the file transfer)
- audio (commands for the audio)
- video (commands for the video)
- recording (commands for the recording)
- main (commands for customization)
- customization (commands for customization)
- previews (commands for authentication)
Note: If you omit the <target>, a default value main is used.
Commands:
Desktop Sharing Commands
These command lines are used when viewing or sharing the desktop, with "desktop" used as the <target> in the command line.
| Command | Description |
|---|---|
| show |
When you use this command with --on-connect event, ISL Light Client will start sharing his screen. Example: ISLLightClient.exe --on-connect "desktop?show” |
| view |
When you use this command with --on-connect event, ISL Light Client will request to view operator's screen. Note: This command line is used in combination when command "desktop?show" is used on the operators side in ISL Light. Example: ISLLightClient.exe --on-connect "desktop?view” |
| control=(grant|grantF12|disable) |
When you use this command on connect event, it grants desktop control. The grantF12 parameter is used for granting control in the compatibility (F12) mode. If you omit grant or grantF12 parameter, the default value (grant) is used. If you specify control=disable, it is not possible to control the remote computer, only view. Example: ISLLightClient.exe --on-connect "desktop?control=grant" |
| topbarpos=(left|top|right|bottom) |
This command is used to specify the location of the desktop streaming bar - it can be on the left, top, right or bottom side of the desktop.
Example: ISLLightClient.exe --on-connect "desktop?topbarpos=left" |
| hidetopbar=(true|false) |
If set to true, the desktop streaming bar is not shown. Example: ISLLightClient.exe --on-connect "desktop?hidetopbar=true" |
| black=(true|false) |
This command (when set to true) instructs the ISL Light to enable black screen when desktop is being shared. Example: ISLLightClient.exe --on-connect "desktop?black=true" |
| disablelocal=(true|false) |
If set to true, the local user cannot take control. Example: ISLLightClient.exe --on-connect "desktop?disablelocal=true" |
| leavebackground=(true|false) |
If set to true, desktop background is not removed when streaming desktop. Example: ISLLightClient.exe --on-connect "desktop?leavebackground=true" |
| color=64k |
Use this option to switch to high quality mode (this means 64k colors, ISSC triple @60%). Note: This command line argument is applied when used in combination with "desktop?view" on clients (ISL Light Client) side and "desktop?show" on operators (ISL Light) side. Example: ISLLightClient.exe --on-connect "desktop?view&color=64k" |
| admin[=restart] |
When you use this command on connect event combined with show desktop sharing, it will automatically try to switch desktop streaming to administrative mode. If you specify admin=restart instead of just admin, it will automatically try to switch desktop streaming to administrative mode and enable the restart and resume functionality. Example: ISLLightClient.exe --on-connect "show&admin=restart" |
| events=stream_stop_close |
Stops the ISL Light session automatically when desktop sharing is closed. Example: ISLLightClient.exe --on-connect "desktop?events=stream_stop_close" |
| leave_aero=(true|false) |
Windows only. By default we disable AERO composition on Windows machines in order to get better performance. Default value: false Example: ISLLightClient.exe --on-connect "desktop?leave_aero=true" |
| leave_effects=(true|false) |
Windows only. By default we disable effects (default value: true) on Windows to increase performance. Example: ISLLightClient.exe --on-connect "desktop?leave_effects=true" |
| leave_font_smoothing=(true|false) |
Windows only. By default we enable font smoothing to increase performance. Example: ISLLightClient.exe --on-connect "desktop?leave_font_smoothing=true" |
| skip_uac=(true|false) |
When you set the value to true, the User Account Control pop-up is skipped when the local user starts streaming his desktop and the streaming begins automatically. Note: The streaming side has to have administrative privileges on the local machine running Windows OS. Example: ISLLightClient.exe --on-connect "desktop?skip_uac=true" |
| topbar_menu_visible=(true|false) |
Use this command to hide "Menu" button in ISL Light Client topbar. Example: ISLLightClient.exe --on-load "desktop?topbar_menu_visible=true" |
| topbar_collapse_visible=(true|false) |
Use this command to hide "Collapse" button in ISL Light Client topbar. Example: ISLLightClient.exe --on-load "desktop?topbar_collapse_visible=true" |
| topbar_move_visible=(true|false) |
Use this command to hide "Move" button in ISL Light Client topbar. Example: ISLLightClient.exe --on-load "desktop?topbar_move_visible=true" |
| topbar_appicon_visible=(true|false) |
Use this command to hide "App Icon" in ISL Light Client topbar. Example: ISLLightClient.exe --on-load "desktop?topbar_appicon_visible=true" |
| topbarsize=(100|150|200) |
Scaling of the topbar is supported by using the following command line argument: Example: ISLLightClient.exe --on-load "desktop?topbarsize=200" |
| topbar_local_status_color=<hex_color_code> |
A command line argument was added to customize the status of text color in the topbar. The argument should be a three or six digit hex color without the "#". The hex color letters can be uppercase or lowercase. Example: ISLLightClient.exe --on-load "desktop?topbar_local_status_color=ffff00" |
| topbar_remote_status_color=<hex_color_code> |
A command line argument was added to customize the status of text color in the topbar. The argument should be a three or six digit hex color without the "#". The hex color letters can be uppercase or lowercase. Example: ISLLightClient.exe --on-load "desktop?topbar_remote_status_color=00ffff" |
| topbar_marker_visible=(true|false) |
Use this command to expose the whiteboard "Marker" button in the topbar. Note: The streaming side has to have administrative privileges on the local machine running Windows OS. Example: ISLLightClient.exe --on-load "desktop?topbar_marker_visible=true" |
File Transfer Commands
These command lines are used when using file transfer feature, with "file_transfer" used as the <target> in the command line.
| Command | Description |
|---|---|
| location=<path_on_local_computer> |
Use this command to change the location where the transferred files should be saved. Example: ISLLightClient.exe --on-connect "file_transfer?location=C:\Users\Sam\Desktop\Files" |
| transfer=[<file_name1>[;<file_name2>...]] |
When you use this command on connect event, the file transfer plugin will start transferring the specified file(s) - separate multiple filenames with semicolons. Example: ISLLightClient.exe --on-connect "file_transfer?transfer=C:\Users\Sam\Desktop\test_file.txt" |
Audio Call Commands
These command line is used when using audio call feature, with "audio" used as the <target> in the command line.
| Command | Description |
|---|---|
| stream |
When you use this command on connect event, it will start streaming the local audio recording. Example: ISLLightClient.exe --on-connect "audio?stream” |
Video Call Commands
These command lines are used when using video call feature, with "video" used as the <target> in the command line.
| Command | Description |
|---|---|
| stream |
When you use this command on connect event, it will start streaming the local video recording. Example: ISLLightClient.exe --on-connect "video?stream” ISLLightClient.exe --on-connect "video?stream "audio?stream” |
| video?quality=480p |
When you use this command on connect event, it will start streaming the local video recording. Example: ISLLightClient.exe --on-connect "video?quality=480p&prevent_remote_quality_change=true" |
Video Background Commands
These command lines are used when using video call feature, with "virtual_background" used as the <target> in the command line.
| Command | Description |
|---|---|
| mode=[blur|image] |
When you use this command on connect event, it will apply a virtual background as image or blured background in video. Example: ISLLightClient.exe --on-load "virtual_background?mode=blur” |
Recording Commands
These command lines are used when using session recording feature, with "recording" used as the <target> in the command line.
| Command | Description |
|---|---|
| record[=silent,true] |
When you use this command on connect event, it will load the recording plugin, start it and ask the remote user if he or she allows recording. If silent or true is specified, the session will be recorded without user consent. If silent is specified, the user will not be offered to view the recorded session after the session has finished. Recording starts even if silent or true are not defined. Example: ISLLightClient.exe --on-connect "recording?record=true” |
| location=<path_on_local_computer> |
Specify the default location where the recording files will be saved. Environment variables can also be used. Please use the following syntax for environment variables - for variable name variable_name use $[variable_name] Example: ISLLightClient.exe --on-connect "recording?location=x:\\recordings\\$[COMPUTERNAME]" |
| allow_stop=false |
This option will disable the user's ability to stop session recording. This option will disable the user's ability to stop session recording. Example: ISLLightClient.exe --on-connect "recording?allow_stop=false" |
| name=$[HOST]-$[TIME] |
You can define the file name for the recording. The default is set to Host and Time. This can be changed around depending on what criteria you wish to include in the file name. You can use any of the parameters listed below. Example: ISLLightClient.exe --on-disconnect "recording?name=$[HOST]-$[TIME]-$[SESSION]" These parameters can be used within the recording commands.
|
Customization Commands
These command lines are used for customizing ISL Light's Login Window, Session Toolbar, etc., with "main" used as the <target> in the command line.
| Command | Description |
|---|---|
| expand=(always|manual) |
When you use expand=always on connect event, it will instruct ISL Light to always restore its window from minimized/iconized state when a new event occurs, e.g. chat is received. When you use expand=manual on disconnect event, it will instruct ISL Light not to restore its window from minimized/iconized state when a session is terminated. Example: ISL_Light_Client.exe --on-connect "main?expand=always” |
| smallfootprint |
Use this option to force a small footprint GUI instead of the standard ISL Light dialog. Example: ISLLightClient.exe --on-load "main?smallfootprint” |
| iconize |
This command instructs ISL Light to switch into the iconized state. Example: ISLLightClient.exe --on-load “main?iconize” |
| minimize |
This command instructs ISL Light to switch into the minimized state. Example: ISLLightClient.exe --on-load “main?minimize” |
| logo=<path-to-logo-image> |
This command instructs ISL Light to load a logo image from an existing file on the computer or from an URL address. Important: Logo has to be in .bmp format. Maximal size for the logo is 350*48 px. Example: ISLLightClient.exe --on-load "main?logo=C:\Users\Sam\Desktop\logo.bmp" |
| pos=([center|lefttop|rightbottom|righttop|leftbottom][(x,y)]) |
This command instructs ISL Light to place the main window to a specific position. Parameters x and y represent the offset towards the center of the desktop. Example: ISLLightClient.exe --on-load "main?pos="righttop" ISLLightClient.exe --on-load "main?pos="righttop(15,20)" |
| sticky |
This command instructs ISL Light to restore the specified position each time the window state changes from minimized or iconized to restored. Example: ISLLightClient.exe --on-connect "main?sticky" |
| open_url=<url> |
This command instructs ISL Light to open the specified URL in the default web browser. Example: ISLLightClient.exe --on-load "main?open_url=www.islonline.com" |
| priority=(normal|high) |
This command sets the ISL Light process priority to normal or high. Example: ISLLightClient.exe --on-load "main?priority=high" |
| topmost=false |
This command works for all events (usually it is used on load event so that it is effective immediately when ISL Light starts) and disables the window on top flag for ISL Light. Example: ISLLightClient.exe --on-load "main?topmost=false" |
| lock=true |
Lock the computer when session ends. Only works in combination with --auto-close parameter. Example: ISLLightClient.exe --auto-close --on-disconnect "main?lock=true" |
These command line is used with "customization" used as the <target> in the command line.
| Command | Description |
|---|---|
| preselect_allow_remote_desktop_control=[true|false] |
Allows you to set the "Allow remote desktop control" checkbox in ISL Light Client to either true or false. Example: ISL_Light_Client.exe --on-load "customization?preselect_allow_remote_desktop_control=true" |