openrv-web / SequenceAPI

Class: SequenceAPI

Defined in: api/SequenceAPI.ts:12

Constructors

Constructor

new SequenceAPI(session): SequenceAPI

Defined in: api/SequenceAPI.ts:15

Parameters

session

Session

Returns

SequenceAPI

Methods

detectMissingFrames()

detectMissingFrames(): number[]

Defined in: api/SequenceAPI.ts:44

Return a list of missing frame numbers in the active sequence.

Missing frames are gaps between the start and end frame numbers of the loaded image sequence.

Returns

number[]

An array of missing frame numbers, or an empty array if no sequence is loaded or there are no gaps.

Example

const missing = openrv.sequence.detectMissingFrames();
// e.g. [5, 12, 13]

---

getFrameRange()

getFrameRange(): { end: number; start: number; } | null

Defined in: api/SequenceAPI.ts:114

Get the frame range of the active sequence.

Returns

{ end: number; start: number; } | null

An object with start and end frame numbers, or null if no sequence is loaded.

Example

const range = openrv.sequence.getFrameRange();
// e.g. { start: 1, end: 100 }

---

getPattern()

getPattern(): string | null

Defined in: api/SequenceAPI.ts:98

Get the naming pattern of the active sequence.

Returns

string | null

The detected pattern string (e.g., "frame_####.png"), or null if no sequence is loaded.

Example

const pattern = openrv.sequence.getPattern(); // e.g. "frame_####.png"

---

isFrameMissing()

isFrameMissing(frame): boolean

Defined in: api/SequenceAPI.ts:65

Check whether a specific frame number is missing in the active sequence.

Parameters

frame

number

The frame number to check (uses the original frame numbering from filenames, not the 0-based index).

Returns

boolean

true if the frame is absent from the sequence, false if it is present or if no sequence is loaded.

Example

if (openrv.sequence.isFrameMissing(5)) {
  console.log('Frame 5 is missing');
}

---

isSequence()

isSequence(): boolean

Defined in: api/SequenceAPI.ts:83

Check whether the current source is an image sequence.

Returns

boolean

true if the active source is a sequence, false otherwise.

Example

if (openrv.sequence.isSequence()) {
  console.log('Current source is a sequence');
}