更新时间:2024-07-31 GMT+08:00
分享

预置模板参数说明

Data+已下线,如果需要使用数据处理服务,可使用数据工坊 DWR。

详情请参见数据工坊 DWR

本小节提供Data+各类函数模板及自定义函数的参数配置说明。

当前支持的函数模板如下:

不同区域支持的预置模板数量不同,请以控制台实际支持的模板为准。

表1 Data+函数模板

分类

模板名称

图像处理

图像标签

视频处理

视频解析

抽帧截图

媒资转码

消息通知

DIS消息通知

内容审核

视频内容审核

其他

事件延迟

自定义

图像标签

模板作用:能准确识别自然图片中数百种场景、上千种通用物体及其属性。让智能相册管理等功能更加直观。该模板实际调用的是Image服务的图像标签接口

表2 图像标签属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

任务超时时间,即任务执行的最长时间。

支持设置0~300秒的超时时间,如果设置为0,则表示超时时间为默认值30秒。

动作提供方

函数模板的提供方。

错误处理

可定义不同类型错误发生时的重试次数、重试间隔,以及重试失败后跳转到的目标任务。

错误类型包括:匹配所有、执行失败、权限不合法、参数不合法、函数不存在、请求太频繁、函数不可用、函数异常

动态参数

tag_threshold

置信度的阈值(0~100),输入非该范围内值算法即取默认值。默认值:0。

tag_limit

最多返回的tag数,默认值:30。

tag_language

中文:返回标签的语言类型为中文。

英文:返回标签的语言类型为英文。

视频解析

模板作用:用于新建视频解析任务,以解析视频元数据。该模板实际调用的是MPC服务的新建视频解析任务接口

表3 视频解析属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

任务超时时间,即任务执行的最长时间。

支持设置0~300秒的超时时间,如果设置为0,则表示超时时间为默认值30秒。

动作提供方

函数模板的提供方。

错误处理

可定义不同类型错误发生时的重试次数、重试间隔,以及重试失败后跳转到的目标任务。

错误类型包括:匹配所有、执行失败、权限不合法、参数不合法、函数不存在、请求太频繁、函数不可用、函数异常

动态参数

metadata_sync

视频解析处理模式。

  • 排队处理:查询后仅返回任务ID,还需进一步调用查询视频解析任务接口才能获取到视频元数据。
  • 同步处理:查询后将直接返回视频元数据。

metadata_outbucket

视频解析输出桶,用于保存解析后的视频。

输出桶需要和Data+工作流在同一区域,工作流所属区域为创建工作流的桶所属区域。例如工作流A是在桶A中创建的,则桶A的区域即为工作流A的区域。

metadata_outpath

视频解析输出桶中存放视频的具体目录。

例如:输入abc或abc/,均表示视频存放在abc文件夹下,如果文件夹不存在,会自动新建。输出路径为空表示存放在桶的根目录。

抽帧截图

模板作用:用于新建视频截图任务。该模板实际调用的是MPC服务的新建截图任务接口

表4 抽帧截图属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

任务超时时间,即任务执行的最长时间。

支持设置0~300秒的超时时间,如果设置为0,则表示超时时间为默认值30秒。

动作提供方

函数模板的提供方。

错误处理

可定义不同类型错误发生时的重试次数、重试间隔,以及重试失败后跳转到的目标任务。

错误类型包括:匹配所有、执行失败、权限不合法、参数不合法、函数不存在、请求太频繁、函数不可用、函数异常

动态参数

thumb_output_bucket

抽帧截图输出桶,用于保存视频截图。

输出桶需要和Data+工作流在同一区域,工作流所属区域为创建工作流的桶所属区域。例如工作流A是在桶A中创建的,则桶A的区域即为工作流A的区域。

thumb_output_path

抽帧截图输出桶中存放截图的具体目录。

例如:输入abc或abc/,均表示视频存放在abc文件夹下,如果文件夹不存在,会自动新建。输出路径为空表示存放在桶的根目录。

thumb_samp_tar

是否压缩抽帧图片生成tar包。

thumb_samp_sync

是否同步处理,同步处理是指不下载全部文件,快速定位到截图位置进行截图。

thumb_samp_type

采样类型,可选择如下类型:

  • 根据视频时长的百分比间隔采样
  • 根据时间间隔采样截图
  • 指定时间点截图

thumb_samp_filename

截图输出文件名。

  • 如果只抽一张图(即:按DOTS方式,指定1个时间点)则按该指定文件名输出图片。
  • 如果抽多张图(即:按DOTS方式指定多个时间点或按TIME间隔截图)则输出图片名在该指定文件名基础上再增加时间点(示例:output_filename_10.jpg)。
  • 如果指定了压缩抽帧图片生成tar包,则tar包按该指定文件名输出。

thumb_samp_format

截图文件格式。

目前支持的取值为:jpg格式

thumb_samp_width

截图图片宽度。

取值范围:(96,3840]

单位:px

thumb_samp_height

截图图片高度。

取值范围:(96,2160]

单位:px

thumb_samp_maxlen

截图最长边的尺寸。宽边尺寸按照该尺寸与原始视频像素等比缩放计算。

取值范围:[240,3840]

单位:像素

说明:

该参数和thumb_samp_width/thumb_samp_height选择使用,以thumb_samp_width/thumb_samp_height优先,如果thumb_samp_width/thumb_samp_height都不等于0,则图片尺寸按thumb_samp_width/thumb_samp_height得出;反之,则图片尺寸按thumb_samp_maxlen得出。

thumb_samp_ratio

截图纵横比。

thumb_samp_percent

根据视频时长百分比间隔采样时的百分比值。

thumb_samp_dots

指定时间截图时的时间点数组。

数组类型参数必须以前括号([)开头,以后括号(])结尾,值之间用英文逗号(,)分隔。

thumb_samp_time

采样截图的时间间隔值。

单位:秒

thumb_samp_start

采样类型为“TIME”模式的开始时间,和thumb_samp_time配合使用。

单位:秒

thumb_samp_duration

采样类型为“TIME”模式的持续时间,和thumb_samp_time、thumb_samp_start配合使用。表示从视频文件的第“thumb_samp_start”开始,持续时间为“thumb_samp_duration”,每间隔“thumb_samp_time”生成一张截图。

取值范围:[数字,ToEND]。“ToEND”表示持续到视频结束。

单位:秒

说明:

“thumb_samp_duration”必须大于等0,如果设置为0,则截图持续时间从“thumb_samp_start”到视频结束。

媒资转码

模板作用:执行MPC服务的转码任务对视频进行转码,并在转码过程中压制水印、内容质检、视频截图等。该模板实际调用的是MPC服务的新建转码任务接口

表5 媒资转码属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

任务超时时间,即任务执行的最长时间。

支持设置0~300秒的超时时间,如果设置为0,则表示超时时间为默认值30秒。

动作提供方

函数模板的提供方。

错误处理

可定义不同类型错误发生时的重试次数、重试间隔,以及重试失败后跳转到的目标任务。

错误类型包括:匹配所有、执行失败、权限不合法、参数不合法、函数不存在、请求太频繁、函数不可用、函数异常

动态参数

(基本参数)

trans_output_bucket

媒资转码输出桶,用于保存转码后的视频文件。

输出桶需要和Data+工作流在同一区域,工作流所属区域为创建工作流的桶所属区域。例如工作流A是在桶A中创建的,则桶A的区域即为工作流A的区域。

trans_output_path

媒资转码输出桶中存放转码后视频的具体目录。

例如:输入abc或abc/,均表示视频存放在abc文件夹下,如果文件夹不存在,会自动新建。输出路径为空表示存放在桶的根目录。

trans_tid

转码模板ID,数组,每一路转码输出对应一个转码配置模板ID,最多支持9个模板ID。

数组类型参数必须以前括号([)开头,以后括号(])结尾,值之间用英文逗号(,)分隔。

动态参数

(字幕参数)

trans_subt_type

媒资转码字幕类型。

trans_subt_bucket

存放字幕文件的OBS桶。

trans_subt_object

字幕对象名,即字幕文件。

动态参数

(图片水印设置)

trans_wm_bucket

存放水印图片的OBS桶。

trans_wm_object

水印图片对象名,即水印文件。

trans_iwm_dx

水印图片起点相对输出视频顶点的水平偏移量。

设置方法有如下两种:

  • 整数型:表示图片起点水平偏移视频顶点的像素值,单位px。取值范围:[0,4096]
  • 小数型:表示图片起点相对于视频分辨率宽的水平偏移比率。取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

示例:输出视频分辨率宽1920,设置“dx”为“0.1”,“referpos”为“TopRight”(右上角),则水印图片右上角到视频右顶点在水平方向上偏移距离为192。

trans_iwm_dy

水印图片起点相对输出视频顶点的垂直偏移量。

设置方法有如下两种:

  • 整数型:表示图片起点垂直偏移视频顶点的像素值,单位px。取值范围:[0,4096]
  • 小数型:表示图片起点相对于视频分辨率高的垂直偏移比率。取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

示例:输出视频分辨率高1080,设置“dy”为“0.1”,“referpos”为“TopRight”(右上角),则水印图片右上角到视频右顶点在垂直方向上的偏移距离为108。

trans_iwm_rpos

水印位置。支持如下位置:

  • 右上角
  • 左上角
  • 右下角
  • 左下角

trans_iwm_tstart

水印开始时间,与trans_iwm_tduration配合使用。

取值范围:数字

单位:秒

trans_iwm_tduration

水印持续时间,与“trans_iwm_tstart”配合使用。

取值范围:[数字,ToEND]。“ToEND”表示持续到视频结束。

trans_iwm_iprocess

水印图片处理方式。支持如下方式:

  • 简单缩放
  • 图片变灰
  • 透明化

trans_iwm_width

水印图片宽度,值有两种形式:

  • 整数型代水印图片宽的像素值,范围[8,4096],单位px。
  • 小数型代表相对输出视频分辨率宽的比率,范围(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

trans_iwm_height

水印图片高度,值有两种形式:

  • 整数型代表水印图片高的像素值,范围[8,4096],单位px。
  • 小数型代表相对输出视频分辨率高的比率,范围(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

trans_iwm_base

水印叠加母体,取值如下:

  • 叠加在输入片源
  • 叠加在转码输出文件

动态参数

(水印参数)

trans_wm_tid

水印模板ID。可通过新建水印模板接口创建水印模板。

动态参数

(文字水印配置)

trans_wm_text

文字水印内容,内容需做Base64编码,此配置项不能为空

示例:如果想添加文字水印“测试文字水印”,那么Content的值为:5rWL6K+V5paH5a2X5rC05Y2w

trans_twm_dx

文字水印起点相对输出视频顶点的水平偏移量。

设置方法有如下两种:

  • 整数型:表示文字起点水平偏移视频顶点的像素值,单位px。取值范围:[0,4096]
  • 小数型:表示文字起点相对于视频分辨率宽的水平偏移比率。取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

示例:输出视频分辨率宽1920,设置“dx”为“0.1”,“referpos”为“TopRight”(右上角),则文字水印右上角到视频右顶点在水平方向上偏移距离为192。

trans_twm_dy

文字水印起点相对输出视频顶点的垂直偏移量。

设置方法有如下两种:

  • 整数型:表示文字起点垂直偏移视频顶点的像素值,单位px。取值范围:[0,4096]
  • 小数型:表示文字起点相对于视频分辨率高的垂直偏移比率。取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

示例:输出视频分辨率高1080,设置“dy”为“0.1”,“referpos”为“TopRight”(右上角),则文字水印右上角到视频右顶点在垂直方向上的偏移距离为108。

trans_twm_rpos

文字水印位置。支持如下位置:

  • 右上角
  • 左上角
  • 右下角
  • 左下角

trans_twm_tstart

文字水印开始时间,与“trans_twm_tduration”配合使用。

取值范围:数字

单位:秒

trans_twm_tduration

文字水印持续时间,与“trans_twm_tstart”配合使用。

取值范围:[数字,ToEND]。“ToEND”表示持续到视频结束。

trans_twm_base

文字水印叠加母体,取值如下:

  • 叠加在输入片源
  • 叠加在转码输出文件

trans_twm_fname

文字水印文字字体名。当前支持的字体有

  • 方正黝黑
  • 微软雅黑

trans_twm_fsize

文字水印文字字体大小。

取值范围:[4, 120]

trans_twm_fcolor

文字水印文字字体颜色。

DIS消息通知

模板作用:发送消息到您指定的DIS通道。

表6 DIS消息通知属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

任务超时时间,即任务执行的最长时间。

支持设置0~300秒的超时时间,如果设置为0,则表示超时时间为默认值30秒。

动作提供方

函数模板的提供方。

错误处理

可定义不同类型错误发生时的重试次数、重试间隔,以及重试失败后跳转到的目标任务。

错误类型包括:匹配所有、执行失败、权限不合法、参数不合法、函数不存在、请求太频繁、函数不可用、函数异常

动态参数

stream_name

已创建的DIS通道名称。

partition_id

DIS通道分区的唯一标识符。

partition_key

数据将写入的DIS通道分区。

视频内容审核

模板作用:审核视频内容是否合规,有无涉黄/涉暴等。

表7 视频内容审核属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

任务超时时间,即任务执行的最长时间。

支持设置0~300秒的超时时间,如果设置为0,则表示超时时间为默认值30秒。

动作提供方

函数模板的提供方。

错误处理

可定义不同类型错误发生时的重试次数、重试间隔,以及重试失败后跳转到的目标任务。

错误类型包括:匹配所有、执行失败、权限不合法、参数不合法、函数不存在、请求太频繁、函数不可用、函数异常

动态参数

task_name

作业名称。

description

作业描述信息。

modeout_bucket

视频内容审核结果输出到指定的OBS桶名。

输出桶需要和Data+工作流在同一区域,工作流所属区域为创建工作流的桶所属区域。例如工作流A是在桶A中创建的,则桶A的区域即为工作流A的区域。

modeout_path

视频内容审核结果输出到指定的OBS桶内路径。

例如:输入abc或abc/,均表示审核结果存放在abc文件夹下,如果文件夹不存在,会自动新建。输出路径为空表示存放在桶的根目录。

frame_interval

截帧时间间隔,单位为秒/帧。

categories

视频检测场景。支持如下场景:

  • 政治人物
  • 暴恐元素
  • 涉黄

text_categories

语音或文字审核服务的检测场景。支持如下场景:

  • 政治人物
  • 暴恐元素
  • 涉黄
  • 辱骂
  • 违禁品

use_sis

是否使用语音审核服务。

use_ocr

是否使用文字审核服务。

modera_upload

是否使用问题场景图片上传服务。

service_version

功能版本,目前仅支持“1.2”。

事件延迟

模板作用:可用于控制工作流两个相邻任务间的等待时长,例如执行任务A后,规定等待一段时间再继续执行任务B。

表8 事件延迟属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

执行下一任务前的等待时长,单位:秒。支持设置的范围为1~86400秒。

自定义

用户可自定义函数,满足不同场景的任务定制需求。

自定义函数属性配置说明见下表,另外需要遵循自定义函数开发规范

表9 自定义函数属性配置说明

属性类别

参数名称

参数说明

基本属性

名称

任务的名称,修改后将体现在工作流编排区域。

  • 必须以字母或数字开头
  • 只能由字母、数字、下划线和中划线组成
  • 长度范围为1~20个字符
  • 不能和同一工作流中的其他任务重名

超时(秒)

任务超时时间,即任务执行的最长时间。

支持设置0~300秒的超时时间,如果设置为0,则表示超时时间为默认值30秒。

函数唯一标识

选择需要执行的FunctionGraph中的函数。函数需通过FunctionGraph页面创建。

FunctionGraph服务的操作指导请参见《函数工作流用户指南》中“创建并初始化函数”章节的内容。

下拉列表中仅展示与Data+工作流同区域且同项目的函数。工作流所属区域为创建工作流的桶所属区域。例如工作流A是在桶A中创建的,则桶A的区域即为工作流A的区域。

动态参数

如果自定义函数中存在动态参数,可以指定动态参数的参数名和取值,作为函数的输入。

相关文档