剪映剪辑助手-文本

文本

剪映剪辑助手 / 文本 类动作。

添加文本片段

add_jianying_text_segment

剪映剪辑助手文本

用途:向当前草稿添加普通文字片段,支持少量高频样式参数、花字气泡和样品包。

写法:添加文本片段 文本内容=<文本内容> [开始时间=<开始时间>] [持续时长=<持续时长>] [轨道=<轨道>] [字体=<字体>] [字号=<字号>] [字体颜色=<字体颜色>] [位置=<位置>] [套用模板属性=<套用模板属性>] [套用预设文本=<套用预设文本>] [花字资源ID=<花字资源ID>] [气泡资源ID=<气泡资源ID>] [原片段后移=<原片段后移>]

保存为

默认保存主结果,通常就是 片段ID 这个字段。

正确示例

添加文本片段 文本内容="示例内容" 开始时间=1

错误示例

添加文本片段 开始时间=1

为什么错:漏写了必填参数:文本内容。

展开查看参数和注意事项
中文参数英文参数用途必填默认值
文本内容text要添加的文本内容。
开始时间start_time文字片段开始时间。
持续时长duration文字片段持续时长。3s
轨道track_name目标文本轨道。
字体font_name字体名称;不填则使用默认字体。
字号font_size文字字号,默认 5。5.0
字体颜色font_color字体颜色,支持 #RRGGBB 或 255,255,255。
位置position文字位置;填写坐标字符串 "x,y",例如 "120,-60"。0,-600
套用模板属性template_property已保存文本属性名;填写后会在新建片段时直接套用模板属性。
套用预设文本preset_text_name剪映本机个人预设文本名;读取并套用对应样式、花字或气泡。
花字资源IDflower_resource_id花字资源ID;提供后会直接给新文本片段挂花字。示例:7539407429763796249
气泡资源IDbubble_resource_id文字气泡资源ID;提供后会直接给新文本片段挂气泡。
原片段后移move_original_segments是否先给新文本片段腾位置;是=命中的原文本片段整体后移,如开始时间落在片段内部则先切分再后移;否=按覆盖语义处理原文本片段。False

返回结果

如果你要整份返回对象,而不只是主结果,可在行尾写 返回结果=变量名

返回结果

保存后通常可按字段路径继续读取。

字段路径类型必有说明
草稿路径string未提供说明
轨道名string未提供说明
片段序号integer未提供说明
片段IDstring未提供说明
文本素材IDstring未提供说明
开始时间integer未提供说明
持续时长integer未提供说明
结束时间integer未提供说明
文本内容string未提供说明
文本长度integer未提供说明
原片段后移boolean未提供说明
文字类型string未提供说明
新增文字效果列表array未提供说明

返回/保存方式:普通动作需要留给后续步骤时,通常可在行尾追加 保存为=变量名,默认保存主结果字段 片段ID。

更新文本片段内容

update_jianying_text_segment_content

剪映剪辑助手文本

用途:更新当前剪映草稿中指定文字片段的整段文本内容。

写法:更新文本片段内容 新文本内容=<新文本内容> [轨道=<轨道>] [片段序号=<片段序号>] [重算样式范围=<重算样式范围>] [批量失败继续=<批量失败继续>]

保存为

默认保存主结果,通常就是 新文本内容 这个字段。

正确示例

更新文本片段内容 新文本内容="示例内容" 轨道="示例名称"

错误示例

更新文本片段内容 轨道="示例名称"

为什么错:漏写了必填参数:新文本内容。

展开查看参数和注意事项
中文参数英文参数用途必填默认值
新文本内容text新的文本内容。
轨道track_name目标轨道
片段序号segment_index轨道内片段选择表达式。支持单个序号、逗号并集、范围、倒数、all/全部、random/随机,以及用 | 从候选里随机取 1 个;不填时默认取该轨道第 1 个片段。
重算样式范围recalc_style是否按新文本长度重算样式 range。True
批量失败继续continue_on_item_error批量命中时遇到失败片段是否跳过并继续处理其它命中片段。False

返回结果

如果你要整份返回对象,而不只是主结果,可在行尾写 返回结果=变量名

返回结果

保存后通常可按字段路径继续读取。

字段路径类型必有说明
草稿路径string未提供说明
轨道名string未提供说明
片段序号integer未提供说明
片段IDstring未提供说明
文本内容string未提供说明
新文本内容string未提供说明
文本长度integer未提供说明
重算样式范围boolean未提供说明
目标片段数量integer未提供说明
目标片段列表array未提供说明
失败片段数量integer未提供说明
失败片段列表array未提供说明

返回/保存方式:普通动作需要留给后续步骤时,通常可在行尾追加 保存为=变量名,默认保存主结果字段 新文本内容。

设置文本片段属性

set_jianying_text_segment_attributes

剪映剪辑助手文本

用途:设置一个或多个文本片段的位置、缩放、旋转和不透明度,支持 all、范围和逗号并集;默认任一片段失败时自动回滚,也可选择批量失败后继续。

写法:设置文本片段属性 [轨道=<轨道>] [片段序号=<片段序号>] [缩放=<缩放>] [位置=<位置>] [旋转=<旋转>] [不透明度=<不透明度>] [批量失败继续=<批量失败继续>]

保存为

默认保存主结果,通常就是 目标片段列表 这个字段。

正确示例

设置文本片段属性 轨道="示例名称" 片段序号="示例值"

错误示例

设置文本片段属性 轨道="示例名称" 错误参数=1

为什么错:使用了不在当前参数表里的参数名。

展开查看参数和注意事项
中文参数英文参数用途必填默认值
轨道track_name目标文本轨道。
片段序号segment_index轨道内片段选择表达式;支持单个序号、逗号并集、范围、倒数、all/全部、random/随机和候选随机。
缩放scale缩放;支持单个值或 x,y 两个值,例如 1.2 或 "1.2,0.8"。单值会同时用于宽高,也支持在数值位里写 随机(...)。
位置position位置,单位为画布像素;原点在画布中心,X 正值向右、Y 正值向上;格式为 "x,y",例如 "120,-60"。落盘时会按当前画布宽高归一化。
旋转rotation旋转角度。
不透明度alpha混合不透明度,0 到 1;客户端通常显示为百分比。
批量失败继续continue_on_item_error批量命中时遇到失败片段是否跳过并继续处理其它命中片段;默认关闭,关闭时自动回滚。False

返回结果

如果你要整份返回对象,而不只是主结果,可在行尾写 返回结果=变量名

返回结果

保存后通常可按字段路径继续读取。

字段路径类型必有说明
草稿路径string未提供说明
轨道名string未提供说明
片段序号integer未提供说明
片段IDstring未提供说明
文本内容string未提供说明
缩放宽度number未提供说明
缩放高度number未提供说明
位置Xnumber未提供说明
位置Ynumber未提供说明
旋转number未提供说明
不透明度number未提供说明
目标片段数量integer未提供说明
目标片段列表array未提供说明
失败片段数量integer未提供说明
失败片段列表array未提供说明

返回/保存方式:普通动作需要留给后续步骤时,通常可在行尾追加 保存为=变量名,默认保存主结果字段 目标片段列表。

设置文本样式

set_jianying_text_style

剪映剪辑助手文本

用途:设置指定文字或字幕片段的整段样式,普通文字也支持按匹配文本修改局部样式,并可直接设置花字气泡。

写法:设置文本样式 [轨道=<轨道>] [片段序号=<片段序号>] [套用模板样式=<套用模板样式>] [套用预设文本=<套用预设文本>] [匹配文本=<匹配文本>] [花字资源ID=<花字资源ID>] [气泡资源ID=<气泡资源ID>] [字体=<字体>] [字号=<字号>] [字体颜色=<字体颜色>] [不透明度=<不透明度>] [加粗=<加粗>] [斜体=<斜体>] [下划线=<下划线>] [对齐方式=<对齐方式>] [字间距=<字间距>] [行间距=<行间距>] [描边宽度=<描边宽度>] [描边颜色=<描边颜色>] [批量失败继续=<批量失败继续>]

保存为

默认保存主结果,通常就是 目标片段列表 这个字段。

正确示例

设置文本样式 轨道="示例名称" 片段序号="示例值"

错误示例

设置文本样式 轨道="示例名称" 错误参数=1

为什么错:使用了不在当前参数表里的参数名。

展开查看参数和注意事项
中文参数英文参数用途必填默认值
轨道track_name目标文本轨道。普通文本和字幕都可用。
片段序号segment_index轨道内片段选择表达式。支持单个序号、逗号并集、范围、倒数、all/全部、random/随机,以及用 | 从候选里随机取 1 个;不填时默认取该轨道第 1 个片段。
套用模板样式style_name已保存样式包名;填写后会在当前片段上套用模板样式,也兼容带文字样式的历史效果包。
套用预设文本preset_text_name剪映本机个人预设文本名;读取并转成样式、花字或气泡参数。
匹配文本match_text局部匹配文本;绝对匹配、区分大小写、允许空格。命中区间固定按 UTF-16 code unit 计算。普通文本命中后会自动拆分样式段。字幕命中后只修改普通 styles 段,不会改 subtitle_keywords.range;如果命中范围跨到关键词区,这次匹配会按未命中处理。
花字资源IDflower_resource_id花字资源ID;整段设置时会替换当前片段花字。填写 匹配文本 时,只对命中范围生效。
气泡资源IDbubble_resource_id文字气泡资源ID;只支持整段文本/字幕片段。填写 匹配文本 时会忽略。
字体font_name字体名称;当前先写入文字素材的 `font_name`。
字号font_size字号;不填则不修改。
字体颜色font_color支持 #RRGGBB 或 255,255,255。
不透明度alpha文字不透明度,0 到 1;会同步到客户端主不透明度显示。
加粗bold是否加粗。
斜体italic是否斜体。
下划线underline是否下划线。
对齐方式align左/居中/右。
字间距letter_spacing字间距,当前按 vendored 口径写入 `letter_spacing = 输入值 * 0.05`。
行间距line_spacing行间距,当前按 vendored 口径写入 `line_spacing = 0.02 + 输入值 * 0.05`。
描边宽度border_width描边宽度,使用客户端 0 到 100 口径。
描边颜色border_color描边颜色。高级阴影和背景效果请改用样品模板或效果包。
批量失败继续continue_on_item_error批量命中时遇到失败片段是否跳过并继续处理其它命中片段。False

返回结果

如果你要整份返回对象,而不只是主结果,可在行尾写 返回结果=变量名

返回结果

保存后通常可按字段路径继续读取。

字段路径类型必有说明
草稿路径string未提供说明
轨道名string未提供说明
片段序号integer未提供说明
片段IDstring未提供说明
文本内容string未提供说明
文字类型string未提供说明
匹配文本string未提供说明
命中数量integer未提供说明
气泡已忽略boolean未提供说明
目标片段数量integer未提供说明
目标片段列表array未提供说明
失败片段数量integer未提供说明
失败片段列表array未提供说明

返回/保存方式:普通动作需要留给后续步骤时,通常可在行尾追加 保存为=变量名,默认保存主结果字段 目标片段列表。

从文本片段套用文本属性

paste_jianying_text_properties_from_segment

剪映剪辑助手文本

用途:从当前草稿某个来源文本片段提取文本属性,并直接按组粘贴到目标文本片段。

写法:从文本片段套用文本属性 来源轨道=<来源轨道> [来源片段序号=<来源片段序号>] 目标轨道=<目标轨道> [目标片段序号=<目标片段序号>] [属性组=<属性组>] [清理旧属性=<清理旧属性>] [批量失败继续=<批量失败继续>]

保存为

默认保存主结果,通常就是 目标片段数量 这个字段。

正确示例

从文本片段套用文本属性 来源轨道="示例名称" 目标轨道="示例名称"

错误示例

从文本片段套用文本属性 来源轨道="示例名称"

为什么错:漏写了必填参数:目标轨道。

展开查看参数和注意事项
中文参数英文参数用途必填默认值
来源轨道source_track_name当前草稿里的来源文本轨道。
来源片段序号source_segment_index当前草稿来源文本片段序号,从 1 开始;不填时默认取来源轨第 1 个片段。
目标轨道target_track_name目标文本轨道。
目标片段序号target_segment_index目标文本片段选择表达式。支持单个序号、逗号并集、范围、倒数、all/全部、random/随机,以及用 | 从候选里随机取 1 个;不填时默认取该轨道第 1 个片段。
属性组property_groups要套用的属性组;支持 全部/基础样式/位置大小/文字效果/动画,也支持逗号分隔。默认 全部。
清理旧属性clear_existing套用前是否先清理同组旧属性。True
批量失败继续continue_on_item_error批量命中时遇到失败片段是否跳过并继续处理其它命中片段。False

返回结果

如果你要整份返回对象,而不只是主结果,可在行尾写 返回结果=变量名

返回结果

保存后通常可按字段路径继续读取。

字段路径类型必有说明
草稿路径string未提供说明
草稿名string未提供说明
来源string未提供说明
属性组列表array未提供说明
目标片段数量integer未提供说明
目标片段列表array未提供说明
复制素材数量integer未提供说明
复制关键帧数量integer未提供说明
失败片段数量integer未提供说明
失败片段列表array未提供说明
属性分组object未提供说明

返回/保存方式:普通动作需要留给后续步骤时,通常可在行尾追加 保存为=变量名,默认保存主结果字段 目标片段数量。

从模板草稿提取文本属性

extract_jianying_text_properties

剪映剪辑助手文本

用途:从模板草稿的指定文字或字幕片段提取一份文本属性,并保存为运行时文本属性名。

写法:从模板草稿提取文本属性 来源草稿名=<来源草稿名> [来源轨道序号=<来源轨道序号>] [来源片段序号=<来源片段序号>] [属性组=<属性组>] 保存为=<保存为> [覆盖已有=<覆盖已有>]

保存为

默认保存主结果,通常就是 文本属性名 这个字段。

正确示例

从模板草稿提取文本属性 来源草稿名="示例名称" 保存为="示例值"

错误示例

从模板草稿提取文本属性 来源草稿名="示例名称"

为什么错:漏写了必填参数:保存为。

展开查看参数和注意事项
中文参数英文参数用途必填默认值
来源草稿名source_draft_name模板草稿名称。
来源轨道序号source_track_index模板草稿里第几条文本轨,从 1 开始。1
来源片段序号source_segment_index模板文本片段序号,从 1 开始。1
属性组property_groups属性组;支持 全部/基础样式/位置大小/文字效果/动画,也支持逗号分隔。默认 全部。
保存为save_as把提取结果保存成这个文本属性名。
覆盖已有overwrite文本属性名已存在时是否覆盖。默认不覆盖。False

返回结果

如果你要整份返回对象,而不只是主结果,可在行尾写 返回结果=变量名

返回结果

保存后通常可按字段路径继续读取。

字段路径类型必有说明
文本属性名string未提供说明
来源草稿名string未提供说明
来源轨道string未提供说明
来源片段序号integer未提供说明
属性组列表array未提供说明
属性分组object未提供说明
覆盖已有boolean未提供说明

返回/保存方式:动作本身包含 save_as 参数;如果要保留动作完整返回对象,请改用 返回结果=变量名。

套用已保存文本属性

paste_saved_jianying_text_properties

剪映剪辑助手文本

用途:把已保存的文本属性按组套用到目标文本片段。

写法:套用已保存文本属性 文本属性名=<文本属性名> 目标轨道=<目标轨道> [目标片段序号=<目标片段序号>] [属性组=<属性组>] [清理旧属性=<清理旧属性>] [批量失败继续=<批量失败继续>]

保存为

默认保存主结果,通常就是 目标片段数量 这个字段。

正确示例

套用已保存文本属性 文本属性名="示例名称" 目标轨道="示例名称"

错误示例

套用已保存文本属性 文本属性名="示例名称"

为什么错:漏写了必填参数:目标轨道。

展开查看参数和注意事项
中文参数英文参数用途必填默认值
文本属性名property_name已提取好的文本属性名。
目标轨道target_track_name目标文本轨道。
目标片段序号target_segment_index目标文本片段选择表达式。支持单个序号、逗号并集、范围、倒数、all/全部、random/随机,以及用 | 从候选里随机取 1 个;不填时默认取该轨道第 1 个片段。
属性组property_groups要套用的属性组;支持 全部/基础样式/位置大小/文字效果/动画,也支持逗号分隔。默认 全部。
清理旧属性clear_existing套用前是否先清理同组旧属性。True
批量失败继续continue_on_item_error批量命中时遇到失败片段是否跳过并继续处理其它命中片段。False

返回结果

如果你要整份返回对象,而不只是主结果,可在行尾写 返回结果=变量名

返回结果

保存后通常可按字段路径继续读取。

字段路径类型必有说明
草稿路径string未提供说明
草稿名string未提供说明
来源string未提供说明
属性组列表array未提供说明
目标片段数量integer未提供说明
目标片段列表array未提供说明
复制素材数量integer未提供说明
复制关键帧数量integer未提供说明
失败片段数量integer未提供说明
失败片段列表array未提供说明
属性分组object未提供说明

返回/保存方式:普通动作需要留给后续步骤时,通常可在行尾追加 保存为=变量名,默认保存主结果字段 目标片段数量。