EOIAPIUtils

A utility class that simplifies common operations with the EyesOnIt API.

Namespace: EyesOnItSDK

Properties

This class has no properties

Constructor

The constructor supports simple construction of an EOIAPIUtils object.

public EOIAPIUtils(EyesOnIt eoiAPI)

Methods

GetFrameFromStream

Gets a frame from a stream even if the stream has not been added to EyesOnIt or if the stream has been added but is not being monitored.

Signature

public async Task<EOIResponse> GetFrameFromStream(string streamUrl)

Parameters

Name	Type	Description
streamUrl	string	the RTSP URL of the stream from which to get a video frame

Return

Type: EOIResponse - the response object providing a success flag and other details. If successful, the frame is returned as a base64 encoded string in the Image property.

GetInfoForStream

Gets the information for a specific stream from a list of EOIStreamInfo objects

Signature

public static EOIStreamInfo GetInfoForStream(List<EOIStreamInfo> streamInfoList, string streamUrl)

Parameters

Name	Type	Description
streamInfoList	List<EOIStreamInfo>	the list of EOIStreamInfo objects from which to get a single EOIStreamInfo object.
streamUrl	string	the RTSP URL of the stream for which to get the stream information

Return

Type: EOIStreamInfo - the EOIStreamInfo object for the specified streamUrl or null if there is no stream info for the streamUrl.

GetMinimumRegionSize

Gets the minimum region size

Signature

public static Size GetMinimumRegionSize()

Parameters

This method has no parameters

Return

Type: Size - a Size object containing the minimum width and height of a region

GetJsonForAddStreamInputsList

Gets the JSON representation of a list of EOIAddStreamInputs objects

Signature

public static string GetJsonForAddStreamInputsList(List<EOIAddStreamInputs> addStreamInputsList)

Parameters

Name	Type	Description
addStreamInputsList	List<EOIAddStreamInputs>	the list of EOIAddStreamInputs objects for which to get the JSON representation.

Return

Type: string - the JSON string representing the list of EOIAddStreamInputs objects

GetAddStreamInputsListFromJson

Creates a list of EOIAddStreamInputs objects from a JSON string

Signature

public static List<EOIAddStreamInputs> GetAddStreamInputsListFromJson(string json)

Parameters

Name	Type	Description
json	string	a JSON string representing a list of EOIAddStreamInputs objects.

Return

Type: List<EOIAddStreamInputs> - a list of EOIAddStreamInputs objects constructed from the JSON string.