Skip to main content

EOIAddStreamInputs

eyesonit-typescript-sdk

eyesonit-typescript-sdk / EOIAddStreamInputs

Class: EOIAddStreamInputs

Request payload for registering a stream and its monitoring configuration.

Extends​

Constructors​

Constructor​

new EOIAddStreamInputs(stream_url, name, frame_rate, index_for_search, search_index_types, regions, lines, notification, recording, effects): EOIAddStreamInputs

Parameters​

stream_url​

string

RTSP URL for the stream.

name​

string

Stream display name. Minimum length: 3.

frame_rate​

number = 5

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

boolean

Whether this stream should be indexed 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

notification​

Optional notification settings (for example phone alerting).

EOINotification | undefined

recording​

Optional recording settings.

EOIRecording | undefined

effects​

Optional visual effect overlays for output frames.

EOIEffects | undefined

Returns​

EOIAddStreamInputs

Overrides​

EOIBaseInputs.constructor

Properties​

stream_url​

stream_url: string

RTSP URL for the stream.

name​

name: string

Stream display name. Minimum length: 3.

frame_rate​

frame_rate: number = 5

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

index_for_search​

index_for_search: boolean

Whether this stream should be indexed 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.

notification​

notification: EOINotification | undefined

Optional notification settings (for example phone alerting).

recording​

recording: EOIRecording | undefined

Optional recording settings.

effects​

effects: EOIEffects | undefined

Optional visual effect overlays for output frames.

Methods​

fromJsonObj()​

static fromJsonObj(obj): EOIAddStreamInputs | null

Parameters​

obj​

any

Returns​

EOIAddStreamInputs | null

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