Skip to navigation
VOS APIPlayout Backend

Toggle source input switch for an ON-AIR or OFF-AIR source when input redundancy is used

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

channelIdstringRequired
ID of the channel

Request

Target declaration to trigger a manual source input switch
inputRankIndexintegerRequired
Input rank to switch to. Value 1 or 2.
serviceIdstringRequired
Id of the service this command applies to.
sourceIdstringRequired
Id of the source this command applies to. This source shall contain 2 inputs.

Response

Toggle source input command triggered

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error