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

    Interface RecordingSchemaOptions

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

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

    Hierarchy (View Summary)

    Index
    entity_path?: string

    Since 0.43.0. Use entityPath instead.

    entityPath?: string

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

    max_entities?: number

    Since 0.43.0. Use maxEntities instead.

    maxEntities?: number

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

    paths_only?: boolean

    Since 0.43.0. Use pathsOnly instead.

    pathsOnly?: boolean

    Name the entities without describing what is logged on them.

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

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