VR Sync API: Introduction

To achieve synchronization of a fleet of VR devices VR Sync uses a specially designed API to communicate between the application’s components. This documentation aims to expose the API for integrators to build VR Sync into their own applications.


Application components

VR Sync’s out-of-the box components all have a variable called "sender". The components are as follows:

  • VR Sync Server ("Server") Our main server application which is at the core of VR Sync’s communication. All clients for your VR Sync account connect to this server. Customers using the VR Sync Box can connect to this server using their unit’s static IP address 172.28.1.9. Default VR Sync Cloud users are hosted in our cloud infrastructure. Details can be requested by contacting VR Sync Support.
  • VR Sync Remote ("Admin") The admin application responsible for sending playback commands to the server. This application can manage groups, devices and view the preloaded content and playback statuses.
  • VR Sync Client ("Client") The client application is the component that caches video content, and listens for playback commands from the server. Some examples of clients are the VR Sync apps for Meta Quest, Pico and the Windows client.


All communication should run through the VR Sync Server using Socket.io 2.x to 4.x. 


Related

VR Sync API: Documentation Read

VR Sync API: Creating a VR Sync Remote Read

VR Sync API: Creating a VR Sync Client Read