Web Viewer - v0.41.0
    Preparing search index...

    Interface RecordingSchemaOptions

    Which recording WebViewer.get_recording_schema describes, and which part of it.

    interface RecordingSchemaOptions {
        entity_path?: string;
        max_entities?: number;
        paths_only?: boolean;
        recording?: `Recording:${string}:${string}`;
    }

    Hierarchy (View Summary)

    Index
    entity_path? max_entities? paths_only? recording?
    entity_path?: string

    Only describe this entity and the entities below it, e.g. /world/robot.

    max_entities?: number

    How many entities to describe at most. Defaults to 100, or to 10000 with paths_only.

    paths_only?: boolean

    Name the entities without describing what is logged on them.

    recording?: `Recording:${string}:${string}`

    The recording, as a store id from WebViewer.get_state. If omitted, the active recording.

    Settings
    Member Visibility

    On This Page
    Properties