Activate Video CDN and get embed settings
Activate Video CDN and get embed settings
Activates the Video CDN for a file if it is not active yet, then returns its embed code in the same call. The embed code is stable from the moment the Video CDN exists; the player shows a notice until the conversion has finished (see status).
Request
- Base URLhttps://api.kontainer.com/jsonapi/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of file
Query parameters
Should video autoplay
Should video loop
Should video be muted
Should video hide player controls
Should video player show download to original file
Show a thumbnail in the video player before playback.
Should video be scaled to fit the player window
Should subtitles be shown by default
Wrap the embed code in a labelled section with schema.org VideoObject metadata (SEO, screen readers, WCAG 2.2 AA). Title and description come from the custom fields marked as CDN title / CDN description, falling back to the file name and file description.
Width of the video player in pixels, at least 1
Height of the video player in pixels, at least 1
ID of a video player preset. Options not given explicitly are taken from the preset.
Hex colour of the play button and progress bar, e.g. #8b0000. Overrides the preset colour and the brand of the video's folder
Response
Video CDN was already active
Changes
No recorded changes to this operation across all 1 revision of this API.