Syncker-Specific Options

Warning

The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.

Command-line options used to specify screen configuration, addressing mode, multicast address of the Master computer, or a port to be used 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.

Command-Line Options#

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 Slave apps 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.	syncker.cfg
sync_master	Sets the flag indicating whether the computer is Master. Shell commands `-sync_master 1`	Master flag.	1
sync_method	Sets the addressing mode to be used by Syncker. One of the following: unicast, multicast, broadcast. Shell commands `-sync_method broadcast`	Addressing mode.	unicast
sync_multicast_address	Sets a multicast address that is used by the Master computer to send messages to Slave over the network. Shell commands `-sync_multicast_address "xxx.xxx.xxx.xxx"`	A multicast address in the xxx.xxx.xxx.xxx format.	239.0.0.1
sync_port	Sets the UDP port to be used to send and receive messages for the Syncker. Shell commands `-sync_port 8890`	UDP port number.	8890
sync_swap	Sets the buffer swapping method to be used by Syncker. One of the following: default, NVIDIA (available only for NVIDIA Quadro GPUs with G-SYNC support). Shell commands `-sync_swap nvidia`	Buffer swap synchronization mode.	default
sync_swap_nvidia_group	Sets NVIDIA's swap group. Shell commands `-sync_swap_nvidia_group 1`	NVIDIA's swap group.	1
sync_swap_nvidia_barrier	Sets NVIDIA's swap barrier. Shell commands `-sync_swap_nvidia_barrier 1`	NVIDIA's swap barrier.	1
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_count	Sets a number of Syncker hosts (including Master itself) in the network. Shell commands `-sync_count 3`	Number of hosts.	1
sync_broadcast_address	Sets a broadcast address of the Master computer that is used to broadcast messages to Slave over the network. If the key is not specified, Syncker shall try to determine the value automatically. Shell commands `-sync_broadcast_address "xxx.xxx.xxx.xxx"`	A broadcast address in the xxx.xxx.xxx.xxx format.	—
sync_allow_extra_slaves	Sets the flag indicating whether additional Slave PCs can be connected after starting the session. Shell commands `-sync_allow_extra_slaves 1`	Extra Slave flag.	0

Slave Options#

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

Name	Description	Arguments	Default
sync_slave_port	Sets a UDP port to be used by Slave. 0 — means any unused port available. Shell commands `-sync_slave_port 0`	UDP port number.	0
sync_master_address	Sets the address of the Master computer. If the key is not specified, Syncker shall try to determine the value automatically. Shell commands `-sync_master_address "xxx.xxx.xxx.xxx"`	Master's address in the xxx.xxx.xxx.xxx format.	—

Console Commands#

The following console commands can be run on a Master or Slave computer.

Name	Description	Arguments
sync	Command. Runs the specified console command on Master and all Slave PCs. Source code `sync show_profiler 3 //shows the profiler 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.

Last update: 2021-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)