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:

SyncEvents

This is the base-class of all schema events.

schemadefs.SyncEvent.SyncEvent.timestamp

timestamp is an ISO 8601 formatted string representing the time of the change. This is used to track when media changes occur in the timeline.

Type:

str

Play

A schema for the event system to define when play is enabled.

schemadefs.SyncEvent.Play.timestamp

timestamp is an ISO 8601 formatted string representing the time of the change. This is used to track when media changes occur in the timeline.

Type:

str

schemadefs.SyncEvent.Play.value

value is a boolean indicating whether play is enabled or not.

Type:

bool

SetCurrentFrame

A schema for the event system to define when the current frame is set.

schemadefs.SyncEvent.SetCurrentFrame.time

time is a RationalTime representing the current frame in the timeline.

Type:

RationalTime

schemadefs.SyncEvent.SetCurrentFrame.timestamp

Timestamp is an ISO 8601 formatted string representing the time of the change.

Type:

str

NewPresenter

New Presenter

schemadefs.SyncEvent.NewPresenter.presenter_hash

The hash of the presenter.

Type:

str

NewParticipant

A new participant for the sync review

SharedKeyRequest

Shared Key Request

schemadefs.SyncEvent.SharedKeyRequest.key

The shared key

Type:

str

Sync Paint Events

PaintStart

A schema for the event system to denote when painting starts.

schemadefs.SyncEvent.PaintStart.source_index

A reference to the media source.

Type:

int

schemadefs.SyncEvent.PaintStart.uuid

A Unique ID for the brush-stroke, used for subsequence brushes.

Type:

int

schemadefs.SyncEvent.PaintStart.friendly_name
Type:

str

schemadefs.SyncEvent.PaintStart.rgba

The color + alpha to be painted.

Type:

[r,g,b,a]

schemadefs.SyncEvent.PaintStart.type

“color” for a regular color brush stroke, “erase” for an eraser stroke.

Type:

str

schemadefs.SyncEvent.PaintStart.brush

The type of brush, currently one of circle, gaussian.

Type:

str

schemadefs.SyncEvent.PaintStart.visible

Is the stroke visible.

Type:

bool

schemadefs.SyncEvent.PaintStart.timestamp

timestamp is an ISO 8601 formatted string representing the time of the change. TODO.

Type:

str

PaintPoint

A schema for the event system to denote when adding onto a paint stroke.

Attribute:

source_index: uuid (str): The UUID of the initial brush stroke. layer_range: point: [List[PaintVertex]]: List of paint vertices. timestamp (str): timestamp is an ISO 8601 formatted string representing the time of the change.

PaintEnd

A schema for the event system to denote when painting ends.

schemadefs.SyncEvent.PaintEnd.uuid

uuid of curve to finish.

Type:

str

schemadefs.SyncEvent.PaintEnd.point

Last point in curve (if any)

Type:

VertexPoint

schemadefs.SyncEvent.PaintEnd.timestamp

timestamp is an ISO 8601 formatted string representing the time of the change.

Type:

str