Get Sequence Property
Reads one property from a sequence, using the active sequence by default when `sequence` is omitted. The `HAS_OBJECT_MASK` property reports whether Premiere currently sees any object mask usage on that sequence.
Inputs
| Input | Required | Value Kind | Types | Enum Values |
|---|---|---|---|---|
sequence | no | expression | reference, string, null | — |
property | yes | string | enum-string | NAME, GUID, TIMEBASE, VIDEO_DISPLAY_FORMAT, AUDIO_DISPLAY_FORMAT, VIDEO_FRAME_RATE, AUDIO_SAMPLE_RATE, AUDIO_TRACK_COUNT, VIDEO_TRACK_COUNT, CAPTION_TRACK_COUNT, IN_POINT_SECONDS, OUT_POINT_SECONDS, WORK_AREA_IN_POINT_SECONDS, WORK_AREA_OUT_POINT_SECONDS, END_SECONDS, ZERO_POINT_SECONDS, PLAYER_POSITION_SECONDS, IS_DONE_ANALYZING_FOR_VIDEO_EFFECTS, FRAME_WIDTH, FRAME_HEIGHT, FRAME_SIZE, HAS_OBJECT_MASK |
Notes
- Reads properties directly from sequence context. Omitted, empty, whitespace-only or null
sequenceuses the active Sequence. Explicit Project Item paths, Sequence refs and::SEQ\ACTIVEare accepted; Merged and Multicam remain eligible when Premiere natively reports a Sequence. - Prefer this getter for new Blockly scripts. The duplicate Project Item Sequence getter is hidden from the toolbox but remains registered for lossless legacy import and execution.
- Canonical time properties
IN_POINT_SECONDS,OUT_POINT_SECONDS,ZERO_POINT_SECONDS,PLAYER_POSITION_SECONDSandEND_SECONDSreturn numeric seconds;TIMEBASEreturns a string of ticks per video frame from nativegetTimebase()(for example,"10160640000"at 25 fps).FRAME_SIZE,FRAME_WIDTH,FRAME_HEIGHTandHAS_OBJECT_MASKare canonical-only properties. - Time getters report actual native values. Read
ZERO_POINT_SECONDSorPLAYER_POSITION_SECONDSafter a committed write rather than assuming the requested seconds were retained; see the bounded native observations underprSetSequenceProperty. WORK_AREA_IN_POINT_SECONDSandWORK_AREA_OUT_POINT_SECONDSread Premiere's Work Area bounds as finite seconds (26.5+). These are not Sequence In/Out or export-range settings. Each property requires only its corresponding WorkAreaUtils getter; missing APIs or invalid native values fail explicitly, with no fallback to Sequence In/Out.- Work Area reads do not commit pending Actions. Read after the intended mutation has committed. Use
prSequenceSetWorkAreafor writes, notprSetSequenceProperty. - Includes timing-audit metadata such as
VIDEO_DISPLAY_FORMAT,AUDIO_DISPLAY_FORMAT,VIDEO_FRAME_RATE, andAUDIO_SAMPLE_RATE. HAS_OBJECT_MASKreports whether Premiere currently sees any object mask usage on that sequence.- Display-format values are returned as stable DSL strings when known, otherwise as
UNKNOWN_*_TYPE_<number>so host drift stays visible.
See Also
- Premiere Reference Paths: Explains Premiere reference path strings for project items, sequences, tracks, timeline items, markers, components, and parameters.
Examples
Create Sequence From Local `.sqpreset` Path
Creates a sequence from a fixed local `.sqpreset` path. This stays visible as the canonical local-path counterpart to the portable embedded-preset example, and its runtime check confirms that the unusual 2000x1000 frame size really came from the preset.
Topics: sequence creation, presets, runtime validation
Source: patterns/ex-sequence-create-from-preset-fixed-path.json
Read Active Sequence Summary
Reads the active sequence name and video track count.
Topics: sequence inspection
Source: patterns/ex-sequence-read-active-summary.json
Render Active-Sequence Frames At Equal Distances To Fixed Folder
Exports a small evenly spaced set of `.png` frames across the active sequence to a fixed folder path, so visual timeline sampling can be runtime-validated deterministically.
Topics: frame export, visual probing, timeline sampling, runtime validation
Source: patterns/ex-sequence-render-active-sequence-frames-equal-distances-fixed-folder.json