Fields
Every value a rule can read, by scope.
Fields are the only data a rule can see. A condition, a message placeholder or a data entry names a field by its path, and the path is checked when the rule loads: a field that its scope does not expose is an error.
Times are integer ticks (254,016,000,000 per second) unless the name says frames, seconds or timecode. A type ending in ? means the value can be unknown: the timeline did not have it (no source media, the scale of an audio clip, an in point that is not set). See Unknown values.
Besides these, every rule reads its own options as options.<name> (see Options).
sequence
Available in every scope.
| Field | Type | Description |
|---|---|---|
sequence.id | string | Sequence GUID. |
sequence.name | string | Sequence name. |
sequence.fps | number | Frame rate (frames per second). |
sequence.frameDuration | number | Ticks per frame. |
sequence.frameWidth | number | Frame width in pixels. |
sequence.frameHeight | number | Frame height in pixels. |
sequence.end | number | End of the last clip (ticks). |
sequence.endTimecode | string | End of the last clip as timecode. |
sequence.durationSeconds | number | End of the last clip in seconds. |
sequence.inPoint | number? | Sequence in point (ticks), unknown when not set. |
sequence.outPoint | number? | Sequence out point (ticks), unknown when not set. |
sequence.inPointTimecode | string? | Sequence in point as timecode, unknown when not set. |
sequence.outPointTimecode | string? | Sequence out point as timecode, unknown when not set. |
sequence.inPointFrameOffset | number? | Ticks between the in point and the frame boundary before it (0 = on a frame); unknown when not set. |
sequence.outPointFrameOffset | number? | Ticks between the out point and the frame boundary before it (0 = on a frame); unknown when not set. |
sequence.videoTrackCount | number | Number of video tracks. |
sequence.audioTrackCount | number | Number of audio tracks. |
sequence.clipCount | number | Number of clips on all tracks. |
sequence.markerCount | number | Number of sequence markers. |
track
Available in the track, clip, effect scopes.
| Field | Type | Description |
|---|---|---|
track.ref | string | Track as shown in Premiere: "V1", "A2". |
track.type | string | "video" or "audio". |
track.index | number | Zero-based index among tracks of its type. |
track.name | string | Track name. |
track.muted | boolean | Track is muted. |
track.clipCount | number | Number of clips on the track. |
track.audibleClipCount | number | Clips that would play: enabled, and for audio not silenced (-∞ dB). |
track.firstClipStart | number? | Start of the first clip (ticks); unknown on an empty track. |
track.beyondLastUsed | boolean | No track of the same type with a higher index carries clips. |
clip
Available in the clip, effect scopes.
| Field | Type | Description |
|---|---|---|
clip.id | string | Clip id: "V1:<start>". |
clip.name | string | Clip name. |
clip.track | string | Clip track as shown in Premiere: "V1", "A2". |
clip.trackType | string | "video" or "audio". |
clip.trackIndex | number | Zero-based index of the clip's track. |
clip.start | number | Start in sequence time (ticks). |
clip.end | number | End in sequence time (ticks). |
clip.startFrameOffset | number | Ticks between the start and the frame boundary before it (0 = on a frame). |
clip.endFrameOffset | number | Ticks between the end and the frame boundary before it (0 = on a frame). |
clip.startTimecode | string | Start as timecode. |
clip.endTimecode | string | End as timecode. |
clip.duration | number | Duration in ticks (end - start). |
clip.durationFrames | number | Duration in whole frames of the sequence. |
clip.durationSeconds | number | Duration in seconds. |
clip.inPoint | number | Source in point (ticks). |
clip.outPoint | number | Source out point (ticks). |
clip.speed | number | Playback speed, 1 = 100 %. |
clip.reversed | boolean | Plays in reverse. |
clip.disabled | boolean | Clip is disabled. |
clip.effectCount | number | Number of user-applied effects. |
clip.source.projectItemId | string? | Project item id; unknown without a source. |
clip.source.name | string? | Project item name; unknown without a source. |
clip.source.kind | string? | "media", "sequence", "multicam" or "merged"; unknown without a source. |
clip.source.mediaPath | string? | Media file path; unknown when empty or without a source. |
clip.source.offline | boolean? | Source media is offline; unknown without a source. |
clip.source.extension | string? | Lower-case extension of the media path without the dot ("mov"); unknown without a path or an extension. |
clip.adjustmentLayer | boolean | Clip is an adjustment layer (false for audio clips). |
clip.scale | number? | Motion scale in percent at clip start (video, uniform scale only). |
clip.scaleAnimated | boolean? | Scale is keyframed (video). |
clip.rotation | number? | Rotation in degrees at clip start (video). |
clip.rotationAnimated | boolean? | Rotation is keyframed (video). |
clip.opacity | number? | Opacity in percent at clip start (video). |
clip.opacityAnimated | boolean? | Opacity is keyframed (video). |
clip.volume | number? | Volume setting in dB at clip start (audio). |
clip.volumeAnimated | boolean? | Volume is keyframed (audio). |
effect
Available in the effect scope.
| Field | Type | Description |
|---|---|---|
effect.index | number | Position in the clip's effect chain, from 0. |
effect.matchName | string | Premiere match name, stable across languages: "AE.ADBE Lumetri". |
effect.displayName | string | Name shown in Premiere, in its UI language. |
effect.count | number | Effects with this match name on the clip. |
effect.firstOfKind | boolean | No earlier effect of the clip has this match name. |
marker
Available in the marker scope.
| Field | Type | Description |
|---|---|---|
marker.id | string | Marker id. |
marker.name | string | Marker name. |
marker.named | boolean | The name is not blank. |
marker.type | string | "Comment", "Chapter", "WebLink", … |
marker.comments | string | Marker comment. |
marker.colorIndex | number | Color index. |
marker.start | number | Start in sequence time (ticks). |
marker.startTimecode | string | Start as timecode. |
marker.duration | number | Duration in ticks (0 for a point marker). |