Skip to main content

EOIProcessVideoInputs

eyesonit-typescript-sdk

eyesonit-typescript-sdk / EOIProcessVideoInputs

Class: EOIProcessVideoInputs

Request payload for processing one or more video files.

Extends​

Constructors​

Constructor​

new EOIProcessVideoInputs(name, input_video_path, rotate_video, output_video_path, frame_rate, index_for_search, search_index_types, regions, lines, real_time, video_start_interval, output_all_frames, effects, recording, video_start_local_time, start_seconds, end_seconds, mode, base_image_path, plugins, validation): EOIProcessVideoInputs

Parameters​

name​

string

Job/display name for the video process request. Minimum length: 3.

input_video_path​

string

Input video file to process.

rotate_video​

number

Degrees to rotate the video before processing. Must be 0, 90, 180 or 270.

output_video_path​

string

Output path for generated/annotated video.

frame_rate​

number = 5

Processing frame rate. Default: 5. Minimum: 1.

boolean

Whether to index results for archive search.

search_index_types​

string[] = []

Search index types to build when indexing is enabled.

regions​

EOIRegion[]

Detection regions and configuration.

lines​

Optional named lines used by line-cross conditions.

EOILine[] | undefined

real_time​

boolean = false

Enables real-time style pacing while processing.

video_start_interval​

number = 0

Offset interval for scheduling/segment logic.

output_all_frames​

boolean = true

Whether all frames should be written to output.

effects​

Optional visual effects/overlays configuration.

EOIEffects | undefined

recording​

Optional recording configuration.

EOIRecording | undefined

video_start_local_time​

string

Start time in ISO date-time format.

start_seconds​

number

Optional trim start offset in seconds.

end_seconds​

number

Optional trim end offset in seconds.

mode​

string = "KNOWN_OBJECT_DETECTION"

Processing mode. Default: KNOWN_OBJECT_DETECTION.

base_image_path​

Optional base image path used by selected modes/plugins.

string | undefined

plugins​

object

Optional plugin configuration object.

validation​

EOIValidation

Optional output validation configuration.

Returns​

EOIProcessVideoInputs

Overrides​

EOIBaseInputs.constructor

Properties​

name​

name: string

Job/display name for the video process request. Minimum length: 3.

input_video_path​

input_video_path: string

Input video file to process.

rotate_video​

rotate_video: number

Degrees to rotate the video before processing. Must be 0, 90, 180 or 270.

output_video_path​

output_video_path: string

Output path for generated/annotated video.

frame_rate​

frame_rate: number = 5

Processing frame rate. Default: 5. Minimum: 1.

index_for_search​

index_for_search: boolean

Whether to index results for archive search.

search_index_types​

search_index_types: string[] = []

Search index types to build when indexing is enabled.

regions​

regions: EOIRegion[]

Detection regions and configuration.

Inherited from​

EOIBaseInputs.regions

lines​

lines: EOILine[] | undefined

Optional named lines used by line-cross conditions.

real_time​

real_time: boolean = false

Enables real-time style pacing while processing.

video_start_interval​

video_start_interval: number = 0

Offset interval for scheduling/segment logic.

output_all_frames​

output_all_frames: boolean = true

Whether all frames should be written to output.

effects​

effects: EOIEffects | undefined

Optional visual effects/overlays configuration.

recording​

recording: EOIRecording | undefined

Optional recording configuration.

video_start_local_time​

video_start_local_time: string

Start time in ISO date-time format.

start_seconds​

start_seconds: number

Optional trim start offset in seconds.

end_seconds​

end_seconds: number

Optional trim end offset in seconds.

mode​

mode: string = "KNOWN_OBJECT_DETECTION"

Processing mode. Default: KNOWN_OBJECT_DETECTION.

base_image_path​

base_image_path: string | undefined = undefined

Optional base image path used by selected modes/plugins.

plugins​

plugins: object

Optional plugin configuration object.

validation​

validation: EOIValidation

Optional output validation configuration.

Methods​

fromJsonObj()​

static fromJsonObj(obj): EOIProcessVideoInputs

Parameters​

obj​

any

Returns​

EOIProcessVideoInputs

stringify()​

stringify(): string

Serializes this payload for the API request body. The serializer excludes nested confidence values.

Returns​

string

validate()​

validate(): EOIResponse

Validates this payload against SDK-side constraints.

Returns​

EOIResponse