- URL:
- https://<root>/system/livestream
- Methods:
GET- Child Resources:
- Server Ports, Client Protocols, Server Protocols
- Version Introduced:
- 12.0
Description
The livestream resource shows all options for WebRTC, HTTPS, Secure Reliable Transport (SRT), User Datagram Protocol (UPD), Real-Time Messaging Protocol (RTMP, RTMPS), and Real-Time Streaming Protocol (RTSP, RTSPS) livestreams.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The response format. The default response format is Values: |
(Required) | Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation. |
Example usage
The following is a sample request URL used to access the livestream resource:
https://organization.example.com/<context>/admin/system/livestream?f=pjsonJSON Response syntax
{
"serverModeProtocols": {
"rtmp": "< true | false >",
"udp": "< true | false >",
"rtmpListen": "< true | false >",
"rtspListen": "< true | false >",
"webrtc": "< true | false >",
"srt": "< true | false >",
"srtListen": "< true | false >",
"rtsp": "< true | false >",
"udpListen": "< true | false >"
},
"livestreamPorts": {
"rangeMax": "<port>",
"rtspPort": "<port>",
"rangeMin": "<port>",
"rtmpPort": "<port>"
},
"clientModeProtocols": {
"rtmp": "< true | false >",
"rtmps": "< true | false >",
"rtsps": "< true | false >",
"rtsp": "< true | false >",
"https": "< true | false >"
}
}JSON Response example
{
"serverModeProtocols": {
"rtmp": true,
"udp": true,
"rtmpListen": true,
"rtspListen": true,
"webrtc": true,
"srt": true,
"srtListen": true,
"rtsp": true,
"udpListen": true
},
"livestreamPorts": {
"rangeMax": 65535,
"rtspPort": 554,
"rangeMin": 49152,
"rtmpPort": 1935
},
"clientModeProtocols": {
"rtmp": true,
"rtmps": true,
"rtsps": true,
"rtsp": true,
"https": true
}
}