.. contents::
   :local:
   :depth: 1

==========================
SyncEvent
==========================

The sync protocol is used to syncronize different review tools to each other. It can also be used to record
the activities of a review tool, either for later playback or for parts of the playback (e.g. just for annotations)>


See:
   * https://docs.google.com/document/d/1dmo5Le5elqNNl9p4GpcRPT76BV7r6KYtrapHITD25uA/edit?tab=t.0#heading=h.3jckyebptegj
   * https://lf-aswf.atlassian.net/wiki/spaces/PRWG/pages/11274625/OTIO-Based+Synchronized+Review+Messaging#Annotation-Schemas


SyncEvents
==========

.. automodule:: schemadefs.SyncEvent.SyncEvent
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:


Play
==========
.. automodule:: schemadefs.SyncEvent.Play
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:


SetCurrentFrame
===============
.. automodule:: schemadefs.SyncEvent.SetCurrentFrame
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

NewPresenter
============
.. automodule:: schemadefs.SyncEvent.NewPresenter
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

NewParticipant
==============
.. automodule:: schemadefs.SyncEvent.NewParticipant
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

SharedKeyRequest
================

.. automodule:: schemadefs.SyncEvent.SharedKeyRequest
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

Sync Paint Events
=================

PaintStart
============

.. automodule:: schemadefs.SyncEvent.PaintStart
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:


PaintPoint
============
.. automodule:: schemadefs.SyncEvent.PaintPoint
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

PaintEnd
=========

.. automodule:: schemadefs.SyncEvent.PaintEnd
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index: