GetStreams
This method returns a list of all streams loaded on the server and brief information about each stream.
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
| |||||||||
uid | stream-uid-N | Unique stream identifier. | |||||||
bool | enabled | Indicates whether server connection to the stream is allowed or not (if not, live and dvr playback and recording are not available). | |||||||
bool | track_video | Indicates the existence of a video channel in the stream. | |||||||
bool | track_audio | Indicates the existence of an audio channel in the stream. | |||||||
bool | dvr_enabled | Indicates whether DVR recording and storage are allowed. | |||||||
str | type | Indicates whether the stream is primary or secondary. | |||||||
bool | dvr_paused | Indicates whether DVR recording and storage are paused. | |||||||
enum | status | Connection status to the stream. | |||||||
enum | access | Indicates 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. | |||||||
int | reconnect_attempt | Number of reconnection attempts since the last disconnection from the stream. | |||||||
int | reconnect_total | Total number of reconnection attempts since stream creation. | |||||||
bps | bitrate_in | Incoming stream bitrate. | |||||||
bps | bitrate_out | Total bitrate delivered to all clients connected to the stream. | |||||||
timestamp | src_ping_time | Time of the last successful connection attempt to the stream. | |||||||
timestamp | reconnect_time | Time when the stream will be reconnected. Only if the stream is inactive. | |||||||
int | clients_count | Number of clients connected to the stream for viewing. | |||||||
uid | camera_uid | Unique identifier of the virtual camera. | |||||||
string | title | Camera name. | |||||||
string | stream_name | Stream name. | |||||||
403 | API request authorization error. Invalid or missing access token. See Mediaserver/Web API/Authorization/CreateApiToken. |
Example | |||||||||
JSON
|