set-srt-settings
Use the interface to configure SRT server.
Only available for users with administrative rights.
SRT server cautions
- Use SRT Caller to pull and push.
- The port, stream name, security enhancements (encryption and its passphrase) must be the same.
Stream ID formats are as follows.
Push ID: <upload_domain_name>/live/<Stream_name>
pull ID: <play_domain_name>live/<Stream_name>
- The SRT pull and push clients should be pinged. They can be either applications or hardwares.
The SRT pull and push clients do not need to register to Cloud platform.
Prototype
Protocol |
HTTP/HTTPS POST |
URL |
ip[:port]/sc_cloud/srtserver/set-settings |
Data Format |
Request: Content-Type: application/json Response: Content-Type: application/json |
Request Cookies
Parameter |
Description |
mwcloud-sid |
A string value that is used to uniquely identify user logged-in. |
mwcloud-uid |
Current logged-in username. |
Request Body
Parameter |
Description |
port |
Port number ranges from 1024 to 65535. |
domain_player |
Play domain name. |
domain_publisher |
Upload domain name. |
pbkeylen |
Stream is not encrypted by default. The options are as follows:- 0: not encrypted
- 16: AES-128
- 24: AES-192
- 32: AES-256
|
passphrase |
Encryption passphrase. It is 10 to 79 characters when pbkeylen is 0. |
app_player_name |
Play app name. |
app_publisher_name |
Upload app name. |
idle_streams_timeout |
Timeout. |
latency |
Latency time. |
max_connections |
The maximum number of connections. |
Upload ID: <domain_publisher>/<app_publisher_name>/<stream_name>
Play ID: <domain_player>/<app_player_name>/<stream_name>
Request Example
POST /sc_cloud/srtserver/set-settings HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=utf-8
Content-Length: 227
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;
{
"app_player_name": "live",
"app_publisher_name": "live",
"domain_player": "play.srt",
"domain_publisher": "upload.srt",
"idle_streams_timeout": 10,
"latency": 20,
"port": 8001,
"max_connections": 20,
"pbkeylen": 16,
"passphrase": "111111111111"
}
Response Parameters
Parameter |
Description |
Content-Type |
Value: 'application/json; charset=UTF-8' |
Response Body
Parameter |
Description |
result |
Result code. The options are as follows:- 0: success.
- Other values. For details about the result codes, please refer to API Status.
|
method |
set-srt-settings |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 40
Connection: keep-alive
{
"method": "set-srt-settings",
"result": 0
}