set-channel-sink-name

Use the interface to modify output stream name.

Only available for users with administrative rights.

Prototype

Protocol HTTP/HTTPS POST
URL ip[:port]/sc_cloud/channel/set-sink-name
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
id Stream ID which you can add by using add-channel and obtain the IDs by using get-channels.
protocol Detailed information of protocol stream.
protocol
Parameter Description
id Output stream ID which you can add by using add-channel-sink and obtain by using get-channels.
name New output stream name. The string range is as follows.
  • 1 to 32 characters;
  • uppercase and lowercase letters, numbers, special symbols including ._-+'[]() and spaces.
  • It can not start or end with spaces.

Request Example

POST /sc_cloud/channel/set-sink-name HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=utf-8
Content-Length: 61
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;
{
  "id": 13,
  "protocol": {
    "id": 26,
    "name": "new output name"
  }
}

Response Parameters

Response Header
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-channel-sink-name

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 40
Connection: keep-alive
{
  "method": "set-channel-sink-name",
  "result": 0
}

results matching ""

    No results matching ""

    results matching ""

      No results matching ""