frame_number_range

The frame_number_range parameter is the position range in a video defined by zero-based frame numbers “start” and “stop”. The value of “stop” parameter is inclusive. Types are unsigned integers.

Example

This defines a frame range from frame 0 to frame 33, with total number of frames 34.

"frame_number_range" : {
    "start": 0,
    "stop": 33
}

frame_number

The frame_number parameter is the position in a video defined by zero-based frame number. Type is unsigned integer.

frame_spec

The frame_spec parameter specifies a frame number or a sequence of frame numbers in a video. The following three formats are recognized.

The first is a single frame number. The type is unsigned integer.

The second is an array of frame numbers. The type is unsigned integer.

The third is an object with three unsigned integers start, stop and step. The step parameter is optional and defaults to 1. The value of stop parameter is inclusive.

Frame numbers are zero-based.

Example

This defines a frame sequence consisting of a single frame number 33:

"frame_spec": 33

This defines a frame sequence 0,100,200 and 900:

"frame_spec": [ 0, 100, 200, 900 ]

In this example we define a frame sequence from frame 0 to frame 33, with (default) step 1 and the total number of frames equal to 34:

"frame_spec" : {
    "start": 0,
    "stop": 33
}

This defines a frame sequence from frame 0 to frame 33, with step 3 total number of frames equal to 12:

"frame_spec" : {
    "start": 0,
    "stop": 33,
    "step":  3
}

The following frame spec is equivalent to the one above:

"frame_spec": [0, 3, 6, 9, 12, 15, 18, 21, 24, 27, 30, 33 ]

time_fraction_range

The time_fraction_range is the position range in a video defined by two fractions of video duration, “start” and “stop”. The value of “stop” parameter is inclusive. Types are float.

Example

This defines a time frame range from 0.250 (end of 1st quarter of the video) to 0.500 (the middle of the video) :

"time_fraction_range" : {
    "start": 0.250,
    "stop":  0.500
}

time_fraction

The time_fraction is the position in a video defined by a fraction of video duration, with 0.0 being the beginning and 1.0 being the end of the video. Type is float.

time_offset_range

The time_offset_range parameter is the position range in a video defined by the times “start” and “stop” since the beginning of the video. The format for each is “[[HH:]MM:]SS[.n[n[…]]]”, where square brackets indicate optional elements.

Example

This defines a time offset range from 10min 5.250sec to 1h 0min 45.000sec:

"frame_offset_range" : {
    "start":   "10:05.250"
    "stop": "01:00:45.000"
}

time_offset

The time_offset parameter is the position in a video defined by the time since the beginning of the video. Type is string. Format is “[[HH:]MM:]SS[.n[n[…]]]”, where square brackets indicate optional elements.