Crate oxframe_protocol 

Protocol shared by the engine (oxframe-preview), the CLI and editor-ui.

Status: oxframe is under very active development. The API is not stable yet and may change from version to version. Pin the exact version in your Cargo.toml and check the changelog before upgrading.

This crate is the single source of truth: TypeScript types for @oxframe/protocol are generated from it with ts-rs.

Structs

AudioClipInfo

A sound effect on the timeline.

AudioMeta

Where the soundtrack plays.

FrameHeader

16-byte little-endian header of a binary WS frame:

MarkerInfo

A marker on the timeline.

Meta

Contents of <scene>.meta.json.

NodeInfo

A node in Event::Tree.

SceneInfo

A scene on the timeline.

SignalValue

A property value in Event::Signals.

Span

A source location in an error.

TransitionMeta

Length of the transition into this scene, edited on the timeline.

Enums

Command

UI → engine.

ErrorKind

Category of an Event::Error.

Event

Engine → UI.

FrameFormat

Image encoding of a binary preview frame.

MetaError

Why a meta.json could not be used.

Constants

META_SCHEMA_VERSION

Current version of the meta.json schema.

PROTOCOL_VERSION

Incremented on every incompatible change of Command, Event or the binary frame header. Every side compares it in Hello/Ready.

Functions

is_valid_name

Names of markers, eases and tunables: [a-z0-9_-]+.