EOIStreamInfo
Represents information about a stream that is added to EyesOnIt.
Namespace: EyesOnItSDK.Data.Elements
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 and data for this stream |
MotionDetection | EOIMotionDetection | the motion detection settings for this stream |
BoundingBox | EOIBoundingBox | the common object detection settings for this stream |
Status | string | the status of the stream. Status values are explained here. |
FrameRate | int? | the frame rate for this stream. |
IsMonitoring | bool | read-only helper property indicating whether the stream is in the monitoring state |
IsAlerting | bool | read-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
Name | Type | Description |
---|---|---|
jsonString | string | the JSON string representing a EOIStreamInfo object |
Return
Type: List<EOIStreamInfo> - the EOIStreamInfo object created from the JSON string