Syncker-Specific Options

There are 2 types of Syncker-specific options:

Command-line options, which are used to specify screen configuration, broadcast address of the master computer, TCP and UDP ports on the application start-up. These options have the same syntax as the other start-up command-line options.
Console options that can be run from the application console on the master or slave sides.

Common Options#

The following command-line options can be run on master or slave application start-up:

Name	Description	Arguments	Default
sync_view_config	Specifies a screen/projection configuration to be used. This configuration represents a configuration of monitors, onto which the application is rendered, or projectors that project the application onto projection screens (1 unit = 1 meter). Projection and modelview matrices are automatically calculated on the basis of the camera position and slave name. When no configuration file is specified, all slaves clone master's display. Notice Check the full list of configuration requirements here. Shell commands `-sync_view_config "my_project/my_config.sync"`	A path to the .sync file.	No configuration is set by default.
sync_master	Sets the flag indicating whether the computer is a master. Shell commands `-sync_master 1`	Master flag.	0
sync_tcp_port	Sets the TCP port to be used to send and receive critical messages with guaranteed delivery. Shell commands `-sync_tcp_port 8891`	TCP port number.	8891
sync_tcp_ping_port	Sets the TCP port to be used for ping messages. Shell commands `-sync_tcp_ping_port 8892`	TCP port number.	8892
sync_udp_port	Sets the UDP port to be used to send and receive non-critical messages. Shell commands `-sync_udp_port 8890`	UDP port number.	8890
sync_view	Sets the view (display or projector stored in the configuration file) to be used. This option is equivalent to sync_view_0. Shell commands `-sync_view display_name`	Name of the display/projector stored in the .sync configuration file.	-
sync_view_0	Sets the view (display or projector stored in the configuration file) to be used for the 1^st monitor/projector of the computer. Shell commands `-sync_view_0 display_name`	Name of the display/projector stored in the .sync configuration file.	-
sync_view_1	Sets the view (display or projector stored in the configuration file) to be used for the 2^nd monitor/projector of the computer. Notice To be specified when a multi-monitor configuration is used. Shell commands `-sync_view_1 display_name`	Name of the display/projector stored in the .sync configuration file.	-
sync_view_2	Sets the view (display or projector stored in the configuration file) to be used for the 3^rd monitor/projector of the computer. Notice To be specified when a multi-monitor configuration is used. Shell commands `-sync_view_2 display_name`	Name of the display/projector stored in the .sync configuration file.	-
sync_view_3	Sets the view (display or projector stored in the configuration file) to be used for the 4^th monitor/projector of the computer. Notice To be specified when a multi-monitor configuration is used. Shell commands `-sync_view_3 display_name`	Name of the display/projector stored in the .sync configuration file.	-
sync_view_4	Sets the view (display or projector stored in the configuration file) to be used for the 5^th monitor/projector of the computer. Notice To be specified when a multi-monitor configuration is used. Shell commands `-sync_view_4 display_name`	Name of the display/projector stored in the .sync configuration file.	-
sync_view_5	Sets the view (display or projector stored in the configuration file) to be used for the 6^th monitor/projector of the computer. Notice To be specified when a multi-monitor configuration is used. Shell commands `-sync_view_5 display_name`	Name of the display/projector stored in the .sync configuration file.	-

Master Options#

The following command-line options can be run on the master application start-up:

Name	Description	Arguments	Default
sync_broadcast_address	Sets a broadcast address of the master computer that is used to broadcast messages to slaves over the network. Shell commands `-sync_broadcast_address "xxx.xxx.xxx.xxx"`	A broadcast address in the xxx.xxx.xxx.xxx format.	127.255.255.255

Slave Options#

The following command-line options can be run on the slave application start-up:

Name	Description	Arguments	Default
sync_slave_name	Sets a name of the slave computer used to display connect/disconnect messages. Shell commands `-sync_slave_name "slave1"`	A slave name, string.	slave

The following console commands can be run on a master or a slave computer.

Name	Description	Arguments
syncker_max_fps	Command. Sets the maximum FPS value for the computer. Notice To disable framerate clamping use -1.	FPS value. By default, 60 FPS is used.
syncker_console	Command. Runs the specified console command on master and all slaves. Source code `syncker_console show_profiler 3 //shows the profiler on all computers syncker_console syncker_max_fps 60 //sets maximum framerate to 60 on all computers`	A console command to run.
syncker_interpolation	Variable. Prints the value indicating if interpolation and extrapolation are enabled on the computer. Command. Enables or disables interpolation and extrapolation on the computer. Source code `syncker_interpolation 1`	0 - disabled 1 - enabled (by default)
syncker_interpolation_period	Variable. Prints the current interpolation period value for the computer, in seconds. Command. Sets the interpolation period for the computer. Source code `syncker_interpolation_period 0.04`	Interpolation period, in seconds (0.04 - by default)
syncker_extrapolation_period	Variable. Prints the current extrapolation period value for the computer, in seconds. Command. Sets the extrapolation period for the computer. Source code `syncker_extrapolation_period 0.2`	Extrapolation period, in seconds (0.2 - by default)
syncker_setup	Variable. Prints the value indicating if screen/ projection setup mode is active. Command. Enables or disables screen/ projection setup mode. Source code `syncker_setup 1`	0 - return to standard mode. 1 - enter the screen/ projection setup mode.
syncker_debug	Variable. Prints the value indicating if the debug window is active. Command. Shows or hides the debug window. Source code `syncker_debug 1`	0 - hide the debug window. 1 - show the debug window.

In This Article:

Command-Line Options#

Common Options#

Master Options#

Slave Options#

Console Commands#