IBM Captioning for Live Streaming
Check if IBM Captioning is enabled
GET https://api.video.ibm.com/channels/{channelId}/settings/watson-live-captioning.json
Success response
Upon success a response with HTTP status “200 OK” is returned with the following key-value pairs.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
is_enabled | boolean | IBM Captioning is enabled |
Example of a success response:
{"is_enabled": true,}
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 |
| 402 Payment required | payment_required | The required benefit is missing from the channel |
| 403 Unauthorized | lack_of_ownership | The provided access token could not access the given channel |
| 404 Not Found | not_found | Channel was not found |
| 405 Method Not Allowed | method_not_allowed | The given HTTP method is not allowed for the endpoint |
| 429 Too Many Requests | too_many_requests | Rate limit exceeded (Read more) |
| 500 Server error | There is a temporary error on the server which makes it impossible to serve the request | |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Turn on/off IBM Captioning
PUT https://api.video.ibm.com/channels/{channelId}/settings/watson-live-captioning.json
Parameters
| KEY | TYPE | IMPORTANCE | DESCRIPTION |
|---|---|---|---|
enable | string | REQUIRED | true/false |
The Content-Type of the request should be application/x-www-form-urlencoded.
Example of the request:
POST /channels/1234/settings/watson-live-captioning.json HTTP/1.1Host: api.video.ibm.comAuthorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950Content-Type: application/x-www-form-urlencodedenable=true
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 | form_error | The provided request body is invalid |
| 401 Unauthorized | invalid_token | The provided access token is missing, revoked, expired or malformed |
| 402 Payment required | payment_required | The required benefit is missing from the channel |
| 403 Unauthorized | lack_of_ownership | The provided access token could not access the given channel |
| 404 Not Found | not_found | Channel was not found |
| 405 Method Not Allowed | method_not_allowed | The given HTTP method is not allowed for the endpoint |
| 429 Too Many Requests | too_many_requests | Rate limit exceeded (Read more) |
| 500 Server error | There is a temporary error on the server which makes it impossible to serve the request | |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |