Skip to main content

get_video_frame

This endpoint gets a video frame from a stream that has been added to EyesOnIt and is being monitored.

Note: To get a video frame from a stream that is not being monitored, call monitor_stream to monitor the stream temporarily, then call GetVideoFrame, then call stop_monitoring_stream.

Method: POST

Endpoint: /get_video_frame

Body

{
"stream_url": "rtsp://192.168.1.54/live0"
}

Body Attribute Descriptions

NameTypeDescription
streamUrlstringthe RTSP URL of the stream from which to get a video frame. The stream must be in the monitoring state.

Response

{
"image": "<base64 encoded image string>",
}

Response Attribute Descriptions

NameTypeDescription
imagestringthe base64 encoded string reprentation of the frame retrieved from the stream