This reference describes unreleased code on main; no release documents it yet.

rlmesh::recorder::RecorderCaptureOptions

structPreviewuse rlmesh::recorder::RecorderCaptureOptions;[source]

Keywords for live recording.

struct RecorderCaptureOptions

Also available as rlmesh::RecorderCaptureOptions.

Fields

task: Option<String>

Task label; defaults to the env name.

config: Option<Metadata>

Caller metadata, copied into the workload.

cameras: Option<Vec<String>>

Sources to record; absent discovers all, empty records metrics only.

session: Option<std::sync::Arc<dyn RunContext>>

Explicit context for hand-driven hooks; otherwise adopted from the run.

video_info_keys: Vec<String>

Step-info keys containing an env-produced video path.

included_in_metrics: bool

Include the episodes in reward and success aggregates.