Ir para o conteúdo

Comandos

template.set_info

Sets the description and the named colours of the template.

Última atualização:

Esta referência é gerada a partir do programa e está em inglês.

Sets the description and adds, replaces or (with null) removes named colours. A colour that a style, a shape or the background still refers to as "$name" cannot be removed. A document that has no template gets one.

Arguments#

ArgumentTypeRequiredDescription
colorsobjectnoName to #RRGGBB or #RRGGBBAA; null removes the name.
descriptionstringno0 to 500 characters.

Example#

As one operation of an edit batch (the edit tool of MCP, vukem-video edit --ops, or POST /api/v1/projects/{id}/edit):

JSON
{
  "op": "template.set_info",
  "args": {
    "colors": {
      "brand": "#ff3366",
      "old": null
    },
    "description": "Product teaser"
  }
}

Errors#

E_VALIDATION, E_IN_USE

Scope and phase#

Scope edit, phase alpha. Run vukem-video command:help template.set_info for the same description from the binary.