Encoder Commands

GET outputs/command/start/{encoder_id}/{device_id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Starts the desired encoder on a specific device in the stack, if defined.

Resource URL

http://{host}/api/2.0/outputs/command/start/{encoder_id}/{device_id}/.format

Example Request

GET

http://44.235.52.211/api/2.0/outputs/command/start/1/9011/.json

{
    "Task": {
        "id": 233046,
        "device_id": 9011,
        "type": "Toggle Encoder State",
        "type_id": 17,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "1612535089416"
    }
}

GET outputs/command/stop/{encoder_id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Stops an active encoder.

Resource URL

http://{host}/api/2.0/outputs/command/stop/{encoder_id}/.format

Parameters

Parameter	Data Type	Description
encoder_id (required)	integer	The ID of the desired encoder.

Example Request

GET

http://44.235.52.211/api/2.0/outputs/command/stop/1/.json

{
    "Task": {
        "id": 290706,
        "device_id": 9011,
        "type": "Toggle Encoder State",
        "type_id": 17,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "1612535003126"
    }
}

GET outputs/command/setSourceAudioPid/<encoder_id>/<channel_source_id>/<pid>

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Changes audio mosaic state.

Resource URL

http://{host}/api/2.0/outputs/command/setSourceAudioPid/<encoder_id>/<channel_source_id>/<pid>/.json

Example Request

GET

http://192.168.10.137/api/2.0/outputs/command/setSourceAudioPid/1/3/68/.json

{
    "success": true
}

GET outputs/command/clearSourceAudioPid/<encoder_id>

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Changes audio mosaic state.

Resource URL

http://{host}/api/2.0/outputs/command/setSourceAudioPid/<encoder_id>/<channel_source_id>/<pid>/.json

Example Request

GET

http://192.168.10.137/api/2.0/outputs/command/clearSourceAudioPid/1/.json

{
    "success": true
}