Sync Options Changed

Table of contents

1. Description
2. Format
3. Example

---

Origin:

Both

Target:

Both

Description

The Sync Options Changed message is a request to either enable or disable sending rendering data and syncing the camera position to the Game/Engine.

The message is bi-directional. Frame by Frame can send it to the Game/Engine, and the other way around. Both applications can decide to enable or disable the feature, so both need to be able to send and receive this type of message.

Format

The format of a Frame by Frame message is a JSON with the following layout:

{
    "syncVisibleShapes": boolean,
    "syncCamera": boolean
}

• syncVisibleShapes: Indicates if Frame by Frame should send rendering data to the Game/Engine.
• syncCamera: Indicates if the Game/Engine should replicate the camera position of Frame by Frame.

Example

Example of a full SyncOptionsChanged message. The type value is documented in the Network Messages section.

{
    "type": 3,
    "data": {
        "syncVisibleShapes": true,
        "syncCamera": false
    }
}