Skip to content

animation_toolset.toolsets.outliner.SequencerOutlinerTools

Tools for inspecting and managing the Sequencer outliner tree. Use when getting a snapshot of the outliner hierarchy, querying node children, managing outliner selection, expanding or collapsing nodes, or toggling node states like mute, solo, deactivate, lock, and pin. Also useful for test verification of Sequencer UI state.

18 tool(s).

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_deactivated_nodes

Get the currently deactivated outliner nodes.

    Returns:
        List of deactivated nodes.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_locked_nodes

Get the currently locked outliner nodes.

    Returns:
        List of locked nodes.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_muted_nodes

Get the currently muted outliner nodes.

    Returns:
        List of muted nodes.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_node_label

Get the display label of an outliner node.

    Args:
        node: The outliner node to query.

    Returns:
        The node's display label text.

Input schema

{
  "properties": {
    "node": {
      "properties": {
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "SequencerViewModelScriptingStruct",
      "type": "object"
    }
  },
  "required": [
    "node"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_outliner_children

Get child nodes of an outliner node.

    Args:
        node: The parent outliner node.
        type_filter: Optional node type name to filter by (e.g. "Track").

    Returns:
        List of child SequencerViewModelScriptingStruct objects.

Input schema

{
  "properties": {
    "node": {
      "properties": {
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "SequencerViewModelScriptingStruct",
      "type": "object"
    },
    "type_filter": {
      "default": null,
      "type": "string"
    }
  },
  "required": [
    "node"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_outliner_selection

Get the currently selected nodes in the outliner.

    Returns:
        List of selected SequencerViewModelScriptingStruct objects.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_outliner_tree

Get a full snapshot of the Sequencer outliner tree.

    Builds a recursive tree structure from the outliner root nodes.
    Useful for testing and UI verification.

    Returns:
        JSON string encoding a list of objects, each with 'label',
        'type', and 'children' (a recursive list of the same structure).

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_pinned_nodes

Get the currently pinned outliner nodes.

    Returns:
        List of pinned nodes.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_sections_for_nodes

Get sections associated with the given outliner nodes.

    Args:
        nodes: The outliner nodes to query.

    Returns:
        List of MovieSceneSection objects associated with the nodes.

Input schema

{
  "properties": {
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "nodes"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "refPath": {
            "description": "The reference stored as a soft path string.",
            "type": "string"
          }
        },
        "required": [
          "refPath"
        ],
        "title": "/Script/MovieScene.MovieSceneSection",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.get_soloed_nodes

Get the currently soloed outliner nodes.

    Returns:
        List of soloed nodes.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.is_node_expanded

Check whether an outliner node is expanded.

    Args:
        node: The outliner node to query.

    Returns:
        True if expanded, False if collapsed.

Input schema

{
  "properties": {
    "node": {
      "properties": {
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "SequencerViewModelScriptingStruct",
      "type": "object"
    }
  },
  "required": [
    "node"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.set_node_deactivated

Deactivate or reactivate outliner nodes.

    Args:
        nodes: List of outliner nodes to modify.
        deactivated: True to deactivate, False to reactivate.

Input schema

{
  "properties": {
    "deactivated": {
      "type": "boolean"
    },
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "nodes",
    "deactivated"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.set_node_expanded

Expand or collapse outliner nodes.

    Args:
        nodes: The nodes to expand or collapse.
        expanded: True to expand, False to collapse.

Input schema

{
  "properties": {
    "expanded": {
      "type": "boolean"
    },
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "nodes",
    "expanded"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.set_node_locked

Lock or unlock outliner nodes for editing.

    Args:
        nodes: List of outliner nodes to modify.
        locked: True to lock, False to unlock.

Input schema

{
  "properties": {
    "locked": {
      "type": "boolean"
    },
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "nodes",
    "locked"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.set_node_muted

Mute or unmute outliner nodes.

    Args:
        nodes: The nodes to mute or unmute.
        muted: True to mute, False to unmute.

Input schema

{
  "properties": {
    "muted": {
      "type": "boolean"
    },
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "nodes",
    "muted"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.set_node_pinned

Pin or unpin outliner nodes.

    Args:
        nodes: List of outliner nodes to modify.
        pinned: True to pin, False to unpin.

Input schema

{
  "properties": {
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    },
    "pinned": {
      "type": "boolean"
    }
  },
  "required": [
    "nodes",
    "pinned"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.set_node_solo

Solo or unsolo outliner nodes.

    Args:
        nodes: The nodes to solo or unsolo.
        soloed: True to solo, False to unsolo.

Input schema

{
  "properties": {
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    },
    "soloed": {
      "type": "boolean"
    }
  },
  "required": [
    "nodes",
    "soloed"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.outliner.SequencerOutlinerTools.set_outliner_selection

Set the outliner selection.

    Args:
        nodes: The nodes to select.

Input schema

{
  "properties": {
    "nodes": {
      "items": {
        "properties": {
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "title": "SequencerViewModelScriptingStruct",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "nodes"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}