set-channel-sink-enable

Use the interface to turn on/off the output switch.

  • The output switch is on by default.
Only available for users with administrative rights.

Prototype

Protocol HTTP/HTTPS POST
URL ip[:port]/sc_cloud/channel/set-sink-enable
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. You can add stream tasks 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.
is-enable Whether the output switch is on.
  • 1: on
  • 0: off

Request Example

POST /sc_cloud/channel/set-sink-enable HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=utf-8
Content-Length: 44
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;
{
  "id": 13,
  "protocol": {
    "id": 25,
    "is-enable": 0
  }
}

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-enable

Response Example

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

results matching ""

    No results matching ""

    results matching ""

      No results matching ""