Skip to main content
Skip table of contents

GetStreams

This method returns a list of all streams loaded on the server and brief information about each stream.

GET /api/streams/
Body
tokenrequired
string
API request authorization token. See Mediaserver/Web API/Authorization/CreateApiToken.
Response
200
Returns a JSON array with a list of streams.
JSON
{
                "stream-uid-2": {
                    "video_width": 2560,
                    "broadcast_proto": [
                        "rtsp",
                        "hls"
                    ],
                    "reconnect_attempt": 0,
                    "video_height": 1440,
                    "bitrate_in": 4655808,
                    "uid": "stream-uid-2",
                    "bitrate_out": 0,
                    "broadcast_paused": false,
                    "src_ping_time": 1676641959,
                    "dvr_paused": false,
                    "bytes_in": 2758464316,
                    "clients_count": 0,
                    "enabled": true,
                    "status": "active",
                    "dvr_enabled": true,
                    "src_start_time": 1676638611,
                    "reconnect_total": 2,
                    "track_video": true,
                    "camera_uid": "stream-uid-2",
                    "reconnect_time": 0,
                    "stream_name": "stream-uid-2",
                    "type": "primary",
                    "track_audio": false,
                    "entry": "stream",
                    "access": "private"
                },
                "stream-uid-1": {
                    "video_width": 0,
                    "broadcast_proto": [
                        "rtsp",
                        "hls"
                    ],
                    "reconnect_attempt": 0,
                    "video_height": 0,
                    "bitrate_in": 0,
                    "uid": "stream-uid-1",
                    "bitrate_out": 0,
                    "broadcast_paused": false,
                    "src_ping_time": 0,
                    "dvr_paused": false,
                    "bytes_in": 0,
                    "clients_count": 0,
                    "enabled": true,
                    "status": "suspend",
                    "dvr_enabled": false,
                    "src_start_time": 0,
                    "reconnect_total": 0,
                    "track_video": true,
                    "camera_uid": "stream-uid-1",
                    "reconnect_time": 0,
                    "stream_name": "stream-uid-1",
                    "type": "secondary",
                    "track_audio": false,
                    "entry": "stream",
                    "access": "private"
                }
            }
uid
stream-uid-NUnique stream identifier.
bool
enabledIndicates whether server connection to the stream is allowed or not (if not, live and dvr playback and recording are not available).
bool
track_videoIndicates the existence of a video channel in the stream.
bool
track_audioIndicates the existence of an audio channel in the stream.
bool
dvr_enabledIndicates whether DVR recording and storage are allowed.
str
typeIndicates whether the stream is primary or secondary.
bool
dvr_pausedIndicates whether DVR recording and storage are paused.
enum
statusConnection status to the stream.
enum
accessIndicates the type of authentication clients must use when connecting to play the stream.

none - Clients cannot connect to the stream for viewing. However, capture functions and API operations are available.
public - No client authentication is required. Public stream; any client can view the stream from allowed IP addresses.
protected - Authentication with a username and password is required to connect to the stream.
private - An authorization token is required to connect to the stream. See: Mediaserver/Web API/Authorization/CreateAccessToken

int
reconnect_attemptNumber of reconnection attempts since the last disconnection from the stream.
int
reconnect_totalTotal number of reconnection attempts since stream creation.
bps
bitrate_inIncoming stream bitrate.
bps
bitrate_outTotal bitrate delivered to all clients connected to the stream.
timestamp
src_ping_timeTime of the last successful connection attempt to the stream.
timestamp
reconnect_timeTime when the stream will be reconnected. Only if the stream is inactive.
int
clients_countNumber of clients connected to the stream for viewing.
uid
camera_uidUnique identifier of the virtual camera.
string
titleCamera name.
string
stream_nameStream name.
403
API request authorization error. Invalid or missing access token. See Mediaserver/Web API/Authorization/CreateApiToken.
Example
JSON
curl -k --location --request GET 'https://localhost:8080/api/streams/?token=string'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.