Ir para o conteúdo

Comandos

text.set

Changes the content or the style of a text item.

Última atualização:

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

Replaces the text, merges a partial style into the stored one (null removes a key), or empties the style first with reset_style. At least one of text, style and reset_style is required.

Arguments#

ArgumentTypeRequiredDescription
item_idstringyesA text item.
reset_stylebooleannoEmpty the stored style before applying style.
styleobjectnoA partial TextStyle, merged; null removes a key.
textstringno

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": "text.set",
  "args": {
    "item_id": "itm_s6t7v8w9x0",
    "style": {
      "color": "#FFE600"
    },
    "text": "Hello world"
  }
}

Errors#

E_VALIDATION, E_NOT_FOUND, E_TYPE_MISMATCH, E_FONT_UNKNOWN

Scope and phase#

Scope edit, phase prototype. Run vukem-video command:help text.set for the same description from the binary.