Skip to main content

EOIStreamInfo

Represents information about a stream that is added to EyesOnIt.

Namespace: EyesOnItSDK.Data.Elements

Properties

NameTypeDescription
StreamUrlstringthe RTSP URL for the stream including credentials required to connect to the stream
Namestringa friendly name for the stream used in the EyesOnIt Web UI and in alerts
RegionsEOIRegion[]an array of rectangle detection regions
ObjectSizeintthe estimated object size in pixels
ObjectDescriptionsEOIObjectDescription[]an array of object descriptions describing objects to detect
AlertingEOIAlertingthe alerting settings and data for this stream
MotionDetectionEOIMotionDetectionthe motion detection settings for this stream
BoundingBoxEOIBoundingBoxthe common object detection settings for this stream
Statusstringthe status of the stream. Status values are explained here.
FrameRateint?the frame rate for this stream.
IsMonitoringboolread-only helper property indicating whether the stream is in the monitoring state
IsAlertingboolread-only helper property indicating whether the stream is in the alerting state

Methods

ToJson

Provides a JSON representation of the EOIStreamInfo object

Signature

public ToJson()

Parameters

This method does not have parameters

Return

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

FromJson

Creates a list of EOIStreamInfo objects from a JSON string

Signature

public static List<EOIStreamInfo> FromJson(string jsonString)

Parameters

NameTypeDescription
jsonStringstringthe JSON string representing a EOIStreamInfo object

Return

Type: List<EOIStreamInfo> - the EOIStreamInfo object created from the JSON string