About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Customize player branding
Control the branding of the player by uploading your own logo and removing the IBM watermark.
TYPE | DESCRIPTION |
---|---|
co-branding | Display your logo in the player. |
full branding | Display your logo in the player and remove the IBM watermark. |
no branding | Remove the IBM watermark without uploading a logo (white label player). |
Check branding type
Get the type of player branding set on a channel.
GET https://api.video.ibm.com/channels/{channel_id}/branding.json
Parameters
This request has no parameters.
Success response
Upon success, a set of key-value pair is returned under a branding
element.
KEY | TYPE | DESCRIPTION |
---|---|---|
type | string | The type of branding set on the channel. Possible values: co (co-branding), full (full-branding) or no (no branding). The disabled value is returned if player branding is not set for the channel. |
Example of a success response:
{"branding": {"type": "full"}}
Error responses
Possible error responses:
HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
---|---|---|
401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
402 Payment Required | invalid_request | The user does not have the benefit |
404 Not Found | not_found | Channel not found |
503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Set branding type
Set the type of player branding on a channel and enable the feature.
PUT https://api.video.ibm.com/channels/{channel_id}/branding.json
Parameters
The parameters for the PUT request:
PARAMETER | TYPE | IMPORTANCE | DESCRIPTION |
---|---|---|---|
type | string | REQUIRED | The type of branding set on the channel. Supported values: co (co-branding), full (full-branding) or no (no branding). |
Success response
Upon success a response with HTTP status “200 OK” is returned.
Error responses
Possible error responses:
HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
---|---|---|
400 Bad Request | input_type | The specified type is invalid or unsupported |
401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
402 Payment Required | invalid_request | The user does not have the embed_restriction benefit |
403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel |
404 Not Found | not_found | Channel not found |
503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Disable branding
Removes custom branding. Only the IBM watermark will be displayed in the player.
DELETE https://api.video.ibm.com/channels/{channel_id}/branding.json
Parameters
This request has no parameters.
Success response
Upon success a response with HTTP status “200 OK” is returned.
Error responses
This request has no error responses.
Upload logo
Upload the image file of the logo for custom branding.
PUT https://api.video.ibm.com/channels/{channel_id}/branding/logo/0.json
Request
The logo must be passed in the HTTP body. Supported image types are image/jpeg, image/png, image/gif. Maximum dimension for the images are 288 x 96 pixels. Maximum file size is 10 MB.
Success response
Upon success a response with HTTP status “200 OK” is returned.
Error responses
Possible error responses:
HTTP RESPONSE CODE | ERROR VALUE | ERROR CONDITIONS |
---|---|---|
400 Bad Request | invalid_file | Validation failed |
400 Bad Request | invalid_image | |
401 Unauthorized | The provided access token is missing, revoked, expired or malformed | |
402 Payment Required | invalid_request | The user does not have the benefit. |
403 Forbidden | lack_of_ownership | The API user is not allowed to manage the given channel |
404 Not Found | not_found | Channel not found |
503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |