发起视频生成精彩集锦接口

最近更新时间:2019-07-24 15:33:55

1. 接口描述

接口请求域名: tci.tencentcloudapi.com 。

发起视频生成精彩集锦接口。该接口可以通过客户传入的课程音频数据及相关策略(如微笑抽取,专注抽取等),自动生成一堂课程的精彩集锦。需要通过QueryHighlightResult接口获取生成结果。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SubmitHighlights
Version String 公共参数,本接口取值:2019-03-18
Region String 公共参数,本接口不需要传递此参数。
Functions HLFunction 表情配置开关项。
FileContent String 视频url。
FileType String 视频类型及来源,目前只支持点播类型:"vod_url"。
LibIds.N Array of String 需要检索的人脸合集库,不在库中的人脸将不参与精彩集锦。
FrameInterval Integer 视频处理的抽帧间隔,单位毫秒。建议留空。
KeywordsLanguage Integer 关键词语言类型,0为英文,1为中文。
KeywordsStrings.N Array of String 关键词数组,当且仅当Funtions中的EnableKeywordWonderfulTime为true时有意义,匹配相应的关键字。
MaxVideoDuration Integer 处理视频的总时长,单位毫秒。该值为0或未设置时,默认值两小时生效;当该值大于视频实际时长时,视频实际时长生效;当该值小于视频实际时长时,该值生效;当获取视频实际时长失败时,若该值设置则生效,否则默认值生效。建议留空。
SimThreshold Float 人脸检索的相似度阈值,默认值0.89。建议留空。

3. 输出参数

参数名称 类型 描述
JobId Integer 视频拆条任务ID,用来唯一标识视频拆条任务。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 提交精彩集锦剪辑任务

根据客户所提供的视频及参数,生成相关的精彩集锦结果。

输入示例

https://tci.tencentcloudapi.com/?Action=SubmitHighlights
&FileCont=https%3A%2F%2Fefpoc-1255701415.cos.ap-shanghai.myqcloud.com%2Fvideos%2Fefpoc_1_27.mp4
&FileType=vod_url
&Functions.EnableFaceDetect=true
&Functions.EnableFaceExpression=true
&Functions.EnableFaceIdent=true
&GistType.0=smile
&LibId.0=test_lib
&<公共请求参数>

输出示例

{
  "Response": {
    "JobId": 278,
    "RequestId": "3c5a7213-e3b5-4732-b5d6-c0ec76897746"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InternalError.JobCanceled 任务已被强制取消
InternalError.JobReachMaxRetryTimes 任务失败重试次数超过上限
InternalError.StatusQueryFaceLibFailed 查询人脸库失败
InvalidParameter 参数错误
InvalidParameter.BodyRetrievalFailed 人体检索失败
InvalidParameter.CannotFindFaceInPicture 图片中没有人脸
InvalidParameter.ClippingFrameFailed 裁剪帧失败
InvalidParameter.ComputationalSimilarityFailed 计算相似度失败
InvalidParameter.CreateFaceFailed 添加 Face 人脸失败
InvalidParameter.CreatePersonFailed 添加 Person 个体失败
InvalidParameter.FaceDetectedFailed 人脸检测失败
InvalidParameter.FaceNotExist 删除face人脸失败,不存在该faceid
InvalidParameter.FaceNotExisted 人脸不存在
InvalidParameter.FaceNumberExceedLimitOfSingleDetection 超出单次检索的人脸数上线
InvalidParameter.FaceNumberLimit 该个体人脸已经到最大值
InvalidParameter.FaceRegistrationFailed 人脸配准失败
InvalidParameter.FaceRetrievalFailed 人脸检索失败
InvalidParameter.FaceTooSmall 人脸太小
InvalidParameter.FailedToDecodeImage 解码图片失败
InvalidParameter.FeatureExtractionFailed 特征提取失败
InvalidParameter.FileContentEmpty 输入内容为空
InvalidParameter.ImageDecodeFailed 输入图片无法解码
InvalidParameter.ImageTooLarge 图片太大
InvalidParameter.ImageTooSmall 图片太小
InvalidParameter.InvalidFileType 不支持的 FileType
InvalidParameter.InvalidLang 无效的语言类型,只支持0 英文,1 中文
InvalidParameter.InvalidResourceName 名称应为60个字符内的汉字、字母、数字或者下划线组成
InvalidParameter.InvalidUrl 输入音频文件无效
InvalidParameter.JobNotValid 任务查询失败,请检查任务标识符后重试
InvalidParameter.LibraryNotExisted 人员库不存在
InvalidParameter.LowQualityPicture 人脸质量低,包括不清晰
InvalidParameter.NoSuchService 服务不存在
InvalidParameter.NotAttendanceJob 非人员考勤任务
InvalidParameter.NotValidPitch 人脸角度pitch不合法
InvalidParameter.NotValidRow 人脸角度row不合法
InvalidParameter.NotValidYaw 人脸角度yaw不合法
InvalidParameter.PersonExisted 指定人员不存在
InvalidParameter.PersonIdNotValid 人员标识不合法
InvalidParameter.PersonNotExist 删除person个体失败,不存在该个体
InvalidParameter.PersonNotExisted 人员不存在
InvalidParameter.PersonNotRegistered 人员未注册
InvalidParameter.ProcessUnReady 任务处理中,请稍后查询。
InvalidParameter.ResourceNameDuplicate 资源名称需要保持唯一
InvalidParameter.StatusJobFailed 任务执行失败,请确保拉流地址稳定
InvalidParameter.StatusJobNotFound 任务不存在
InvalidParameter.StatusJobUnfinished 任务未完成
InvalidParameter.StatusNoCameraFound 没有找到摄像头
InvalidParameter.TooManyFace 图片中含有多张人脸
InvalidParameter.TrackingFailed 轨迹追踪失败
LimitExceeded.StatusCameraCountOverMax 该教室的摄像头数量超出最大限制
ResourceNotFound 资源不存在
ResourceUnavailable.StatusQueryStreamFailed 提交任务时获取拉流地址失败,请确认该教室的摄像头都配置好