Cluster#

  • masteraddress
    non-empty string

    Contains the address of the node that acts as the server for this cluster. This means that one of the Node elements described in this configuration file has to have an address that corresponds to this masterAddress. This value can be either an IP address or a DNS name, which will be resolved at application startup.

  • version
    integer

    The version of this configuration file. The current version number is 1.

  • debuglog (optional)
    boolean

    Determines whether the logging should include Debug level log messages. The default value is false, such that only Info level log messages or above are added to the console, the file, or the registered callback. Log messages that are not logged are discarded.

  • threadaffinity (optional)
    integer [0, \(\infty\))

    Forces the thread affinity for the main thread of the application. On Windows, this is achieved using the SetThreadAffinityMask function, but it might not be implemented on other operating systems. The default value is that no thread affinity is set for the application.

  • firmsync (optional)
    boolean

    Determines whether the server should frame lock and wait for all client nodes or not. The default for this is false. Additionally, it is possible (and more advised) to set the frame locking on an individual node bases for the cases where not all nodes are part of a swap group or the same swap group.

  • scene (optional)
    Scene

  • nodes (optional)
    array of Nodes

    Each object in this array has to be a valid Node. At least one of the described nodes has to have an address that matches the cluster’s masteraddress.

  • users (optional)
    array of Users

    Each object in this array has to be a valid User. The first value in the array is considered to be the default user for the application.

  • capture (optional)
    Capture

    The object provides attributes that describe how the application will treat screen captures.

  • trackers (optional)
    array of Trackers

    Each object in this array describes a VRPN tracker.

  • settings (optional)
    Settings

    This object describes general settings for the application. The scene-specific settings can be found under the scene entry instead.

  • generator (optional)
    object

    Information about the generator application that was used (if any) to create this configuration file.

    • name
      non-empty string

      A human-friendly name for the generator that created this configuration file.

    • major
      integer [0, \(\infty\))

      The major version of the generator that created this configuration file.

    • minor
      integer [0, \(\infty\))

      The minor version of the generator that created this configuration file.

  • meta (optional)
    object

    Information and description of configuration file.

    • description
      string

      Description of the window configuration.

    • name
      string

      Name of the window configuration.

    • author (optional)
      string

      Author’s name.

    • license (optional)
      string

      Details of the software license.

    • version (optional)
      string

      Version number of configuration meta.