Video methods: draft, finalize
The Video Verbs draft, finalize as typed SDK methods, with inputs, result, refusals and an example.
Reference for Video, one group of Video methods.
Video.draft
Draft writes a Video’s timeline from a Startup’s records, its Brand and a Template, with a draft mark on every frame. Verb page.
interface VideoVerbs {
draft(input: VideoDraftInput, options?: SB.CallOptions): SB.Call<Video>
}Emits Video.drafted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
brand | Brand | required | The Brand the Video speaks for. |
offer | Offer | The Offer the Video presents. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
video | Video | required | The drafted Video, in status Draft. |
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.draft({ brand: 'brand_PluVQrB1HF' })Video.finalize
Finalize lifts a Video’s draft mark once every claim it makes reads from a live record, so its cuts can be published. Verb page.
interface VideoVerbs {
finalize(input: VideoFinalizeInput, options?: SB.CallOptions): SB.Call<Video>
}Emits Video.finalized.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
video | Video | required | The rendered Video to finalize. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
video | Video | required | The Video, in status Final. |
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.finalize({ video: 'video_xVlGG2TxBA' })