List Project Items

Category: Pr Bins & Project Items List Project Items block screenshot

Returns Project Items from a Bin or the current Project Panel selection, optionally expanding selected Bins recursively. With onlySelected=false, bin/includeSubbins define normal bin traversal. With onlySelected=true, selected Project Panel items are traversal roots; BIN_AND_SUBBINS recursively expands selected bins even when TYPE_BIN is not requested, then types filters returned items. Selected bins themselves require TYPE_BIN. Overlapping roots are deduplicated at first occurrence. An explicit bin scopes selected roots to that subtree; omitting bin uses the whole selection. Order preserves Premiere selection-API order followed by depth-first folder-item API order, not an alphabetical/UI-sort guarantee. With onlySelected=false, bin is the traversal root. BIN_ONLY reads its direct children; BIN_AND_SUBBINS recursively includes descendants. types filters returned items. types accepts only TYPE_FOOTAGE, TYPE_SEQUENCE, TYPE_MULTICAM_SEQUENCE, TYPE_MERGED_CLIP, TYPE_BIN, and TYPE_FILE; omitting it or passing an empty list means all of them. Any other string, including Premiere API constants such as TYPE_CLIP, is rejected by validation and makes the block fail at runtime instead of matching nothing. Use TYPE_FOOTAGE for ordinary media clips. With onlySelected=true, the current Project Panel selection supplies the traversal roots. A selected non-bin item is returned when it matches types. With includeSubbins=BIN_AND_SUBBINS, every selected bin is traversed recursively even when TYPE_BIN is absent from types. Its descendants are returned only when they match types. A selected bin itself is returned only when TYPE_BIN is included. With BIN_ONLY, selected bins are not expanded. Overlapping selected roots are deduplicated by project-item identity. The first occurrence wins: selected roots keep the order returned by Premiere's selection API, and expanded bin contents use depth-first order from Premiere's folder-item API. When bin is explicitly supplied together with onlySelected=true, it scopes the selected roots to that bin's subtree. Without an explicit bin, the whole Project Panel selection is considered. The returned order is not an alphabetical or visible Project Panel sort guarantee. Sort explicitly in the workflow when a different order is required. If Premiere returns a Bin child list containing a null item, the block rereads that list up to three times. A list that remains incomplete aborts the operation instead of silently omitting a Project Item; no partial listing is returned. Use includeSubbins to search only the current bin or also its children, for example BIN_ONLY or BIN_AND_SUBBINS. Use types to filter by item kinds such as TYPE_FOOTAGE, TYPE_SEQUENCE, TYPE_MULTICAM_SEQUENCE, TYPE_MERGED_CLIP, TYPE_BIN, or TYPE_FILE. Set onlySelected to return only currently selected project items.

Inputs

Input	Required	Value Kind	Types	Enum Values
`bin`	no	`expression`	reference, string, null	—
`includeSubbins`	no	`expression`	enum-string, boolean	`BIN_ONLY`, `BIN_AND_SUBBINS`
`onlySelected`	no	`expression`	boolean	—
`types`	no	`array`	enum-string	`TYPE_FOOTAGE`, `TYPE_SEQUENCE`, `TYPE_MULTICAM_SEQUENCE`, `TYPE_MERGED_CLIP`, `TYPE_BIN`, `TYPE_FILE`

Notes

Returns Project Items from a Bin or the current Project Panel selection, optionally expanding selected Bins recursively.
With onlySelected=false, bin is the traversal root. BIN_ONLY reads its direct children; BIN_AND_SUBBINS recursively includes descendants. types filters returned items.
types accepts only TYPE_FOOTAGE, TYPE_SEQUENCE, TYPE_MULTICAM_SEQUENCE, TYPE_MERGED_CLIP, TYPE_BIN, and TYPE_FILE; omitting it or passing an empty list means all of them. Any other string, including Premiere API constants such as TYPE_CLIP, is rejected by validation and makes the block fail at runtime instead of matching nothing. Use TYPE_FOOTAGE for ordinary media clips.
With onlySelected=true, the current Project Panel selection supplies the traversal roots.
A selected non-bin item is returned when it matches types.
With includeSubbins=BIN_AND_SUBBINS, every selected bin is traversed recursively even when TYPE_BIN is absent from types. Its descendants are returned only when they match types.
A selected bin itself is returned only when TYPE_BIN is included. With BIN_ONLY, selected bins are not expanded.
Overlapping selected roots are deduplicated by project-item identity. The first occurrence wins: selected roots keep the order returned by Premiere's selection API, and expanded bin contents use depth-first order from Premiere's folder-item API.
When bin is explicitly supplied together with onlySelected=true, it scopes the selected roots to that bin's subtree. Without an explicit bin, the whole Project Panel selection is considered.
The returned order is not an alphabetical or visible Project Panel sort guarantee. Sort explicitly in the workflow when a different order is required.
If Premiere returns a Bin child list containing a null item, the block rereads that list up to three times. A list that remains incomplete aborts the operation instead of silently omitting a Project Item; no partial listing is returned.

Examples

Create Empty Sequence Matching Selected Item And Place It

Creates an empty sequence whose settings match the first selected project item, stores the returned sequence ref, then places the item explicitly into that sequence.

kind: Pattern · format: runtime-dsl · validation: Manual workspace

Topics: sequence creation, project inspection, timeline placement, matched sequence settings

Source: patterns/ex-sequence-create-matching-item-and-place.json

Download JSON