codevideo-types

Experimental renderer metadata is optional: RenderMode is realtime or deterministic; ICodeVideoIDEProps accepts renderMode and renderSeed. ICodeVideoManifest additionally accepts renderWorkers. Omitted mode remains realtime. IAudioItem can carry actionIndex, assetId and measured durationMs for offline speech timing; existing text/MP3 URL producers remain compatible.

TypeScript types used around the CodeVideo ecosystem.

Theory

A software course is represented by the top level interface ICourse. A course is made up of an array of ILessons, which are made up of a series of IActions. Each of ICourse, ILesson, and IAction also have additional metadata properties.

Read more about this in our whitepaper.

Domains

There are 5 domains to a codevideo action: the file explorer, the editor, the terminal, the mouse, and the author. Each of these domains has its own set of actions that can be performed with it, prefixed by file-explorer-, editor-, terminal-, mouse-, and author- respectively.

IAction

IAction - The bread and butter of all things CodeVideo. An action is defined by a name and a value and can perform all possible actions in the CodeVideo ecosystem. Examples include type-editor, type-terminal, arrow-up, enter, etc.

Action Names

A convenience array of all possible action names is available at AllActionStrings.

Action Values

Action values are always strings, but typically represent a number when they are repeatable actions such as editor-arrow-up, editor-enter, etc. These are catalogued in RepeatableActionNames.

Project Snapshots

A project snapshot is a snapshot of the state of a project at a given point in time. It is represented by the IProjectSnapshot interface. Any instance of IProjectSnapshot can be derived by evaluating the actions in the project up to the point in time that the snapshot was taken.