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
Copy to clipboard

Success response

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

KEY	TYPE	DESCRIPTION
`mode`	string	Off Air mode

Possible values of mode:

KEY	DESCRIPTION
`last`	Last video
`selected`	Selected videos
`picture`	Slideshow

Example of a success response:

{
  "mode": "last"
}
Copy to clipboard

Error responses

Possible error responses:

HTTP RESPONSE CODE	ERROR VALUE	ERROR CONDITIONS
401 Unauthorized	`invalid_token`	The provided access token is missing, revoked, expired or malformed
403 Unauthorized	`lack_of_ownership`	The provided access token could not access the given channel
503 Service Unavailable		There 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
Copy to clipboard

Parameters

KEY	TYPE	IMPORTANCE	DESCRIPTION
`mode`	string	REQUIRED	Off Air mode

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

Example of the request:

PUT /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
Copy to clipboard

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 CODE	ERROR VALUE	ERROR CONDITIONS
400 Bad Request	`bad_request`	Invalid `mode`
401 Unauthorized	`invalid_token`	The provided access token is missing, revoked, expired or malformed
403 Unauthorized	`lack_of_ownership`	The provided access token could not access the given channel
503 Service Unavailable		There is a temporary error on the server which makes it impossible to serve the request

Edit this page on GitHub

Channel page design: Cover image

Off Air Settings: Manage selected videos