Skip to main content
Version: 3.1.0

Main Sections

Action

Replay consists of actions, which are the building blocks of the format. An action a change done by some tool to update the editing scene. The actions contain information on who, what and how did the changes. This allows to navigate through history of the editing and recreate the scene. Actions are keeping the patches between previous and current states.

Check out the API for Action

Context

Replay context is the full current state of editing, which is to be rendered. The context is based on actions only, in other words, context's state is what actions did to it. Applying patches to the context, given actions always result in the same final context when done in the same sequence.

Check out the API for IReplayContext

Meta

Replay files are being encrypted when they are packages. The encryption information is being stored in in this section. Note that this section is not encrypted itself, so information on the version of the encryption is free for read. However the versioning of encryption is conventional and the decryption is possible only by knowing the convention

Check out the API for IReplayMeta

SETTINGS

Replay settings has a purpose to provide suggested configurations for exporting per mime type. The current state of the settings is based on the existing functionality and requirement. The last means that the values can be extended if required, still keeping the same structural shape.

Check out the API for IReplaySettings