Video methods: update
The Video Verbs update as typed SDK methods, with inputs, result, refusals and an example.
Reference for Video, one group of Video methods.
Video.update
Changes the given properties of a Video. Verb page.
interface VideoVerbs {
update(input: VideoUpdateInput, options?: SB.CallOptions): SB.Call<Video>
}Emits Video.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Video. |
timeline | json | The ordered scenes on a fixed grid, the only timing truth for picture, voice and captions. | |
brand | Brand | The Brand whose voice, palette and type the Video uses. | |
offer | Offer | The Offer the Video presents, when it presents one. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
video | Video | required | The Video. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const video = await $.Video.update({ id: 'video_xVlGG2TxBA', timeline: {} })