RenderStream Schema

When using the RenderStream plugin in a project, a JSON file is automatically generated.

The schema of the RenderStream JSON file is detailed below.

Top-Level Fields

Field	Description
majorVersion	The major version of the JSON schema.
minorVersion	The minor version of the JSON schema.
engineName	Name of the engine generating the file (e.g., “Unreal Engine”).
engineVersion	The version of the engine used (e.g., “5.4.0”).
pluginVersion	Version of the RenderStream plugin.
info	Reserved for additional metadata (currently empty in your example).
channels	A list of RenderStream channels (typically camera names or IDs).
schema	An array of scene-specific parameter definitions (explained below).

Schema → Parameters Structure

Each item in the schema array defines a scene and its controllable parameters. In your example:

Schema Object

{
    "name": "SampleScene",
    "parameters": [ ... ]
}

• name: The name of the RenderStream scene.
• parameters: An array of adjustable parameters in that scene.

Example Parameter Object

{
    "group": "Default",
    "displayName": "Message",
    "key": "Message",
    "type": 0,
    "min": 0.0,
    "max": 1.0,
    "step": 1.0,
    "defaultValue": {
        "index": 0,
        "data": 1.0
    },
    "options": ["Off", "On"],
    "dmxOffset": -1,
    "dmxType": 2,
    "noSequence": false,
    "readOnly": false
}

Parameter Field Breakdown

Field	Description
group	Logical grouping for UI display (e.g., “Default”).
displayName	Name shown in the RenderStream controller interface.
key	Internal key identifier for the parameter.
type	Data type (e.g., 0 often represents enum/switch-style).
min, max	Range of values allowed.
step	Incremental step between values.
defaultValue	Contains both index and actual data value.
options	For enumerated types, a list of string values (e.g., “Off”, “On”).
dmxOffset	DMX control offset (if used in lighting/control contexts).
dmxType	Type of DMX value.
noSequence	If true, disables sequence recording.
readOnly	If true, the parameter is read-only.

Channels

"channels": ["rscam1", "rscam2", "rscam3"]