Method

catalogue.list

Every effect package the build knows, with its parameters. Enough to build a valid effect chain without reading a manifest.

Parameters

  • kindstringoptional

    Restrict to one kind: "effect", "filter", "audio", "transition" or "generator".

ReplyPackageInfo[]

{ "method": "catalogue.list", "kind": "effect" }

Reply: an array of PackageInfo, in id order.

[
  {
    "id": "concat.gaussian-blur",
    "name": "Gaussian Blur",
    "kind": "effect",
    "category": "Blur",
    "description": "A soft, even blur.",
    "intensity": "radius",
    "params": [
      {
        "key": "radius",
        "label": "Radius",
        "type": "float",
        "min": 1.0,
        "max": 50.0,
        "default": 10.0,
        "step": 1.0,
        "unit": "px",
        "animate": false,
        "values": [],
        "labels": []
      }
    ]
  }
]

How to use it:

  • id is what a clip's chain stores: in videoEffects, filters, or a transitionIn.
  • each param's key is what the chain entry's params object stores it under. See Types → AppliedFilter.