Module protocol 

Wire protocol types for OGraf v1 Server API — messages sent between server and renderer over WebSocket. These types define the JSON structure on the wire; server-internal bookkeeping lives in models.

Structs

InstanceSnapshot

Instance state snapshot sent by a renderer during reconnect (Hello message). Contains the minimal information needed to resync Core’s view of what instances are loaded on the renderer.

Enums

RendererMessage

Messages received from a renderer over its WebSocket.

ServerMessage

Messages sent from the server to a renderer over its WebSocket. Every variant carries a request_id so the HTTP handler that triggered it can correlate the renderer’s eventual *Result reply (see RendererMessage) and return the real statusCode/statusMessage, per the OGraf spec.

Type Aliases

InstanceId

RenderTarget

Identifies a RenderTarget on a Renderer. Per the OGraf spec, its shape is defined by each Renderer’s own renderTargetSchema — Core treats it as an opaque, shallow JSON object and only ever compares it for equality. For example, a CasparCG renderer might use {channel, layer}, fixed for the lifetime of one WS connection; other renderer types (eg a file-render worker) are free to use a different shape (eg {profile: "16:9-1080p"}).