Skip to main content

sdk.videoapi

Home > @kittl/sdk > VideoAPI

VideoAPI interface

Signature:

export interface VideoAPI 

Methods

Method

Description

addVideo(params, opts)

Creates a new video element within the design

A video contains a list of video clips called a playlist. For now we only support one clip.

The video will be created with the dimensions of the first clip in the playlist (if available) You can also create a video with a generation ID and generating state, which will show a loading state until the video is updated with an object name and the generation is complete.

It supports both absolute and relative positioning as well as custom sizing.

updateVideo(params, opts)

Updates an existing video in the design

You can update the playlist of a video.

You can also update the generation ID and generating state, which will show a loading state until the video is updated with an object name and the generation is complete.