Skip to main content

get_video_frame

This endpoint gets the current video frame from an RTSP URL.

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

{
"success": true,
"message": null,
"data": {
"image": "base64-encoded image string",
}
}

Response Attribute Descriptions

NameTypeDescription
successbooleantrue if the operation was successful. false otherwise.
messagestringa human readable message describing the operation result
dataJSONprovides JSON data related to the last detection(s) for the specified video stream as described below

Data Object Attributes

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