功能简介
添加文字到草稿,支持丰富的文字样式设置,包括字体、颜色、描边、背景、阴影、动画等效果。可以为视频添加标题、字幕、说明文字等。
使用场景
- 需要为视频添加标题或说明文字
- 需要添加带样式的文字效果
- 需要添加带动画的文字
- 需要添加花字或气泡文字效果
参数说明
输入参数
基础参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 文本内容 | 字符串 | 是 | 要显示的文本内容 |
| 起始时间 | 小数 | 是 | 文本开始显示的时间,单位:秒 |
| 结束时间 | 小数 | 是 | 文本结束显示的时间,单位:秒 |
| 草稿ID | 字符串 | 否 | 目标草稿的ID,不填则创建新草稿 |
位置和变换参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 垂直偏移 | 小数 | 否 | 垂直方向的偏移(相对值),单位为半个画布高,范围-1.0到1.0,默认0表示居中 |
| 垂直偏移_像素 | 整数 | 否 | 垂直方向的偏移(像素值),单位:像素 |
| 水平偏移 | 小数 | 否 | 水平方向的偏移(相对值),单位为半个画布宽,范围-1.0到1.0,默认0表示居中 |
| 水平偏移_像素 | 整数 | 否 | 水平方向的偏移(像素值),单位:像素 |
| 水平缩放 | 小数 | 否 | 水平方向的缩放比例,1.0为原始大小,默认1 |
| 垂直缩放 | 小数 | 否 | 垂直方向的缩放比例,1.0为原始大小,默认1 |
| 旋转角度 | 小数 | 否 | 文本的旋转角度,单位:度,默认0 |
字体参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 字体名称 | 字符串 | 否 | 字体名称,通过【获取字体类型】指令来获取,默认"系统" |
| 字体大小 | 整数 | 否 | 字体大小,默认8 |
| 字体颜色 | 字符串 | 否 | 字体颜色,十六进制格式,默认#FF0000(红色) |
| 字体透明度 | 小数 | 否 | 字体透明度,范围0.0-1.0,默认1.0表示完全不透明 |
| 对齐方式 | 整数 | 否 | 文本对齐方式,0左对齐,1居中,2右对齐,默认1(居中) |
| 是否垂直显示 | 布尔值 | 否 | 是否垂直显示文本,默认false |
| 字符间距 | 整数 | 否 | 字符之间的间距 |
| 行间距 | 整数 | 否 | 行与行之间的间距 |
描边参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 描边宽度 | 整数 | 否 | 描边宽度,0表示无描边,默认0 |
| 描边颜色 | 字符串 | 否 | 描边颜色,十六进制格式,默认#000000(黑色) |
| 描边透明度 | 小数 | 否 | 描边透明度,范围0.0-1.0,1.0为完全不透明(默认值),0.0为完全透明 |
背景参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 背景颜色 | 字符串 | 否 | 背景颜色,十六进制格式,默认#000000(黑色) |
| 背景样式 | 整数 | 否 | 背景样式,默认0 |
| 背景透明度 | 小数 | 否 | 背景透明度,范围0.0-1.0,默认0.0表示完全透明 |
| 背景圆角 | 小数 | 否 | 背景圆角,范围0.0-1.0,默认0 |
| 背景高度 | 小数 | 否 | 背景高度占画布的比例,范围0.0-1.0,默认0.14 |
| 背景宽度 | 小数 | 否 | 背景宽度占画布的比例,范围0.0-1.0,默认0.14 |
| 背景X偏移 | 小数 | 否 | 背景水平偏移,范围0.0-1.0,默认0.5表示居中 |
| 背景Y偏移 | 小数 | 否 | 背景垂直偏移,范围0.0-1.0,默认0.5表示居中 |
阴影参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 是否启用阴影 | 布尔值 | 否 | 是否启用阴影效果,默认false |
| 阴影颜色 | 字符串 | 否 | 阴影颜色,十六进制格式,默认#000000(黑色) |
| 阴影透明度 | 小数 | 否 | 阴影透明度,范围0.0-1.0,0.9为默认值,0.0为完全透明,1.0为完全不透明 |
| 阴影角度 | 小数 | 否 | 阴影角度,范围-180.0~180.0,单位:度,默认-45.0 |
| 阴影距离 | 整数 | 否 | 阴影距离,范围0-100,默认5 |
| 阴影平滑度 | 小数 | 否 | 阴影平滑度,范围0.0-1.0,默认0.15 |
动画参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 入场动画名称 | 字符串 | 否 | 入场动画名称,通过【获取文本入场动画类型】指令来获取 |
| 入场动画时长 | 小数 | 否 | 入场动画的持续时间,单位:秒,默认0.5 |
| 出场动画名称 | 字符串 | 否 | 出场动画名称,通过【获取文本出场动画类型】指令来获取 |
| 出场动画时长 | 小数 | 否 | 出场动画的持续时间,单位:秒,默认0.5 |
| 循环动画名称 | 字符串 | 否 | 循环动画名称,通过【获取文本循环动画类型】指令来获取 |
| 循环动画时长 | 小数 | 否 | 循环动画的持续时间,单位:秒 |
特殊效果参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 花字效果ID | 字符串 | 否 | 花字效果ID,通过【搜索花字】指令来获取 |
| 气泡效果ID | 字符串 | 否 | 气泡效果ID |
| 气泡资源ID | 字符串 | 否 | 气泡资源ID |
其他参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 轨道名称 | 字符串 | 否 | 文本所在的轨道名称,默认text_main。设置为main则位于主轨道 |
| 轨道相对位置 | 整数 | 否 | 轨道相对位置,数值越大越靠上 |
| 宽度限制 | 小数 | 否 | 文本宽度限制,-1表示不限制,默认-1 |
| 高度限制 | 小数 | 否 | 文本高度限制,-1表示不限制,默认-1 |
| 画布宽度 | 整数 | 否 | 画布的宽度,单位:像素。仅在创建新草稿时需要指定 |
| 画布高度 | 整数 | 否 | 画布的高度,单位:像素。仅在创建新草稿时需要指定 |
| 文本样式数组 | 列表 | 否 | 文本样式数组,用于设置复杂的文本样式 |
输出参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 返回草稿ID | 字符串 | 是 | 操作后的草稿ID |
| 草稿URL | 字符串 | 是 | 草稿的访问链接 |
注意事项
时间参数:起始时间必须小于结束时间,文本会在指定的时间范围内显示
偏移参数:相对值和像素值只需设置其中一个,如果都设置,像素值优先级更高
字体名称:字体名称必须通过【获取字体类型】指令来获取,不能随意填写
动画效果:可以同时设置入场动画、出场动画和循环动画,实现丰富的文字动画效果
花字效果:使用花字效果时,部分字体样式参数可能无效
草稿ID:如果不提供草稿ID,系统会自动创建新草稿,后续操作需要使用返回的草稿ID
