EOIAddStreamInputs

Encapsulates inputs for the call to the EyesOnIt.AddStream method.

Namespace: EyesOnItSDK.Data.Inputs

Properties

Name	Type	Description
StreamUrl	string	the RTSP URL for the stream including credentials required to connect to the stream
Name	string	a friendly name for the stream used in the EyesOnIt Web UI and in alerts
Regions	EOIRegion[]	an array of rectangle detection regions
ObjectSize	int	the estimated object size in pixels
ObjectDescriptions	EOIObjectDescription[]	an array of object descriptions describing objects to detect
Alerting	EOIAlerting	the alerting settings for this stream
MotionDetection	EOIMotionDetection	the motion detection settings for this stream
BoundingBox	EOIBoundingBox	the common object detection settings for this stream
FrameRate	int?	the frame rate for this stream.

Constructor

Supports simple construction of an EOIAddStreamInputs object.

Signature 1

Creates an EOIAddStreamInputs object from provided parameters.

public EOIAddStreamInputs(
    string streamUrl,
    string name,
    EOIRegion[] regions,
    int objectSize,
    EOIObjectDescription[] objectDescriptions,
    EOIAlerting alerting,
    EOIMotionDetection motionDetection = null,
    EOIBoundingBox boundingBox = null,
    int? frameRate = 5)

Parameters

Name	Type	Description
streamUrl	string	the RTSP URL for the stream including credentials required to connect to the stream
name	string	a friendly name for the stream used in the EyesOnIt Web UI and in alerts
regions	EOIRegion[]	an array of rectangle detection regions
objectSize	int	the estimated object size in pixels
objectDescriptions	EOIObjectDescription[]	an array of object descriptions describing objects to detect
alerting	EOIAlerting	the alerting settings for this stream
motionDetection	EOIMotionDetection	the motion detection settings for this stream
boundingBox	EOIBoundingBox	the common object detection settings for this stream
frameRate	int?	the frame rate for this stream. Set

Signature 2

Creates an EOIAddStreamInputs object with default values

public EOIAddStreamInputs()

Parameters

This method has no parameters

Methods

ToJson

Provides a JSON representation of the EOIAddStreamInputs object

Signature

public string ToJson()

Parameters

This method does not have parameters

Return

Type: string - the JSON string representation of the EOIAddStreamInputs object

FromJson

Creates a EOIAddStreamInputs object from a JSON string

Signature

public static EOIAddStreamInputs FromJson(string jsonString)

Parameters

Name	Type	Description
jsonString	string	the JSON string representing a EOIAddStreamInputs object

Return

Type: EOIAddStreamInputs - the EOIAddStreamInputs object created from the JSON string