Skip to main contentIBM Video Streaming Developers

Off Air Settings

Get Off Air Mode

Returns the current Off Air mode on a channel

GET https://api.video.ibm.com/channels/{channelId}/settings/off-air/mode.json

Success response

Upon success a response with HTTP status “200 OK” is returned with the following key-value pairs.

KEYTYPEDESCRIPTION
modestringOff Air mode

Possible values of mode:

KEYDESCRIPTION
lastLast video
selectedSelected videos
pictureSlideshow

Example of a success response:

{
"mode": "last"
}

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 Unauthorizedinvalid_tokenThe provided access token is missing, revoked, expired or malformed
403 Unauthorizedlack_of_ownershipThe provided access token could not access the given channel
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Set Off Air Mode

PUT https://api.video.ibm.com/channels/{channelId}/settings/off-air/mode.json

Parameters

KEYTYPEIMPORTANCEDESCRIPTION
modestringREQUIREDOff Air mode

The Content-Type of the request should be application/x-www-form-urlencoded.

Example of the request:

POST /channels/1234/settings/off-air/mode.json HTTP/1.1
Host: api.video.ibm.com
Authorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950
Content-Type: application/x-www-form-urlencoded
mode=picture

Note that the token in the above call is only an example.

Success response

Upon success the response body is empty with an HTTP Status code of 204.

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
400 Bad Requestbad_requestInvalid mode
401 Unauthorizedinvalid_tokenThe provided access token is missing, revoked, expired or malformed
403 Unauthorizedlack_of_ownershipThe provided access token could not access the given channel
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request