{ "name": "ie", "display_name": "智能编辑", "description": "介绍如何使用API对智能编辑进行操作，包括获取智能编辑任务结果、创建智能编辑任务等。", "domain": "other", "api_version": "2020-03-04", "endpoint": "ie.tencentcloudapi.com", "actions": [ { "name": "CreateEditingTask", "description": "创建编辑理解任务，可以同时选择视频标签识别、分类识别、智能拆条、智能集锦、智能封面和片头片尾识别中的一项或者多项能力。", "status": "online", "parameters": [ { "name": "EditingInfo", "type": "object", "required": true, "description": "智能编辑任务参数。", "example": "无", "children": [ { "name": "TagEditingInfo", "type": "object", "required": false, "description": "视频标签识别任务参数，不填则不开启。", "example": "null", "children": [ { "name": "Switch", "type": "integer", "required": true, "description": "是否开启视频标签识别。0为关闭，1为开启。其他非0非1值默认为0。" }, { "name": "CustomInfo", "type": "string", "required": false, "description": "额外定制化服务参数。参数为序列化的Json字符串，例如：{\"k1\":\"v1\"}。" } ] }, { "name": "ClassificationEditingInfo", "type": "object", "required": false, "description": "视频分类识别任务参数，不填则不开启。", "example": "null", "children": [ { "name": "Switch", "type": "integer", "required": true, "description": "是否开启视频分类识别。0为关闭，1为开启。其他非0非1值默认为0。" }, { "name": "CustomInfo", "type": "string", "required": false, "description": "额外定制化服务参数。参数为序列化的Json字符串，例如：{\"k1\":\"v1\"}。" } ] }, { "name": "StripEditingInfo", "type": "object", "required": false, "description": "智能拆条任务参数，不填则不开启。", "example": "null", "children": [ { "name": "Switch", "type": "integer", "required": true, "description": "是否开启智能拆条。0为关闭，1为开启。其他非0非1值默认为0。" }, { "name": "CustomInfo", "type": "string", "required": false, "description": "额外定制化服务参数。参数为序列化的Json字符串，例如：{\"k1\":\"v1\"}。" } ] }, { "name": "HighlightsEditingInfo", "type": "object", "required": false, "description": "智能集锦任务参数，不填则不开启。", "example": "null", "children": [ { "name": "Switch", "type": "integer", "required": true, "description": "是否开启智能集锦。0为关闭，1为开启。其他非0非1值默认为0。" }, { "name": "CustomInfo", "type": "string", "required": false, "description": "额外定制化服务参数。参数为序列化的Json字符串，例如：{\"k1\":\"v1\"}。" } ] }, { "name": "CoverEditingInfo", "type": "object", "required": false, "description": "智能封面任务参数，不填则不开启。", "example": "null", "children": [ { "name": "Switch", "type": "integer", "required": true, "description": "是否开启智能封面。0为关闭，1为开启。其他非0非1值默认为0。" }, { "name": "CustomInfo", "type": "string", "required": false, "description": "额外定制化服务参数。参数为序列化的Json字符串，例如：{\"k1\":\"v1\"}。" } ] }, { "name": "OpeningEndingEditingInfo", "type": "object", "required": false, "description": "片头片尾识别任务参数，不填则不开启。", "example": "null", "children": [ { "name": "Switch", "type": "integer", "required": true, "description": "是否开启片头片尾识别。0为关闭，1为开启。其他非0非1值默认为0。" }, { "name": "CustomInfo", "type": "string", "required": false, "description": "额外定制化服务参数。参数为序列化的Json字符串，例如：{\"k1\":\"v1\"}。" } ] } ] }, { "name": "DownInfo", "type": "object", "required": true, "description": "视频源信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "下载类型，可选值： 0：UrlInfo； 1：CosInfo。" }, { "name": "UrlInfo", "type": "object", "required": false, "description": "Url形式下载信息，当Type等于0时必选。", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频 URL。 注意：编辑理解仅支持mp4、flv等格式的点播文件，不支持hls；", "example": "“”" }, { "name": "Format", "type": "integer", "required": false, "description": "视频地址格式，可选值： 0：音视频 ; 1：直播流。 默认为0。其他非0非1值默认为0。画质重生任务只支持0。", "example": "0" }, { "name": "Host", "type": "string", "required": false, "description": "【不再支持】指定请求资源时，HTTP头部host的值。", "example": "“”" } ] }, { "name": "CosInfo", "type": "object", "required": false, "description": "Cos形式下载信息，当Type等于1时必选。", "children": [ { "name": "Region", "type": "string", "required": true, "description": "cos 区域值。例如：ap-beijing。" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos 存储桶，格式为BuketName-AppId。例如：test-123456。" }, { "name": "Path", "type": "string", "required": true, "description": "cos 路径。 对于写表示目录，例如：/test； 对于读表示文件路径，例如：/test/test.mp4。" }, { "name": "CosAuthMode", "type": "object", "required": false, "description": "cos 授权信息，不填默认为公有权限。", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "授权类型，可选值： 0：bucket授权，需要将对应bucket授权给本服务帐号（3020447271和100012301793），否则会读写cos失败； 1：key托管，把cos的账号id和key托管于本服务，本服务会提供一个托管id； 3：临时key授权。 注意：目前智能编辑还不支持临时key授权；画质重生目前只支持bucket授权", "example": "0" }, { "name": "HostedId", "type": "string", "required": false, "description": "cos账号托管id，Type等于1时必选。", "example": "“”" }, { "name": "SecretId", "type": "string", "required": false, "description": "cos身份识别id，Type等于3时必选。", "example": "“”" }, { "name": "SecretKey", "type": "string", "required": false, "description": "cos身份秘钥，Type等于3时必选。", "example": "“”" }, { "name": "Token", "type": "string", "required": false, "description": "临时授权 token，Type等于3时必选。", "example": "“”" } ] } ] } ] }, { "name": "SaveInfo", "type": "object", "required": false, "description": "结果存储信息。对于包含智能拆条、智能集锦或者智能封面的任务必选。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "存储类型，可选值： 1：CosInfo。", "example": "0" }, { "name": "CosInfo", "type": "object", "required": false, "description": "Cos形式存储信息，当Type等于1时必选。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "cos 区域值。例如：ap-beijing。" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos 存储桶，格式为BuketName-AppId。例如：test-123456。" }, { "name": "Path", "type": "string", "required": true, "description": "cos 路径。 对于写表示目录，例如：/test； 对于读表示文件路径，例如：/test/test.mp4。" }, { "name": "CosAuthMode", "type": "object", "required": false, "description": "cos 授权信息，不填默认为公有权限。", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "授权类型，可选值： 0：bucket授权，需要将对应bucket授权给本服务帐号（3020447271和100012301793），否则会读写cos失败； 1：key托管，把cos的账号id和key托管于本服务，本服务会提供一个托管id； 3：临时key授权。 注意：目前智能编辑还不支持临时key授权；画质重生目前只支持bucket授权", "example": "0" }, { "name": "HostedId", "type": "string", "required": false, "description": "cos账号托管id，Type等于1时必选。", "example": "“”" }, { "name": "SecretId", "type": "string", "required": false, "description": "cos身份识别id，Type等于3时必选。", "example": "“”" }, { "name": "SecretKey", "type": "string", "required": false, "description": "cos身份秘钥，Type等于3时必选。", "example": "“”" }, { "name": "Token", "type": "string", "required": false, "description": "临时授权 token，Type等于3时必选。", "example": "“”" } ] } ] }, { "name": "Id", "type": "string", "required": false, "description": "存储信息ID标记，用于多个输出场景。部分任务支持多输出时，一般要求必选。 ID只能包含字母、数字、下划线、中划线，长读不能超过128。", "example": "“”" } ] }, { "name": "CallbackInfo", "type": "object", "required": false, "description": "任务结果回调地址信息。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "回调URL。" } ] } ], "required": [ "EditingInfo", "DownInfo" ] }, { "name": "CreateMediaProcessTask", "description": "用于创建编辑处理任务，如媒体截取、媒体编辑、媒体拼接、媒体字幕。", "status": "online", "parameters": [ { "name": "MediaProcessInfo", "type": "object", "required": true, "description": "编辑处理任务参数。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "编辑处理任务类型，可选值： MediaEditing：媒体编辑（待上线）； MediaCutting：媒体剪切； MediaJoining：媒体拼接。 MediaRecognition: 媒体识别。" }, { "name": "MediaCuttingInfo", "type": "object", "required": false, "description": "视频剪切任务参数，Type=MediaCutting时必选。", "children": [ { "name": "TimeInfo", "type": "object", "required": true, "description": "截取时间信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "时间类型，可选值： PointSet：时间点集合； IntervalPoint：周期采样点； SectionSet：时间片段集合。" }, { "name": "PointSet", "type": "array", "required": false, "description": "截取时间点集合，单位毫秒，Type=PointSet时必选。", "item_type": "integer" }, { "name": "IntervalPoint", "type": "object", "required": false, "description": "周期采样点信息，Type=IntervalPoint时必选。" }, { "name": "SectionSet", "type": "array", "required": false, "description": "时间区间集合信息，Type=SectionSet时必选。", "item_type": "string" } ] }, { "name": "TargetInfo", "type": "object", "required": true, "description": "输出结果信息。", "example": "无", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "目标文件名，不能带特殊字符（如/等），无需后缀名，最长200字符。 注1：部分子服务支持占位符，形式为： {parameter} 预设parameter有： index：序号；", "example": "test" }, { "name": "Format", "type": "string", "required": true, "description": "媒体封装格式，最长5字符，具体格式支持根据子任务确定。", "example": "mp4" }, { "name": "TargetVideoInfo", "type": "object", "required": false, "description": "视频流信息。", "example": "null" }, { "name": "ResultListSaveType", "type": "string", "required": false, "description": "【不再使用】", "example": "\"\"" } ] }, { "name": "OutForm", "type": "object", "required": true, "description": "截取结果形式信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输出类型，可选值： Static：静态图； Dynamic：动态图； Sprite：雪碧图； Video：视频。 注1：不同类型时，对应的 TargetInfo.Format 格式支持如下： Static：jpg、png； Dynamic：gif； Sprite：jpg、png； Video：mp4。 注2：当 Type=Sprite时，TargetInfo指定的尺寸表示小图的大小，最终结果尺寸以输出为准。", "example": "“”" }, { "name": "FillType", "type": "string", "required": false, "description": "背景填充方式，可选值： White：白色填充； Black：黑色填充； Stretch：拉伸； Gaussian：高斯模糊； 默认White。", "example": "“”" }, { "name": "SpriteRowCount", "type": "integer", "required": false, "description": "【废弃】参考SpriteInfo", "example": "0" }, { "name": "SpriteColumnCount", "type": "integer", "required": false, "description": "【废弃】参考SpriteInfo", "example": "0" }, { "name": "SpriteInfo", "type": "object", "required": false, "description": "Type=Sprite时有效，表示雪碧图参数信息。", "example": "无" }, { "name": "DynamicInfo", "type": "object", "required": false, "description": "Type=Dynamic时有效，表示动图参数信息。", "example": "无" } ] }, { "name": "ResultListSaveType", "type": "string", "required": false, "description": "列表文件形式，存储到用户存储服务中，可选值： NoListFile：不存储结果列表; UseSaveInfo：默认，结果列表和结果存储同一位置（即SaveInfoSet 的第一个存储位置）； SaveInfoSet 存储的Id：存储在指定的存储位置。", "example": "“”" }, { "name": "WatermarkInfoSet", "type": "array", "required": false, "description": "水印信息，最多支持 10 个水印。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "水印类型，可选值： Image：图像水印； Text：文字水印。", "example": "“”" }, { "name": "Image", "type": "object", "required": false, "description": "图像水印信息，当 Type=Image 时必选。", "example": "无" }, { "name": "Text", "type": "object", "required": false, "description": "文字水印信息，当 Type=Text 时必选。", "example": "无" } ] }, { "name": "DropPureColor", "type": "string", "required": false, "description": "是否去除纯色截图，如果值为 True ，对应时间点的截图如果是纯色，将略过。", "example": "“”" } ] }, { "name": "MediaJoiningInfo", "type": "object", "required": false, "description": "视频拼接任务参数，Type=MediaJoining时必选。", "children": [ { "name": "TargetInfo", "type": "object", "required": true, "description": "输出目标信息，拼接只采用FileName和Format，用于指定目标文件名和格式。 其中Format只支持mp4.", "example": "null", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "目标文件名，不能带特殊字符（如/等），无需后缀名，最长200字符。 注1：部分子服务支持占位符，形式为： {parameter} 预设parameter有： index：序号；", "example": "test" }, { "name": "Format", "type": "string", "required": true, "description": "媒体封装格式，最长5字符，具体格式支持根据子任务确定。", "example": "mp4" }, { "name": "TargetVideoInfo", "type": "object", "required": false, "description": "视频流信息。", "example": "null" }, { "name": "ResultListSaveType", "type": "string", "required": false, "description": "【不再使用】", "example": "\"\"" } ] }, { "name": "Mode", "type": "string", "required": false, "description": "拼接模式： Fast：快速； Normal：正常；", "example": "Fast" } ] }, { "name": "MediaRecognitionInfo", "type": "object", "required": false, "description": "媒体识别任务参数，Type=MediaRecognition时必选", "children": [ { "name": "FrameTagRec", "type": "object", "required": false, "description": "帧标签识别", "children": [ { "name": "TagType", "type": "string", "required": true, "description": "标签类型： \"Common\": 通用类型 \"Game\":游戏类型" }, { "name": "GameExtendType", "type": "string", "required": false, "description": "游戏具体类型: \"HonorOfKings_AnchorViews\":王者荣耀主播视角 \"HonorOfKings_GameViews\":王者荣耀比赛视角 \"LOL_AnchorViews\":英雄联盟主播视角 \"LOL_GameViews\":英雄联盟比赛视角 \"PUBG_AnchorViews\":和平精英主播视角 \"PUBG_GameViews\":和平精英比赛视角" } ] }, { "name": "SubtitleRec", "type": "object", "required": false, "description": "语音字幕识别", "children": [ { "name": "AsrDst", "type": "string", "required": false, "description": "语音识别： zh：中文 en：英文" }, { "name": "TransDst", "type": "string", "required": false, "description": "翻译识别： zh：中文 en：英文" } ] } ] } ] }, { "name": "SourceInfoSet", "type": "array", "required": false, "description": "编辑处理任务输入源列表。", "example": "无", "item_type": "object", "children": [ { "name": "DownInfo", "type": "object", "required": true, "description": "媒体源资源下载信息。", "example": "null", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "下载类型，可选值： 0：UrlInfo； 1：CosInfo。" }, { "name": "UrlInfo", "type": "object", "required": false, "description": "Url形式下载信息，当Type等于0时必选。", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频 URL。 注意：编辑理解仅支持mp4、flv等格式的点播文件，不支持hls；", "example": "“”" }, { "name": "Format", "type": "integer", "required": false, "description": "视频地址格式，可选值： 0：音视频 ; 1：直播流。 默认为0。其他非0非1值默认为0。画质重生任务只支持0。", "example": "0" }, { "name": "Host", "type": "string", "required": false, "description": "【不再支持】指定请求资源时，HTTP头部host的值。", "example": "“”" } ] }, { "name": "CosInfo", "type": "object", "required": false, "description": "Cos形式下载信息，当Type等于1时必选。", "children": [ { "name": "Region", "type": "string", "required": true, "description": "cos 区域值。例如：ap-beijing。" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos 存储桶，格式为BuketName-AppId。例如：test-123456。" }, { "name": "Path", "type": "string", "required": true, "description": "cos 路径。 对于写表示目录，例如：/test； 对于读表示文件路径，例如：/test/test.mp4。" }, { "name": "CosAuthMode", "type": "object", "required": false, "description": "cos 授权信息，不填默认为公有权限。" } ] } ] }, { "name": "Id", "type": "string", "required": false, "description": "媒体源ID标记，用于多个输入源时，请内媒体源的定位，对于多输入的任务，一般要求必选。 ID只能包含字母、数字、下划线、中划线，长读不能超过128。", "example": "“id”" }, { "name": "Type", "type": "string", "required": false, "description": "媒体源类型，具体类型如下： Video：视频 Image：图片 Audio：音频", "example": "Video" } ] }, { "name": "SaveInfoSet", "type": "array", "required": false, "description": "结果存储信息，对于涉及存储的请求必选。部子任务支持数组备份写，具体以对应任务文档为准。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "存储类型，可选值： 1：CosInfo。", "example": "0" }, { "name": "CosInfo", "type": "object", "required": false, "description": "Cos形式存储信息，当Type等于1时必选。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "cos 区域值。例如：ap-beijing。" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos 存储桶，格式为BuketName-AppId。例如：test-123456。" }, { "name": "Path", "type": "string", "required": true, "description": "cos 路径。 对于写表示目录，例如：/test； 对于读表示文件路径，例如：/test/test.mp4。" }, { "name": "CosAuthMode", "type": "object", "required": false, "description": "cos 授权信息，不填默认为公有权限。", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "授权类型，可选值： 0：bucket授权，需要将对应bucket授权给本服务帐号（3020447271和100012301793），否则会读写cos失败； 1：key托管，把cos的账号id和key托管于本服务，本服务会提供一个托管id； 3：临时key授权。 注意：目前智能编辑还不支持临时key授权；画质重生目前只支持bucket授权", "example": "0" }, { "name": "HostedId", "type": "string", "required": false, "description": "cos账号托管id，Type等于1时必选。", "example": "“”" }, { "name": "SecretId", "type": "string", "required": false, "description": "cos身份识别id，Type等于3时必选。", "example": "“”" }, { "name": "SecretKey", "type": "string", "required": false, "description": "cos身份秘钥，Type等于3时必选。", "example": "“”" }, { "name": "Token", "type": "string", "required": false, "description": "临时授权 token，Type等于3时必选。", "example": "“”" } ] } ] }, { "name": "Id", "type": "string", "required": false, "description": "存储信息ID标记，用于多个输出场景。部分任务支持多输出时，一般要求必选。 ID只能包含字母、数字、下划线、中划线，长读不能超过128。", "example": "“”" } ] }, { "name": "CallbackInfoSet", "type": "array", "required": false, "description": "任务结果回调地址信息。部子任务支持数组备份回调，具体以对应任务文档为准。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "回调URL。" } ] } ], "required": [ "MediaProcessInfo" ] }, { "name": "CreateMediaQualityRestorationTask", "description": "创建画质重生任务，对视频进行转码、去噪、去划痕、去毛刺、超分、细节增强和色彩增强。", "status": "online", "parameters": [ { "name": "DownInfo", "type": "object", "required": true, "description": "源文件地址。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "下载类型，可选值： 0：UrlInfo； 1：CosInfo。" }, { "name": "UrlInfo", "type": "object", "required": false, "description": "Url形式下载信息，当Type等于0时必选。", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频 URL。 注意：编辑理解仅支持mp4、flv等格式的点播文件，不支持hls；", "example": "“”" }, { "name": "Format", "type": "integer", "required": false, "description": "视频地址格式，可选值： 0：音视频 ; 1：直播流。 默认为0。其他非0非1值默认为0。画质重生任务只支持0。", "example": "0" }, { "name": "Host", "type": "string", "required": false, "description": "【不再支持】指定请求资源时，HTTP头部host的值。", "example": "“”" } ] }, { "name": "CosInfo", "type": "object", "required": false, "description": "Cos形式下载信息，当Type等于1时必选。", "children": [ { "name": "Region", "type": "string", "required": true, "description": "cos 区域值。例如：ap-beijing。" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos 存储桶，格式为BuketName-AppId。例如：test-123456。" }, { "name": "Path", "type": "string", "required": true, "description": "cos 路径。 对于写表示目录，例如：/test； 对于读表示文件路径，例如：/test/test.mp4。" }, { "name": "CosAuthMode", "type": "object", "required": false, "description": "cos 授权信息，不填默认为公有权限。", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "授权类型，可选值： 0：bucket授权，需要将对应bucket授权给本服务帐号（3020447271和100012301793），否则会读写cos失败； 1：key托管，把cos的账号id和key托管于本服务，本服务会提供一个托管id； 3：临时key授权。 注意：目前智能编辑还不支持临时key授权；画质重生目前只支持bucket授权", "example": "0" }, { "name": "HostedId", "type": "string", "required": false, "description": "cos账号托管id，Type等于1时必选。", "example": "“”" }, { "name": "SecretId", "type": "string", "required": false, "description": "cos身份识别id，Type等于3时必选。", "example": "“”" }, { "name": "SecretKey", "type": "string", "required": false, "description": "cos身份秘钥，Type等于3时必选。", "example": "“”" }, { "name": "Token", "type": "string", "required": false, "description": "临时授权 token，Type等于3时必选。", "example": "“”" } ] } ] } ] }, { "name": "TransInfo", "type": "array", "required": true, "description": "画质重生任务参数信息。", "example": "无", "item_type": "object", "children": [ { "name": "TaskName", "type": "string", "required": true, "description": "子任务名称。" }, { "name": "TargetInfo", "type": "object", "required": true, "description": "目标文件信息。", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "目标文件名" }, { "name": "SegmentInfo", "type": "object", "required": false, "description": "目标文件切片信息", "children": [ { "name": "FragmentTime", "type": "integer", "required": false, "description": "每个切片平均时长，默认10s。" }, { "name": "SegmentType", "type": "string", "required": false, "description": "切片类型，可选项：hls，不填时默认hls。" }, { "name": "FragmentName", "type": "string", "required": false, "description": "切片文件名字。注意： 1.不填切片文件名时，默认按照按照如下格式命名：m3u8文件名{order}。 2.若填了切片文件名字，则会按照如下格式命名：用户指定文件名{order}。" } ] } ] }, { "name": "EditInfo", "type": "object", "required": false, "description": "视频剪辑信息。注意：如果填写了EditInfo，则VideoInfo和AudioInfo必填", "children": [ { "name": "StartTime", "type": "integer", "required": true, "description": "剪辑开始时间，单位：ms。" }, { "name": "EndTime", "type": "integer", "required": true, "description": "剪辑结束时间，单位：ms" } ] }, { "name": "VideoInfo", "type": "object", "required": false, "description": "视频转码信息，不填保持和源文件一致。", "children": [ { "name": "Fps", "type": "integer", "required": false, "description": "视频帧率，取值范围：[0, 60]，单位：Hz。 注意：当取值为 0，表示帧率和原始视频保持一致。", "example": "25" }, { "name": "Width", "type": "integer", "required": false, "description": "宽度，取值范围：0 和 [128, 4096] 注意： 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "高度，取值范围：0 和 [128, 4096] 注意： 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。", "example": "720" }, { "name": "LongSide", "type": "integer", "required": false, "description": "长边分辨率，取值范围：0 和 [128, 4096] 注意： 当 LongSide、ShortSide 均为 0，则分辨率按照Width，Height； 当 LongSide 为 0，ShortSide 非 0，则 LongSide 按比例缩放； 当 LongSide非 0，ShortSide为 0，则 ShortSide 按比例缩放； 当 LongSide、ShortSide 均非 0，则分辨率按用户指定。 长短边优先级高于Weight,Height,设置长短边则忽略宽高。", "example": "1280" }, { "name": "ShortSide", "type": "integer", "required": false, "description": "短边分辨率，取值范围：0 和 [128, 4096] 注意： 当 LongSide、ShortSide 均为 0，则分辨率按照Width，Height； 当 LongSide 为 0，ShortSide 非 0，则 LongSide 按比例缩放； 当 LongSide非 0，ShortSide为 0，则 ShortSide 按比例缩放； 当 LongSide、ShortSide 均非 0，则分辨率按用户指定。 长短边优先级高于Weight,Height,设置长短边则忽略宽高。", "example": "720" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "视频流的码率，取值范围：0 和 [128, 35000]，单位：kbps。当取值为 0，表示视频码率和原始视频保持一致。", "example": "20000" }, { "name": "Gop", "type": "integer", "required": false, "description": "固定I帧之间，视频帧数量，取值范围： [25, 2500]，如果不填，使用编码默认最优序列。", "example": "25" }, { "name": "VideoCodec", "type": "string", "required": false, "description": "编码器支持选项，可选值： h264, h265, av1。 不填默认h264。", "example": "h264" }, { "name": "PicMarkInfo", "type": "array", "required": false, "description": "图片水印。", "example": "无", "item_type": "object", "children": [ { "name": "PosX", "type": "integer", "required": true, "description": "图片水印的X坐标。" }, { "name": "PosY", "type": "integer", "required": true, "description": "图片水印的Y坐标 。" }, { "name": "Path", "type": "string", "required": false, "description": "图片水印路径,，如果不从Cos拉取水印，则必填" }, { "name": "CosInfo", "type": "object", "required": false, "description": "图片水印的Cos 信息，从Cos上拉取图片水印时必填。" }, { "name": "Width", "type": "integer", "required": false, "description": "图片水印宽度，不填为图片原始宽度。" }, { "name": "Height", "type": "integer", "required": false, "description": "图片水印高度，不填为图片原始高度。" }, { "name": "StartTime", "type": "integer", "required": false, "description": "添加图片水印的开始时间,单位：ms。" }, { "name": "EndTime", "type": "integer", "required": false, "description": "添加图片水印的结束时间,单位：ms。" } ] }, { "name": "DarInfo", "type": "object", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。", "example": "无", "children": [ { "name": "FillMode", "type": "integer", "required": false, "description": "填充模式，可选值： 1：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 2：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“。 默认为2。" } ] }, { "name": "Hdr", "type": "string", "required": false, "description": "支持hdr,可选项： hdr10, hlg。 此时，VideoCodec会强制设置为h265, 编码位深为10", "example": "hdr10" }, { "name": "VideoEnhance", "type": "object", "required": false, "description": "画质增强参数信息。", "example": "无", "children": [ { "name": "ArtifactReduction", "type": "object", "required": false, "description": "去编码毛刺、伪影参数。", "example": "无" }, { "name": "Denoising", "type": "object", "required": false, "description": "去噪声参数。", "example": "无" }, { "name": "ColorEnhance", "type": "object", "required": false, "description": "颜色增强参数。", "example": "无" }, { "name": "Sharp", "type": "object", "required": false, "description": "细节增强参数。", "example": "无" }, { "name": "WdSuperResolution", "type": "integer", "required": false, "description": "超分参数，可选项：2，目前仅支持2倍超分。 注意：此参数已经弃用，超分可以使用VideoSuperResolution参数", "example": "2" }, { "name": "FaceProtect", "type": "object", "required": false, "description": "人脸保护信息。", "example": "无" }, { "name": "WdFps", "type": "integer", "required": false, "description": "插帧，取值范围：[0, 60]，单位：Hz。 注意：当取值为 0，表示帧率和原始视频保持一致。", "example": "30" }, { "name": "ScratchRepair", "type": "object", "required": false, "description": "去划痕参数", "example": "无" }, { "name": "LowLightEnhance", "type": "object", "required": false, "description": "低光照增强参数", "example": "无" }, { "name": "VideoSuperResolution", "type": "object", "required": false, "description": "视频超分参数", "example": "无" }, { "name": "VideoRepair", "type": "object", "required": false, "description": "视频画质修复参数", "example": "无" } ] }, { "name": "HiddenMarkInfo", "type": "object", "required": false, "description": "数字水印参数信息。", "example": "无", "children": [ { "name": "Path", "type": "string", "required": true, "description": "数字水印路径,，如果不从Cos拉取水印，则必填", "example": "https://aidata-1251820392.cos.ap-guangzhou.myqcloud.com/logo.png" }, { "name": "Frequency", "type": "integer", "required": false, "description": "数字水印频率，可选值：[1,256]，默认值为30", "example": "30" }, { "name": "Strength", "type": "integer", "required": false, "description": "数字水印强度，可选值：[32,128]，默认值为64", "example": "64" }, { "name": "CosInfo", "type": "object", "required": false, "description": "数字水印的Cos 信息，从Cos上拉取图片水印时必填。", "example": "无" } ] }, { "name": "TextMarkInfo", "type": "array", "required": false, "description": "文本水印参数信息。", "example": "无", "item_type": "object", "children": [ { "name": "Text", "type": "string", "required": true, "description": "文字内容。" }, { "name": "PosX", "type": "integer", "required": true, "description": "文字水印X坐标。" }, { "name": "PosY", "type": "integer", "required": true, "description": "文字水印Y坐标。" }, { "name": "FontSize", "type": "integer", "required": true, "description": "文字大小" }, { "name": "FontFile", "type": "string", "required": false, "description": "字体，可选项：hei,song，simkai,arial；默认hei(黑体）。" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，颜色见附录，不填默认black。" }, { "name": "FontAlpha", "type": "float", "required": false, "description": "文字透明度，可选值0-1。0：不透明，1：全透明。默认为0" } ] } ] }, { "name": "AudioInfo", "type": "object", "required": false, "description": "音频转码信息，不填保持和源文件一致。", "children": [ { "name": "Bitrate", "type": "integer", "required": true, "description": "音频码率，取值范围：0 和 [26, 256]，单位：kbps。 注意：当取值为 0，表示音频码率和原始音频保持一致。", "example": "2000" }, { "name": "Codec", "type": "string", "required": true, "description": "音频编码器，可选项：aac,mp3,ac3,flac,mp2。", "example": "aac" }, { "name": "Channel", "type": "integer", "required": true, "description": "声道数，可选项： 1：单声道， 2：双声道， 6：立体声。", "example": "6" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "采样率，单位：Hz。可选项：32000，44100,48000", "example": "44100" }, { "name": "Denoise", "type": "object", "required": false, "description": "音频降噪信息", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "音频降噪强度，可选项： 1. weak 2.normal， 3.strong 默认为weak" } ] }, { "name": "EnableMuteAudio", "type": "integer", "required": false, "description": "开启添加静音，可选项： 0：不开启， 1：开启， 默认不开启", "example": "1" }, { "name": "LoudnessInfo", "type": "object", "required": false, "description": "音频响度信息", "example": "无", "children": [ { "name": "Loudness", "type": "float", "required": false, "description": "音频整体响度", "example": "-10.5" }, { "name": "LoudnessRange", "type": "float", "required": false, "description": "音频响度范围", "example": "10.5" } ] }, { "name": "AudioEnhance", "type": "object", "required": false, "description": "音频音效增强", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "音效增强种类，可选项：normal", "example": "normal" } ] }, { "name": "RemoveReverb", "type": "object", "required": false, "description": "去除混音", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "去混响类型，可选项：normal", "example": "normal" } ] } ] }, { "name": "MuxInfo", "type": "object", "required": false, "description": "指定封装信息。", "children": [ { "name": "DeleteStream", "type": "string", "required": false, "description": "删除流，可选项：video,audio。", "example": "video" }, { "name": "FlvFlags", "type": "string", "required": false, "description": "Flv 参数，目前支持add_keyframe_index", "example": "add_keyframe_index" } ] } ] }, { "name": "SaveInfo", "type": "object", "required": true, "description": "任务结束后文件存储信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "存储类型，可选值： 1：CosInfo。", "example": "0" }, { "name": "CosInfo", "type": "object", "required": false, "description": "Cos形式存储信息，当Type等于1时必选。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "cos 区域值。例如：ap-beijing。" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos 存储桶，格式为BuketName-AppId。例如：test-123456。" }, { "name": "Path", "type": "string", "required": true, "description": "cos 路径。 对于写表示目录，例如：/test； 对于读表示文件路径，例如：/test/test.mp4。" }, { "name": "CosAuthMode", "type": "object", "required": false, "description": "cos 授权信息，不填默认为公有权限。", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "授权类型，可选值： 0：bucket授权，需要将对应bucket授权给本服务帐号（3020447271和100012301793），否则会读写cos失败； 1：key托管，把cos的账号id和key托管于本服务，本服务会提供一个托管id； 3：临时key授权。 注意：目前智能编辑还不支持临时key授权；画质重生目前只支持bucket授权", "example": "0" }, { "name": "HostedId", "type": "string", "required": false, "description": "cos账号托管id，Type等于1时必选。", "example": "“”" }, { "name": "SecretId", "type": "string", "required": false, "description": "cos身份识别id，Type等于3时必选。", "example": "“”" }, { "name": "SecretKey", "type": "string", "required": false, "description": "cos身份秘钥，Type等于3时必选。", "example": "“”" }, { "name": "Token", "type": "string", "required": false, "description": "临时授权 token，Type等于3时必选。", "example": "“”" } ] } ] }, { "name": "Id", "type": "string", "required": false, "description": "存储信息ID标记，用于多个输出场景。部分任务支持多输出时，一般要求必选。 ID只能包含字母、数字、下划线、中划线，长读不能超过128。", "example": "“”" } ] }, { "name": "CallbackInfo", "type": "object", "required": false, "description": "任务结果回调地址信息。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "回调URL。" } ] }, { "name": "TopSpeedCodecChannel", "type": "integer", "required": false, "description": "极速高清体验馆渠道标志。", "example": "无" } ], "required": [ "DownInfo", "TransInfo", "SaveInfo" ] }, { "name": "CreateQualityControlTask", "description": "通过接口可以智能检测视频画面中抖动重影、模糊、低光照、过曝光、黑边、白边、黑屏、白屏、花屏、噪点、马赛克、二维码等在内的多个场景，还可以自动检测视频无音频异常、无声音片段。", "status": "online", "parameters": [ { "name": "QualityControlInfo", "type": "object", "required": true, "description": "质检任务参数", "children": [ { "name": "Interval", "type": "integer", "required": false, "description": "对流进行截图的间隔ms，默认1000ms" }, { "name": "VideoShot", "type": "boolean", "required": false, "description": "是否保存截图" }, { "name": "Jitter", "type": "boolean", "required": false, "description": "是否检测抖动重影" }, { "name": "Blur", "type": "boolean", "required": false, "description": "是否检测模糊" }, { "name": "AbnormalLighting", "type": "boolean", "required": false, "description": "是否检测低光照、过曝" }, { "name": "CrashScreen", "type": "boolean", "required": false, "description": "是否检测花屏" }, { "name": "BlackWhiteEdge", "type": "boolean", "required": false, "description": "是否检测黑边、白边、黑屏、白屏、绿屏" }, { "name": "Noise", "type": "boolean", "required": false, "description": "是否检测噪点" }, { "name": "Mosaic", "type": "boolean", "required": false, "description": "是否检测马赛克" }, { "name": "QRCode", "type": "boolean", "required": false, "description": "是否检测二维码，包括小程序码、条形码" }, { "name": "QualityEvaluation", "type": "boolean", "required": false, "description": "是否开启画面质量评价" }, { "name": "QualityEvalScore", "type": "integer", "required": false, "description": "画面质量评价过滤阈值，结果只返回低于阈值的时间段，默认60" }, { "name": "Voice", "type": "boolean", "required": false, "description": "是否检测视频音频，包含静音、低音、爆音" } ] }, { "name": "DownInfo", "type": "object", "required": true, "description": "视频源信息", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "下载类型，可选值： 0：UrlInfo； 1：CosInfo。" }, { "name": "UrlInfo", "type": "object", "required": false, "description": "Url形式下载信息，当Type等于0时必选。", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频 URL。 注意：编辑理解仅支持mp4、flv等格式的点播文件，不支持hls；", "example": "“”" }, { "name": "Format", "type": "integer", "required": false, "description": "视频地址格式，可选值： 0：音视频 ; 1：直播流。 默认为0。其他非0非1值默认为0。画质重生任务只支持0。", "example": "0" }, { "name": "Host", "type": "string", "required": false, "description": "【不再支持】指定请求资源时，HTTP头部host的值。", "example": "“”" } ] }, { "name": "CosInfo", "type": "object", "required": false, "description": "Cos形式下载信息，当Type等于1时必选。", "children": [ { "name": "Region", "type": "string", "required": true, "description": "cos 区域值。例如：ap-beijing。" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos 存储桶，格式为BuketName-AppId。例如：test-123456。" }, { "name": "Path", "type": "string", "required": true, "description": "cos 路径。 对于写表示目录，例如：/test； 对于读表示文件路径，例如：/test/test.mp4。" }, { "name": "CosAuthMode", "type": "object", "required": false, "description": "cos 授权信息，不填默认为公有权限。", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "授权类型，可选值： 0：bucket授权，需要将对应bucket授权给本服务帐号（3020447271和100012301793），否则会读写cos失败； 1：key托管，把cos的账号id和key托管于本服务，本服务会提供一个托管id； 3：临时key授权。 注意：目前智能编辑还不支持临时key授权；画质重生目前只支持bucket授权", "example": "0" }, { "name": "HostedId", "type": "string", "required": false, "description": "cos账号托管id，Type等于1时必选。", "example": "“”" }, { "name": "SecretId", "type": "string", "required": false, "description": "cos身份识别id，Type等于3时必选。", "example": "“”" }, { "name": "SecretKey", "type": "string", "required": false, "description": "cos身份秘钥，Type等于3时必选。", "example": "“”" }, { "name": "Token", "type": "string", "required": false, "description": "临时授权 token，Type等于3时必选。", "example": "“”" } ] } ] } ] }, { "name": "CallbackInfo", "type": "object", "required": false, "description": "任务结果回调地址信息", "children": [ { "name": "Url", "type": "string", "required": true, "description": "回调URL。" } ] } ], "required": [ "QualityControlInfo", "DownInfo" ] }, { "name": "DescribeEditingTaskResult", "description": "获取编辑理解任务结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "编辑任务 ID。", "example": "8E312055EBF7A503B92947E6D3B21EFF_1573715265075" } ], "required": [ "TaskId" ] }, { "name": "DescribeMediaProcessTaskResult", "description": "用于获取编辑处理任务的结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "编辑处理任务ID。", "example": "12001326083614739554304" } ], "required": [ "TaskId" ] }, { "name": "DescribeMediaQualityRestorationTaskRusult", "description": "获取画质重生任务结果，查看结束后的文件信息", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "画质重生任务ID" } ], "required": [ "TaskId" ] }, { "name": "DescribeQualityControlTaskResult", "description": "获取媒体质检任务结果", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "质检任务 ID" } ], "required": [ "TaskId" ] }, { "name": "StopMediaProcessTask", "description": "用于停止正在进行中的编辑处理任务。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "编辑处理任务ID。", "example": "12001326083614739554304" } ], "required": [ "TaskId" ] }, { "name": "StopMediaQualityRestorationTask", "description": "删除正在进行的画质重生任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "要删除的画质重生任务ID。" } ], "required": [ "TaskId" ] } ] }