云点播
有奖：腾讯混元大模型征文大赛邀您参加！> HOT
文档中心>云点播>服务端 API 文档>数据结构

数据结构

最近更新时间：2024-10-23 01:37:26

我的收藏

本页目录：

AIAnalysisTemplateItem

AI 智能分析模板详情

被如下接口引用：DescribeAIAnalysisTemplates。

名称 类型 描述
Definition Integer 智能分析模板唯一标识。
Name String 智能分析模板名称。
Comment String 智能分析模板描述信息。
ClassificationConfigure ClassificationConfigureInfo 智能分类任务控制参数。
注意：此字段可能返回 null，表示取不到有效值。
TagConfigure TagConfigureInfo 智能标签任务控制参数。
注意：此字段可能返回 null，表示取不到有效值。
CoverConfigure CoverConfigureInfo 智能封面任务控制参数。
注意：此字段可能返回 null，表示取不到有效值。
FrameTagConfigure FrameTagConfigureInfo 智能按帧标签任务控制参数。
注意：此字段可能返回 null，表示取不到有效值。
HighlightConfigure HighlightsConfigureInfo 智能精彩集锦任务控制参数。
CreateTime String 模板创建时间，使用 ISO 日期格式。
UpdateTime String 模板最后修改时间，使用 ISO 日期格式。

AIRecognitionTemplateItem

视频内容识别模板详情

被如下接口引用：DescribeAIRecognitionTemplates。

名称 类型 描述
Definition Integer 视频内容识别模板唯一标识。
Name String 视频内容识别模板名称。
Comment String 视频内容识别模板描述信息。
Type String 模板类型，取值：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Preset
    HeadTailConfigure HeadTailConfigureInfo 头尾识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    SegmentConfigure SegmentConfigureInfo 拆条识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    FaceConfigure FaceConfigureInfo 人脸识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrFullTextConfigure OcrFullTextConfigureInfo 文本全文识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrWordsConfigure OcrWordsConfigureInfo 文本关键词识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrFullTextConfigure AsrFullTextConfigureInfo 语音全文识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrWordsConfigure AsrWordsConfigureInfo 语音关键词识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrTranslateConfigure AsrTranslateConfigureInfo 语音翻译控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ObjectConfigure ObjectConfigureInfo 物体识别控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ScreenshotInterval Float 截图时间间隔，单位：秒。
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。

    AbnormalLightingConfigureInfo

    视频画面低光、过曝检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面低光、过曝检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    AbnormalLightingConfigureInfoForUpdate

    视频画面低光、过曝检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面低光、过曝检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    AccelerateAreaInfo

    域名的地区加速信息

    被如下接口引用：DescribeVodDomains。

    名称 类型 描述
    Area String 加速地区，可选值：
  • Chinese Mainland：中国境内（不包含港澳台）。
  • Outside Chinese Mainland：中国境外。

    • 示例值：Chinese Mainland
    TencentDisableReason String 腾讯禁用原因，可选值：
  • ForLegalReasons：因法律原因导致关闭加速；
  • ForOverdueBills：因欠费停服导致关闭加速。

    • 示例值：ForLegalReasons
    TencentEdgeDomain String 加速域名对应的 CNAME 域名。
    示例值：www.test.com

    AdaptiveDynamicStreamingInfoItem

    转自适应码流信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    Definition Integer 转自适应码流规格。
    示例值：10
    Package String 打包格式，取值范围：
  • HLS；
  • DASH。

    • 示例值：HLS
    DrmType String 加密类型。
    示例值：SimpleAES
    Url String 播放地址。
    示例值：http://xxx.myqcloud.com/xxx.mp4
    Size Integer 媒体文件大小，单位：字节。
  • 当媒体文件为 HLS 时，大小是 m3u8 和 ts 文件大小的总和；
  • 当媒体文件为 DASH 时，大小是 mpd 和分片文件大小的总和；
  • 注意：在 2022-01-10T16:00:00Z 前处理生成的自适应码流文件此字段为0。

    • 示例值：100
    DigitalWatermarkType String 数字水印类型。可选值：
  • Trace 表示经过溯源水印处理；
  • CopyRight 表示经过版权水印处理；
  • None 表示没有经过数字水印处理。

    • 示例值：Trace
    SubStreamSet Array of MediaSubStreamInfoItem 子流信息列表。
    CopyRightWatermarkText String 版权信息。
    示例值：CopyRightXXX
    SubtitleSet Array of MediaSubtitleItem 字幕信息列表。
    DefaultSubtitleId String 默认字幕的唯一标识。
    示例值：subtitle1

    AdaptiveDynamicStreamingTaskInput

    对视频转自适应码流的输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 转自适应码流模板 ID。
    示例值：10
    WatermarkSet Array of WatermarkInput 否 水印列表，支持多张图片或文字水印，最大可支持 10 张。
    示例值：[]
    TraceWatermark TraceWatermarkInput 否 溯源水印，该功能已不再支持使用。
    CopyRightWatermark CopyRightWatermarkInput 否 版权水印，该功能已不再支持使用。
    SubtitleSet Array of String 否 字幕列表，元素为字幕 ID，支持多个字幕，最大可支持16个。
    示例值：[]

    AdaptiveDynamicStreamingTemplate

    转自适应码流模板详情

    被如下接口引用：DescribeAdaptiveDynamicStreamingTemplates。

    名称 类型 描述
    Definition Integer 转自适应码流模板唯一标识。
    示例值：20
    Type String 模板类型，取值范围：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Preset
    Name String 转自适应码流模板名称。
    示例值：xxx
    Comment String 转自适应码流模板描述信息。
    示例值：xxx
    Format String 自适应转码格式，取值范围：
  • HLS。

    • 示例值：HLS
    DrmType String DRM 类型，取值范围：
  • SimpleAES
  • Widevine
  • FairPlay

    • 如果取值为空字符串，代表不对视频做 DRM 保护。
    示例值：SimpleAES
    DrmKeyProvider String DRM 的密钥提供商，取值范围：
  • SDMC：华曦达；
  • VOD：云点播。

    • 默认值为 VOD 。
    示例值：SDMC
    StreamInfos Array of AdaptiveStreamTemplate 自适应转码输入流参数信息，最多输入10路流。
    DisableHigherVideoBitrate Integer 是否禁止视频低码率转高码率，取值范围：
  • 0：否，
  • 1：是。

    • 示例值：0
    DisableHigherVideoResolution Integer 是否禁止视频分辨率转高分辨率，取值范围：
  • 0：否，
  • 1：是。

    • 示例值：0
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    SegmentType String 切片类型，仅当 Format 为 HLS 时有效。
    示例值：xxx

    AdaptiveStreamTemplate

    自适应转码流参数模板

    被如下接口引用：CreateAdaptiveDynamicStreamingTemplate, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate。

    名称 类型 必选 描述
    Video VideoTemplateInfo 是 视频参数信息。
    示例值：null
    Audio AudioTemplateInfo 是 音频参数信息。
    示例值：null
    RemoveAudio Integer 否 是否移除音频流，取值范围：
  • 0：否，
  • 1：是。

    • 示例值：0
    RemoveVideo Integer 否 是否移除视频流，取值范围：
  • 0：否，
  • 1：是。

    • 示例值：0
    TEHDConfig TEHDConfig 否 极速高清转码参数。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null

    AiAnalysisResult

    智能分析结果

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Type String 任务的类型，可以取的值有：
  • Classification：智能分类
  • Cover：智能封面
  • Tag：智能标签
  • FrameTag：智能按帧标签
  • Highlight：智能精彩集锦
    		•
    ClassificationTask AiAnalysisTaskClassificationResult 视频内容分析智能分类任务的查询结果，当任务类型为 Classification 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    CoverTask AiAnalysisTaskCoverResult 视频内容分析智能封面任务的查询结果，当任务类型为 Cover 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TagTask AiAnalysisTaskTagResult 视频内容分析智能标签任务的查询结果，当任务类型为 Tag 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    FrameTagTask AiAnalysisTaskFrameTagResult 视频内容分析智能按帧标签任务的查询结果，当任务类型为 FrameTag 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    HighlightTask AiAnalysisTaskHighlightResult 视频内容分析智能精彩集锦任务的查询结果，当任务类型为 Highlight 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    AiAnalysisTaskClassificationInput

    智能分类任务输入类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 视频智能分类模板 ID。

    AiAnalysisTaskClassificationOutput

    智能分类结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ClassificationSet Array of MediaAiAnalysisClassificationItem 视频智能分类列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 ClassificationSetFileUrl 对应的文件中获取。
    ClassificationSetFileUrl String 视频智能分类列表文件 URL。文件的内容为 JSON，数据结构与 ClassificationSet 字段一致。 （文件不会永久存储，到达 ClassificationSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    ClassificationSetFileUrlExpireTime String 视频智能分类列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiAnalysisTaskClassificationResult

    智能分类任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiAnalysisTaskClassificationInput 智能分类任务输入。
    Output AiAnalysisTaskClassificationOutput 智能分类任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 智能分类任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 智能分类任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 智能分类任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiAnalysisTaskCoverInput

    智能分类任务输入类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 视频智能封面模板 ID。

    AiAnalysisTaskCoverOutput

    智能封面结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    CoverSet Array of MediaAiAnalysisCoverItem 智能封面列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 CoverSetFileUrl 对应的文件中获取。
    CoverSetFileUrl String 智能封面列表文件 URL。文件的内容为 JSON，数据结构与 CoverSet 字段一致。 （文件不会永久存储，到达 CoverSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    CoverSetFileUrlExpireTime String 智能封面列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiAnalysisTaskCoverResult

    智能封面结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiAnalysisTaskCoverInput 智能封面任务输入。
    Output AiAnalysisTaskCoverOutput 智能封面任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 智能封面任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 智能封面任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 智能封面任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiAnalysisTaskFrameTagInput

    智能按帧标签任务输入类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 视频智能按帧标签模板 ID。

    AiAnalysisTaskFrameTagOutput

    智能按帧标签结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    SegmentSet Array of MediaAiAnalysisFrameTagSegmentItem 视频按帧标签列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String 视频按帧标签列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String 视频按帧标签列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiAnalysisTaskFrameTagResult

    智能按帧标签结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiAnalysisTaskFrameTagInput 智能按帧标签任务输入。
    Output AiAnalysisTaskFrameTagOutput 智能按帧标签任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 智能按帧标签任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 智能按帧标签任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 智能按帧标签任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiAnalysisTaskHighlightInput

    智能精彩片段任务输入类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 视频智能精彩片段模板 ID。

    AiAnalysisTaskHighlightOutput

    智能精彩片段结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    HighlightSet Array of MediaAiAnalysisHighlightItem 视频智能精彩片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 HighlightSetFileUrl 对应的文件中获取。
    HighlightSetFileUrl String 视频智能精彩片段列表文件 URL。文件的内容为 JSON，数据结构与 HighlightSet 字段一致。 （文件不会永久存储，到达 HighlightSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    HighlightSetFileUrlExpireTime String 视频智能精彩片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiAnalysisTaskHighlightResult

    智能精彩片段结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiAnalysisTaskHighlightInput 智能精彩片段任务输入。
    Output AiAnalysisTaskHighlightOutput 智能精彩片段任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 智能精彩片段任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 智能精彩片段任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 智能精彩片段任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiAnalysisTaskInput

    AI 视频智能分析输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 视频内容分析模板 ID。

    AiAnalysisTaskTagInput

    智能标签任务输入类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 视频智能标签模板 ID。

    AiAnalysisTaskTagOutput

    智能标签结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TagSet Array of MediaAiAnalysisTagItem 视频智能标签列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 TagSetFileUrl 对应的文件中获取。
    TagSetFileUrl String 视频智能标签列表文件 URL。文件的内容为 JSON，数据结构与 TagSet 字段一致。 （文件不会永久存储，到达 TagSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    TagSetFileUrlExpireTime String 视频智能标签列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiAnalysisTaskTagResult

    智能标签结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiAnalysisTaskTagInput 智能标签任务输入。
    Output AiAnalysisTaskTagOutput 智能标签任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 智能标签任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 智能标签任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 智能标签任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiContentReviewResult

    音视频审核结果

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Type String 任务的类型，可以取的值有：
  • Porn：图片鉴别是否涉及令人反感的信息
  • Terrorism：图片鉴别是否涉及令人不安全的信息
  • Political：图片鉴别是否涉及令人不适宜的信息
  • Porn.Asr：Asr 文字（ 音频中的文字）鉴别是否涉及令人反感的信息
  • Porn.Ocr：Ocr 文字鉴别是否涉及令人反感的信息
  • Political.Asr：Asr 文字（ 音频中的文字）鉴别是否涉及令人不适宜的信息
  • Political.Ocr：Ocr 文字鉴别是否涉及令人不适宜的信息
  • Terrorism.Ocr：Ocr 文字鉴别是否涉及令人不安全的信息
  • Prohibited.Asr：Asr 文字（ 音频中的文字）鉴违禁
  • Prohibited.Ocr：Ocr 文字鉴违禁

    • 示例值：Porn
    PornTask AiReviewTaskPornResult 视频音视频审核任务（画面涉及令人反感的信息）的查询结果，当任务类型为 Porn 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TerrorismTask AiReviewTaskTerrorismResult 视频音视频审核任务（画面涉及令人不安全的信息）的查询结果，当任务类型为 Terrorism 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PoliticalTask AiReviewTaskPoliticalResult 视频音视频审核任务（画面涉及令人不适宜的信息）的查询结果，当任务类型为 Political 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PornAsrTask AiReviewTaskPornAsrResult 视频音视频审核任务（Asr 文字涉及令人反感的信息）的查询结果，当任务类型为 Porn.Asr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PornOcrTask AiReviewTaskPornOcrResult 视频音视频审核任务（Ocr 文字涉及令人反感的信息）的查询结果，当任务类型为 Porn.Ocr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PoliticalAsrTask AiReviewTaskPoliticalAsrResult 视频音视频审核任务（Asr 文字涉及令人不适宜的信息）的查询结果，当任务类型为 Political.Asr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PoliticalOcrTask AiReviewTaskPoliticalOcrResult 视频音视频审核任务（Ocr 文字涉及令人不适宜的信息）的查询结果，当任务类型为 Political.Ocr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TerrorismOcrTask AiReviewTaskTerrorismOcrResult 视频音视频审核任务（ Ocr 文字涉及令人不安全的信息）的查询结果，当任务类型为 Terrorism.Ocr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ProhibitedOcrTask AiReviewTaskProhibitedOcrResult 视频音视频审核 Ocr 文字鉴违禁任务的查询结果，当任务类型为 Prohibited.Ocr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ProhibitedAsrTask AiReviewTaskProhibitedAsrResult 视频音视频审核 Asr 文字鉴违禁任务的查询结果，当任务类型为 Prohibited.Asr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    AiContentReviewTaskInput

    音视频审核任务类型

    被如下接口引用：CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 音视频审核模板 ID。
    示例值：20

    AiRecognitionResult

    智能识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Type String 任务的类型，取值范围：
  • FaceRecognition：人脸识别，
  • AsrWordsRecognition：语音关键词识别，
  • OcrWordsRecognition：文本关键词识别，
  • AsrFullTextRecognition：语音全文识别，
  • AsrTranslateRecognition：语音翻译识别，
  • OcrFullTextRecognition：文本全文识别，
  • HeadTailRecognition：视频片头片尾识别，
  • ObjectRecognition：物体识别。
    		•
    HeadTailTask AiRecognitionTaskHeadTailResult 视频片头片尾识别结果，当 Type 为
    HeadTailRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    SegmentTask AiRecognitionTaskSegmentResult 视频拆条识别结果，当 Type 为
    SegmentRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    FaceTask AiRecognitionTaskFaceResult 人脸识别结果，当 Type 为
    FaceRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrWordsTask AiRecognitionTaskAsrWordsResult 语音关键词识别结果，当 Type 为
    AsrWordsRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrFullTextTask AiRecognitionTaskAsrFullTextResult 语音全文识别结果，当 Type 为
    AsrFullTextRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrTranslateTask AiRecognitionTaskAsrTranslateResult 语音翻译结果，当 Type 为 AsrTranslateRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrWordsTask AiRecognitionTaskOcrWordsResult 文本关键词识别结果，当 Type 为
    OcrWordsRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrFullTextTask AiRecognitionTaskOcrFullTextResult 文本全文识别结果，当 Type 为
    OcrFullTextRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ObjectTask AiRecognitionTaskObjectResult 物体识别结果，当 Type 为
    ObjectRecognition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    AiRecognitionTaskAsrFullTextResult

    语音全文识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：SUCCESS
    Input AiRecognitionTaskAsrFullTextResultInput 语音全文识别任务输入信息。
    示例值：null
    Output AiRecognitionTaskAsrFullTextResultOutput 语音全文识别任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    Progress Integer 语音全文识别任务进度，取值范围 [0-100] 。
    示例值：0
    BeginProcessTime String 语音全文识别任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 语音全文识别任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskAsrFullTextResultInput

    语音全文识别的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 语音全文识别模板 ID。

    AiRecognitionTaskAsrFullTextResultOutput

    语音全文识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    SegmentSet Array of AiRecognitionTaskAsrFullTextSegmentItem 语音全文识别片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    示例值：null
    SegmentSetFileUrl String 语音全文识别片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://123xxx
    SegmentSetFileUrlExpireTime String 语音全文识别片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z
    SubtitleSet Array of AiRecognitionTaskAsrFullTextResultOutputSubtitleItem 生成的字幕列表，对应 语音全文识别任务控制参数 SubtitleFormats。
    SubtitleUrl String 生成的字幕文件 Url，对应 语音全文识别任务控制参数 SubtitleFormat。
    示例值：http://123xxx

    AiRecognitionTaskAsrFullTextResultOutputSubtitleItem

    字幕信息。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Id String 媒资字幕 ID，用于媒资字幕管理，仅当 Format 为 vtt 时有效。
    注意：2024-11-01T10:00:00Z 之前的任务返回此字段无效。
    Name String 媒资字幕名字，用于播放器展示，仅当 Format 为 vtt 时有效。
    注意：2024-11-01T10:00:00Z 之前的任务返回此字段无效。
    Language String 字幕语言。
    Format String 字幕文件格式，取值范围：
  • vtt：WebVTT 字幕文件；
  • srt：SRT 字幕文件。

    • 示例值：vtt
    Url String 字幕文件 Url。
    示例值：/xxxx/sdf

    AiRecognitionTaskAsrFullTextSegmentItem

    语音全文识别片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float 识别片段置信度。取值：0~100。
    StartTimeOffset Float 识别片段起始的偏移时间，单位：秒。
    EndTimeOffset Float 识别片段终止的偏移时间，单位：秒。
    Text String 识别文本。

    AiRecognitionTaskAsrTranslateResult

    语音翻译结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：SUCCESS
    Input AiRecognitionTaskAsrTranslateResultInput 语音翻译任务输入信息。
    示例值：null
    Output AiRecognitionTaskAsrTranslateResultOutput 语音翻译任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    Progress Integer 语音翻译任务进度，取值范围 [0-100] 。
    示例值：0
    BeginProcessTime String 语音翻译任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 语音翻译任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskAsrTranslateResultInput

    语音翻译的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 语音翻译模板 ID。

    AiRecognitionTaskAsrTranslateResultOutput

    语音翻译结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    SegmentSet Array of AiRecognitionTaskAsrTranslateSegmentItem 语音翻译片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    示例值：null
    SegmentSetFileUrl String 语音翻译片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://123xxx
    SegmentSetFileUrlExpireTime String 语音翻译片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z
    SubtitleSet Array of AiRecognitionTaskAsrFullTextResultOutputSubtitleItem 生成的字幕列表。

    AiRecognitionTaskAsrTranslateSegmentItem

    语音翻译片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float 语音翻译片段置信度。取值：0~100。
    StartTimeOffset Float 语音翻译片段起始的偏移时间，单位：秒。
    EndTimeOffset Float 语音翻译片段终止的偏移时间，单位：秒。
    Text String 识别文本。
    Translation String 翻译文本。

    AiRecognitionTaskAsrWordsResult

    语音关键词识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiRecognitionTaskAsrWordsResultInput 语音关键词识别任务输入信息。
    Output AiRecognitionTaskAsrWordsResultOutput 语音关键词识别任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 语音关键词识别任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 语音关键词识别任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 语音关键词识别任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskAsrWordsResultInput

    语音关键词识别输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 语音关键词识别模板 ID。

    AiRecognitionTaskAsrWordsResultItem

    语音关键词识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Word String 语音关键词。
    SegmentSet Array of AiRecognitionTaskAsrWordsSegmentItem 语音关键词出现的时间片段列表。

    AiRecognitionTaskAsrWordsResultOutput

    语音关键词识别输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskAsrWordsResultItem 语音关键词识别结果集。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 ResultSetFileUrl 对应的文件中获取。
    示例值：null
    ResultSetFileUrl String 语音关键词识别结果集文件 URL。文件的内容为 JSON，数据结构与 ResultSet 字段一致。 （文件不会永久存储，到达ResultSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：htttp://12xxx
    ResultSetFileUrlExpireTime String 语音关键词识别结果集文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiRecognitionTaskAsrWordsSegmentItem

    语音识别片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 识别片段起始的偏移时间，单位：秒。
    EndTimeOffset Float 识别片段终止的偏移时间，单位：秒。
    Confidence Float 识别片段置信度。取值：0~100。

    AiRecognitionTaskFaceResult

    人脸识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiRecognitionTaskFaceResultInput 人脸识别任务输入信息。
    Output AiRecognitionTaskFaceResultOutput 人脸识别任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 人脸识别任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 人脸识别任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 人脸识别任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskFaceResultInput

    人脸识别输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 人脸识别模板 ID。

    AiRecognitionTaskFaceResultItem

    人脸识别结果

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Id String 人物唯一标识 ID。
    Type String 人物库类型，表示识别出的人物来自哪个人物库：
  • Default：默认人物库；
  • UserDefine：用户自定义人物库。
    		•
    Name String 人物名称。
    SegmentSet Array of AiRecognitionTaskFaceSegmentItem 人物出现的片段结果集。

    AiRecognitionTaskFaceResultOutput

    智能人脸识别输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskFaceResultItem 智能人脸识别结果集。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 ResultSetFileUrl 对应的文件中获取。
    示例值：null
    ResultSetFileUrl String 智能人脸识别结果集文件 URL。文件的内容为 JSON，数据结构与 ResultSet 字段一致。 （文件不会永久存储，到达ResultSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://123xxx
    ResultSetFileUrlExpireTime String 智能人脸识别结果集文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiRecognitionTaskFaceSegmentItem

    人脸识别结果片段

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 识别片段起始的偏移时间，单位：秒。
    EndTimeOffset Float 识别片段终止的偏移时间，单位：秒。
    Confidence Float 识别片段置信度。取值：0~100。
    AreaCoordSet Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2]，依次表示区域左上点、右下点的横纵坐标。

    AiRecognitionTaskHeadTailResult

    视频片头片尾识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiRecognitionTaskHeadTailResultInput 视频片头片尾识别任务输入信息。
    Output AiRecognitionTaskHeadTailResultOutput 视频片头片尾识别任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 视频片头片尾识别任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 视频片头片尾识别任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 视频片头片尾识别任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskHeadTailResultInput

    视频片头片尾识别的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 视频片头片尾识别模板 ID。

    AiRecognitionTaskHeadTailResultOutput

    视频片头片尾识别输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    HeadConfidence Float 片头识别置信度。取值：0~100。
    HeadTimeOffset Float 视频片头的结束时间点，单位：秒。
    TailConfidence Float 片尾识别置信度。取值：0~100。
    TailTimeOffset Float 视频片尾的开始时间点，单位：秒。

    AiRecognitionTaskInput

    视频内容识别输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 视频智能识别模板 ID 。
    示例值：20

    AiRecognitionTaskObjectResult

    物体识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiRecognitionTaskObjectResultInput 物体识别任务输入信息。
    Output AiRecognitionTaskObjectResultOutput 物体识别任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 物体识别任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 物体识别任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 物体识别任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskObjectResultInput

    物体识别任务输入类型。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 物体识别模板 ID。

    AiRecognitionTaskObjectResultItem

    单个物体识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Name String 识别的物体名称。
    RecognitionSegmentSet Array of AiRecognitionTaskObjectSegmentItem 物体出现的片段列表。

    AiRecognitionTaskObjectResultOutput

    智能物体识别输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskObjectResultItem 智能物体识别结果集。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 ResultSetFileUrl 对应的文件中获取。
    示例值：null
    ResultSetFileUrl String 智能物体识别结果集文件 URL。文件的内容为 JSON，数据结构与 ResultSet 字段一致。 （文件不会永久存储，到达ResultSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    ResultSetFileUrlExpireTime String 智能物体识别结果集文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiRecognitionTaskObjectSegmentItem

    物体识别结果片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 识别片段起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 识别片段终止的偏移时间，单位：秒。
    示例值：10
    Confidence Float 识别片段置信度。取值：0~100。
    示例值：90
    AreaCoordSet Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2]，依次表示区域左上点、右下点的横纵坐标。
    示例值：[529,212,580,242]

    AiRecognitionTaskOcrFullTextResult

    文本全文识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiRecognitionTaskOcrFullTextResultInput 文本全文识别任务输入信息。
    Output AiRecognitionTaskOcrFullTextResultOutput 文本全文识别任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 文本全文识别任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 文本全文识别任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 文本全文识别任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskOcrFullTextResultInput

    文本全文识别输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 文本全文识别模板 ID。

    AiRecognitionTaskOcrFullTextResultOutput

    文本全文识别输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    SegmentSet Array of AiRecognitionTaskOcrFullTextSegmentItem 文本全文识别结果集。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    示例值：null
    SegmentSetFileUrl String 文本全文识别结果集文件 URL。文件的内容为 JSON，数据结构与 ResultSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String 文本全文识别结果集文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiRecognitionTaskOcrFullTextSegmentItem

    文本全文识别片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 识别片段起始的偏移时间，单位：秒。
    EndTimeOffset Float 识别片段终止的偏移时间，单位：秒。
    TextSet Array of AiRecognitionTaskOcrFullTextSegmentTextItem 识别片段结果集。

    AiRecognitionTaskOcrFullTextSegmentTextItem

    文本全文识别片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float 识别片段置信度。取值：0~100。
    AreaCoordSet Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2]，依次表示区域左上点、右下点的横纵坐标。
    Text String 识别文本。

    AiRecognitionTaskOcrWordsResult

    文本关键识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiRecognitionTaskOcrWordsResultInput 文本关键词识别任务输入信息。
    Output AiRecognitionTaskOcrWordsResultOutput 文本关键词识别任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 文本关键词识别任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 文本关键词识别任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 文本关键词识别任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskOcrWordsResultInput

    文本关键词识别输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 文本关键词识别模板 ID。

    AiRecognitionTaskOcrWordsResultItem

    文本关键词识别结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Word String 文本关键词。
    SegmentSet Array of AiRecognitionTaskOcrWordsSegmentItem 文本关键出现的片段列表。

    AiRecognitionTaskOcrWordsResultOutput

    文本关键词识别输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskOcrWordsResultItem 文本关键词识别结果集。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 ResultSetFileUrl 对应的文件中获取。
    示例值：null
    ResultSetFileUrl String 文本关键词识别结果集文件 URL。文件的内容为 JSON，数据结构与 ResultSet 字段一致。 （文件不会永久存储，到达ResultSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    ResultSetFileUrlExpireTime String 文本关键词识别结果集文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiRecognitionTaskOcrWordsSegmentItem

    文本识别片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 识别片段起始的偏移时间，单位：秒。
    EndTimeOffset Float 识别片段终止的偏移时间，单位：秒。
    Confidence Float 识别片段置信度。取值：0~100。
    AreaCoordSet Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2]，依次表示区域左上点、右下点的横纵坐标。

    AiRecognitionTaskSegmentResult

    视频拆条结果。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AiRecognitionTaskSegmentResultInput 视频拆条任务输入信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Output AiRecognitionTaskSegmentResultOutput 视频拆条任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 视频拆条任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 视频拆条任务开始执行的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FinishTime String 视频拆条任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    AiRecognitionTaskSegmentResultInput

    视频拆条输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 视频拆条模板 ID。

    AiRecognitionTaskSegmentResultOutput

    视频拆条输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    SegmentSet Array of AiRecognitionTaskSegmentSegmentItem 视频拆条片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    示例值：null
    SegmentSetFileUrl String 视频拆条片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://123xxx
    SegmentSetFileUrlExpireTime String 视频拆条片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiRecognitionTaskSegmentSegmentItem

    视频拆条片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 文件 ID。仅当处理的是点播文件并且拆条生成的子片段为点播文件时有效。
    SegmentUrl String 视频拆条片段 Url。
    Confidence Float 拆条片段置信度。取值：0~100。
    StartTimeOffset Float 拆条片段起始的偏移时间，单位：秒。
    EndTimeOffset Float 拆条片段终止的偏移时间，单位：秒。
    CovImgUrl String 拆条封面图片 Url。
    SpecialInfo String 特殊字段，请忽略。

    AiReviewPoliticalAsrTaskInput

    音视频审核 Asr 文字涉及令人不适宜的信息、违规任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴别涉及令人不适宜信息的模板 ID。
    示例值：20

    AiReviewPoliticalAsrTaskOutput

    Asr 文字涉及令人不适宜的信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float Asr 文字涉及令人不适宜的信息、违规评分，分值为0到100。
    示例值：0
    Suggestion String Asr 文字涉及令人不适宜的信息、违规结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉及令人不适宜的信息、违规嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String Asr 文字有涉及令人不适宜的信息、违规嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String Asr 文字有涉及令人不适宜的信息、违规嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewPoliticalOcrTaskInput

    音视频审核 Ocr 文字涉及令人不适宜信息的任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴别涉及令人不适宜信息的模板 ID。
    示例值：20

    AiReviewPoliticalOcrTaskOutput

    Ocr 文字涉及令人不适宜的信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float Ocr 文字涉及令人不适宜的信息、违规评分，分值为0到100。
    示例值：0
    Suggestion String Ocr 文字涉及令人不适宜的信息、违规结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉及令人不适宜的信息、违规嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String Ocr 文字有涉及令人不适宜的信息、违规嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String Ocr 文字有涉及令人不适宜的信息、违规嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewPoliticalTaskInput

    音视频审核涉及令人不适宜信息的任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴别涉及令人不适宜信息的模板 ID。
    示例值：20

    AiReviewPoliticalTaskOutput

    涉及令人不适宜的信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float 视频涉及令人不适宜信息的评分，分值为0到100。
    示例值：0
    Suggestion String 涉及令人不适宜信息的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    Label String 视频涉及令人不适宜信息的结果标签。音视频审核模板画面鉴政任务控制参数里 LabelSet 参数与此参数取值范围的对应关系：
    violation_photo：
  • violation_photo：违规图标。

    • 其他（即 politician/entertainment/sport/entrepreneur/scholar/celebrity/military）：
  • politician：相关人物。

    • 示例值：violation_photo
    SegmentSet Array of MediaContentReviewPoliticalSegmentItem 有涉及令人不适宜信息嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String 有涉及令人不适宜的信息嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String 有涉及令人不适宜的信息嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewPornAsrTaskInput

    音视频审核 Asr 文字涉及令人反感的信息的任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴别涉及令人反感的信息的模板 ID。
    示例值：20

    AiReviewPornAsrTaskOutput

    Asr 文字涉及令人反感的信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float Asr 文字涉及令人反感的信息的评分，分值为0到100。
    示例值：0
    Suggestion String Asr 文字涉及令人反感的信息的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉及令人反感的信息的嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String Asr 文字有涉及令人反感的信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String Asr 文字有涉及令人反感的信息的嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewPornOcrTaskInput

    音视频审核 Ocr 文字涉及令人反感的信息的任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴别涉及令人反感的信息的模板 ID。
    示例值：20

    AiReviewPornOcrTaskOutput

    Ocr 文字涉及令人反感的信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float Ocr 文字涉及令人反感的信息的评分，分值为0到100。
    示例值：0
    Suggestion String Ocr 文字涉及令人反感的信息的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉及令人反感的信息的嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String Ocr 文字有涉及令人反感的信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String Ocr 文字有涉及令人反感的信息的嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewPornTaskInput

    音视频审核涉及令人反感的信息的任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 必选 描述
    Definition Integer 是 鉴别涉及令人反感的信息的模板 ID。
    示例值：20

    AiReviewPornTaskOutput

    鉴别涉及令人反感的信息的结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float 视频鉴别涉及令人反感的信息的评分，分值为0到100。
    示例值：0
    Suggestion String 鉴别涉及令人反感的信息的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    Label String 视频鉴别涉及令人反感的信息的结果标签，取值范围：
  • porn：色情。
  • sexy：性感。
  • vulgar：低俗。
  • intimacy：亲密行为。

    • 示例值：porn
    SegmentSet Array of MediaContentReviewSegmentItem 有涉及令人反感的信息的嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String 涉及令人反感的信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String 涉及令人反感的信息的嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewProhibitedAsrTaskInput

    音视频审核 Asr 文字鉴违禁任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴违禁模板 ID。
    示例值：20

    AiReviewProhibitedAsrTaskOutput

    Asr 文字涉违禁信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float Asr 文字涉违禁评分，分值为0到100。
    示例值：0
    Suggestion String Asr 文字涉违禁结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉违禁嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String Asr 文字有涉违禁嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String Asr 文字有涉违禁嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewProhibitedOcrTaskInput

    音视频审核 Ocr 文字鉴违禁任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴违禁模板 ID。
    示例值：20

    AiReviewProhibitedOcrTaskOutput

    Ocr 文字涉违禁信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float Ocr 文字涉违禁评分，分值为0到100。
    示例值：0
    Suggestion String Ocr 文字涉违禁结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉违禁嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String Ocr 文字有涉违禁嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String Ocr 文字有涉违禁嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewTaskPoliticalAsrResult

    音视频审核 Asr 文字涉及令人不适宜信息、违规任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewPoliticalAsrTaskInput 音视频审核 Asr 文字涉及令人不适宜信息的任务输入。
    Output AiReviewPoliticalAsrTaskOutput 音视频审核 Asr 文字涉及令人不适宜信息的任务输出。
    Progress Integer 音视频审核 Asr 文字涉及令人不适宜信息的任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskPoliticalOcrResult

    音视频审核 Ocr 文字涉及令人不适宜信息、违规任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewPoliticalOcrTaskInput 音视频审核 Ocr 文字涉及令人不适宜信息的任务输入。
    Output AiReviewPoliticalOcrTaskOutput 音视频审核 Ocr 文字涉及令人不适宜信息的任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核 Ocr 文字涉及令人不适宜信息的任务进度，取值范围 [0-100] 。
    示例值：0

    AiReviewTaskPoliticalResult

    音视频审核涉及令人不适宜信息的任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewPoliticalTaskInput 音视频审核涉及令人不适宜信息的任务输入。
    Output AiReviewPoliticalTaskOutput 音视频审核涉及令人不适宜信息的任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核涉及令人不适宜信息的任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskPornAsrResult

    音视频审核 Asr 文字涉及令人反感的信息的任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewPornAsrTaskInput 音视频审核 Asr 文字涉及令人反感的信息的任务输入。
    Output AiReviewPornAsrTaskOutput 音视频审核 Asr 文字涉及令人反感的信息的任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核 Asr 文字涉及令人反感的信息的任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskPornOcrResult

    音视频审核 Ocr 文字涉及令人反感的信息的任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewPornOcrTaskInput 音视频审核 Ocr 文字涉及令人反感的信息的任务输入。
    Output AiReviewPornOcrTaskOutput Ocr 文字音视频审核涉及令人反感的信息的任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer Ocr 文字音视频审核涉及令人反感的信息的任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskPornResult

    音视频审核涉及令人反感的信息的任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewPornTaskInput 音视频审核涉及令人反感的信息的任务输入。
    Output AiReviewPornTaskOutput 音视频审核涉及令人反感的信息的任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核涉及令人反感的信息的任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskProhibitedAsrResult

    音视频审核 Asr 文字鉴违禁任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewProhibitedAsrTaskInput 音视频审核 Asr 文字鉴违禁任务输入。
    Output AiReviewProhibitedAsrTaskOutput 音视频审核 Asr 文字鉴违禁任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核 Asr 文字鉴违禁任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskProhibitedOcrResult

    音视频审核 Ocr 文字鉴违禁任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewProhibitedOcrTaskInput 音视频审核 Ocr 文字鉴违禁任务输入。
    Output AiReviewProhibitedOcrTaskOutput 音视频审核 Ocr 文字鉴违禁任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核 Ocr 文字鉴违禁任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskTerrorismOcrResult

    音视频审核 Ocr 文字鉴别涉及令人不安全的信息的任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewTerrorismOcrTaskInput 音视频审核 Ocr 文字涉及令人不安全的信息的任务输入。
    Output AiReviewTerrorismOcrTaskOutput 音视频审核 Ocr 文字涉及令人不安全的信息的任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核 Ocr 文字涉及令人不安全的信息的任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTaskTerrorismResult

    音视频审核涉及令人不安全的信息的任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：InvalidInput
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：text
    Input AiReviewTerrorismTaskInput 音视频审核涉及令人不安全的信息的任务输入。
    Output AiReviewTerrorismTaskOutput 音视频审核涉及令人不安全的信息的任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 音视频审核涉及令人不安全的信息的任务进度，取值范围 [0-100] 。
    示例值：100

    AiReviewTerrorismOcrTaskInput

    音视频审核 Ocr 文字涉及令人不安全的信息的任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴别涉及令人不安全的信息的模板 ID。
    示例值：20

    AiReviewTerrorismOcrTaskOutput

    Ocr 文字涉及令人不安全的信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float Ocr 文字有涉及令人不安全信息的评分，分值为0到100。
    示例值：0
    Suggestion String Ocr 文字有涉及令人不安全信息的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉及令人不安全信息嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String Ocr 文字有涉及令人不安全信息嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String Ocr 文字有涉及令人不安全信息嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiReviewTerrorismTaskInput

    音视频审核涉及令人不安全的信息的任务输入参数类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Definition Integer 鉴别涉及令人不安全的信息的模板 ID。
    示例值：20

    AiReviewTerrorismTaskOutput

    暴恐信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float 视频暴恐评分，分值为0到100。
    示例值：20
    Suggestion String 暴恐结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值： pass
    Label String 视频暴恐结果标签，取值范围：
  • guns：武器枪支。
  • crowd：人群聚集。
  • police：警察部队。
  • bloody：血腥画面。
  • banners：暴恐旗帜。
  • militant：武装分子。
  • explosion：爆炸火灾。
  • terrorists：暴恐人物。
  • scenario：暴恐画面。

    • 示例值： crowd
    SegmentSet Array of MediaContentReviewSegmentItem 有暴恐嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    示例值：[]
    SegmentSetFileUrl String 暴恐嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://12xxx
    SegmentSetFileUrlExpireTime String 暴恐嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z

    AiSampleFaceInfo

    AI 样本管理，人脸信息。

    被如下接口引用：CreatePersonSample, DescribePersonSamples, ModifyPersonSample。

    名称 类型 描述
    FaceId String 人脸图片 ID。
    Url String 人脸图片地址。

    AiSampleFaceOperation

    AI 样本管理，人脸数据操作。

    被如下接口引用：ModifyPersonSample。

    名称 类型 必选 描述
    Type String 是 操作类型，可选值：add（添加）、delete（删除）、reset（重置）。重置操作将清空该人物已有人脸数据，并添加 FaceContents 指定人脸数据。
    示例值：add
    FaceIds Array of String 否 人脸 ID 集合，当 Type为delete 时，该字段必填。
    示例值：xxxx
    FaceContents Array of String 否 人脸图片 Base64 编码后的字符串集合，仅支持 jpeg、png 图片格式。
  • 当 Type为add 或 reset 时，该字段必填；
  • 数组长度限制：5 张图片。

    • 注意：图片必须是单人像正面人脸较清晰的照片，像素不低于 200*200。
    示例值：xxxx

    AiSampleFailFaceInfo

    AI 样本管理，处理失败的人脸信息

    被如下接口引用：CreatePersonSample, ModifyPersonSample。

    名称 类型 描述
    Index Integer 对应入参 FaceContents 中错误图片下标，从 0 开始。
    ErrCode Integer 错误码，取值：
  • 0：成功；
  • 其他：失败。
    		•
    Message String 错误描述。

    AiSamplePerson

    AI 样本管理，人物信息。

    被如下接口引用：CreatePersonSample, DescribePersonSamples, ModifyPersonSample。

    名称 类型 描述
    PersonId String 人物 ID。
    Name String 人物名称。
    Description String 人物描述。
    FaceInfoSet Array of AiSampleFaceInfo 人脸信息。
    TagSet Array of String 人物标签。
    UsageSet Array of String 应用场景。
    CreateTime String 创建时间，使用 ISO 日期格式。
    UpdateTime String 最后修改时间，使用 ISO 日期格式。

    AiSampleTagOperation

    AI 样本管理，标签操作。

    被如下接口引用：ModifyPersonSample, ModifyWordSample。

    名称 类型 必选 描述
    Type String 是 操作类型，可选值：add（添加）、delete（删除）、reset（重置）。
    Tags Array of String 是 标签，长度限制：128 个字符。

    AiSampleWord

    AI 样本管理，关键词输出信息。

    被如下接口引用：DescribeWordSamples。

    名称 类型 描述
    Keyword String 关键词。
    TagSet Array of String 关键词标签。
    UsageSet Array of String 关键词应用场景。
    CreateTime String 创建时间，使用 ISO 日期格式。
    UpdateTime String 最后修改时间，使用 ISO 日期格式。

    AiSampleWordInfo

    AI 样本管理，关键词输入信息。

    被如下接口引用：CreateWordSamples。

    名称 类型 必选 描述
    Keyword String 是 关键词，长度限制：20 个字符。
    Tags Array of String 否 关键词标签
  • 数组长度限制：20 个标签；
  • 单个标签长度限制：128 个字符。
    		•

    AnimatedGraphicTaskInput

    转动图任务类型

    被如下接口引用：CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 视频转动图模板 ID
    StartTimeOffset Float 是 动图在视频中的起始时间偏移，单位为秒。
  • 不填或填0，表示从视频的起始位置开始；
  • 当数值大于0时（假设为 n），表示从视频的第 n 秒位置开始；
  • 当数值小于0时（假设为 -n），表示从视频结束 n 秒前的位置开始。
    		•
    EndTimeOffset Float 是 动图在视频中的终止时间偏移，单位为秒。
  • 不填或填0，表示持续到视频的末尾终止；
  • 当数值大于0时（假设为 n），表示持续到视频第 n 秒时终止；
  • 当数值小于0时（假设为 -n），表示持续到视频结束 n 秒前终止。
    		•

    AnimatedGraphicsTemplate

    转动图模板详情。

    被如下接口引用：DescribeAnimatedGraphicsTemplates。

    名称 类型 描述
    Definition Integer 转动图模板唯一标识。
    Type String 模板类型，取值范围：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。
    		•
    Name String 转动图模板名称。
    Comment String 转动图模板描述信息。
    Width Integer 动图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    Height Integer 动图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    ResolutionAdaptive String 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。

    • 默认值：open。
    Format String 动图格式。
    Fps Integer 帧率。
    Quality Float 图片质量。
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。

    AreaCLSTargetInfo

    日志推送目标。

    被如下接口引用：DescribeCLSPushTargets, SetCLSPushTarget。

    名称 类型 必选 描述
    CLSRegion String 是 日志集所属地区：
  • ap-guangzhou：广州；
  • ap-beijing：北京；
  • ap-chengdu：成都；
  • ap-chongqing：重庆；
  • ap-nanjing：南京；
  • ap-shanghai：上海；
  • ap-singapore：新加坡。

    • 示例值："ap-guangzhou"
    TopicId String 是 投递的目标主题 ID。
    示例值："780ba384-5bc1-4cb1-a0e9-0cf8fafd3ee0"
    LogsetId String 是 投递的目标集 ID。
    示例值："54079098-61ea-48f9-8270-3b041a5d0150"
    Switch String 否 日志投递状态。
    ON：启用；
    OFF：停用。
    示例值："ON"

    ArtifactRepairInfo

    去伪影（毛刺）控制信息

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 去伪影（毛刺）控制开关，可选值：
  • ON：开启去伪影（毛刺）；
  • OFF：关闭去伪影（毛刺）。

    • 示例值：ON
    Type String 否 去伪影（毛刺）类型，仅当去伪影（毛刺）控制开关为 ON 时有效，可选值：
  • weak：轻去伪影（毛刺）；
  • strong：强去伪影（毛刺）。

    • 默认值：weak。
    示例值：weak

    AsrFullTextConfigureInfo

    语音全文识别任务控制参数

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 语音全文识别任务开关，可选值：
  • ON：开启智能语音全文识别任务；
  • OFF：关闭智能语音全文识别任务。

    • 示例值：ON
    SubtitleFormats Array of String 否 生成的字幕文件格式列表，不填或者填空数组表示不生成字幕文件，可选值：
  • vtt：生成 WebVTT 字幕文件；
  • srt：生成 SRT 字幕文件。
    • 注意：云点播媒资信息仅支持添加 vtt 字幕，因此当且仅当 SubtitleFormats 包含 vtt 时，云点播将生成的字幕添加到媒资。
    示例值：vtt
    SubtitleFormat String 否 生成的字幕文件格式，不填或者填空字符串表示不生成字幕文件，可选值：
  • vtt：生成 WebVTT 字幕文件；
  • srt：生成 SRT 字幕文件。

    • 注意：此字段已废弃，建议使用 SubtitleFormats。
    示例值：vtt
    SrcLanguage String 否 媒体源语言，取值范围：
  • zh：中文普通话；
  • en：英语；
  • ja：日语；
  • zh-ca：粤语。

    • 注意： 填空字符串，或者不填该参数，则自动识别（效果较难保证，推荐填写原始媒体对应的语言，以提高识别的准确率）。
    示例值：zh
    SubtitleName String 否 指定字幕名称，长度限制：64 个字符。该值将用于播放器展示，若不填则云点播自动生成。
    注意：仅当 SubtitleFormats 包含 vtt 时，该字段有效。
    示例值：test

    AsrFullTextConfigureInfoForUpdate

    语音全文识别任务控制参数

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 语音全文识别任务开关，可选值：
  • ON：开启智能语音全文识别任务；
  • OFF：关闭智能语音全文识别任务。

    • 示例值：ON
    SubtitleFormatsOperation SubtitleFormatsOperation 否 字幕格式列表操作信息。
    SubtitleFormat String 否 生成的字幕文件格式，填空字符串表示不生成字幕文件，可选值：
  • vtt：生成 WebVTT 字幕文件；
  • srt：生成 SRT 字幕文件。

    • 注意：此字段已废弃，建议使用 SubtitleFormatsOperation。
    示例值：vtt
    SrcLanguage String 否 媒体源语言，取值范围：
  • zh：中文普通话；
  • en：英语；
  • ja：日语；
  • zh-ca：粤语。

    • 示例值：zh
    SubtitleName String 否 指定字幕名称，长度限制：64 个字符。该值将用于播放器展示。
    示例值：test2

    AsrTranslateConfigureInfo

    语音翻译任务控制参数

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 语音翻译任务开关，可选值：
  • ON：开启；
  • OFF：关闭。
    • 注意：语音翻译任务本身会返回 ASR 全文识别结果，为避免重复收费，因此禁止同时开启语音翻译和 ASR 全文识别功能项。

    示例值：ON
    SrcLanguage String 否 媒体源语言，当 Switch 为 ON 时，此参数必填。取值范围：
  • zh：中文；
  • en：英文；
  • ja：日文；
  • ko：韩文；
  • vi：越南语；
  • ms：马来语；
  • th：泰语；
  • pt：葡萄牙语；
  • tr：土耳其语；
  • ar：阿拉伯语；
  • es：西班牙语；
  • hi：印地语；
  • fr：法语。

    • 示例值：zh
    DstLanguage String 否 翻译目标语言，当 Switch 为 ON 时，此参数必填。
    当 SrcLanguage 为 zh（中文）时，取值范围：
  • en：英文；
  • ja：日文；
  • ko：韩文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语；
  • vi：越南语；
  • id：印尼语；
  • th：泰语；
  • ms：马来语。

    • 当 SrcLanguage 为 en（英文）时，取值范围：
  • zh：中文；
  • ja：日文；
  • ko：韩文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语；
  • vi：越南语；
  • id：印尼语；
  • th：泰语；
  • ms：马来语；
  • ar：阿拉伯语；
  • hi：印地语。

    • 当 SrcLanguage 为 ja（日文）时，取值范围：
  • zh：中文；
  • en：英文；
  • ko：韩文。

    • 当 SrcLanguage 为 ko（韩文）时，取值范围：
  • zh：中文；
  • en：英文；
  • ja：日文。

    • 当 SrcLanguage 为 vi（越南语）或 ms（马来语）或 th（泰语）时，取值范围：
  • zh：中文；
  • en：英文。

    • 当 SrcLanguage 为 pt（葡萄牙语）时，取值范围：
  • zh：中文；
  • en：英文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语。

    • 当 SrcLanguage 为 tr（土耳其语）时，取值范围：
  • zh：中文；
  • en：英文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • ru：俄语；
  • pt：葡萄牙语。

    • 当 SrcLanguage 为 es（西班牙语）时，取值范围：
  • zh：中文；
  • en：英文；
  • fr：法语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语。

    • 当 SrcLanguage 为 ar（阿拉伯语）或 hi（印地语）时，取值范围：
  • en：英文。

    • 当 SrcLanguage 为 fr（法语）时，取值范围：
  • zh：中文；
  • en：英文；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语。

    • 示例值：en
    SubtitleFormats Array of String 否 生成的字幕文件格式列表，不填或者填空数组表示不生成字幕文件，可选值：
  • vtt：生成 WebVTT 字幕文件；
  • srt：生成 SRT 字幕文件。
    • 注意： 云点播媒资信息仅支持添加 vtt 字幕，因此当且仅当 SubtitleFormats 包含 vtt 时，云点播将生成的字幕添加到媒资。
    示例值：["vtt"]
    SubtitleName String 否 指定字幕名称，长度限制：64 个字符。该值将用于播放器展示，若不填则云点播自动生成。
    注意：仅当 SubtitleFormats 包含 vtt 时，该字段有效。

    示例值：test

    AsrTranslateConfigureInfoForUpdate

    语音翻译控制参数

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 语音翻译任务开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON
    SrcLanguage String 否 媒体源语言，取值范围：
  • zh：中文；
  • en：英文；
  • ja：日文；
  • ko：韩文；
  • vi：越南语；
  • ms：马来语；
  • th：泰语；
  • pt：葡萄牙语；
  • tr：土耳其语；
  • ar：阿拉伯语；
  • es：西班牙语；
  • hi：印地语；
  • fr：法语。

    • 示例值：zh
    DstLanguage String 否 翻译目标语言。
    当 SrcLanguage 为 zh（中文）时，取值范围：
  • en：英文；
  • ja：日文；
  • ko：韩文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语；
  • vi：越南语；
  • id：印尼语；
  • th：泰语；
  • ms：马来语。

    • 当 SrcLanguage 为 en（英文）时，取值范围：
  • zh：中文；
  • ja：日文；
  • ko：韩文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语；
  • vi：越南语；
  • id：印尼语；
  • th：泰语；
  • ms：马来语；
  • ar：阿拉伯语；
  • hi：印地语。

    • 当 SrcLanguage 为 ja（日文）时，取值范围：
  • zh：中文；
  • en：英文；
  • ko：韩文。

    • 当 SrcLanguage 为 ko（韩文）时，取值范围：
  • zh：中文；
  • en：英文；
  • ja：日文。

    • 当 SrcLanguage 为 vi（越南语）或 ms（马来语）或 th（泰语）时，取值范围：
  • zh：中文；
  • en：英文。

    • 当 SrcLanguage 为 pt（葡萄牙语）时，取值范围：
  • zh：中文；
  • en：英文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语。

    • 当 SrcLanguage 为 tr（土耳其语）时，取值范围：
  • zh：中文；
  • en：英文；
  • fr：法语；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • ru：俄语；
  • pt：葡萄牙语。

    • 当 SrcLanguage 为 es（西班牙语）时，取值范围：
  • zh：中文；
  • en：英文；
  • fr：法语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语。

    • 当 SrcLanguage 为 ar（阿拉伯语）或 hi（印地语）时，取值范围：
  • en：英文。

    • 当 SrcLanguage 为 fr（法语）时，取值范围：
  • zh：中文；
  • en：英文；
  • es：西班牙语；
  • it：意大利语；
  • de：德语；
  • tr：土耳其语；
  • ru：俄语；
  • pt：葡萄牙语。

    • 示例值：en
    SubtitleFormatsOperation SubtitleFormatsOperation 否 字幕格式列表操作信息。
    SubtitleName String 否 指定字幕名称，长度限制：64 个字符。该值将用于播放器展示。
    示例值：test2

    AsrWordsConfigureInfo

    语音关键词识别控制参数。

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 语音关键词识别任务开关，可选值：
  • ON：开启语音关键词识别任务；
  • OFF：关闭语音关键词识别任务。
    		•
    LabelSet Array of String 否 关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。
    标签个数最多 10 个，每个标签长度最多 16 个字符。

    AsrWordsConfigureInfoForUpdate

    语音关键词识别控制参数。

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 语音关键词识别任务开关，可选值：
  • ON：开启语音关键词识别任务；
  • OFF：关闭语音关键词识别任务。
    		•
    LabelSet Array of String 否 关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。
    标签个数最多 10 个，每个标签长度最多 16 个字符。

    AudioDenoiseInfo

    音频降噪控制信息

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 音频降噪控制开关，可选值：
  • ON：开启音频降噪；
  • OFF：关闭音频降噪。

    • 示例值：ON
    Type String 否 音频降噪类型，仅当音频降噪控制开关为 ON 时有效，可选值：
  • weak：轻音频降噪；
  • normal：正常音频降噪；
  • strong：强音频降噪。

    • 默认值：weak。
    示例值：weak

    AudioTemplateInfo

    音频流配置参数

    被如下接口引用：CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate。

    名称 类型 必选 描述
    Codec String 是 音频流的编码格式。
    当外层参数 Container 为 mp3 时，可选值为：
  • libmp3lame。

    • 当外层参数 Container 为 ogg 或 flac 时，可选值为：
  • flac。

    • 当外层参数 Container 为 m4a 时，可选值为：
  • libfdk_aac；
  • libmp3lame；
  • ac3。

    • 当外层参数 Container 为 mp4 或 flv 时，可选值为：
  • libfdk_aac：更适合 mp4；
  • libmp3lame：更适合 flv；
  • mp2。

    • 当外层参数 Container 为 hls 时，可选值为：
  • libfdk_aac。

    • 当外层参数 Format 为 HLS 或 MPEG-DASH 时，可选值为：
  • libfdk_aac。

    • 当外层参数 Container 为 wav 时，可选值为：
  • pcm16。

    • 示例值：libmp3lame
    Bitrate Integer 是 音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。
    当取值为 0，表示音频码率和原始音频保持一致。
    示例值：0
    SampleRate Integer 是 音频流的采样率，可选值：
  • 16000，仅当 Codec 为 pcm16 时可选。
  • 32000
  • 44100
  • 48000

    • 单位：Hz。
    示例值：16000
    AudioChannel Integer 否 音频通道，可选值：
  • 1：单通道
  • 2：双通道
  • 6：立体声
  • 0：音频声道数和原始音频保持一致

    • 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为立体声。
    默认值：2。
    示例值：1

    AudioTemplateInfoForUpdate

    音频流配置参数

    被如下接口引用：ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Codec String 否 音频流的编码格式。
    当外层参数 Container 为 mp3 时，可选值为：
  • libmp3lame。

    • 当外层参数 Container 为 ogg 或 flac 时，可选值为：
  • flac。

    • 当外层参数 Container 为 m4a 时，可选值为：
  • libfdk_aac；
  • libmp3lame；
  • ac3。

    • 当外层参数 Container 为 mp4 或 flv 时，可选值为：
  • libfdk_aac：更适合 mp4；
  • libmp3lame：更适合 flv；
  • mp2。

    • 当外层参数 Container 为 hls 时，可选值为：
  • libfdk_aac。

    • 当外层参数 Format 为 HLS 或 MPEG-DASH 时，可选值为：
  • libfdk_aac。

    • 当外层参数 Container 为 wav 时，可选值为：
  • pcm16。

    • 示例值：libmp3lame
    Bitrate Integer 否 音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。 当取值为 0，表示音频码率和原始音频保持一致。
    示例值：0
    SampleRate Integer 否 音频流的采样率，可选值：
  • 16000，仅当 Codec 为 pcm16 时可选。
  • 32000
  • 44100
  • 48000

    • 单位：Hz。
    示例值：16000
    AudioChannel Integer 否 音频通道，可选值：
  • 1：单通道
  • 2：双通道
  • 6：立体声
  • 0：音频声道数和原始音频保持一致

    • 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为立体声。
    示例值：1

    AudioTrackItem

    音频轨道上的音频片段信息。

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    SourceMedia String 是 音频片段的媒体素材来源，可以是：
  • 点播的媒体文件 ID；
  • 其他媒体文件的下载 URL。

    • 注意：当使用其他媒体文件的下载 URL 作为素材来源，且开启了访问控制（如防盗链）时，需要在 URL 携带访问控制参数（如防盗链签名）。
    示例值：101
    SourceMediaStartTime Float 否 音频片段取自素材文件的起始时间，单位为秒。0 表示从素材开始位置截取。默认为0。
    示例值：1
    Duration Float 否 音频片段的时长，单位为秒。默认和素材本身长度一致，表示截取全部素材。
    示例值：2
    TargetDuration Float 否 音频片段目标时长，单位为秒。
  • 当 TargetDuration 不填或填0时，表示目标时长和 Duration 一致；
  • 当 TargetDuration 取大于0的值时，将对音频片段做快进或慢放等处理，使得输出片段的时长等于 TargetDuration。

    • 示例值：2
    AudioOperations Array of AudioTransform 否 对音频片段进行的操作，如音量调节等。

    AudioTransform

    音频操作

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Type String 是 音频操作类型，取值有：
  • Volume：音量调节。
    		•
    VolumeParam AudioVolumeParam 否 音量调节参数， 当 Type = Volume 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    AudioVolumeParam

    音频增益调节参数

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Mute Integer 否 是否静音，取值范围0或1。
  • 0表示不静音。
  • 1表示静音。

    • 默认是0。
    Gain Float 否 音频增益，取值范围0~10。
  • 大于1表示增加音量。
  • 小于1表示降低音量。
  • 0和1：表示不改变。

    • 默认是0。

    BlackWhiteEdgeConfigureInfo

    视频画面黑边、白边、黑屏、白屏检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面黑边、白边、黑屏、白屏检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    BlackWhiteEdgeConfigureInfoForUpdate

    视频画面黑边、白边、黑屏、白屏检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面黑边、白边、黑屏、白屏检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    BlurConfigureInfo

    视频画面模糊检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面模糊检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    BlurConfigureInfoForUpdate

    视频画面模糊检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面模糊检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    CLSLogsetInfo

    CLS 日志集信息

    被如下接口引用：DescribeCLSLogsets。

    名称 类型 描述
    LogsetId String 日志集 ID。
    示例值：“54079098-61ea-48f9-8270-3b041a5d0150”
    LogsetName String 日志集名。
    示例值：“mylogset”

    CLSTopicInfo

    CLS日志主题信息。

    被如下接口引用：DescribeCLSTopics。

    名称 类型 描述
    TopicId String 日志主题 ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值："abc"
    TopicName String 日志主题名。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值："abc"
    LogsetId String 日志集 ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值："abc"

    Canvas

    画布信息。制作视频时，如果源素材（视频或者图片）不能填满输出的视频窗口，将用设置的画布进行背景绘制。

    被如下接口引用：ComposeMedia, DescribeTaskDetail, PullEvents。

    名称 类型 必选 描述
    Color String 否 背景颜色，取值有：
  • Black：黑色背景
  • White：白色背景

    • 默认值：Black。
    示例值：Black
    Width Integer 否 画布宽度，即输出视频的宽度，取值范围：0~ 3840，单位：px。
    默认值：0，表示和第一个视频轨的第一个视频片段的视频宽度一致。
    示例值：0
    Height Integer 否 画布高度，即输出视频的高度（或长边），取值范围：0~ 3840，单位：px。
    默认值：0，表示和第一个视频轨的第一个视频片段的视频高度一致。
    示例值：0

    CdnLogInfo

    CDN 日志信息

    被如下接口引用：DescribeCdnLogs。

    名称 类型 描述
    Date String 日志所属日期， 格式为：yyyy-MM-dd ，如2018-03-01。
    示例值：2018-03-01
    Name String 日志名称，格式为：日期小时-域名
    如 2018120101-test.vod2.mqcloud.com。
    示例值：2018120101-test.vod2.mqcloud.com
    Url String 日志下载链接，24小时内下载有效。
    示例值：http://test.com
    StartTime String 日志起始时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    EndTime String 日志结束时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    ClassificationConfigureInfo

    智能分类任务控制参数

    被如下接口引用：CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。

    名称 类型 必选 描述
    Switch String 是 智能分类任务开关，可选值：
  • ON：开启智能分类任务；
  • OFF：关闭智能分类任务。
    		•

    ClassificationConfigureInfoForUpdate

    智能分类任务控制参数

    被如下接口引用：ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 否 智能分类任务开关，可选值：
  • ON：开启智能分类任务；
  • OFF：关闭智能分类任务。
    		•

    ClipFileInfo2017

    视频裁剪结果文件信息（2017 版）

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。
    		•
    Message String 错误描述。
    FileId String 输出目标文件的文件 ID。
    FileUrl String 输出目标文件的文件地址。
    FileType String 输出目标文件的文件类型。

    ClipTask2017

    视频剪辑任务信息，该结构仅用于对 2017 版视频剪辑接口发起的任务。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 视频剪辑任务 ID。
    SrcFileId String 视频剪辑任务源文件 ID。
    FileInfo ClipFileInfo2017 视频剪辑输出的文件信息。

    ColorEnhanceInfo

    色彩增强控制参数

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 色彩增强控制开关，可选值：
  • ON：开启综合增强；
  • OFF：关闭综合增强。

    • 示例值：ON
    Type String 否 色彩增强类型，仅当色彩增强控制开关为 ON 时有效，可选值：
  • weak：轻色彩增强；
  • normal：正常色彩增强；
  • strong：强色彩增强。

    • 默认值：weak。
    示例值：weak

    ComposeMediaOutput

    输出的媒体文件信息。

    被如下接口引用：ComposeMedia, DescribeTaskDetail, PullEvents。

    名称 类型 必选 描述
    FileName String 是 文件名称，最长 64 个字符。
    Description String 否 描述信息，最长 128 个字符。
    ClassId Integer 否 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。
    		•
    ExpireTime String 否 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    Container String 否 封装格式，可选值：mp4、mp3。其中，mp3 为纯音频文件。
    VideoStream OutputVideoStream 否 输出的视频信息。
    注意：此字段可能返回 null，表示取不到有效值。
    AudioStream OutputAudioStream 否 输出的音频信息。
    注意：此字段可能返回 null，表示取不到有效值。
    RemoveVideo Integer 否 是否去除视频数据，可选值：
  • 0：保留
  • 1：去除

    • 默认值：0。
    RemoveAudio Integer 否 是否去除音频数据，可选值：
  • 0：保留
  • 1：去除

    • 默认值：0。

    ComposeMediaTask

    制作媒体文件任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：12530xxx-procedurev2-xxx
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：FINISH
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。

    • 示例值：0
    Message String 错误信息。
    示例值：""
    Progress Integer 制作媒体文件任务进度，取值范围 [0-100] 。
    示例值：0
    Input ComposeMediaTaskInput 制作媒体文件任务的输入。
    注意：此字段可能返回 null，表示取不到有效值。
    Output ComposeMediaTaskOutput 制作媒体文件任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    MetaData MediaMetaData 输出视频的元信息。
    注意：此字段可能返回 null，表示取不到有效值。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：example
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：example

    ComposeMediaTaskInput

    制作媒体文件任务的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Tracks Array of MediaTrack 输入的媒体轨道列表，包括视频、音频、图片等素材组成的多个轨道信息。
    Canvas Canvas 制作视频文件时使用的画布。
    注意：此字段可能返回 null，表示取不到有效值。
    Output ComposeMediaOutput 输出的媒体文件信息。

    ComposeMediaTaskOutput

    制作媒体文件任务的输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileType String 文件类型，例如 mp4、mp3 等。
    示例值：mp4
    FileId String 媒体文件 ID。
    示例值：523xxx
    FileUrl String 媒体文件播放地址。
    示例值：http://125xxx.vod2.myqcloud.com/xxx/xxx/xx.mp4
    MediaName String 文件名称，最长 64 个字符。
    示例值：fileName
    ClassId Integer 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：9999-12-31T23:59:59Z

    ConcatFileInfo2017

    视频拼接源文件信息（2017 版）

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。
    		•
    Message String 错误信息。
    FileId String 视频拼接源文件的 ID。
    FileUrl String 视频拼接源文件的地址。
    FileType String 视频拼接源文件的格式。

    ConcatTask2017

    视频拼接任务信息，该结构仅用于对 2017 版视频拼接接口发起的任务。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 视频拼接任务 ID。
    FileInfoSet Array of ConcatFileInfo2017 视频拼接源文件信息。

    ContentReviewOcrResult

    图片Ocr 文字鉴别信息的任务结果类型

    被如下接口引用：ProcessImage, ReviewImage。

    名称 类型 描述
    Confidence Float Ocr 文字鉴别结果的评分，分值为0到100。
    示例值：0
    Suggestion String Ocr 文字鉴别的结果建议，取值范围：
  • pass；
  • review；
  • block。

    • 示例值：pass
    KeywordSet Array of String Ocr 文字鉴别的嫌疑关键词列表。
    示例值：["text"]
    AreaCoordSet Array of Integer Ocr 文字鉴别的嫌疑文字出现的区域坐标 (像素级)，[x1, y1, x2, y2]，即左上角坐标、右下角坐标。
    示例值：[x1, y1, x2, y2]

    ContentReviewResult

    图片智能内容识别任务结果

    被如下接口引用：ProcessImage, ReviewImage。

    名称 类型 描述
    Type String 结果类型，取值范围：
  • Porn.Image：图片画面中的鉴别令人反感的信息结果；
  • Terrorism.Image：图片画面中的鉴别令人不安全的信息结果；
  • Political.Image：图片画面中的鉴别令人不适宜信息结果；
  • Porn.Ocr：图片 OCR 文字中的鉴别令人反感的信息结果；
  • Terrorism.Ocr：图片 OCR 文字中的鉴别令人不安全的信息结果；
  • Political.Ocr：图片 OCR 文字中的鉴别令人不适宜信息结果。

    • 示例值：Porn.Image
    PornImageResult PornImageResult 图片画面中的鉴别令人反感的信息结果，当 Type 为 Porn.Image 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TerrorismImageResult TerrorismImageResult 图片画面中的鉴别令人不安全的信息结果，当 Type 为 Terrorism.Image 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PoliticalImageResult PoliticalImageResult 图片画面中的鉴别令人不适宜信息结果，当 Type 为 Political.Image 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PornOcrResult ContentReviewOcrResult 图片 OCR 文字中的鉴别令人反感的信息结果，当 Type 为 Porn.Ocr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TerrorismOcrResult ContentReviewOcrResult 图片 OCR 中的鉴别令人不安全的信息结果，当 Type 为 Terrorism.Ocr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PoliticalOcrResult ContentReviewOcrResult 图片 OCR 文字中的鉴别令人不适宜信息结果，当 Type 为 Political.Ocr 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    ContentReviewTemplateItem

    音视频审核模板详情

    被如下接口引用：DescribeContentReviewTemplates。

    名称 类型 描述
    Definition Integer 音视频审核模板唯一标识。
    示例值：20
    Name String 音视频审核模板名称，长度限制：64 个字符。
    示例值：templetexxx
    Comment String 音视频审核模板描述信息，长度限制：256 个字符。
    示例值：text
    PornConfigure PornConfigureInfo 鉴别涉及令人反感的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    TerrorismConfigure TerrorismConfigureInfo 鉴别涉及令人不安全的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    PoliticalConfigure PoliticalConfigureInfo 鉴别涉及令人不适宜的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ProhibitedConfigure ProhibitedConfigureInfo 违禁控制参数。违禁内容包括：
  • 谩骂；
  • 涉毒违法。

    • 注意：此字段可能返回 null，表示取不到有效值。
    UserDefineConfigure UserDefineConfigureInfo 用户自定义音视频审核控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ReviewWallSwitch String 音视频审核结果是否进入音视频审核墙（对音视频审核结果进行人工复核）的开关。
  • ON：是；
  • OFF：否。

    • 示例值：ON
    ScreenshotInterval Float 截帧间隔，单位为秒。当不填时，默认截帧间隔为 1 秒，最小值为 0.5 秒。
    示例值：0.5
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    CopyRightWatermarkInput

    版权水印参数

    被如下接口引用：CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate。

    名称 类型 必选 描述
    Text String 是 版权信息，最大长度为 200 个字符。
    示例值：copyRightxxx

    CoverBySnapshotTaskInput

    对视频截图做封面任务输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 指定时间点截图模板 ID。
    PositionType String 是 截图方式。包含：
  • Time：依照时间点截图
  • Percent：依照百分比截图
    		•
    PositionValue Float 是 截图位置：
  • 对于依照时间点截图，该值表示指定视频第几秒的截图作为封面
  • 对于依照百分比截图，该值表示使用视频百分之多少的截图作为封面
    		•
    WatermarkSet Array of WatermarkInput 否 水印列表，支持多张图片或文字水印，最大可支持 10 张。

    CoverBySnapshotTaskOutput

    对视频截图做封面任务输出类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    CoverUrl String 封面 URL。

    CoverConfigureInfo

    智能封面任务控制参数

    被如下接口引用：CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。

    名称 类型 必选 描述
    Switch String 是 智能封面任务开关，可选值：
  • ON：开启智能封面任务；
  • OFF：关闭智能封面任务。
    		•

    CoverConfigureInfoForUpdate

    智能封面任务控制参数

    被如下接口引用：ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 否 智能封面任务开关，可选值：
  • ON：开启智能封面任务；
  • OFF：关闭智能封面任务。
    		•

    CrashScreenConfigureInfo

    视频画面花屏检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面花屏检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    CrashScreenConfigureInfoForUpdate

    视频画面花屏检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面花屏检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    CreateImageSpriteTask2017

    视频截取雪碧图任务，该结构仅用于对 2017 版截取雪碧图接口发起的任务。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 截图雪碧图任务 ID。
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。
    		•
    Message String 错误信息。
    FileId String 截取雪碧图文件 ID。
    Definition Integer 雪碧图规格，参见雪碧图截图模板。
    TotalCount Integer 雪碧图小图总数量。
    ImageSpriteUrlSet Array of String 截取雪碧图输出的地址。
    WebVttUrl String 雪碧图子图位置与时间关系 WebVtt 文件地址。

    DNSVerifyInfo

    DNS解析验证信息

    被如下接口引用：CreateDomainVerifyRecord。

    名称 类型 描述
    SubDomain String 子解析。
    示例值：_cdnauth
    Record String 解析值。
    示例值：2023091115xxxxxx63d1d6c8595
    RecordType String 解析类型。
    示例值：txt

    DailyPlayStatInfo

    播放统计信息。

    被如下接口引用：DescribeDailyMediaPlayStat, DescribeDailyMostPlayedStat。

    名称 类型 描述
    Date String 播放媒体文件的日期，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FileId String 媒体文件ID。
    示例值：234
    PlayTimes Integer 播放次数。
    示例值：1
    Traffic Integer 播放流量，单位：字节。
    示例值：12

    DescribeFileAttributesTask

    获取文件属性任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：123
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    Message String 错误信息。
    示例值：""
    Progress Integer 任务进度，取值范围 [0-100] 。
    示例值：0
    FileId String 媒体文件 ID。
    示例值：123
    Output DescribeFileAttributesTaskOutput 获取媒体文件属性任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：123
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：345

    DescribeFileAttributesTaskOutput

    获取文件属性任务输出

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Md5 String 媒体文件的 Md5 值。
    示例值：123
    Sha1 String 媒体文件的 Sha1 值。
    示例值：891fedd90cac00fa0e0c183094d3306e13a7d415

    DomainCLSTargetInfo

    域名推送 CLS 目标。

    被如下接口引用：DescribeCLSPushTargets。

    名称 类型 描述
    Domain String 域名。
    示例值：xxx.vod-qcloud.com
    ChineseMainlandCLSTargetInfo AreaCLSTargetInfo 中国大陆地区的日志推送目标。
    OutsideChineseMainlandCLSTargetInfo AreaCLSTargetInfo 中国大陆以外地区的日志推送目标。

    DomainDetailInfo

    域名信息

    被如下接口引用：DescribeVodDomains。

    名称 类型 描述
    Domain String 域名名称。
    示例值：www.text.com
    AccelerateAreaInfos Array of AccelerateAreaInfo 加速地区信息。
    注意：此字段可能返回 null，表示取不到有效值。
    DeployStatus String 部署状态，取值有：
  • Online：上线；
  • Deploying：部署中；
  • Locked: 锁定中，出现该状态时，无法对该域名进行部署变更。

    • 示例值：Online
    HTTPSConfig DomainHTTPSConfig HTTPS 配置信息。
    注意：此字段可能返回 null，表示取不到有效值。
    UrlSignatureAuthPolicy UrlSignatureAuthPolicy Key 防盗链配置信息。
    注意：此字段可能返回 null，表示取不到有效值。
    RefererAuthPolicy RefererAuthPolicy Referer 防盗链配置信息。
    注意：此字段可能返回 null，表示取不到有效值。
    CreateTime String 域名添加到腾讯云点播系统中的时间。
  • 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。

    • 示例值：2018-10-01T18:00:00+08:00
    QUICConfig DomainQUICConfig 域名 QUIC 配置信息。
    注意：此字段可能返回 null，表示取不到有效值。

    DomainHTTPSConfig

    域名 HTTPS 配置信息

    被如下接口引用：DescribeVodDomains。

    名称 类型 必选 描述
    CertExpireTime String 是 证书过期时间。
  • 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。

    • 示例值：2018-10-01T18:00:00+08:00
    CloudCertId String 否 腾讯云 SSL 产品中的证书 ID。
    示例值：xxx234xxx

    DomainQUICConfig

    域名 QUIC 配置信息

    被如下接口引用：DescribeVodDomains, ModifyVodDomainConfig。

    名称 类型 必选 描述
    Status String 是 QUIC 配置状态，可选值：
  • Enabled: 启用；
  • Disabled: 禁用。

    • 示例值：Enabled

    DrmStreamingsInfo

    DRM 自适应码流播放信息

    被如下接口引用：CreateSuperPlayerConfig, DescribeSuperPlayerConfigs。

    名称 类型 必选 描述
    SimpleAesDefinition Integer 否 保护类型为 SimpleAES 的转自适应码流模板 ID。
    示例值：123
    WidevineDefinition Integer 否 保护类型为 Widevine 的转自适应码流模板 ID。
    示例值：123
    FairPlayDefinition Integer 否 保护类型为 FairPlay 的转自适应码流模板 ID。
    示例值：123

    DrmStreamingsInfoForUpdate

    DRM 自适应码流播放信息修改对象

    被如下接口引用：ModifySuperPlayerConfig。

    名称 类型 必选 描述
    SimpleAesDefinition Integer 否 保护类型为 SimpleAES 的转自适应码流模板 ID。
    示例值：20
    WidevineDefinition Integer 否 保护类型为 Widevine 的转自适应码流模板 ID。
    示例值：20
    FairPlayDefinition Integer 否 保护类型为 FairPlay 的转自适应码流模板 ID。
    示例值：20

    DynamicRangeInfo

    画面动态范围信息。

    被如下接口引用：LiveRealTimeClip, SimpleHlsClip。

    名称 类型 描述
    Type String 画面动态范围信息。可取值：
  • SDR：Standard Dynamic Range 标准动态范围；
  • HDR：High Dynamic Range 高动态范围。

    • 示例值：SDR
    HDRType String 高动态范围类型，当 Type 为 HDR 时有效。目前支持的可取值：
  • hdr10：表示 hdr10 标准；
  • hlg：表示 hlg 标准。

    • 示例值：hdr10

    EditMediaFileInfo

    编辑点播视频文件信息

    被如下接口引用：DescribeTaskDetail, EditMedia, PullEvents。

    名称 类型 必选 描述
    FileId String 是 视频的 ID。
    StartTimeOffset Float 否 视频剪辑起始的偏移时间，单位：秒。
    EndTimeOffset Float 否 视频剪辑结束的偏移时间，单位：秒。

    EditMediaOutputConfig

    编辑视频的结果文件输出。

    被如下接口引用：EditMedia。

    名称 类型 必选 描述
    MediaName String 否 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：filenamexx
    Type String 否 输出文件格式，可选值：mp4、hls。默认是 mp4。
    示例值：mp4
    ClassId Integer 否 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 否 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：2018-10-01T18:00:00+08:00
    VideoStream EditMediaVideoStream 否 输出的视频信息。
    TEHDConfig EditMediaTEHDConfig 否 极速高清转码参数。

    EditMediaStreamInfo

    编辑视频流信息

    被如下接口引用：DescribeTaskDetail, EditMedia, PullEvents。

    名称 类型 必选 描述
    StreamId String 是 录制的流 ID
    StartTime String 否 流剪辑的起始时间，使用 ISO 日期格式。
    EndTime String 否 流剪辑的结束时间，使用 ISO 日期格式。

    EditMediaTEHDConfig

    视频编辑极速高清参数配置。

    被如下接口引用：EditMedia。

    名称 类型 必选 描述
    Type String 是 极速高清类型，可选值：
  • TEHD-100 表示极速高清-100;
  • OFF 表示关闭极速高清。
    • 不填表示 OFF。
    示例值：TEHD-100
    MaxVideoBitrate Integer 否 视频码率上限，当 Type 指定了极速高清类型时有效。
    不填或填0表示不设视频码率上限。
    示例值：0

    EditMediaTask

    编辑视频任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：12530xxx-procedurev2-xxx
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：FINISH
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    Message String 错误信息。
    示例值：“”
    Progress Integer 编辑视频任务进度，取值范围 [0-100] 。
    示例值：0
    Input EditMediaTaskInput 视频编辑任务的输入。
    注意：此字段可能返回 null，表示取不到有效值。
    Output EditMediaTaskOutput 视频编辑任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    MetaData MediaMetaData 输出视频的元信息。
    ProcedureTaskId String 任务类型为 Procedure 的任务 ID。若发起编辑视频任务时指定了任务流模板(ProcedureName)，当该任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
    示例值：12530xxx-procedurev2-xxx
    ReviewAudioVideoTaskId String 任务类型为 ReviewAudioVideo 的任务 ID。若发起编辑视频任务时指定了任务流模板(ProcedureName)，当该任务流模板指定了 ReviewAudioVideoTask 时，发起该任务。
    示例值：123
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：Example
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：Example

    EditMediaTaskInput

    编辑视频任务的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    InputType String 输入视频的来源类型，可以取的值为 File，Stream 两种。
    FileInfoSet Array of EditMediaFileInfo 输入的视频文件信息，当 InputType 为 File 时，该字段有值。
    StreamInfoSet Array of EditMediaStreamInfo 输入的流信息，当 InputType 为 Stream 时，该字段有值。

    EditMediaTaskOutput

    编辑视频任务的输出

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileType String 文件类型，例如 mp4、flv 等。
    示例值：mp4
    FileUrl String 媒体文件播放地址。
    示例值：http://125xxx.vod2.myqcloud.com/xxx/xxx/xx.mp4
    FileId String 媒体文件 ID。
    示例值：523xxx
    MediaName String 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：fileName
    ClassId Integer 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：9999-12-31T23:59:59Z

    EditMediaVideoStream

    视频流配置信息

    被如下接口引用：EditMedia。

    名称 类型 必选 描述
    Codec String 否 视频流的编码格式，可选值：
  • libx264：H.264 编码；
  • libx265：H.265 编码；
  • av1：AOMedia Video 1 编码；
  • H.266：H.266 编码。

    • 示例值：libx264
    Bitrate Integer 否 视频流的码率，取值范围：0 和 [128, 35000]，单位：kbps。
    当取值为 0 或不填时，表示自动选择最佳视频码率。
    示例值：500
    ResolutionAdaptive String 否 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。

    • 默认值：open。
    示例值：open
    Width Integer 否 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率取基准分辨率；
  • 当 Width 为 0，Height 非 0，则 Width 按基准分辨率比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按基准分辨率比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：0
    Height Integer 否 视频流高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率取基准分辨率；
  • 当 Width 为 0，Height 非 0，则 Width 按基准分辨率比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按基准分辨率比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：0
    Fps Integer 否 视频帧率，取值范围：[0, 100]，单位：Hz。
    当取值为0，将自动为视频设置帧率。
    默认值为 0。
    示例值：0

    EmptyTrackItem

    空的轨道片段，用来进行时间轴的占位。如需要两个音频片段之间有一段时间的静音，可以用 EmptyTrackItem 来进行占位。

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Duration Float 是 持续时间，单位为秒。

    EnhanceMediaQualityOutputConfig

    音画质重生结果文件输出。

    被如下接口引用：EnhanceMediaQuality。

    名称 类型 必选 描述
    MediaName String 否 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：name
    ClassId Integer 否 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 否 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：2023-09-08T02:23:29Z

    EventContent

    事件通知内容，其中，TranscodeCompleteEvent、ConcatCompleteEvent、ClipCompleteEvent、CreateImageSpriteCompleteEvent、SnapshotByTimeOffsetCompleteEvent 为兼容 2017 版接口发起任务的事件通知。

    被如下接口引用：PullEvents。

    名称 类型 描述
    EventHandle String 事件句柄，调用方必须调用 ConfirmEvents 来确认消息已经收到，确认有效时间 30 秒。失效后，事件可重新被获取。
    示例值：123
    EventType String 支持事件类型：
  • NewFileUpload：视频上传完成；
  • ProcedureStateChanged：任务流状态变更；
  • FileDeleted：视频删除完成；
  • RestoreMediaComplete：视频取回完成；
  • PullComplete：视频转拉完成；
  • EditMediaComplete：视频编辑完成；
  • SplitMediaComplete：视频拆分完成；
  • ComposeMediaComplete：制作媒体文件完成；
  • WechatMiniProgramPublishComplete：微信小程序发布完成。
  • RemoveWatermark：智能去除水印完成。
  • RebuildMediaComplete：音画质重生完成事件（不推荐使用）。
  • ReviewAudioVideoComplete：音视频审核完成；
  • ExtractTraceWatermarkComplete：提取溯源水印完成；
  • ExtractCopyRightWatermarkComplete：提取版权水印完成；
  • DescribeFileAttributesComplete：获取文件属性完成；
  • QualityInspectComplete：音画质检测完成；
  • QualityEnhanceComplete：音画质重生任务完成；
  • PersistenceComplete：剪辑固化完成。

    • 兼容 2017 版的事件类型：
  • TranscodeComplete：视频转码完成；
  • ConcatComplete：视频拼接完成；
  • ClipComplete：视频剪辑完成；
  • CreateImageSpriteComplete：视频截取雪碧图完成；
  • CreateSnapshotByTimeOffsetComplete：视频按时间点截图完成。

    • 示例值：null
    FileUploadEvent FileUploadTask 视频上传完成事件，当事件类型为 NewFileUpload 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    ProcedureStateChangeEvent ProcedureTask 任务流状态变更事件，当事件类型为 ProcedureStateChanged 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    FileDeleteEvent FileDeleteTask 文件删除事件，当事件类型为 FileDeleted 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    PullCompleteEvent PullUploadTask 视频转拉完成事件，当事件类型为 PullComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    EditMediaCompleteEvent EditMediaTask 视频编辑完成事件，当事件类型为 EditMediaComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    SplitMediaCompleteEvent SplitMediaTask 视频拆分完成事件，当事件类型为 SplitMediaComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    ComposeMediaCompleteEvent ComposeMediaTask 制作媒体文件任务完成事件，当事件类型为 ComposeMediaComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    ClipCompleteEvent ClipTask2017 视频剪辑完成事件，当事件类型为 ClipComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    TranscodeCompleteEvent TranscodeTask2017 视频转码完成事件，当事件类型为 TranscodeComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    CreateImageSpriteCompleteEvent CreateImageSpriteTask2017 视频截取雪碧图完成事件，当事件类型为 CreateImageSpriteComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    ConcatCompleteEvent ConcatTask2017 视频拼接完成事件，当事件类型为 ConcatComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    SnapshotByTimeOffsetCompleteEvent SnapshotByTimeOffsetTask2017 视频按时间点截图完成事件，当事件类型为 CreateSnapshotByTimeOffsetComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    WechatPublishCompleteEvent WechatPublishTask 微信发布完成事件，当事件类型为 WechatPublishComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    WechatMiniProgramPublishCompleteEvent WechatMiniProgramPublishTask 微信小程序发布任务完成事件，当事件类型为 WechatMiniProgramPublishComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    RemoveWatermarkCompleteEvent RemoveWatermarkTask 智能去除水印完成事件，当事件类型为 RemoveWatermark 有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    RestoreMediaCompleteEvent RestoreMediaTask 视频取回完成事件，当事件类型为 RestoreMediaComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    RebuildMediaCompleteEvent RebuildMediaTask 音画质重生完成事件，当事件类型为 RebuildMediaComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    ExtractTraceWatermarkCompleteEvent ExtractTraceWatermarkTask 溯源水印提取完成事件，当事件类型为 ExtractTraceWatermarkComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    ExtractCopyRightWatermarkCompleteEvent ExtractCopyRightWatermarkTask 版权水印提取完成事件，当事件类型为 ExtractCopyRightWatermarkComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ReviewAudioVideoCompleteEvent ReviewAudioVideoTask 音视频审核完成事件，当事件类型为 ReviewAudioVideoComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    ReduceMediaBitrateCompleteEvent ReduceMediaBitrateTask 该字段已无效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    DescribeFileAttributesCompleteEvent DescribeFileAttributesTask 获取文件属性完成事件，当事件类型为 DescribeFileAttributesComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    QualityInspectCompleteEvent QualityInspectTask 音画质检测完成事件，当事件类型为 QualityInspectComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    QualityEnhanceCompleteEvent QualityEnhanceTask 音画质重生完成事件，当事件类型为 QualityEnhanceComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    MediaCastStatusChangedEvent MediaCastEvent 媒体转推状态变化事件，当事件类型为 MediaCastStatusChanged 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    PersistenceCompleteEvent PersistenceCompleteTask 剪辑固化完成事件，当事件类型为 PersistenceComplete 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null

    ExtractCopyRightWatermarkTask

    提取版权水印任务。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：123
    Status String 任务状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：PROCESSING
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    Message String 错误信息。
    示例值：text
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：text
    Input ExtractCopyRightWatermarkTaskInput 提取版权水印任务输入信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Output ExtractCopyRightWatermarkTaskOutput 提取版权水印任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：text
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：text

    ExtractCopyRightWatermarkTaskInput

    提取版权水印任务输入

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Url String 需要提取水印的媒体 URL。
    示例值：http://www.test.com

    ExtractCopyRightWatermarkTaskOutput

    提取版权水印输出信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Text String 版权信息。
    示例值：text

    ExtractTraceWatermarkTask

    提取溯源水印任务。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：123-xxx-xx
    Status String 任务状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：SUCCESS
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    Message String 错误信息。
    示例值：SUCCESS
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：SUCCESS
    Input ExtractTraceWatermarkTaskInput 提取溯源水印任务输入信息。
    Output ExtractTraceWatermarkTaskOutput 提取溯源水印任务输出信息。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：sid
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：scontext

    ExtractTraceWatermarkTaskInput

    提取溯源水印输入

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Url String 需要提取水印的媒体 URL。
    示例值：123abc
    FileId String 媒体文件 ID。Url 对应的原始媒体文件 ID。
    示例值：123

    ExtractTraceWatermarkTaskOutput

    提取溯源水印输出信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Uv String 播放者的 ID，以十六进制表示，共6位。
    示例值：abc
    Uid String 该字段已废弃。
    示例值：abc

    FaceConfigureInfo

    人脸识别任务控制参数

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 人脸识别任务开关，可选值：
  • ON：开启智能人脸识别任务；
  • OFF：关闭智能人脸识别任务。

    • 示例值：ON
    Score Float 否 人脸识别过滤分数，当识别结果达到该分数以上，返回识别结果。默认 95 分。取值范围：0 - 100。
    示例值：0
    DefaultLibraryLabelSet Array of String 否 默认人物过滤标签，指定需要返回的默认人物的标签。如果未填或者为空，则全部默认人物结果都返回。标签可选值：
  • entertainment：娱乐明星；
  • sport：体育明星；
  • politician：相关人物。

    • 示例值：entertainment
    UserDefineLibraryLabelSet Array of String 否 用户自定义人物过滤标签，指定需要返回的用户自定义人物的标签。如果未填或者为空，则全部自定义人物结果都返回。
    标签个数最多 100 个，每个标签长度最多 16 个字符。
    示例值：text
    FaceLibrary String 否 人物库选择，可选值：
  • Default：使用默认人物库；
  • UserDefine：使用用户自定义人物库。
  • All：同时使用默认人物库和用户自定义人物库。

    • 默认值：All，使用系统默认人物库及用户自定义人物库。
    示例值：Default

    FaceConfigureInfoForUpdate

    人脸识别任务控制参数

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 人脸识别任务开关，可选值：
  • ON：开启智能人脸识别任务；
  • OFF：关闭智能人脸识别任务。

    • 示例值：ON
    Score Float 否 人脸识别过滤分数，当识别结果达到该分数以上，返回识别结果。取值范围：0-100。
    示例值：0
    DefaultLibraryLabelSet Array of String 否 默认人物过滤标签，指定需要返回的默认人物的标签。如果未填或者为空，则全部默认人物结果都返回。标签可选值：
  • entertainment：娱乐明星；
  • sport：体育明星；
  • politician：相关人物。

    • 示例值：entertainment
    UserDefineLibraryLabelSet Array of String 否 用户自定义人物过滤标签，指定需要返回的用户自定义人物的标签。如果未填或者为空，则全部自定义人物结果都返回。
    标签个数最多 100 个，每个标签长度最多 16 个字符。
    示例值：text
    FaceLibrary String 否 人物库选择，可选值：
  • Default：使用默认人物库；
  • UserDefine：使用用户自定义人物库。
  • All：同时使用默认人物库和用户自定义人物库。

    • 示例值：Default

    FaceEnhanceInfo

    人脸增强控制

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 人脸增强控制开关，可选值：
  • ON：开启人脸增强；
  • OFF：关闭人脸增强。

    • 示例值：ON
    Intensity Float 否 人脸增强强度，仅当人脸增强控制开关为 ON 时有效，取值范围：0.0~1.0。
    默认：0.0。
    示例值：0

    FastEditMediaFileInfo

    快速媒体编辑操作的输入媒体类型

    被如下接口引用：FastEditMedia。

    名称 类型 必选 描述
    FileId String 是 媒体的 ID。
    示例值：12345
    AudioVideoType String 是 操作的音视频类型，可选值有：
  • Transcode：转码输出；
  • Original：原始音视频。

    • 注意：操作的音视频，必须为 HLS 格式。
    示例值：Original
    TranscodeDefinition Integer 否 当 AudioVideoType 为 Transcode 时有效，表示操作媒体的的转码模板 ID。
    示例值：100210
    StartTimeOffset Float 否 媒体剪辑起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 否 媒体剪辑结束的时间偏移，单位：秒。
    示例值：0

    FileDeleteResultItem

    文件删除结果信息

    被如下接口引用：PullEvents。

    名称 类型 描述
    FileId String 删除的文件 ID 。
    示例值：7447398156998994860
    DeleteParts Array of MediaDeleteItem 本次删除的文件部分。
    注意：此字段可能返回 null，表示取不到有效值。

    FileDeleteTask

    文件删除任务

    被如下接口引用：PullEvents。

    名称 类型 描述
    FileIdSet Array of String 删除文件 ID 列表。
    示例值：["123"]
    FileDeleteResultInfo Array of FileDeleteResultItem 删除文件结果信息列表。

    FileReviewInfo

    文件审核信息。

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    MediaReviewInfo ReviewInfo 媒体审核信息*。

    * 只展示通过 音视频审核(ReviewAudioVideo) 或 图片审核(ReviewImage) 发起的审核结果信息。
    注意：此字段可能返回 null，表示取不到有效值。
    CoverReviewInfo ReviewInfo 媒体封面审核信息*。

    * 只展示通过 音视频审核(ReviewAudioVideo) 或 图片审核(ReviewImage) 发起的审核结果信息。
    注意：此字段可能返回 null，表示取不到有效值。

    FileUploadTask

    文件上传任务信息

    被如下接口引用：PullEvents。

    名称 类型 描述
    FileId String 文件唯一 ID。
    示例值：123
    MediaBasicInfo MediaBasicInfo 上传完成后生成的媒体文件基础信息。
    ProcedureTaskId String 任务类型为 Procedure 的任务 ID。若视频上传时指定要执行的任务(procedure)，当该任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
    示例值：123
    ReviewAudioVideoTaskId String 任务类型为 ReviewAudioVideo 的任务 ID。若视频上传时指定要执行的任务(procedure)，当该任务流模板指定了 ReviewAudioVideoTask 时，发起该任务。
    示例值：123
    MetaData MediaMetaData 元信息。包括大小、时长、视频流信息、音频流信息等。
    注意：此字段可能返回 null，表示取不到有效值。

    FileVerifyInfo

    文件验证信息

    被如下接口引用：CreateDomainVerifyRecord。

    名称 类型 描述
    FileVerifyUrl String 文件验证 URL 指引。
    示例值：http://xxx.com/verification.html
    FileVerifyDomains Array of String 文件校验域名列表。
    示例值：["xxx.com"]
    FileVerifyName String 文件校验文件名。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：verification.html

    FrameTagConfigureInfo

    智能按帧标签任务控制参数

    被如下接口引用：CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。

    名称 类型 必选 描述
    Switch String 是 智能按帧标签任务开关，可选值：
  • ON：开启智能按帧标签任务；
  • OFF：关闭智能按帧标签任务。
    		•
    ScreenshotInterval Float 否 截帧间隔，单位为秒，当不填时，默认截帧间隔为 1 秒，最小值为 0.5 秒。

    FrameTagConfigureInfoForUpdate

    智能按帧标签任务控制参数

    被如下接口引用：ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 否 智能按帧标签任务开关，可选值：
  • ON：开启智能按帧标签任务；
  • OFF：关闭智能按帧标签任务。
    		•
    ScreenshotInterval Float 否 截帧间隔，单位为秒，最小值为 0.5 秒。

    HDRInfo

    高动态范围类型控制参数。

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 高动态范围类型控制开关，可选值：
  • ON：开启高动态范围类型转换；
  • OFF：关闭高动态范围类型转换。

    • 示例值：ON
    Type String 否 高动态范围类型，可选值：
  • hdr10：表示 hdr10 标准；
  • hlg：表示 hlg 标准。


    • 注意：
  • 仅当高动态范围类型控制开关为 ON 时有效；
  • 当画质重生目标参数中指定视频输出参数的视频流编码格式 Codec 为 libx265 时有效。

    • 示例值：hlg

    HeadTailConfigureInfo

    视频片头片尾识别任务控制参数

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 视频片头片尾识别任务开关，可选值：
  • ON：开启智能视频片头片尾识别任务；
  • OFF：关闭智能视频片头片尾识别任务。
    		•

    HeadTailConfigureInfoForUpdate

    视频片头片尾识别任务控制参数

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 视频片头片尾识别任务开关，可选值：
  • ON：开启智能视频片头片尾识别任务；
  • OFF：关闭智能视频片头片尾识别任务。
    		•

    HeadTailTaskInput

    片尾任务输入类型。

    被如下接口引用：CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 片头片尾模板号。
    示例值：10000

    HeadTailTemplate

    片头片尾模板详情

    被如下接口引用：DescribeHeadTailTemplates。

    名称 类型 描述
    Definition Integer 片头片尾模板号。
    示例值：10000
    Name String 模板名，最大支持 64 个字符。
    示例值：模板名
    Comment String 模板描述，最大支持 256 个字符。
    示例值：模板描述
    HeadCandidateSet Array of String 片头候选列表。使用时会选择跟正片分辨率最贴近的一个使用，当存在相同的候选时，选择第一个使用，最大支持 5 个。
    示例值：["123xxx90"]
    TailCandidateSet Array of String 片尾候选列表。使用时会选择跟正片分辨率最贴近的一个使用，当存在相同的候选时，选择第一个使用，最大支持 5 个。
    示例值：["123xxx89"]
    FillType String 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
  • gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊；
  • white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充；
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。

    • 默认值：stretch 。
    示例值：black
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    HighlightSegmentItem

    智能精彩集锦片段列表。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Confidence Float 置信度。
    StartTimeOffset Float 片段起始时间偏移。
    EndTimeOffset Float 片段结束时间偏移。

    HighlightsConfigureInfo

    智能精彩片段任务控制参数

    被如下接口引用：CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。

    名称 类型 必选 描述
    Switch String 是 智能精彩片段任务开关，可选值：
  • ON：开启智能精彩片段任务；
  • OFF：关闭智能精彩片段任务。
    		•

    HighlightsConfigureInfoForUpdate

    智能精彩片段任务控制参数

    被如下接口引用：ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 否 智能精彩片段任务开关，可选值：
  • ON：开启智能精彩片段任务；
  • OFF：关闭智能精彩片段任务。
    		•

    ImageBlur

    图片模糊处理。

    被如下接口引用：CreateImageProcessingTemplate。

    名称 类型 必选 描述
    Type String 是 图片模糊的操作类型。可选模式有：
  • Gaussian : 高斯模糊。

    • 示例值：Gaussian
    Radius Integer 否 模糊半径，取值范围为1 - 50。当 Type 取值为 Gaussian 时此字段有效。
    示例值：1
    Sigma Integer 否 正态分布的标准差，必须大于0。当 Type 取值为 Gaussian 时此字段有效。
    示例值：1

    ImageCenterCut

    图片中心裁剪处理。

    被如下接口引用：CreateImageProcessingTemplate。

    名称 类型 必选 描述
    Type String 是 图片的裁剪模式，可选 Circle 和 Rectangle。
  • Circle ： 内切圆裁剪，输出图片半径为 Radius。
  • Rectangle ： 矩形裁剪，输出图片宽为 Width ， 高为 Height。

    • 示例值：Circle
    Width Integer 否 输出图片的宽度，单位为像素，当 Type 取值为 Rectangle 时有效。
    示例值：12
    Height Integer 否 输出图片的高度，单位为像素，当 Type 取值为 Rectangle 时有效。
    示例值：12
    Radius Integer 否 输出图片的半径，单位为像素，当 Type 取值为 Circle 时有效。
    示例值：12

    ImageContentReviewInput

    图片智能内容识别任务输入

    被如下接口引用：ProcessImage。

    名称 类型 必选 描述
    Definition Integer 是 图片智能内容审核模板 ID。当前只支持：
  • 10：所有审核类型均打开。

    • 示例值：10

    ImageOperation

    单个图片处理操作。

    被如下接口引用：CreateImageProcessingTemplate, DescribeImageProcessingTemplates。

    名称 类型 必选 描述
    Type String 是 图片处理类型。可选类型有：
  • Scale : 图片缩略处理；
  • CenterCut : 图片裁剪处理；
  • Blur : 图片模糊处理。

    • 示例值：Scale
    Scale ImageScale 否 图片缩略处理，仅当 Type 为 Scale 时有效。
    CenterCut ImageCenterCut 否 图片裁剪处理，仅当 Type 为 CenterCut 时有效。
    Blur ImageBlur 否 图片模糊处理，仅当 Type 为 Blur 时有效。

    ImageProcessingTemplate

    图片处理模板， 最多支持三次操作。例如：裁剪-缩略-裁剪。

    被如下接口引用：DescribeImageProcessingTemplates。

    名称 类型 描述
    Definition Integer 图片处理模板唯一标识。
    示例值：20
    Type String 模板类型，取值范围：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Preset
    Name String 图片处理模板名称。
    示例值：text
    Comment String 模板描述信息。
    示例值：text
    Operations Array of ImageOperation 图片处理操作数组，操作将以数组顺序执行。
  • 长度限制：3。
    		•
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00

    ImageReviewUsageDataItem

    图片审核次数统计数据。

    被如下接口引用：DescribeImageReviewUsageData。

    名称 类型 描述
    Time String 数据所在时间区间的开始时间，使用 ISO 日期格式。如：当时间粒度为天，2018-12-01T00:00:00+08:00，表示2018年12月1日（含）到2018年12月2日（不含）区间。
    示例值：2018-12-01T00:00:00+08:00
    Count Integer 次数。
    示例值：10

    ImageScale

    图片缩放处理。

    被如下接口引用：CreateImageProcessingTemplate。

    名称 类型 必选 描述
    Type String 是 图片缩放的操作类型。可选模式有：
  • WidthFirst : 指定图片的宽为 Width ，高度等比缩放。
  • HeightFirst : 指定图片的高为 Height ，宽度等比缩放。
  • LongEdgeFirst : 指定图片的长边为 LongEdge ，短边等比缩放。
  • ShortEdgeFirst : 指定图片的短边为 ShortEdge ，长边等比缩放。
  • Force : 忽略原图宽高比例，指定图片宽度为 Width，高度为 Height ，强行缩放图片，可能导致目标图片变形。

    • 示例值：WidthFirst
    Height Integer 否 输出图片的高度，单位为像素。当 Type 取值为 HeightFirst 或 Force 时此字段有效。
    示例值：1
    Width Integer 否 输出图片的宽度，单位为像素。当 Type 取值为 WidthFirst 或 Force 时此字段有效。
    示例值：1
    LongEdge Integer 否 输出图片的长边长度，单位为像素。当 Type 取值为 LongEdgeFirst 时此字段有效。
    示例值：1
    ShortEdge Integer 否 输出图片的短边长度，单位为像素。当 Type 取值为 ShortEdgeFirst 时此字段有效。
    示例值：1

    ImageSpriteTaskInput

    对视频截雪碧图任务输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 雪碧图模板 ID。

    ImageSpriteTemplate

    雪碧图模板详情

    被如下接口引用：DescribeImageSpriteTemplates。

    名称 类型 描述
    Definition Integer 雪碧图模板唯一标识。
    示例值：10000
    Type String 模板类型，取值范围：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Custom
    Name String 雪碧图模板名称。
    示例值：截图
    Width Integer 雪碧图中小图的宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：1080
    Height Integer 雪碧图中小图的高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：1080
    ResolutionAdaptive String 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。

    • 默认值：open。
    示例值：Open
    SampleType String 采样类型。
    示例值：Time
    SampleInterval Integer 采样间隔。
    示例值：10
    RowCount Integer 雪碧图中小图的行数。
    示例值：1
    ColumnCount Integer 雪碧图中小图的列数。
    示例值：1
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2018-10-01T18:00:00+08:00
    FillType String 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。

    • 默认值：black 。
    示例值：stretch
    Comment String 模板描述信息。
    示例值：desc
    Format String 图片格式。
    示例值：jpg

    ImageTransform

    图像旋转、翻转等操作

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Type String 是 类型，取值有：
  • Rotate：图像旋转。
  • Flip：图像翻转。
    		•
    RotateAngle Float 否 图像以中心点为原点进行旋转的角度，取值范围0~360。当 Type = Rotate 时有效。
    Flip String 否 图像翻转动作，取值有：
  • Horizental：水平翻转，即左右镜像。
  • Vertical：垂直翻转，即上下镜像。

    • 当 Type = Flip 时有效。

    ImageWatermarkInput

    图片水印模板输入参数

    被如下接口引用：CreateWatermarkTemplate。

    名称 类型 必选 描述
    ImageContent String 是 水印图片 Base64 编码后的字符串。支持 jpeg、png、gif 图片格式。
    示例值：xxx234
    Width String 否 水印的宽度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%；
  • 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素。取值范围为[8, 4096]。

    • 默认值：10%。
    示例值：10
    Height String 否 水印的高度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%；
  • 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素。取值范围为0或[8, 4096]。

    • 默认值：0px，表示 Height 按照原始水印图片的宽高比缩放。
    示例值：10
    RepeatType String 否 水印重复类型。使用场景：水印为动态图像。取值范围：
  • once：动态水印播放完后，不再出现；
  • repeat_last_frame：水印播放完后，停留在最后一帧；
  • repeat：水印循环播放，直到视频结束（默认值）。

    • 示例值：once
    Transparency Integer 否 图片透明度，取值范围：[0, 100]
  • 0：完全不透明
  • 100：完全透明

    • 默认值：0。
    示例值：0

    ImageWatermarkInputForUpdate

    图片水印模板输入参数

    被如下接口引用：ModifyWatermarkTemplate。

    名称 类型 必选 描述
    ImageContent String 否 水印图片 Base64 编码后的字符串。支持 jpeg、png 图片格式。
    示例值：12ab
    Width String 否 水印的宽度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%；
  • 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素。取值范围为[8, 4096]。

    • 示例值：10px
    Height String 否 水印的高度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%；
  • 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素。取值范围为0或[8, 4096]。

    • 示例值：10px
    RepeatType String 否 水印重复类型。使用场景：水印为动态图像。取值范围：
  • once：动态水印播放完后，不再出现；
  • repeat_last_frame：水印播放完后，停留在最后一帧；
  • repeat：水印循环播放，直到视频结束。

    • 示例值：once
    Transparency Integer 否 图片透明度，取值范围：[0, 100]
  • 0：完全不透明
  • 100：完全透明。

    • 示例值：0

    ImageWatermarkTemplate

    图片水印模板

    被如下接口引用：DescribeWatermarkTemplates。

    名称 类型 描述
    ImageUrl String 水印图片地址。
    示例值：http://xxx/xxx.png
    Width String 水印的宽度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%；
  • 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素。

    • 示例值：10px
    Height String 水印的高度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%；
  • 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素；

    • 0px：表示 Height 按照 Width 对视频宽度的比例缩放。
    示例值：10px
    RepeatType String 水印重复类型。使用场景：水印为动态图像。取值范围：
  • once：动态水印播放完后，不再出现；
  • repeat_last_frame：水印播放完后，停留在最后一帧；
  • repeat：水印循环播放，直到视频结束。

    • 示例值：once
    Transparency Integer 图片透明度，取值范围：[0, 100]
  • 0：完全不透明
  • 100：完全透明。

    • 示例值：0

    JitterConfigureInfo

    视频画面抖动重影检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面抖动重影检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    JitterConfigureInfoForUpdate

    视频画面抖动重影检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面抖动重影检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    JustInTimeTranscodeTemplate

    即时转码模板详情。

    被如下接口引用：DescribeJustInTimeTranscodeTemplates。

    名称 类型 描述
    Type String 模板类型。
    示例值：Custom
    Name String 模板名。
    示例值：模板名
    Comment String 模板描述。
    示例值：模板描述
    VideoConfigure VideoConfigureInfo 视频参数配置。
    注意：此字段可能返回 null，表示取不到有效值。
    WatermarkConfigure WatermarkConfigureData 水印参数配置。
    注意：此字段可能返回 null，表示取不到有效值。

    LicenseUsageDataItem

    License 请求次数统计数据。

    被如下接口引用：DescribeLicenseUsageData。

    名称 类型 描述
    Time String 数据所在时间区间的开始时间，使用 ISO 日期格式。如：当时间粒度为天，2018-12-01T00:00:00+08:00，表示2018年12月1日（含）到2018年12月2日（不含）区间。
    示例值：2018-12-01T00:00:00+08:00
    Count Integer License 请求次数。
    示例值：10

    LiveRealTimeClipMediaSegmentInfo

    即时剪辑后媒体的片段信息。

    被如下接口引用：LiveRealTimeClip。

    名称 类型 描述
    StartTime String 片段的起始时间。格式参照 ISO 日期格式说明。
    示例值：2018-10-01T18:00:00+08:00
    EndTime String 片段的结束时间。格式参照 ISO 日期格式说明。
    示例值：2018-10-01T18:00:00+08:00

    LiveRealTimeClipStreamInfo

    直播即时剪辑流信息

    被如下接口引用：LiveRealTimeClip。

    名称 类型 必选 描述
    Type String 否 直播流类型，可选值：
  • Original（原始流，默认值）。
  • Transcoding（转码流）。

    • 示例值：Original
    TemplateId Integer 否 直播转码模板ID。
    当Type值为"Transcoding"时，必须填写。
    示例值：0

    LiveRecordInfo

    直播录制信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    StreamId String 直播录制流 ID。
    RecordStartTime String 录制起始时间，使用 ISO 日期格式。
    RecordEndTime String 录制结束时间，使用 ISO 日期格式。

    LowLightEnhanceInfo

    低光照增强控制

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 低光照增强控制开关，可选值：
  • ON：开启低光照增强；
  • OFF：关闭低光照增强。

    • 示例值：ON
    Type String 否 低光照增强类型，仅当低光照增强控制开关为 ON 时有效，可选值：
  • normal：正常低光照增强；

    • 默认值：normal。
    示例值：normal

    MediaAdaptiveDynamicStreamingInfo

    转自适应码流信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    AdaptiveDynamicStreamingSet Array of AdaptiveDynamicStreamingInfoItem 转自适应码流信息数组。

    MediaAiAnalysisClassificationItem

    智能分类结果

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Classification String 智能分类的类别名称。
    Confidence Float 智能分类的可信度，取值范围是 0 到 100。

    MediaAiAnalysisCoverItem

    智能封面信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    CoverUrl String 智能封面地址。
    Confidence Float 智能封面的可信度，取值范围是 0 到 100。

    MediaAiAnalysisFrameTagItem

    智能按帧标签结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Tag String 按帧标签名称。
    CategorySet Array of String 按帧标签名称的分类列表，CategorySet.N 表示第 N+1级分类。
    比如 Tag 为“塔楼”时，CategorySet 包含两个元素：CategorySet.0 为“场景”，CategorySet.1为 “建筑”，表示按帧标签为“塔楼”，且第1级分类是“场景”，第2级分类是“建筑”。
    Confidence Float 按帧标签的可信度，取值范围是 0 到 100。

    MediaAiAnalysisFrameTagSegmentItem

    按帧标签片段列表

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 按帧标签起始的偏移时间。
    EndTimeOffset Float 按帧标签结束的偏移时间。
    TagSet Array of MediaAiAnalysisFrameTagItem 时间片段内的标签列表。

    MediaAiAnalysisHighlightItem

    智能精彩片段信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    HighlightUrl String 智能精彩集锦地址。
    CovImgUrl String 智能精彩集锦封面地址。
    Confidence Float 智能精彩集锦的可信度，取值范围是 0 到 100。
    Duration Float 智能精彩集锦持续时间。
    SegmentSet Array of HighlightSegmentItem 智能精彩集锦子片段列表，精彩集锦片段由这些子片段拼接生成。

    MediaAiAnalysisTagItem

    智能标签结果信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Tag String 标签名称。
    Confidence Float 标签的可信度，取值范围是 0 到 100。

    MediaAnimatedGraphicsInfo

    点播文件视频转动图结果信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    AnimatedGraphicsSet Array of MediaAnimatedGraphicsItem 视频转动图结果信息

    MediaAnimatedGraphicsItem

    视频转动图结果信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    Url String 转动图的文件地址。
    Definition Integer 转动图模板 ID，参见转动图参数模板。
    Container String 动图格式，如 gif。
    Height Integer 动图的高度，单位：px。
    Width Integer 动图的宽度，单位：px。
    Bitrate Integer 动图码率，单位：bps。
    Size Integer 动图大小，单位：字节。
    Md5 String 动图的md5值。
    StartTimeOffset Float 动图在视频中的起始时间偏移，单位：秒。
    EndTimeOffset Float 动图在视频中的结束时间偏移，单位：秒。

    MediaAudioStreamItem

    点播文件音频流信息

    被如下接口引用：DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip。

    名称 类型 描述
    Bitrate Integer 音频流的码率，单位：bps。
    示例值：1
    SamplingRate Integer 音频流的采样率，单位：hz。
    示例值：1
    Codec String 音频流的编码格式，例如 aac。
    示例值：aac

    MediaBasicInfo

    点播媒体文件基础信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    Name String 媒体文件名称。
    示例值：示例视频
    Description String 媒体文件描述。
    示例值：用作示例展示
    CreateTime String 媒体文件的创建时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    UpdateTime String 媒体文件的最近更新时间（如修改视频属性、发起视频处理等会触发更新媒体文件信息的操作），使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    ExpireTime String 媒体文件的过期时间，使用 ISO 日期格式。过期后该媒体文件及其相关资源（转码结果、雪碧图等）将被永久删除。“9999-12-31T23:59:59Z”表示永不过期。
    示例值：2024-09-08T02:23:29Z
    ClassId Integer 媒体文件的分类 ID。
    示例值：0
    ClassName String 媒体文件的分类名称。
    示例值：体育
    ClassPath String 媒体文件的分类路径，分类间以“-”分隔，如“新的一级分类 - 新的二级分类”。
    示例值：体育-篮球
    CoverUrl String 媒体文件的封面图片地址。
    示例值：http://xxx.vod-qcloud.com/xxx/snapshot/1572936704_3908310029.100_0.jpg
    Type String 媒体文件的封装格式，例如 mp4、flv 等。
    示例值：mp4
    MediaUrl String 原始媒体文件的 URL 地址。
    示例值：http://xxx.vod-qcloud.com/xxx/snapshot/xxx.mp4
    SourceInfo MediaSourceData 该媒体文件的来源信息。
    注意：此字段可能返回 null，表示取不到有效值。
    StorageRegion String 媒体文件存储地区，如 ap-chongqing，参见地域列表。
    示例值：ap-chongqing
    TagSet Array of String 媒体文件的标签信息。
    示例值：["体育", "篮球"]
    Vid String 直播录制文件的唯一标识。
    示例值：327083**3604148
    Category String 文件类型：
  • Video: 视频文件
  • Audio: 音频文件
  • Image: 图片文件

    • 示例值：Video
    Status String 文件状态：Normal：正常，Forbidden：封禁。
    示例值：Normal
    StorageClass String 媒体文件的存储类别：
  • STANDARD：标准存储。
  • STANDARD_IA：低频存储。
  • ARCHIVE：归档存储。
  • DEEP_ARCHIVE：深度归档存储。

    • 示例值：STANDARD

    MediaCastEvent

    媒体转推事件通知消息。

    被如下接口引用：PullEvents。

    名称 类型 必选 描述
    CastId String 否 媒体转推 ID。
    Status String 否 转推状态，取值有：
  • Working ：运行中；
  • Scheduled ：等待定时时间到达后启动；
  • Stopped ：已经停止转推；
  • Idle ：空闲。

    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：Working

    MediaClassInfo

    分类信息描述

    被如下接口引用：DescribeAllClass。

    名称 类型 描述
    ClassId Integer 分类 ID。
    示例值：0
    ParentId Integer 父类 ID，一级分类的父类 ID 为 -1。
    示例值：0
    Name String 分类名称。
    示例值："SystemDefault"
    Level Integer 分类级别，一级分类为 0，最大值为 3，即最多允许 4 级分类层次。
    示例值：0
    SubClassIdSet Array of Integer 当前分类的第一级子类 ID 集合。
    示例值：[4]
    ClassName String 分类名称（该字段已不推荐使用，建议使用新的分类名称字段 Name）。
    示例值："其他"

    MediaContentReviewAsrTextSegmentItem

    音视频审核 Asr 文字的嫌疑片段

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 嫌疑片段结束的偏移时间，单位：秒。
    示例值：10
    Confidence Float 嫌疑片段置信度。
    示例值：0
    Suggestion String 嫌疑片段音视频审核的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    KeywordSet Array of String 嫌疑关键词列表。
    示例值：["嫌疑关键字1","嫌疑关键字2"]

    MediaContentReviewOcrTextSegmentItem

    音视频审核 Ocr 文字的嫌疑片段

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 嫌疑片段结束的偏移时间，单位：秒。
    示例值：10
    Confidence Float 嫌疑片段置信度。
    示例值：0
    Suggestion String 嫌疑片段音视频审核的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    KeywordSet Array of String 嫌疑关键词列表。
    示例值：["嫌疑关键字1","嫌疑关键字2"]
    AreaCoordSet Array of Integer 嫌疑文字出现的区域坐标 (像素级)，[x1, y1, x2, y2]，即左上角坐标、右下角坐标。
    示例值：[529,212,580,242]
    Url String 嫌疑图片 URL （图片不会永久存储，到达
    PicUrlExpireTime 时间点后图片将被删除）。
    示例值：https://xxx.vod2.myqcloud.com/xxx/xxx.jpg
    PicUrlExpireTime String 嫌疑图片 URL 失效时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z

    MediaContentReviewPoliticalSegmentItem

    音视频审核涉及令人不适宜信息的嫌疑片段

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 嫌疑片段结束的偏移时间，单位：秒。
    示例值：10
    Confidence Float 嫌疑片段分数。
    示例值：0
    Suggestion String 嫌疑片段涉及令人不适宜的信息的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    Name String 涉及令人不适宜的信息、违规图标名字。
    示例值：违规图片名字
    Label String 嫌疑片段涉及令人不适宜的信息的结果标签。音视频审核模板画面涉及令人不适宜的信息的任务控制参数里 LabelSet 参数与此参数取值范围的对应关系：
    violation_photo：
  • violation_photo：违规图标。

    • politician：
  • nation_politician：国家领导人；
  • province_politician: 省部级领导人；
  • bureau_politician：厅局级领导人；
  • county_politician：县处级领导人；
  • rural_politician：乡科级领导人；
  • sensitive_politician：违规相关人物；
  • foreign_politician：国外领导人。

    • entertainment：
  • sensitive_entertainment：违规娱乐人物。

    • sport：
  • sensitive_sport：违规体育人物。

    • entrepreneur：
  • sensitive_entrepreneur：违规商业人物。

    • scholar：
  • sensitive_scholar：违规教育学者。

    • celebrity：
  • sensitive_celebrity：违规知名人物；
  • historical_celebrity：历史知名人物。

    • military：
  • sensitive_military：违规相关人物。

    • 示例值：violation_photo
    Url String 嫌疑图片 URL （图片不会永久存储，到达
    PicUrlExpireTime 时间点后图片将被删除）。
    示例值：https://xxx.vod2.myqcloud.com/xxx/xxx.jpg
    AreaCoordSet Array of Integer 涉及令人不适宜的信息、违规图标出现的区域坐标 (像素级)，[x1, y1, x2, y2]，即左上角坐标、右下角坐标。
    示例值：[529,212,580,242]
    PicUrlExpireTimeStamp Integer 该字段已废弃，请使用 PicUrlExpireTime。
    示例值：2023-09-08T02:23:29Z
    PicUrlExpireTime String 嫌疑图片 URL 失效时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z

    MediaContentReviewSegmentItem

    音视频审核涉及令人反感的信息、涉及令人不安全的信息的嫌疑片段

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 嫌疑片段结束的偏移时间，单位：秒。
    示例值：10
    Confidence Float 嫌疑片段涉及令人反感的信息的分数。
    示例值：0
    Label String 嫌疑片段涉及令人反感的信息的结果标签。
    示例值：porn
    Suggestion String 嫌疑片段鉴别涉及令人反感的信息的结果建议，取值范围：
  • pass。
  • review。
  • block。

    • 示例值：pass
    Url String 嫌疑图片 URL （图片不会永久存储，到达
    PicUrlExpireTime 时间点后图片将被删除）。
    示例值：https://xxx.vod2.myqcloud.com/xxx/xxx.jpg
    PicUrlExpireTimeStamp Integer 该字段已废弃，请使用 PicUrlExpireTime。
    示例值：2023-09-08T02:23:29Z
    PicUrlExpireTime String 嫌疑图片 URL 失效时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z

    MediaDeleteItem

    指定删除点播视频时的删除内容

    被如下接口引用：DeleteMedia, PullEvents。

    名称 类型 必选 描述
    Type String 是 所指定的删除部分。如果未填写该字段则参数无效。可选值有：
  • OriginalFiles（删除原文件，删除后无法发起转码、微信发布等任何视频处理操作）；
  • TranscodeFiles（删除转码文件）；
  • AdaptiveDynamicStreamingFiles（删除转自适应码流文件）；
  • WechatPublishFiles（删除微信发布文件）；
  • WechatMiniProgramPublishFiles（删除微信小程序发布文件）。

    • 注意：
  • 取值为OriginalFiles时，文件上传时携带的封面文件会被删除；
  • 取值为TranscodeFiles时，媒体处理产生的封面文件会被删除。

    • 示例值：TranscodeFiles
    Definition Integer 否 删除由Type参数指定的种类下的视频模板号，模板定义参见转码模板。
    默认值为0，表示删除参数Type指定种类下所有的视频。
    示例值：0

    MediaImageSpriteInfo

    点播文件雪碧图信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    ImageSpriteSet Array of MediaImageSpriteItem 特定规格的雪碧图信息集合，每个元素代表一套相同规格的雪碧图。

    MediaImageSpriteItem

    雪碧图信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    Definition Integer 雪碧图规格，参见雪碧图参数模板。
    Height Integer 雪碧图小图的高度。
    Width Integer 雪碧图小图的宽度。
    TotalCount Integer 每一张雪碧图大图里小图的数量。
    ImageUrlSet Array of String 每一张雪碧图大图的地址。
    WebVttUrl String 雪碧图子图位置与时间关系的 WebVtt 文件地址。WebVtt 文件表明了各个雪碧图小图对应的时间点，以及在雪碧大图里的坐标位置，一般被播放器用于实现预览。

    MediaInfo

    点播文件信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    BasicInfo MediaBasicInfo 基础信息。包括视频名称、分类、播放地址、封面图片等。
    注意：此字段可能返回 null，表示取不到有效值。
    MetaData MediaMetaData 元信息。包括大小、时长、视频流信息、音频流信息等。
    注意：此字段可能返回 null，表示取不到有效值。
    TranscodeInfo MediaTranscodeInfo 转码结果信息。包括该视频转码生成的各种码率的视频的地址、规格、码率、分辨率等。
    注意：此字段可能返回 null，表示取不到有效值。
    AnimatedGraphicsInfo MediaAnimatedGraphicsInfo 转动图结果信息。对视频转动图（如 gif）后，动图相关信息。
    注意：此字段可能返回 null，表示取不到有效值。
    SampleSnapshotInfo MediaSampleSnapshotInfo 采样截图信息。对视频采样截图后，相关截图信息。
    注意：此字段可能返回 null，表示取不到有效值。
    ImageSpriteInfo MediaImageSpriteInfo 雪碧图信息。对视频截取雪碧图之后，雪碧的相关信息。
    注意：此字段可能返回 null，表示取不到有效值。
    SnapshotByTimeOffsetInfo MediaSnapshotByTimeOffsetInfo 指定时间点截图信息。对视频依照指定时间点截图后，各个截图的信息。
    注意：此字段可能返回 null，表示取不到有效值。
    KeyFrameDescInfo MediaKeyFrameDescInfo 视频打点信息。对视频设置的各个打点信息。
    注意：此字段可能返回 null，表示取不到有效值。
    AdaptiveDynamicStreamingInfo MediaAdaptiveDynamicStreamingInfo 转自适应码流信息。包括规格、加密类型、打包格式等相关信息。
    注意：此字段可能返回 null，表示取不到有效值。
    MiniProgramReviewInfo MediaMiniProgramReviewInfo 小程序审核信息。
    注意：此字段可能返回 null，表示取不到有效值。
    SubtitleInfo MediaSubtitleInfo 字幕信息。
    注意：此字段可能返回 null，表示取不到有效值。
    FileId String 媒体文件唯一标识 ID。
    示例值：327083**3604148
    ReviewInfo FileReviewInfo 审核信息。
    注意：此字段可能返回 null，表示取不到有效值。

    MediaInputInfo

    要处理的源视频信息，视频名称、视频自定义 ID。

    被如下接口引用：ProcessMediaByUrl。

    名称 类型 必选 描述
    Url String 是 视频 URL。
    Name String 否 视频名称。
    Id String 否 视频自定义 ID。

    MediaKeyFrameDescInfo

    视频打点信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    KeyFrameDescSet Array of MediaKeyFrameDescItem 视频打点信息数组。

    MediaKeyFrameDescItem

    视频打点信息

    被如下接口引用：DescribeMediaInfos, ModifyMediaInfo, SearchMedia。

    名称 类型 必选 描述
    TimeOffset Float 是 打点的视频偏移时间，单位：秒。
    示例值：0
    Content String 是 打点的内容字符串，限制 1-128 个字符。
    示例值：打点内容

    MediaMetaData

    点播媒体文件元信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, LiveRealTimeClip, PullEvents, SearchMedia, SimpleHlsClip。

    名称 类型 描述
    Size Integer 上传的媒体文件大小（视频为 HLS 时，大小是 m3u8 和 ts 文件大小的总和），单位：字节。
    示例值：1
    Container String 容器类型，例如 m4a，mp4 等。
    示例值：mp4
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和，单位：bps。
    示例值：123
    Height Integer 视频流高度的最大值，单位：px。
    示例值：1080
    Width Integer 视频流宽度的最大值，单位：px。
    示例值：1080
    Duration Float 视频时长，单位：秒。
    示例值：30
    Rotate Integer 视频拍摄时的选择角度，单位：度。
    示例值：90
    VideoStreamSet Array of MediaVideoStreamItem 视频流信息。
    AudioStreamSet Array of MediaAudioStreamItem 音频流信息。
    VideoDuration Float 视频时长，单位：秒。
    示例值：30.1
    AudioDuration Float 音频时长，单位：秒。
    示例值：30.1
    Md5 String 媒体文件的 Md5 值。
  • 注意：如需要获取媒体文件的 Md5，调用 DescribeFileAttributes 接口，待任务执行完成后获取。

    • 示例值：123

    MediaMiniProgramReviewElem

    小程序音视频审核概要元信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    Type String 音视频审核类型。
  • Porn：画面涉及令人反感的信息，
  • Porn.Ocr：文字涉及令人反感的信息，
  • Porn.Asr：声音涉及令人反感的信息，
  • Terrorism：画面涉及令人不安全的信息，
  • Political：画面涉及令人不适宜的信息，
  • Political.Ocr：文字涉及令人不适宜的信息，
  • Political.Asr：声音涉及令人不适宜的信息。

    • 示例值：Porn
    Suggestion String 音视频审核意见。
  • pass：确认正常，
  • block：确认违规，
  • review：疑似违规。

    • 示例值：pass
    Confidence Float 音视频审核结果置信度。取值 0~100。
    示例值：100

    MediaMiniProgramReviewInfo

    小程序音视频审核信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    MiniProgramReviewList Array of MediaMiniProgramReviewInfoItem 音视频审核信息列表。

    MediaMiniProgramReviewInfoItem

    小程序音视频审核信息单元

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    Definition Integer 模板id。小程序视频发布的视频所对应的转码模板ID，为0代表原始视频。
    示例值：0
    MetaData MediaMetaData 视频元信息。
    Url String 小程序音视频审核视频播放地址。
    示例值：http://xxx.vod2.myqcloud.com/xxx/xxx/m.f0.mp4
    ReviewResult String 小程序视频发布状态：
  • Pass：成功。
  • Rejected：未通过。

    • 示例值：Pass
    ReviewSummary Array of MediaMiniProgramReviewElem 小程序音视频审核元素。

    MediaOutputInfo

    视频处理输出文件信息参数。

    被如下接口引用：ProcessMediaByUrl。

    名称 类型 必选 描述
    Region String 否 输出文件 Bucket 所属地域，如 ap-guangzhou 。
    Bucket String 否 输出文件 Bucket 。
    Dir String 否 输出文件目录，目录名必须以 "/" 结尾。

    MediaProcessTaskAdaptiveDynamicStreamingResult

    对视频转自适应码流任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：SUCCESS
    Progress Integer 转自适应码流任务进度，取值范围 [0-100] 。
    示例值：100
    Input AdaptiveDynamicStreamingTaskInput 对视频转自适应码流任务的输入。
    Output AdaptiveDynamicStreamingInfoItem 对视频转自适应码流任务的输出。
    BeginProcessTime String 转自适应码流任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    FinishTime String 转自适应码流任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-09-08T03:23:29Z

    MediaProcessTaskAnimatedGraphicResult

    转动图任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input AnimatedGraphicTaskInput 转动图任务的输入。
    Output MediaAnimatedGraphicsItem 转动图任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 转动图任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 转动图任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    FinishTime String 转动图任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-09-08T03:23:29Z

    MediaProcessTaskCoverBySnapshotResult

    对视频截图做封面任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input CoverBySnapshotTaskInput 对视频截图做封面任务的输入。
    Output CoverBySnapshotTaskOutput 对视频截图做封面任务的输出。
    Progress Integer 对视频截图做封面任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 截图做封面任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    FinishTime String 截图做封面任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-09-08T03:23:29Z

    MediaProcessTaskImageSpriteResult

    对视频截雪碧图任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input ImageSpriteTaskInput 对视频截雪碧图任务的输入。
    Output MediaImageSpriteItem 对视频截雪碧图任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 对视频截雪碧图任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 截雪碧图任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    FinishTime String 截雪碧图任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-09-08T03:23:29Z

    MediaProcessTaskInput

    视频处理任务类型

    被如下接口引用：CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ResetProcedureTemplate。

    名称 类型 必选 描述
    TranscodeTaskSet Array of TranscodeTaskInput 否 视频转码任务列表。
    AnimatedGraphicTaskSet Array of AnimatedGraphicTaskInput 否 视频转动图任务列表。
    SnapshotByTimeOffsetTaskSet Array of SnapshotByTimeOffsetTaskInput 否 对视频按时间点截图任务列表。
    SampleSnapshotTaskSet Array of SampleSnapshotTaskInput 否 对视频采样截图任务列表。
    ImageSpriteTaskSet Array of ImageSpriteTaskInput 否 对视频截雪碧图任务列表。
    CoverBySnapshotTaskSet Array of CoverBySnapshotTaskInput 否 对视频截图做封面任务列表。
    AdaptiveDynamicStreamingTaskSet Array of AdaptiveDynamicStreamingTaskInput 否 对视频转自适应码流任务列表。

    MediaProcessTaskResult

    任务查询结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Type String 任务的类型，可以取的值有：
  • Transcode：转码
  • AnimatedGraphics：转动图
  • SnapshotByTimeOffset：时间点截图
  • SampleSnapshot：采样截图
  • ImageSprites：雪碧图
  • CoverBySnapshot：截图做封面
  • AdaptiveDynamicStreaming：自适应码流
    		•
    TranscodeTask MediaProcessTaskTranscodeResult 视频转码任务的查询结果，当任务类型为 Transcode 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AnimatedGraphicTask MediaProcessTaskAnimatedGraphicResult 视频转动图任务的查询结果，当任务类型为 AnimatedGraphics 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    SnapshotByTimeOffsetTask MediaProcessTaskSnapshotByTimeOffsetResult 对视频按时间点截图任务的查询结果，当任务类型为 SnapshotByTimeOffset 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    SampleSnapshotTask MediaProcessTaskSampleSnapshotResult 对视频采样截图任务的查询结果，当任务类型为 SampleSnapshot 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ImageSpriteTask MediaProcessTaskImageSpriteResult 对视频截雪碧图任务的查询结果，当任务类型为 ImageSprite 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    CoverBySnapshotTask MediaProcessTaskCoverBySnapshotResult 对视频截图做封面任务的查询结果，当任务类型为 CoverBySnapshot 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult 对视频转自适应码流任务的查询结果，当任务类型为 AdaptiveDynamicStreaming 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    MediaProcessTaskSampleSnapshotResult

    对视频做采样截图任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input SampleSnapshotTaskInput 对视频做采样截图任务输入。
    Output MediaSampleSnapshotItem 对视频做采样截图任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 对视频做采样截图任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 采样截图任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    FinishTime String 采样截图任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-09-08T03:23:29Z

    MediaProcessTaskSnapshotByTimeOffsetResult

    对视频按指定时间点截图任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input SnapshotByTimeOffsetTaskInput 对视频按指定时间点截图任务输入。
    Output MediaSnapshotByTimeOffsetItem 对视频按指定时间点截图任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 对视频按指定时间点截图任务进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 时间点截图任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    FinishTime String 时间点截图任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-09-08T03:23:29Z

    MediaProcessTaskTranscodeResult

    转码任务结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：SUCCESS
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    Input TranscodeTaskInput 转码任务的输入。
    Output MediaTranscodeItem 转码任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 转码进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 转码任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    FinishTime String 转码任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-09-08T03:23:29Z

    MediaSampleSnapshotInfo

    点播文件采样截图信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    SampleSnapshotSet Array of MediaSampleSnapshotItem 特定规格的采样截图信息集合，每个元素代表一套相同规格的采样截图。

    MediaSampleSnapshotItem

    采样截图信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    Definition Integer 采样截图规格 ID，参见采样截图参数模板。
    SampleType String 采样方式，取值范围：
  • Percent：根据百分比间隔采样。
  • Time：根据时间间隔采样。
    		•
    Interval Integer 采样间隔
  • 当 SampleType 为 Percent 时，该值表示多少百分比一张图。
  • 当 SampleType 为 Time 时，该值表示多少时间间隔一张图，单位秒， 第一张图均为视频首帧。
    		•
    ImageUrlSet Array of String 生成的截图 url 列表。
    WaterMarkDefinition Array of Integer 截图如果被打上了水印，被打水印的模板 ID 列表。

    MediaSnapshotByTimeOffsetInfo

    点播文件指定时间点截图信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    SnapshotByTimeOffsetSet Array of MediaSnapshotByTimeOffsetItem 特定规格的指定时间点截图信息集合。目前每种规格只能有一套截图。

    MediaSnapshotByTimeOffsetItem

    点播文件指定时间点截图信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    Definition Integer 指定时间点截图规格，参见指定时间点截图参数模板。
    示例值：10
    PicInfoSet Array of MediaSnapshotByTimePicInfoItem 同一规格的截图信息集合，每个元素代表一张截图。
    示例值：null

    MediaSnapshotByTimePicInfoItem

    指定时间点截图信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    TimeOffset Float 该张截图对应视频文件中的时间偏移，单位为毫秒。
    Url String 该张截图的 URL 地址。
    WaterMarkDefinition Array of Integer 截图如果被打上了水印，被打水印的模板 ID 列表。

    MediaSourceData

    来源文件信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    SourceType String 媒体文件的来源类别：
  • Record：来自录制。如直播录制、直播时移录制等。
  • Upload：来自上传。如拉取上传、服务端上传、客户端 UGC 上传等。
  • VideoProcessing：来自视频处理。如视频拼接、视频剪辑等。
  • TrtcRecord：来自TRTC 伴生录制。
  • WebPageRecord：来自全景录制。
  • Unknown：未知来源。

    • 示例值：Record
    SourceContext String 用户创建文件时透传的字段。
    示例值：""
    LiveRecordInfo LiveRecordInfo 直播录制信息，当文件来源为 Record 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TrtcRecordInfo TrtcRecordInfo TRTC 伴生录制信息，当文件来源为 TrtcRecord 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    WebPageRecordInfo WebPageRecordInfo 全景录制信息，当文件来源为 WebPageRecord 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    MediaSubStreamInfoItem

    转自适应码流子流信息。

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    Type String 子流类型，取值范围：
  • audio：纯音频；
  • video：视频（可能包含音频流）。

    • 示例值：video
    Width Integer 当子流为视频流时，视频画面宽度，单位：px。
    示例值：1080
    Height Integer 当子流为视频流时，视频画面高度，单位：px。
    示例值：1920
    Size Integer 子流媒体文件大小，单位：Byte。
    注意：在 2023-02-09T16:00:00Z 前处理生成的自适应码流文件此字段为0。
    示例值：10240

    MediaSubtitleInfo

    字幕信息。

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    SubtitleSet Array of MediaSubtitleItem 字幕信息列表。

    MediaSubtitleInput

    字幕信息输入参数。

    被如下接口引用：ModifyMediaInfo。

    名称 类型 必选 描述
    Name String 是 字幕名字，长度限制：64 个字符。
    示例值：MySubtitle
    Language String 是 字幕语言。常见的取值如下：
  • zh：中文；
  • en：英文；
  • ja：日文；
  • ko：韩文；
  • vi：越南语；
  • ms：马来语；
  • th：泰语；
  • pt：葡萄牙语；
  • tr：土耳其语；
  • ar：阿拉伯语；
  • es：西班牙语；
  • hi：印地语；
  • fr：法语。

    • 其他取值参考 RFC5646
    示例值：zh
    Format String 是 字幕格式。取值范围如下：
  • vtt

    • 示例值：vtt
    Content String 是 字幕内容，进行 Base64 编码后的字符串。
    示例值：V0VCVlRUCSNFbGVtZW50YWwgTWVkaWEgRW5naW5lKFRNKSAyLjE2LjAuNjAyMzk5ClgtVElNRVNUQU1QLU1BUD1MT0NBTDowMDowMDowMC4wMDAsTVBFR1RTOjE4MzY5MAoKMDA6MDA6MDEuNjAwIC0tPiAwMDowMDoxMC4yMDAKdGhpcyBpcyB0aGUgdnR0IHN1YnRpdGxlcyA=
    Id String 否 字幕的唯一标识。长度不能超过16个字符，可以使用大小写字母、数字、下划线（_）或横杠（-）。不能与媒体文件中现有字幕的唯一标识重复。
    示例值：MySubtitleId

    MediaSubtitleItem

    字幕信息。

    被如下接口引用：DescribeMediaInfos, ModifyMediaInfo, SearchMedia。

    名称 类型 描述
    Id String 字幕的唯一标识。
    示例值：MySubtitleId
    Name String 字幕名字。
    示例值：MySubtitle
    Language String 字幕语言。常见的取值如下：
  • zh：中文；
  • en：英文；
  • ja：日文；
  • ko：韩文；
  • vi：越南语；
  • ms：马来语；
  • th：泰语；
  • pt：葡萄牙语；
  • tr：土耳其语；
  • ar：阿拉伯语；
  • es：西班牙语；
  • hi：印地语；
  • fr：法语。

    • 其他取值参考 RFC5646
    示例值：zh
    Format String 字幕格式。取值范围如下：
  • vtt

    • 示例值：vtt
    Url String 字幕 URL。
    示例值：http://xxx.vod2.myqcloud.com/xxx/xxx/subtitles/MySubtitleId.vtt
    Source String 字幕来源，取值范围：
  • UserUploaded：用户上传；
  • AIRecognition：AI 识别，通过语音识别或语音翻译生成。

    • 示例值：UserUploaded

    MediaTrack

    轨道信息

    被如下接口引用：ComposeMedia, DescribeTaskDetail, PullEvents。

    名称 类型 必选 描述
    Type String 是 轨道类型，取值有：

    • Video ：视频轨道。视频轨道由以下 Item 组成：
      • VideoTrackItem
      • MediaTransitionItem
      • EmptyTrackItem
    • Audio ：音频轨道。音频轨道由以下 Item 组成：
      • AudioTrackItem
      • MediaTransitionItem
      • EmptyTrackItem
    • Sticker ：贴图轨道。贴图轨道以下 Item 组成：
      • StickerTrackItem
      • EmptyTrackItem
    TrackItems Array of MediaTrackItem 是 轨道上的媒体片段列表。

    MediaTrackItem

    媒体轨道的片段信息

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Type String 是 片段类型。取值有：
  • Video：视频片段。
  • Audio：音频片段。
  • Sticker：贴图片段。
  • Transition：转场。
  • Empty：空白片段。
    		•
    VideoItem VideoTrackItem 否 视频片段，当 Type = Video 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AudioItem AudioTrackItem 否 音频片段，当 Type = Audio 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    StickerItem StickerTrackItem 否 贴图片段，当 Type = Sticker 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TransitionItem MediaTransitionItem 否 转场，当 Type = Transition 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    EmptyItem EmptyTrackItem 否 空白片段，当 Type = Empty 时有效。空片段用于时间轴的占位。
  • 如需要两个音频片段之间有一段时间的静音，可以用 EmptyTrackItem 来进行占位。
  • 使用 EmptyTrackItem 进行占位，来定位某个Item。

    • 注意：此字段可能返回 null，表示取不到有效值。

    MediaTranscodeInfo

    点播文件转码信息

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    TranscodeSet Array of MediaTranscodeItem 各规格的转码信息集合，每个元素代表一个规格的转码结果。

    MediaTranscodeItem

    转码信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    Url String 转码后的视频文件地址。
    示例值：http://xxxx/xxx.mp4
    Definition Integer 转码规格 ID，参见转码参数模板。
    注意：取值 0 表示原始文件。
    示例值：10010
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和， 单位：bps。
    示例值：125000
    Height Integer 视频流高度的最大值，单位：px。
    示例值：720
    Width Integer 视频流宽度的最大值，单位：px。
    示例值：1080
    Size Integer 媒体文件总大小，单位：字节。
  • 当媒体文件为 HLS 时，大小是 m3u8 和 ts 文件大小的总和。

    • 示例值：123000
    Duration Float 视频时长，单位：秒。
    示例值：10
    Md5 String 视频的 md5 值。
    示例值：1231
    Container String 容器类型，例如 m4a，mp4 等。
    示例值：mp4
    VideoStreamSet Array of MediaVideoStreamItem 视频流信息。
    AudioStreamSet Array of MediaAudioStreamItem 音频流信息。
    DigitalWatermarkType String 数字水印类型。可选值：
  • Trace 表示经过溯源水印处理；
  • CopyRight 表示经过版权水印处理；
  • None 表示没有经过数字水印处理。

    • 示例值：Trace
    CopyRightWatermarkText String 版权信息。
    示例值：""

    MediaTransitionItem

    转场信息

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Duration Float 是 转场持续时间，单位为秒。进行转场处理的两个媒体片段，第二个片段在轨道上的起始时间会自动进行调整，设置为前面一个片段的结束时间减去转场的持续时间。
    MediaTransitions Array of TransitionOperation 否 转场操作列表。图像转场操作和音频转场操作各自最多支持一个。

    MediaVideoStreamItem

    点播文件视频流信息

    被如下接口引用：DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip。

    名称 类型 描述
    Bitrate Integer 视频流的码率，单位：bps。
    示例值：100
    Height Integer 视频流的高度，单位：px。
    示例值：1080
    Width Integer 视频流的宽度，单位：px。
    示例值：720
    Codec String 视频流的编码格式，例如 h264。
    示例值：h264
    Fps Integer 帧率，单位：hz。
    示例值：25
    CodecTag String 编码标签，仅当 Codec 为 hevc 时有效。
    示例值：hev1
    DynamicRangeInfo DynamicRangeInfo 画面动态范围信息。
  • 注意：在 2023-01-10T00:00:00Z 后处理的转码文件，此字段有效。
    		•

    MosaicConfigureInfo

    视频画面马赛克检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面马赛克检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    MosaicConfigureInfoForUpdate

    视频画面马赛克检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面马赛克检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    MosaicInput

    视频处理任务中的马赛克参数类型

    被如下接口引用：CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate。

    名称 类型 必选 描述
    CoordinateOrigin String 否 原点位置，目前仅支持：
  • TopLeft：表示坐标原点位于视频图像左上角，马赛克原点为图片或文字的左上角。

    • 默认值：TopLeft。
    XPos String 否 马赛克原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示马赛克 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%；
  • 当字符串以 px 结尾，表示马赛克 XPos 为指定像素，如 100px 表示 XPos 为 100 像素。

    • 默认值：0px。
    YPos String 否 马赛克原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示马赛克 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%；
  • 当字符串以 px 结尾，表示马赛克 YPos 为指定像素，如 100px 表示 YPos 为 100 像素。

    • 默认值：0px。
    Width String 否 马赛克的宽度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示马赛克 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%；
  • 当字符串以 px 结尾，表示马赛克 Width 单位为像素，如 100px 表示 Width 为 100 像素。

    • 默认值：10%。
    Height String 否 马赛克的高度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示马赛克 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%；
  • 当字符串以 px 结尾，表示马赛克 Height 单位为像素，如 100px 表示 Height 为 100 像素。

    • 默认值：10%。
    StartTimeOffset Float 否 马赛克的起始时间偏移，单位：秒。不填或填0，表示马赛克从画面出现时开始显现。
  • 不填或填0，表示马赛克从画面开始就出现；
  • 当数值大于0时（假设为 n），表示马赛克从画面开始的第 n 秒出现；
  • 当数值小于0时（假设为 -n），表示马赛克从离画面结束 n 秒前开始出现。
    		•
    EndTimeOffset Float 否 马赛克的结束时间偏移，单位：秒。
  • 不填或填0，表示马赛克持续到画面结束；
  • 当数值大于0时（假设为 n），表示马赛克持续到第 n 秒时消失；
  • 当数值小于0时（假设为 -n），表示马赛克持续到离画面结束 n 秒前消失。
    		•

    NoiseConfigureInfo

    视频画面噪点检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面噪点检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    NoiseConfigureInfoForUpdate

    视频画面噪点检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面噪点检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    ObjectConfigureInfo

    物体识别任务控制参数

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 物体识别任务开关，可选值：
  • ON：开启智能物体识别任务；
  • OFF：关闭智能物体识别任务。
    		•
    ObjectLibrary String 否 物体库选择，可选值：
  • Default：使用默认物体库；
  • UserDefine：使用用户自定义物体库。
  • All：同时使用默认物体库和用户自定义物体库。

    • 默认值： All，同时使用默认物体库和用户自定义物体库。

    ObjectConfigureInfoForUpdate

    物体识别任务控制参数

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 物体识别任务开关，可选值：
  • ON：开启智能物体识别任务；
  • OFF：关闭智能物体识别任务。
    		•
    ObjectLibrary String 否 物体库选择，可选值：
  • Default：使用默认物体库；
  • UserDefine：使用用户自定义物体库。
  • All：同时使用默认物体库和用户自定义物体库。
    		•

    OcrFullTextConfigureInfo

    文本全文本识别任务控制参数

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 文本全文识别任务开关，可选值：
  • ON：开启智能文本全文识别任务；
  • OFF：关闭智能文本全文识别任务。
    		•

    OcrFullTextConfigureInfoForUpdate

    文本全文本识别任务控制参数

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 文本全文识别任务开关，可选值：
  • ON：开启智能文本全文识别任务；
  • OFF：关闭智能文本全文识别任务。
    		•

    OcrWordsConfigureInfo

    文本关键词识别控制参数。

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 文本关键词识别任务开关，可选值：
  • ON：开启文本关键词识别任务；
  • OFF：关闭文本关键词识别任务。
    		•
    LabelSet Array of String 否 关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。
    标签个数最多 10 个，每个标签长度最多 16 个字符。

    OcrWordsConfigureInfoForUpdate

    文本关键词识别控制参数。

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 文本关键词识别任务开关，可选值：
  • ON：开启文本关键词识别任务；
  • OFF：关闭文本关键词识别任务。
    		•
    LabelSet Array of String 否 关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。
    标签个数最多 10 个，每个标签长度最多 16 个字符。

    OutputAudioStream

    输出的音频流信息

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Codec String 否 音频流的编码格式，可选值：
  • libfdk_aac：适合 mp4 文件。

    • 默认值：libfdk_aac。
    示例值：libfdk_aac
    SampleRate Integer 否 音频流的采样率，可选值：
  • 16000
  • 32000
  • 44100
  • 48000

    • 单位：Hz。
    默认值：16000。
    示例值：44100
    AudioChannel Integer 否 音频声道数，可选值：
  • 1：单声道 。
  • 2：双声道

    • 默认值：2。
    示例值：2
    Bitrate Integer 否 音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。
    当取值为 0，将自动设置音频码率。
    示例值：192

    OutputVideoStream

    输出的视频流信息

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Codec String 否 视频流的编码格式，可选值：
  • libx264：H.264 编码

    • 默认值：libx264。
    Fps Integer 否 视频帧率，取值范围：[0, 60]，单位：Hz。
    默认值：0，表示和第一个视频轨的第一个视频片段的视频帧率一致。

    PersistenceCompleteTask

    剪辑固化任务信息。

    被如下接口引用：PullEvents。

    名称 类型 描述
    FileId String 固化生成的媒体 ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：4424135347900333234
    PersistenceSource String 剪辑固化的来源，有以下三种。
  • SimpleHlsClip：来自简单 HLS 剪辑；
  • FastEditMedia：来自快速媒体编辑；
  • LiveRealTimeClip:来自直播即时剪辑。

    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：SimpleHlsClip

    PlayStatFileInfo

    播放统计文件信息

    被如下接口引用：DescribeDailyPlayStatFileList。

    名称 类型 描述
    Date String 播放统计数据所属日期，使用 ISO 日期格式。
    Url String 播放统计文件的 URL 地址。播放统计文件内容为：
  • date：播放日期。
  • file_id：视频文件 ID。
  • ip_count：去重后的客户端 IP 数。
  • flux：播放流量，单位：字节。
  • play_times：总的播放次数。
  • pc_play_times：PC 端播放次数。
  • mobile_play_times：移动端播放次数。
  • iphone_play_times：iPhone 端播放次数。
  • android_play_times：Android 端播放次数。
  • host_name 域名。
    		•

    PlayStatInfo

    播放统计信息。

    被如下接口引用：DescribeMediaPlayStatDetails。

    名称 类型 描述
    Time String 数据所在时间区间的开始时间，使用 ISO 日期格式。如：当时间粒度为天，2018-12-01T00:00:00+08:00，表示2018年12月1日（含）到2018年12月2日（不含）区间。
  • 表示小时级别数据时，2019-08-22T00:00:00+08:00表示2019-08-22日0点到1点的统计数据。
  • 表示天级别数据时，2019-08-22T00:00:00+08:00表示2019-08-22日的统计数据。

    • 示例值：2023-09-08T02:23:29Z
    FileId String 媒体文件ID。
    示例值：327083**3604148
    PlayTimes Integer 播放次数。
    示例值：10
    Traffic Integer 播放流量，单位：字节。
    示例值：10240

    PlayerConfig

    播放器配置详情

    被如下接口引用：DescribeSuperPlayerConfigs。

    名称 类型 描述
    Name String 播放器配置名字。
    示例值：MyPlayConfigName
    Type String 播放器配置类型，取值范围：
  • Preset：系统预置配置；
  • Custom：用户自定义配置。

    • 示例值：Preset
    AudioVideoType String 播放的音视频类型，可选值有：
  • AdaptiveDynamicStream：自适应码流输出；
  • Transcode：转码输出；
  • Original：原始音视频。

    • 示例值：AdaptiveDynamicStream
    DrmSwitch String 播放 DRM 保护的自适应码流开关：
  • ON：开启，表示仅播放 DRM 保护的自适应码流输出；
  • OFF：关闭，表示播放未加密的自适应码流输出。

    • 示例值：ON
    AdaptiveDynamicStreamingDefinition Integer 允许输出的未加密的自适应码流模板 ID。
    示例值：10
    DrmStreamingsInfo DrmStreamingsInfo 允许输出的 DRM 自适应码流模板内容。
    注意：此字段可能返回 null，表示取不到有效值。
    TranscodeDefinition Integer 允许输出的转码模板 ID。
    示例值：10
    ImageSpriteDefinition Integer 允许输出的雪碧图模板 ID。
    示例值：10
    ResolutionNameSet Array of ResolutionNameInfo 播放器对不于不同分辨率的子流展示名字。
    CreateTime String 播放器配置创建时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    UpdateTime String 播放器配置最后修改时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    Domain String 播放时使用的域名。值为 Default，表示使用默认分发配置中的域名。
    示例值：xxx.com
    Scheme String 播放时使用的 Scheme。取值范围：
  • Default：使用默认分发配置中的 Scheme；
  • HTTP；
  • HTTPS。

    • 示例值：Default
    Comment String 模板描述信息。
    示例值：""

    PoliticalAsrReviewTemplateInfo

    语音鉴别涉及令人不适宜的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 语音鉴别涉及令人不适宜的信息的任务开关，可选值：
  • ON：开启语音鉴别涉及令人不适宜的信息的任务；
  • OFF：关闭语音鉴别的涉及令人不适宜的信息的任务。

    • 示例值：ON
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当音视频审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当音视频审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90

    PoliticalAsrReviewTemplateInfoForUpdate

    语音鉴别涉及令人不适宜的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 语音鉴别涉及令人不适宜的信息的任务开关，可选值：
  • ON：开启语音鉴别涉及令人不适宜的信息的任务；
  • OFF：关闭语音鉴别涉及令人不适宜的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当音视频审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当音视频审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：90

    PoliticalConfigureInfo

    鉴别涉及令人不适宜的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    ImgReviewInfo PoliticalImgReviewTemplateInfo 否 画面鉴别涉及令人不适宜的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrReviewInfo PoliticalAsrReviewTemplateInfo 否 语音鉴别涉及令人不适宜的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrReviewInfo PoliticalOcrReviewTemplateInfo 否 文本鉴别涉及令人不适宜的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。

    PoliticalConfigureInfoForUpdate

    鉴别涉及令人不适宜的信息的控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    ImgReviewInfo PoliticalImgReviewTemplateInfoForUpdate 否 画面鉴别涉及令人不适宜的信息的控制参数。
    AsrReviewInfo PoliticalAsrReviewTemplateInfoForUpdate 否 语音鉴别涉及令人不适宜的信息的控制参数。
    OcrReviewInfo PoliticalOcrReviewTemplateInfoForUpdate 否 文本鉴别涉及令人不适宜的信息的控制参数。

    PoliticalImageResult

    图片画面审核涉及令人不适宜信息的任务结果类型

    被如下接口引用：ProcessImage, ReviewImage。

    名称 类型 描述
    Confidence Float 鉴别涉及令人不适宜信息的评分，分值为0到100。
    示例值：90
    Suggestion String 鉴别涉及令人不适宜信息的结果建议，取值范围：
  • pass；
  • review；
  • block。

    • 示例值：pass
    Name String 涉及令人不适宜的信息、违规图标名字。
    示例值：""
    AreaCoordSet Array of Integer 涉及令人不适宜的信息、违规图标出现的区域坐标 (像素级)，[x1, y1, x2, y2]，即左上角坐标、右下角坐标。
    示例值：[529,212,580,242]

    PoliticalImgReviewTemplateInfo

    画面鉴别涉及令人不适宜的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 画面鉴别涉及令人不适宜的信息的任务开关，可选值：
  • ON：开启画面鉴别涉及令人不适宜的信息的任务；
  • OFF：关闭画面鉴别涉及令人不适宜的信息的任务。

    • 示例值：ON
    LabelSet Array of String 否 画面鉴别涉及令人不适宜的信息的过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为：
  • violation_photo：违规图标；
  • politician：相关人物；
  • entertainment：娱乐人物；
  • sport：体育人物；
  • entrepreneur：商业人物；
  • scholar：教育学者；
  • celebrity：知名人物；
  • military：相关人物。

    • 示例值：violation_photo
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 97 分。取值范围：0~100。
    示例值：97
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 95 分。取值范围：0~100。
    示例值：95

    PoliticalImgReviewTemplateInfoForUpdate

    画面鉴别涉及令人不适宜的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 画面鉴别涉及令人不适宜的信息的任务开关，可选值：
  • ON：开启画面鉴别涉及令人不适宜的信息的任务；
  • OFF：关闭画面鉴别涉及令人不适宜的信息的任务。

    • 示例值：ON
    LabelSet Array of String 否 画面鉴别涉及令人不适宜的信息的过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为：
  • violation_photo：违规图标；
  • politician：相关人物；
  • entertainment：娱乐人物；
  • sport：体育人物；
  • entrepreneur：商业人物；
  • scholar：教育学者；
  • celebrity：知名人物；
  • military：相关人物。

    • 示例值：violation_photo
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：90

    PoliticalOcrReviewTemplateInfo

    文本鉴别涉及令人不适宜的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 文本鉴别涉及令人不适宜的信息的任务开关，可选值：
  • ON：开启文本鉴别涉及令人不适宜的信息的任务；
  • OFF：关闭文本鉴别涉及令人不适宜的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90

    PoliticalOcrReviewTemplateInfoForUpdate

    文本鉴别涉及令人不适宜的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 文本鉴别涉及令人不适宜的信息的任务开关，可选值：
  • ON：开启文本鉴别涉及令人不适宜的信息的任务；
  • OFF：关闭文本鉴别涉及令人不适宜的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：90

    PornAsrReviewTemplateInfo

    语音鉴别涉及令人反感的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 语音鉴别涉及令人反感的信息的任务开关，可选值：
  • ON：开启语音鉴别涉及令人反感的信息的任务；
  • OFF：关闭语音鉴别涉及令人反感的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90

    PornAsrReviewTemplateInfoForUpdate

    语音鉴别涉及令人反感的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 语音鉴别涉及令人反感的信息的任务开关，可选值：
  • ON：开启语音鉴别涉及令人反感的信息的任务；
  • OFF：关闭语音鉴别涉及令人反感的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：90

    PornConfigureInfo

    鉴别涉及令人反感的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    ImgReviewInfo PornImgReviewTemplateInfo 否 画面鉴别涉及令人反感的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrReviewInfo PornAsrReviewTemplateInfo 否 语音鉴别涉及令人反感的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrReviewInfo PornOcrReviewTemplateInfo 否 文本鉴别涉及令人反感的信息的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。

    PornConfigureInfoForUpdate

    鉴别涉及令人反感的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    ImgReviewInfo PornImgReviewTemplateInfoForUpdate 否 画面鉴别涉及令人反感的信息的控制参数。
    AsrReviewInfo PornAsrReviewTemplateInfoForUpdate 否 语音鉴别涉及令人反感的信息的控制参数。
    OcrReviewInfo PornOcrReviewTemplateInfoForUpdate 否 文本鉴别涉及令人反感的信息的控制参数。

    PornImageResult

    图片画面审核涉及令人反感的信息的任务结果类型

    被如下接口引用：ProcessImage, ReviewImage。

    名称 类型 描述
    Confidence Float 鉴别涉及令人反感的信息的评分，分值为0到100。
    示例值：90
    Suggestion String 鉴别涉及令人反感的信息的结果建议，取值范围：
  • pass；
  • review；
  • block。

    • 示例值：pass
    Label String 鉴别涉及令人反感的信息的结果标签，取值范围：
  • porn：色情；
  • sexy：性感；
  • vulgar：低俗；
  • intimacy：亲密行为。

    • 示例值：porn

    PornImgReviewTemplateInfo

    画面鉴别涉及令人反感的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 画面鉴别涉及令人反感的信息的任务开关，可选值：
  • ON：开启画面鉴别涉及令人反感的信息的任务；
  • OFF：关闭画面鉴别涉及令人反感的信息的任务。

    • 示例值：ON
    LabelSet Array of String 否 画面鉴别涉及令人反感的信息的过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为：
  • porn：色情；
  • vulgar：低俗；
  • intimacy：亲密行为；
  • sexy：性感。

    • 示例值：porn
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 90 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 0 分。取值范围：0~100。
    示例值：90

    PornImgReviewTemplateInfoForUpdate

    画面鉴别涉及令人反感的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 画面鉴别涉及令人反感的信息的任务开关，可选值：
  • ON：开启画面鉴别涉及令人反感的信息的任务；
  • OFF：关闭画面鉴别涉及令人反感的信息的任务。

    • 示例值：ON
    LabelSet Array of String 否 画面鉴别涉及令人反感的信息的过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为：
  • porn：色情；
  • vulgar：低俗；
  • intimacy：亲密行为；
  • sexy：性感。

    • 示例值：porn
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：90

    PornOcrReviewTemplateInfo

    文本鉴别涉及令人反感的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 文本鉴别涉及令人反感的信息的任务开关，可选值：
  • ON：开启文本鉴别涉及令人反感的信息的任务；
  • OFF：关闭文本鉴别涉及令人反感的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90

    PornOcrReviewTemplateInfoForUpdate

    文本鉴别涉及令人反感的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 文本鉴别涉及令人反感的信息的任务开关，可选值：
  • ON：开启文本鉴别涉及令人反感的信息的任务；
  • OFF：关闭文本鉴别涉及令人反感的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：90

    ProcedureReviewAudioVideoTaskInput

    任务流模板音视频审核输入参数类型。

    被如下接口引用：CreateProcedureTemplate, DescribeProcedureTemplates, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 审核模板。
    示例值：10
    ReviewContents Array of String 否 审核的内容，可选值：
  • Media：原始音视频；
  • Cover：封面。

    • 不填或填空数组时，默认为审核 Media。
    示例值：["Media","Cover"]

    ProcedureTask

    音视频处理任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 音视频处理任务 ID。
    示例值：150****788-procedurev2-6b96c1a69d55ac4ce33d082482f7736bt
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：FINISH
    ErrCode Integer 已弃用，请使用各个具体任务的 ErrCode。
    示例值：0
    Message String 已弃用，请使用各个具体任务的 Message。
    示例值：""
    FileId String 媒体文件 ID
  • 若流程由 ProcessMedia 发起，该字段表示 MediaInfo 的 FileId；
  • 若流程由 ProcessMediaByUrl 发起，该字段表示 MediaInputInfo 的 Id。

    • 示例值：327083**3604148
    FileName String 媒体文件名称
  • 若流程由 ProcessMedia 发起，该字段表示 MediaInfo 的 BasicInfo.Name；
  • 若流程由 ProcessMediaByUrl 发起，该字段表示 MediaInputInfo 的 Name。

    • 示例值：MyFileName
    FileUrl String 媒体文件地址
  • 若流程由 ProcessMedia 发起，该字段表示 MediaInfo 的 BasicInfo.MediaUrl；
  • 若流程由 ProcessMediaByUrl 发起，该字段表示 MediaInputInfo 的 Url。

    • 示例值：http://xxx.com/xxx/xxx/xxx.mp4
    MetaData MediaMetaData 原始音视频的元信息。
    注意：此字段可能返回 null，表示取不到有效值。
    MediaProcessResultSet Array of MediaProcessTaskResult 音视频处理任务的执行状态与结果。
    AiContentReviewResultSet Array of AiContentReviewResult 音视频审核任务的执行状态与结果。
    AiAnalysisResultSet Array of AiAnalysisResult 音视频内容分析任务的执行状态与结果。
    AiRecognitionResultSet Array of AiRecognitionResult 音视频内容识别任务的执行状态与结果。
    TasksPriority Integer 任务流的优先级，取值范围为 [-10, 10]。
    示例值：10
    TasksNotifyMode String 任务流状态变更通知模式。
  • Finish：只有当任务流全部执行完毕时，才发起一次事件通知；
  • Change：只要任务流中每个子任务的状态发生变化，都进行事件通知；
  • None：不接受该任务流回调。

    • 示例值：Finish
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：""
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：""
    Operator String 操作者。取值范围：
  • System: 表示系统触发。

    • 示例值：System
    OperationType String 操作类型。取值范围：
  • TSC: 表示使用极速高清进行智能降码。

    • 示例值：TSC

    ProcedureTemplate

    任务流模板详情

    被如下接口引用：DescribeProcedureTemplates。

    名称 类型 描述
    Name String 任务流名字。
    示例值：MyProcedureName
    Type String 任务流模板类型，取值范围：
  • Preset：系统预置任务流模板；
  • Custom：用户自定义任务流模板。

    • 示例值：Custom
    Comment String 模板描述信息，长度限制：256 个字符。
    示例值：""
    MediaProcessTask MediaProcessTaskInput 视频处理类型任务参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AiContentReviewTask AiContentReviewTaskInput AI 智能审核类型任务参数 *。
    *：该参数用于发起旧版审核，不建议使用。推荐使用 ReviewAudioVideoTask 参数发起审核。
    注意：此字段可能返回 null，表示取不到有效值。
    AiAnalysisTask AiAnalysisTaskInput AI 智能内容分析类型任务参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AiRecognitionTask AiRecognitionTaskInput AI 内容识别类型任务参数。
    注意：此字段可能返回 null，表示取不到有效值。
    MiniProgramPublishTask WechatMiniProgramPublishTaskInput 微信小程序发布任务参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ReviewAudioVideoTask ProcedureReviewAudioVideoTaskInput 音视频审核类型任务参数。
    注意：此字段可能返回 null，表示取不到有效值。
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z

    ProductInstance

    预付费商品实例

    被如下接口引用：DescribePrepaidProducts。

    名称 类型 描述
    ProductType String 预付费商品实例类型，取值有：
  • StarterPackage：点播新手包。
  • MiniProgramPlugin：点播小程序插件。
  • ResourcePackage：点播资源包。

    • 示例值：ResourcePackage
    StartTime String 资源包实例起始日期。使用 ISO 日期格式。
    示例值：2019-02-23T16:00:00Z
    ExpireTime String 资源包实例过期日期。使用 ISO 日期格式。
    示例值：2020-02-23T16:01:00Z
    ProductInstanceId String 资源包实例ID。对应每个资源包，系统会分配相应的资源。续费或者升级资源包时，需要带上这个资源ID。
    示例值：50011-251007502-27891
    LastConsumeDate String 系统最近一次扣除资源包的日期。使用 ISO 日期格式。
    示例值：2020-02-22T16:00:00Z
    BindStatus Integer 资源包绑定 License 状态，取值有：
  • 0：未绑定。
  • 1：已绑定。

    • 示例值：0
    ResourceSet Array of ProductInstanceResource 预付费资源包实例中包含的资源包列表。
    ProductInstanceStatus String 资源包实例的状态，取值有：
  • Effective：生效，可用于计费抵扣。
  • Isolated：隔离，不可用于计费抵扣。

    • 示例值：Effective
    RefundStatus String 资源包实例的可退还状态，取值有：
  • FullRefund：可全额退款。
  • Denied：不可退款。

    • 示例值：Denied
    RenewStatus String 自动续费状态，取值有：
  • Never：不自动续费。
  • Expire：到期自动续费。
  • ExpireOrUseOut：到期或用完自动续费。
  • NotSupport：不支持。

    • 示例值：Expire

    ProductInstanceResource

    资源包中包含的资源。

    被如下接口引用：DescribePrepaidProducts。

    名称 类型 描述
    ResourceType String 资源类型。
  • Storage：存储资源包。
  • Traffic：流量资源包。
  • Transcode：普通转码资源包。
  • TESHD：极速高清转码资源包。
  • Review：音视频审核转码资源包。
  • MediaProcess：媒体处理时长资源包。
    		•
    Amount Integer 资源包额度。
  • 音视频存储资源包，单位为字节。
  • 音视频转码资源包，单位为秒。
  • 音视频审核资源包，单位为秒。
  • 音视频极速高清资源包，单位为秒。
  • 音视频加速资源包，单位为字节。
  • 媒体处理时长资源包，单位为秒。
    		•
    Left Integer 资源包余量。
  • 音视频存储资源包，单位为字节。
  • 音视频转码资源包，单位为秒。
  • 音视频审核资源包，单位为秒。
  • 音视频极速高清资源包，单位为秒。
  • 音视频加速资源包，单位为字节。
  • 媒体处理时长资源包，单位为秒。
    		•

    ProhibitedAsrReviewTemplateInfo

    语音违禁任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 语音违禁任务开关，可选值：
  • ON：开启语音违禁任务；
  • OFF：关闭语音违禁任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90

    ProhibitedAsrReviewTemplateInfoForUpdate

    语音违禁任务控制参数

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 语音违禁任务开关，可选值：
  • ON：开启语音违禁任务；
  • OFF：关闭语音违禁任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90

    ProhibitedConfigureInfo

    违禁任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    AsrReviewInfo ProhibitedAsrReviewTemplateInfo 否 语音违禁控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrReviewInfo ProhibitedOcrReviewTemplateInfo 否 文本违禁控制参数。
    注意：此字段可能返回 null，表示取不到有效值。

    ProhibitedConfigureInfoForUpdate

    违禁任务控制参数

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    AsrReviewInfo ProhibitedAsrReviewTemplateInfoForUpdate 否 语音违禁控制参数。
    OcrReviewInfo ProhibitedOcrReviewTemplateInfoForUpdate 否 文本违禁控制参数。

    ProhibitedOcrReviewTemplateInfo

    文本违禁任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 文本违禁任务开关，可选值：
  • ON：开启文本违禁任务；
  • OFF：关闭文本违禁任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90

    ProhibitedOcrReviewTemplateInfoForUpdate

    文本违禁任务控制参数

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 文本违禁任务开关，可选值：
  • ON：开启文本违禁任务；
  • OFF：关闭文本违禁任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：90
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：90

    PullUploadTask

    拉取上传任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 拉取上传任务 ID。
    示例值：12530xxx
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：FINISH
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    Message String 错误信息。
    示例值：""
    FileId String 拉取上传完成后生成的视频 ID。
    示例值：825xxx
    MediaBasicInfo MediaBasicInfo 拉取上传完成后生成的媒体文件基础信息。
    注意：此字段可能返回 null，表示取不到有效值。
    MetaData MediaMetaData 输出视频的元信息。
    FileUrl String 拉取上传完成后生成的播放地址。
    示例值：http://125xxx.vod2.myqcloud.com/xxx/xxx/xxx.mp4
    ProcedureTaskId String 任务类型为 Procedure 的任务 ID。若拉取上传时指定了媒体后续任务操作(Procedure)，当该任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
    示例值：12530xxx
    ReviewAudioVideoTaskId String 任务类型为 ReviewAudioVideo 的任务 ID。若拉取上传时指定了媒体后续任务操作(Procedure)，当该任务流模板指定了 ReviewAudioVideoTask 时，发起该任务。
    示例值：12530xxx
    SessionContext String 来源上下文，用于透传用户请求信息，URL 拉取视频上传完成将返回该字段值，最长 1000 个字符。
    示例值：abcd
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：abcd
    Progress Integer 拉取上传进度，取值范围 [0-100] 。
    示例值：100

    QRCodeConfigureInfo

    视频画面二维码检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面二维码检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    QRCodeConfigureInfoForUpdate

    视频画面二维码检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面二维码检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    QualityEnhanceTask

    音画质重生任务

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：123-xxx-xx
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：SUCCESS
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    Message String 错误信息。
    示例值：""
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    Progress Integer 音画质重生任务进度，取值范围 [0-100] 。
    示例值：0
    Input QualityEnhanceTaskInput 音画质重生任务的输入。
    注意：此字段可能返回 null，表示取不到有效值。
    Output QualityEnhanceTaskOutput 音画质重生任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    MetaData MediaMetaData 音画质重生输出视频的元信息。
    注意：此字段可能返回 null，表示取不到有效值。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：123
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：123

    QualityEnhanceTaskInput

    音画质重生任务的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 媒体文件 ID。
    示例值：327083**3604148
    Definition Integer 音画质重生模板 ID。
    示例值：10

    QualityEnhanceTaskOutput

    音画质重生任务输出

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileType String 文件类型，例如 mp4、flv 等。
    示例值：mp4
    FileUrl String 媒体文件播放地址。
    示例值：http://125.xxx.mp4
    FileId String 媒体文件 ID。
    示例值：123
    MediaName String 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：mediaName
    ClassId Integer 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：9999-12-31T23:59:59Z

    QualityEvaluationConfigureInfo

    视频画面质量评价的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 视频画面质量评价检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON
    Score Integer 否 视频画面质量评价过滤阈值，结果只返回低于该值的时间段，默认值为 60。
    示例值：60

    QualityEvaluationConfigureInfoForUpdate

    视频画面质量评价的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 视频画面质量评价开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON
    Score Integer 否 视频画面质量评价过滤阈值，结果只返回低于该值的时间段。
    示例值：60

    QualityInspectItem

    音画质检测异常片段信息。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 异常片段起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 异常片段终止的偏移时间，单位：秒。
    示例值：10
    AreaCoordSet Array of Integer 检测出异常的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2]，依次表示区域左上点、右下点的横纵坐标。
    注意： 仅当 Type 取值为下列之一时，本字段取值有效：
  • BlackWhiteEdge：黑白边；
  • Mosaic：马赛克；
  • QRCode：二维码；
  • AppletCode：小程序码；
  • BarCode：条形码。

    • 示例值：[529,212,580,242]
    Confidence Integer 置信度，取值范围：[0, 100]。
    注意： 仅当 Type 取值为下列之一时，本字段取值有效：
  • Mosaic：马赛克；
  • QRCode：二维码；
  • AppletCode：小程序码；
  • BarCode：条形码。

    • 示例值：90

    QualityInspectResultItem

    音画质检测异常结果信息。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Type String 异常类型，取值范围：
  • Jitter：抖动；
  • Blur：模糊；
  • LowLighting：低光照；
  • HighLighting：过曝；
  • CrashScreen：花屏；
  • BlackWhiteEdge：黑白边；
  • SolidColorScreen：纯色屏；
  • Noise：噪点；
  • Mosaic：马赛克；
  • QRCode：二维码；
  • AppletCode：小程序码；
  • BarCode：条形码；
  • LowVoice：低音；
  • HighVoice：爆音；
  • NoVoice：静音；
  • LowEvaluation：无参考打分低于阈值。

    • 示例值：Jitter
    SegmentSet Array of QualityInspectItem 异常片段列表。
    注意： 该列表最多仅展示前 100 个元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String 异常片段列表文件 URL。文件 内容 为 JSON，数据结构与 SegmentSet 字段一致。（文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：""
    SegmentSetFileUrlExpireTime String 异常片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z

    QualityInspectTask

    音画质检测任务信息。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：12530xxx
    Status String 任务状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：FINISH
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    Message String 错误信息。
    示例值：""
    MetaData MediaMetaData 音画质检测输入音视频的元信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Input QualityInspectTaskInput 音画质检测任务输入。
    注意：此字段可能返回 null，表示取不到有效值。
    Output QualityInspectTaskOutput 音画质检测任务输出。
    注意：此字段可能返回 null，表示取不到有效值。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：""
    SessionContext String 来源上下文，用于透传用户请求信息，音画质检测完成回调将返回该字段值，最长 1000 个字符。
    示例值：""

    QualityInspectTaskInput

    音画质检测任务的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 媒体文件 ID。
    示例值：327083**3604148
    Definition Integer 音画质检测模板 ID。
    示例值：10

    QualityInspectTaskOutput

    音画质检测任务的输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    NoAudio Integer 媒体文件是否无音频轨，取值范围：
  • 0：否，即有音频轨；
  • 1：是，即无音频轨。

    • 示例值：1
    NoVideo Integer 媒体文件是否无视频轨，取值范围：
  • 0：否，即有视频轨；
  • 1：是，即无视频轨。

    • 示例值：1
    QualityEvaluationScore Integer 视频画面质量评分，取值范围：[0, 100]。
    示例值：90
    QualityInspectResultSet Array of QualityInspectResultItem 音画质检测出的异常项列表。

    QualityInspectTemplateItem

    音画质检测模板详情。

    被如下接口引用：DescribeQualityInspectTemplates。

    名称 类型 描述
    Definition Integer 模板 ID。
    示例值：10
    Type String 模板类型，可选值：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Custom
    Name String 模板名称。
    示例值：""
    Comment String 模板描述。
    示例值：""
    ScreenshotInterval Float 截帧间隔，单位为秒。
    示例值：10
    JitterConfigure JitterConfigureInfo 视频画面抖动重影检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    BlurConfigure BlurConfigureInfo 视频画面模糊检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AbnormalLightingConfigure AbnormalLightingConfigureInfo 视频画面低光、过曝检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    CrashScreenConfigure CrashScreenConfigureInfo 视频画面花屏检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    BlackWhiteEdgeConfigure BlackWhiteEdgeConfigureInfo 视频画面黑边、白边、黑屏、白屏检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    NoiseConfigure NoiseConfigureInfo 视频画面噪点检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    MosaicConfigure MosaicConfigureInfo 视频画面马赛克检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    QRCodeConfigure QRCodeConfigureInfo 视频画面二维码检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    QualityEvaluationConfigure QualityEvaluationConfigureInfo 视频画面质量评价的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    VoiceConfigure VoiceConfigureInfo 音频（静音、低音、爆音）检测的控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z

    RebuildAudioInfo

    音画质重生音频控制控制信息。

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate。

    名称 类型 必选 描述
    AudioDenoiseInfo AudioDenoiseInfo 否 音频降噪控制参数。
    注意：此字段可能返回 null，表示取不到有效值。

    RebuildMediaOutputConfig

    音画质重生结果文件输出。

    被如下接口引用：EnhanceMediaByTemplate, RebuildMediaByTemplate。

    名称 类型 必选 描述
    MediaName String 否 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：name
    ClassId Integer 否 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 否 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：2023-09-08T02:23:29Z

    RebuildMediaTargetAudioStream

    画质重生输出的音频信息

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, RebuildMedia。

    名称 类型 必选 描述
    Codec String 否 音频流的编码格式。
    当外层参数 Container 为 mp3 时，可选值为：
  • libmp3lame。

    • 当外层参数 Container 为 ogg 或 flac 时，可选值为：
  • flac。

    • 当外层参数 Container 为 m4a 时，可选值为：
  • libfdk_aac；
  • libmp3lame；
  • ac3。

    • 当外层参数 Container 为 mp4 或 flv 时，可选值为：
  • libfdk_aac：更适合 mp4；
  • libmp3lame：更适合 flv；
  • mp2。

    • 当外层参数 Container 为 hls 时，可选值为：
  • libfdk_aac。

    • 示例值：libfdk_aac
    Bitrate Integer 否 音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。
    当取值为 0，表示音频码率和原始音频保持一致。
    示例值：128
    SampleRate Integer 否 音频流的采样率，可选值：
  • 32000
  • 44100
  • 48000


    • 单位：Hz。
    示例值：44100
    AudioChannel Integer 否 音频通道方式，可选值：
  • 1：单通道
  • 2：双通道
  • 6：立体声


    • 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为立体声。
    默认值：2。
    示例值：2

    RebuildMediaTargetInfo

    画质重生目标参数

    被如下接口引用：DescribeTaskDetail, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    MediaName String 否 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：name
    Description String 否 描述信息，最长 128 个字符。缺省描述信息为空。
    示例值：desc
    ClassId Integer 否 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 否 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：2018-10-01T10:00:00Z
    Container String 否 输出文件封装格式，可选值：mp4、flv、hls。默认mp4。
    示例值：flv
    VideoStream RebuildMediaTargetVideoStream 否 输出的视频信息。
    AudioStream RebuildMediaTargetAudioStream 否 输出的音频信息。
    RemoveVideo Integer 否 是否去除视频数据，可选值：
  • 0：保留
  • 1：去除


    • 默认值：0。
    示例值：0
    RemoveAudio Integer 否 是否去除音频数据，可选值：
  • 0：保留
  • 1：去除


    • 默认值：0。
    示例值：0

    RebuildMediaTargetVideoStream

    画质重生输出的视频信息

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, RebuildMedia。

    名称 类型 必选 描述
    Codec String 否 视频流的编码格式，可选值：
  • libx264：H.264 编码；
  • libx265：H.265 编码；
  • av1：AOMedia Video 1 编码。

    • 默认视频流的编码格式为 H.264 编码。
    示例值：libx264
    Bitrate Integer 否 视频流的码率，取值范围：0 和 [128, 35000]，单位：kbps。
    当取值为 0，表示视频码率和原始视频保持一致。
    示例值：1000
    Fps Integer 否 视频帧率，取值范围：[0, 100]，单位：Hz。 当取值为 0，表示帧率和原始视频保持一致。
    示例值：25
    ResolutionAdaptive String 否 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。


    • 默认值：open。
    示例值：open
    Width Integer 否 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。


    • 默认值：0。
    示例值：128
    Height Integer 否 视频流高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。


    • 默认值：0。
    示例值：128
    FillType String 否 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。


    • 默认值：stretch 。
    示例值：black
    Gop Integer 否 关键帧 I 帧之间的间隔，取值范围：0 和 [1, 100000]，单位：帧数。
    当填 0 或不填时，系统将自动设置 gop 长度。
    示例值：125

    RebuildMediaTask

    音画质重生任务

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：123-xxx-xx
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：SUCCESS
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    Message String 错误信息。
    示例值：""
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    Progress Integer 音画质重生任务进度，取值范围 [0-100] 。
    示例值：0
    Input RebuildMediaTaskInput 音画质重生任务的输入。
    注意：此字段可能返回 null，表示取不到有效值。
    Output RebuildMediaTaskOutput 音画质重生任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    MetaData MediaMetaData 音画质重生输出视频的元信息。
    注意：此字段可能返回 null，表示取不到有效值。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：123
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：123

    RebuildMediaTaskInput

    音画质重生任务的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 媒体文件 ID。
    示例值：123
    StartTimeOffset Float 起始偏移时间，单位：秒，不填表示从视频开始截取。
    示例值：0
    EndTimeOffset Float 结束偏移时间，单位：秒，不填表示截取到视频末尾。
    示例值：0
    Definition Integer 音画质重生模版号。
    示例值：10
    RepairInfo RepairInfo 画质修复控制参数。
    VideoFrameInterpolationInfo VideoFrameInterpolationInfo 智能插帧控制参数。
    SuperResolutionInfo SuperResolutionInfo 画面超分控制参数。
    HDRInfo HDRInfo 高动态范围类型控制参数。
    VideoDenoiseInfo VideoDenoiseInfo 视频降噪控制参数。
    AudioDenoiseInfo AudioDenoiseInfo 音频降噪控制参数。
    ColorInfo ColorEnhanceInfo 色彩增强控制参数。
    SharpInfo SharpEnhanceInfo 细节增强控制参数。
    FaceInfo FaceEnhanceInfo 人脸增强控制参数。
    LowLightInfo LowLightEnhanceInfo 低光照控制参数。
    ScratchRepairInfo ScratchRepairInfo 去划痕控制参数。
    ArtifactRepairInfo ArtifactRepairInfo 去伪影（毛刺）控制参数。
    TargetInfo RebuildMediaTargetInfo 音画质重生输出目标参数。

    RebuildMediaTaskOutput

    音画质重生任务输出

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileType String 文件类型，例如 mp4、flv 等。
    示例值：mp4
    FileUrl String 媒体文件播放地址。
    示例值：http://125.xxx.mp4
    FileId String 媒体文件 ID。
    示例值：123
    MediaName String 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：mediaName
    ClassId Integer 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：0
    ExpireTime String 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：9999-12-31T23:59:59Z

    RebuildMediaTemplate

    音画质重生模板详情。

    被如下接口引用：DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates。

    名称 类型 描述
    Definition Integer 音画质重生模板号。
    示例值：10
    Type String 模板类型，可选值：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Preset
    Name String 音画质重生模板名称。
    示例值：""
    Comment String 音画质重生模板描述。
    示例值：""
    RebuildVideoInfo RebuildVideoInfo 音画质重生视频控制信息。
    注意：此字段可能返回 null，表示取不到有效值。
    RebuildAudioInfo RebuildAudioInfo 音画质重生音频控制信息。
    注意：此字段可能返回 null，表示取不到有效值。
    TargetVideoInfo RebuildMediaTargetVideoStream 输出视频控制信息。
    注意：此字段可能返回 null，表示取不到有效值。
    TargetAudioInfo RebuildMediaTargetAudioStream 输出音频控制信息。
    注意：此字段可能返回 null，表示取不到有效值。
    Container String 封装格式。可选值：mp4、hls。默认是 mp4。
    示例值：mp4
    RemoveVideo Integer 是否去除视频数据，可选值：
  • 0：保留
  • 1：去除

    • 默认值 0。
    示例值：1
    RemoveAudio Integer 是否去除音频数据，可选值：
  • 0：保留
  • 1：去除

    • 默认值 0。
    示例值：1
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2023-09-08T02:23:29Z

    RebuildVideoInfo

    音画质重生视频控制控制信息。

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate。

    名称 类型 必选 描述
    RepairInfo RepairInfo 否 画质修复控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    VideoFrameInterpolationInfo VideoFrameInterpolationInfo 否 智能插帧控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    SuperResolutionInfo SuperResolutionInfo 否 画面超分控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    HDRInfo HDRInfo 否 高动态范围类型控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    VideoDenoiseInfo VideoDenoiseInfo 否 视频降噪控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ColorInfo ColorEnhanceInfo 否 色彩增强控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    SharpInfo SharpEnhanceInfo 否 细节增强控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    FaceInfo FaceEnhanceInfo 否 人脸增强控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    LowLightInfo LowLightEnhanceInfo 否 低光照控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ScratchRepairInfo ScratchRepairInfo 否 去划痕控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ArtifactRepairInfo ArtifactRepairInfo 否 去伪影控制参数。
    注意：此字段可能返回 null，表示取不到有效值。

    ReduceMediaBitrateAdaptiveDynamicStreamingResult

    降码率任务转自适应码流结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：SUCCESS
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：SourceFileError
    Message String 错误信息。
    示例值：Success
    Input AdaptiveDynamicStreamingTaskInput 对视频转自适应码流任务的输入。
    Output AdaptiveDynamicStreamingInfoItem 对视频转自适应码流任务的输出。

    ReduceMediaBitrateMediaProcessTaskResult

    降码率任务结果

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Type String 任务的类型，可以取的值有：
  • Transcode：转码
  • AdaptiveDynamicStreaming：自适应码流

    • 示例值：Transcode
    TranscodeTask ReduceMediaBitrateTranscodeResult 降码率任务中视频转码任务的查询结果，当任务类型为 Transcode 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AdaptiveDynamicStreamingTask ReduceMediaBitrateAdaptiveDynamicStreamingResult 降码率任务中对视频转自适应码流任务的查询结果，当任务类型为 AdaptiveDynamicStreaming 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    ReduceMediaBitrateTask

    降码率任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 视频处理任务 ID。
    示例值：15000xxxxx-procedurev2-e3a6d5a29038805a22e2617d39abc16btt0
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：FINISH
    FileId String 媒体文件 ID。
    示例值：557667xxxxx96721813
    FileName String 媒体文件名称。
    示例值：a.mp4
    FileUrl String 媒体文件地址。
    示例值：15000xxxxx.vod2.myqcloud.com/xxx/xxx/a.mp4
    MetaData MediaMetaData 原始视频的元信息。
    注意：此字段可能返回 null，表示取不到有效值。
    MediaProcessResultSet Array of ReduceMediaBitrateMediaProcessTaskResult 降码率任务执行状态与结果。
    TasksPriority Integer 任务流的优先级，取值范围为 [-10, 10]。
    示例值：0
    TasksNotifyMode String 任务流状态变更通知模式。
  • Finish：只有当任务流全部执行完毕时，才发起一次事件通知；
  • None：不接受该任务流回调。

    • 示例值：Finish
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：SessionContext
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：SessionId

    ReduceMediaBitrateTranscodeResult

    降码率任务转码结果类型

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Status String 任务状态，有 PROCESSING，SUCCESS 和 FAIL 三种。
    示例值：SUCCESS
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：SourceFileError
    Message String 错误信息。
    示例值：Success
    Input TranscodeTaskInput 转码任务的输入。
    Output MediaTranscodeItem 转码任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    Progress Integer 转码进度，取值范围 [0-100] 。
    示例值：100
    BeginProcessTime String 转码任务开始执行的时间，采用 ISO 日期格式。
    示例值：2023-06-01T00:00:00+08:00
    FinishTime String 转码任务执行完毕的时间，采用 ISO 日期格式。
    示例值：2023-06-02T00:00:00+08:00

    RefererAuthPolicy

    Referer 防盗链配置

    被如下接口引用：DescribeVodDomains, ModifyVodDomainConfig。

    名称 类型 必选 描述
    Status String 是 Referer 防盗链设置状态，可选值：
  • Enabled: 启用；
  • Disabled: 禁用。

    • 示例值：Enabled
    AuthType String 否 Referer 校验类型，可选值：
  • Black：黑名单方式校验。HTTP 请求携带了 Referers 列表中的某个 Referer 将被拒绝访问。
  • White：白名单方式校验。HTTP 请求携带了 Referers 列表中的 Referer 时才允许访问。

    • 当 Status 取值为 Enabled 时，AuthType 必须赋值。
    示例值：Black
    Referers Array of String 否 用于校验的 Referer 列表，最大支持20个 Referer。当 Status 取值为 Enabled 时， Referers 不能为空数组。Referer 的格式参考域名的格式。
    示例值：["abc.test.com"]
    BlankRefererAllowed String 否 是否允许空 Referer 访问本域名，可选值：
  • Yes： 是。
  • No： 否。

    • 当 Status 取值为 Enabled 时，BlankRefererAllowed 必须赋值。
    示例值：Yes

    RemoveWaterMarkTaskInput

    智能去除水印任务的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 媒体文件 ID。
    示例值：123

    RemoveWaterMarkTaskOutput

    智能去除水印任务的输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 媒体文件 ID。
    示例值：123
    FileType String 文件类型，例如 mp4、mp3 等。
    示例值：mp4
    FileUrl String 媒体文件播放地址。
    示例值：15000xxxxx.vod2.myqcloud.com/xxx/xxx/abc.mp4
    MediaName String 文件名称，最长 64 个字符。
    示例值：abc
    MetaData MediaMetaData 元信息。包括大小、时长、视频流信息、音频流信息等。
    示例值：null

    RemoveWatermarkTask

    智能去除水印任务信息，仅当 TaskType 为 RemoveWatermark，该字段有值。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID 。
    示例值：125xxx-procedurev2-xxx
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：FINISH
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败：
  • 40000：输入参数不合法，请检查输入参数；
  • 60000：源文件错误（如视频数据损坏），请确认源文件是否正常；
  • 70000：内部服务错误，建议重试。

    • 示例值：0
    Message String 错误信息。
    示例值：“”
    Input RemoveWaterMarkTaskInput 智能去除水印任务的输入。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    Output RemoveWaterMarkTaskOutput 智能去除水印任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：null
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：demo
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：demo

    RepairInfo

    画质修复控制参数

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 画质修复控制开关，可选值：
  • ON：开启画质修复；
  • OFF：关闭画质修复。

    • 示例值：ON
    Type String 否 画质修复类型，仅当画质修复控制开关为 ON 时有效，可选值：
  • weak：轻画质修复；
  • normal：正常画质修复；
  • strong：强画质修复。

    • 默认值：weak。
    示例值：weak

    ResolutionNameInfo

    播放器子流名字信息

    被如下接口引用：CreateSuperPlayerConfig, DescribeSuperPlayerConfigs, ModifySuperPlayerConfig。

    名称 类型 必选 描述
    MinEdgeLength Integer 是 视频短边长度，单位：像素。
    Name String 是 展示名字。

    ResourceTag

    标签键值。参考标签。

    被如下接口引用：DescribeSubAppIds。

    名称 类型 必选 描述
    TagKey String 是 标签键。
    TagValue String 是 标签值。

    RestoreMediaTask

    取回视频任务信息

    被如下接口引用：PullEvents。

    名称 类型 描述
    FileId String 文件ID。
    示例值：""
    OriginalStorageClass String 文件原始存储类型。
    示例值："ARCHIVE"
    TargetStorageClass String 文件目标存储类型。对于临时取回，目标存储类型与原始存储类型相同。
    示例值："STANDARD"
    RestoreTier String 取回模式，取值：
  • Expedited：极速模式
  • Standard：标准模式
  • Bulk：批量模式

    • 示例值："Expedited"
    RestoreDay Integer 临时取回副本有效期，单位：天。对于永久取回，取值为0。
    示例值：5
    Status Integer 该字段已废弃。
    示例值：0
    Message String 该字段已废弃。
    示例值：""

    ReviewAudioVideoSegmentItem

    音视频审核片段。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间，单位：秒。
    示例值：0
    EndTimeOffset Float 嫌疑片段结束的偏移时间，单位：秒。
    示例值：10
    Confidence Float 嫌疑片段涉及令人反感的信息的分数。
    示例值：20
    Suggestion String 嫌疑片段鉴别涉及违规信息的结果建议，取值范围：
  • review：疑似违规，建议复审；
  • block：确认违规，建议封禁。

    • 示例值：review
    Label String 嫌疑片段最可能的违规的标签，取值范围：
  • Porn：色情；
  • Terror：暴力；
  • Polity：不适宜的信息；
  • Ad：广告；
  • Illegal：违法；
  • Abuse：谩骂；
  • Moan：娇喘。

    • 示例值：Terror
    SubLabel String 违规子标签。
    示例值：SubLabel
    Form String 嫌疑片段违禁的形式，取值范围：
  • Image：画面上的人物或图标；
  • OCR：画面上的文字；
  • ASR：语音中的文字；
  • Voice：声音。

    • 示例值：Image
    AreaCoordSet Array of Integer 当 Form 为 Image 或 OCR 时有效，表示嫌疑人物、图标或文字出现的区域坐标 (像素级)，[x1, y1, x2, y2]，即左上角坐标、右下角坐标。
    示例值：[0,0,0,0]
    Text String 当 Form 为 OCR 或 ASR 时有效，表示识别出来的 OCR 或 ASR 文本内容。
    示例值：Test
    KeywordSet Array of String 当 Form 为 OCR 或 ASR 时有效，表示嫌疑片段命中的违规关键词列表。
    示例值：["嫌疑关键字1","嫌疑关键字2"]
    Url String 嫌疑图片 URL （图片不会永久存储，到达
    PicUrlExpireTime 时间点后图片将被删除）。
    示例值：http://xxx.vod-qcloud.com/xxx/image.jpg
    PicUrlExpireTime String 嫌疑图片 URL 失效时间，使用 ISO 日期格式。
    示例值：2023-06-01T00:00:00+08:00

    ReviewAudioVideoTask

    音视频审核任务信息。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：12567683xx-Procedure-2e1af2456351812be963e309cc133403t0
    Status String 任务状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：SourceFileError
    Message String 错误信息。
    示例值：SourceFileError
    Input ReviewAudioVideoTaskInput 音视频审核任务的输入。
    注意：此字段可能返回 null，表示取不到有效值。
    Output ReviewAudioVideoTaskOutput 音视频审核任务的输出。
    注意：此字段可能返回 null，表示取不到有效值。
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：SessionId
    SessionContext String 来源上下文，用于透传用户请求信息，音视频审核完成回调将返回该字段值，最长 1000 个字符。
    示例值：SessionContext

    ReviewAudioVideoTaskInput

    音视频审核任务的输入。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 媒体文件 ID。
    示例值：123
    Definition Integer 音视频审核模板 ID。
    示例值：10
    ReviewContents Array of String 审核的内容，可选值：
  • Media：原始音视频；
  • Cover：封面。

    • 示例值：["Media"]

    ReviewAudioVideoTaskOutput

    音视频审核任务的输出。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Suggestion String 音视频内容审核的结果建议，取值范围：
  • pass：建议通过；
  • review：建议复审；
  • block：建议封禁。

    • 示例值：review
    Label String 当 Suggestion 为 review 或 block 时有效，表示音视频最可能的违规的标签，取值范围：
  • Porn：色情；
  • Terror：暴力；
  • Polity：不适宜的信息；
  • Ad：广告；
  • Illegal：违法；
  • Abuse：谩骂；
  • Moan：娇喘。

    • 示例值：Porn
    Form String 当 Suggestion 为 review 或 block 时有效，表示音视频最可能的违禁的形式，取值范围：
  • Image：画面上的人物或图标；
  • OCR：画面上的文字；
  • ASR：语音中的文字；
  • Voice：声音。

    • 示例值：Image
    SegmentSet Array of ReviewAudioVideoSegmentItem 有违规信息的嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 10个 元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String 涉及违规信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://xxx.vod-qcloud.com/xxx/a.mp4
    SegmentSetFileUrlExpireTime String 涉及违规信息的嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2019-06-01T00:00:00+08:00
    CoverReviewResult ReviewImageResult 封面审核结果。
    注意：此字段可能返回 null，表示取不到有效值。

    ReviewImageResult

    图片审核结果。

    被如下接口引用：DescribeTaskDetail, PullEvents, ReviewImage。

    名称 类型 描述
    Suggestion String 图片审核的结果建议，取值范围：
  • pass：建议通过；
  • review：建议复审；
  • block：建议封禁。

    • 示例值：review
    Label String 当 Suggestion 为 review 或 block 时有效，表示最可能的违规的标签，取值范围：
  • Porn：色情；
  • Terror：暴力；
  • Polity：不适宜的信息；
  • Ad：广告；
  • Illegal：违法；
  • Abuse：谩骂。

    • 示例值：Porn
    Form String 当 Suggestion 为 review 或 block 时有效，表示最可能的违禁的形式，取值范围：
  • Image：画面上的人物或图标；
  • OCR：画面上的文字。

    • 示例值：Image
    SegmentSet Array of ReviewImageSegmentItem 有违规信息的嫌疑的视频片段列表。
    注意 ：该列表最多仅展示前 10个 元素。如希望获得完整结果，请从 SegmentSetFileUrl 对应的文件中获取。
    SegmentSetFileUrl String 涉及违规信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON，数据结构与 SegmentSet 字段一致。 （文件不会永久存储，到达SegmentSetFileUrlExpireTime 时间点后文件将被删除）。
    示例值：http://xxx.vod-qcloud.com/xxx/a.mp4
    SegmentSetFileUrlExpireTime String 涉及违规信息的嫌疑的视频片段列表文件 URL 失效时间，使用 ISO 日期格式。
    示例值：2019-06-01T00:00:00+08:00

    ReviewImageSegmentItem

    图片审核片段。

    被如下接口引用：ReviewImage。

    名称 类型 描述
    Confidence Float 嫌疑片段涉及令人反感的信息的分数。
    示例值：20
    Suggestion String 嫌疑片段鉴别涉及违规信息的结果建议，取值范围：
  • review：疑似违规，建议复审；
  • block：确认违规，建议封禁。

    • 示例值：review
    Label String 嫌疑片段最可能的违规的标签，取值范围：
  • Porn：色情；
  • Terror：暴力；
  • Polity：不适宜的信息；
  • Ad：广告；
  • Illegal：违法；
  • Abuse：谩骂。

    • 示例值：Porn
    SubLabel String 违规子标签。
    示例值：Balenciaga
    Form String 嫌疑片段违禁的形式，取值范围：
  • Image：画面上的人物或图标；
  • OCR：画面上的文字。

    • 示例值：Image
    AreaCoordSet Array of Integer 嫌疑人物、图标或文字出现的区域坐标 (像素级)，[x1, y1, x2, y2]，即左上角坐标、右下角坐标。
    示例值：[529,212,580,242]
    Text String 当 Form 为 OCR 时有效，表示识别出来的 OCR 文本内容。
    示例值：text
    KeywordSet Array of String 当 Form 为 OCR 时有效，表示嫌疑片段命中的违规关键词列表。
    示例值：["嫌疑片段1"]

    ReviewInfo

    审核信息。

    被如下接口引用：DescribeMediaInfos, SearchMedia。

    名称 类型 描述
    Definition Integer 审核模板 ID。
    示例值：10
    Suggestion String 审核的结果建议，取值范围：
  • pass：建议通过；
  • review：建议复审；
  • block：建议封禁。

    • 示例值：pass
    TypeSet Array of String 审核类型，当 Suggestion 为 review 或 block 时有效，格式为：Form.Label。
    Form 表示违禁的形式，取值范围：
  • Image：画面上的人物或图标；
  • OCR：画面上的文字；
  • ASR：语音中的文字；
  • Voice：声音。

    • Label 表示违禁的标签，取值范围：
  • Porn：色情；
  • Terror：暴力；
  • Polity：不适宜的信息；
  • Ad：广告；
  • Illegal：违法；
  • Abuse：谩骂；
  • Moan：娇喘。

    • 示例值：["Image"]
    ReviewTime String 审核时间，使用 ISO 日期格式。
    示例值：2019-06-01T00:00:00+08:00

    ReviewTemplate

    审核模版详情

    被如下接口引用：DescribeReviewTemplates。

    名称 类型 描述
    Definition Integer 审核模版唯一标签。
    示例值：10
    Name String 模板名称。
    示例值：myTemplate
    Comment String 模板描述信息。
    示例值：myTemplate
    Type String 模板类型，可选值：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Custom
    Labels Array of String 需要返回的违规标签列表。
    示例值：["Porn"]
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2019-06-01T00:00:00+08:00
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2019-06-01T00:00:00+08:00

    RoundPlayFilePlayInfo

    轮播节目播放信息

    被如下接口引用：DescribeCurrentPlaylist。

    名称 类型 描述
    ItemId String 播单节目的 ID，由系统分配。
    示例值：a123
    FileId String 媒体文件标识。
    示例值：12345
    StartPlayTime String 启播时间，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：2024-07-25T10:12:00+08:00
    Duration Float 播放时长，单位为秒。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：100
    Progress Float 播放进度，单位为秒。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：50

    RoundPlayInfo

    轮播任务信息

    被如下接口引用：DescribeRoundPlays。

    名称 类型 描述
    RoundPlayId String 轮播播单标识。
    示例值：bffb15f07530b57bc1aabb01fac74bca
    StartTime String 启播时间，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：2018-12-01T00:00:00+08:00
    RoundPlaylist Array of RoundPlayListItemInfo 轮播列表。
    Name String 轮播播单名称，长度限制：64 个字符。
    示例值：Shift
    Desc String 轮播播单描述信息，长度限制：256 个字符。
    示例值：roundplay
    Status String 播放状态，可选值：
  • Enabled：启动状态；
  • Disabled：停止状态。

    • 默认值：Enabled。
    示例值：Enabled
    PlayBackMode String 播放模式，可选值：
  • Loop：循环播放播单；
  • Linear：单次播放，播单播放完停止播放。

    • 默认值：Loop。
    示例值：Loop
    Url String 轮播播放地址。
    示例值：http://123.vod-qcloud.com/rplay/v1/xxxx/playlist.m3u8
    CreateTime String 创建时间，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：2018-12-01T00:00:00+08:00
    UpdateTime String 更新时间，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：2018-12-01T00:00:00+08:00

    RoundPlayListItemInfo

    轮播播放节目信息

    被如下接口引用：CreateRoundPlay, DescribeRoundPlays, HandleCurrentPlaylist, ModifyRoundPlay。

    名称 类型 必选 描述
    FileId String 是 媒体文件标识。
    示例值：123
    AudioVideoType String 是 播放的音视频类型，可选值：
  • Transcode：转码输出；转码输出会有多个模版，必须指定 Definition 字段
  • Original：原始音视频。

    • Type 对应的格式必须为 HLS 格式。
    示例值：Transcode
    ItemId String 否 播放节目的 ID，由系统分配。
    示例值：a01
    Definition Integer 否 指定播放的转码模版，当 AudioVideoType 为 Transcode 时必须指定。
    示例值：10

    SDMCDrmKeyProviderInfo

    华曦达（SDMC）相关的 DRM 密钥提供商信息。

    被如下接口引用：DescribeDrmKeyProviderInfo, SetDrmKeyProviderInfo。

    名称 类型 必选 描述
    Uid String 是 华曦达分配的用户 ID。最大长度为128个字符。
    示例值：123
    SecretId String 是 华曦达分配的用户密钥 ID。最大长度为128个字符。
    示例值：MySecretId
    SecretKey String 是 华曦达分配的用户密钥内容。最大长度为128个字符。
    示例值：MySecretKey
    FairPlayCertificateUrl String 是 华曦达分配的 FairPlay 证书地址。该地址需使用 HTTPS 协议，最大长度为1024个字符。
    示例值：https://xx/fairplay.cer

    SampleSnapshotTaskInput

    对视频做采样截图任务输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 采样截图模板 ID。
    示例值：10
    WatermarkSet Array of WatermarkInput 否 水印列表，支持多张图片或文字水印，最大可支持 10 张。

    SampleSnapshotTemplate

    采样截图模板详情

    被如下接口引用：DescribeSampleSnapshotTemplates。

    名称 类型 描述
    Definition Integer 采样截图模板唯一标识。
    示例值：10
    Type String 模板类型，取值范围：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Custom
    Name String 采样截图模板名称。
    示例值：MyTemplate
    Comment String 模板描述信息。
    示例值：MyTemplate
    Width Integer 截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：1920
    Height Integer 截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：1080
    ResolutionAdaptive String 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。

    • 默认值：open。
    示例值：open
    Format String 图片格式。
    示例值：jpg
    SampleType String 采样截图类型。
    示例值：Time
    SampleInterval Integer 采样间隔。
    示例值：1
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z
    FillType String 填充方式，当截图配置宽高参数与原始视频的宽高比不一致时，对截图的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
  • white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
  • gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊。

    • 默认值：black 。
    示例值：black

    ScratchRepairInfo

    去划痕控制信息

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 去划痕控制开关，可选值：
  • ON：开启去划痕；
  • OFF：关闭去划痕。

    • 示例值：ON
    Intensity Float 否 去划痕强度，仅当去划痕控制开关为 ON 时有效，取值范围：0.0~1.0。
    默认：0.0。
    示例值：0
    Type String 否 去划痕类型，仅当去划痕控制开关为 ON 时有效，可选值：
  • normal：正常去划痕；

    • 默认值：normal。
    示例值：normal

    SegmentConfigureInfo

    视频拆条任务识别控制参数

    被如下接口引用：CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。

    名称 类型 必选 描述
    Switch String 是 视频拆条识别任务开关，可选值：
  • ON：开启智能视频拆条识别任务；
  • OFF：关闭智能视频拆条识别任务。
    		•

    SegmentConfigureInfoForUpdate

    视频拆条识别任务控制参数

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 否 视频拆条识别任务开关，可选值：
  • ON：开启智能视频拆条识别任务；
  • OFF：关闭智能视频拆条识别任务。
    		•

    SharpEnhanceInfo

    细节增强控制

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 细节增强控制开关，可选值：
  • ON：开启细节增强；
  • OFF：关闭细节增强。

    • 示例值：ON
    Intensity Float 否 细节增强强度，仅当细节增强控制开关为 ON 时有效，取值范围：0.0~1.0。
    默认：0.0。
    示例值：0

    SimpleAesEdkPair

    简单加密加解密密钥对。

    被如下接口引用：DescribeDrmDataKey。

    名称 类型 描述
    Edk String 加密后的数据密钥。
    Dk String 数据密钥。返回的数据密钥 DK 为 Base64 编码字符串。

    SnapshotByTimeOffset2017

    截图输出信息（2017 版）

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。
    		•
    TimeOffset Integer 截图的具体时间点，单位：毫秒。
    Url String 截图输出文件地址。

    SnapshotByTimeOffsetTask2017

    视频指定时间点截图任务信息，该结构仅用于 2017 版指定时间点截图接口发起的任务。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 截图任务 ID。
    FileId String 截图文件 ID。
    Definition Integer 截图规格，参见指定时间点截图参数模板。
    SnapshotInfoSet Array of SnapshotByTimeOffset2017 截图结果信息。

    SnapshotByTimeOffsetTaskInput

    对视频按指定时间点截图任务输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 指定时间点截图模板 ID。
    ExtTimeOffsetSet Array of String 否 截图时间点列表，时间点支持 s、% 两种格式：
  • 当字符串以 s 结尾，表示时间点单位为秒，如 3.5s 表示时间点为第3.5秒；
  • 当字符串以 % 结尾，表示时间点为视频时长的百分比大小，如10%表示时间点为视频前第10%的时间。
    		•
    TimeOffsetSet Array of Float 否 截图时间点列表，单位为毫秒。此参数已不再建议使用，建议您使用 ExtTimeOffsetSet 参数。
    WatermarkSet Array of WatermarkInput 否 水印列表，支持多张图片或文字水印，最大可支持 10 张。

    SnapshotByTimeOffsetTemplate

    指定时间点截图模板详情

    被如下接口引用：DescribeSnapshotByTimeOffsetTemplates。

    名称 类型 描述
    Definition Integer 指定时间点截图模板唯一标识。
    示例值：10
    Type String 模板类型，取值范围：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Custom
    Name String 指定时间点截图模板名称。
    示例值：MyTemplate
    Comment String 模板描述信息。
    示例值：MyTemplate
    Width Integer 截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：1920
    Height Integer 截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：1080
    ResolutionAdaptive String 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。

    • 默认值：open。
    示例值：open
    Format String 图片格式。
    示例值：jpg
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2018-10-01T10:00:00Z
    FillType String 填充方式，当截图配置宽高参数与原始视频的宽高比不一致时，对截图的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
  • white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
  • gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊。

    • 默认值：black 。
    示例值：black

    SortBy

    排序依据

    被如下接口引用：DescribeTasks, SearchMedia。

    名称 类型 必选 描述
    Field String 是 排序字段
    示例值：CreateTime
    Order String 是 排序方式，可选值：Asc（升序）、Desc（降序）
    示例值：Asc

    SpecificationDataItem

    指定规格任务统计数据。

    被如下接口引用：DescribeMediaProcessUsageData。

    名称 类型 描述
    Specification String 任务规格。
    Data Array of TaskStatDataItem 统计数据。

    SplitMediaOutputConfig

    视频拆条的结果文件输出。

    被如下接口引用：DescribeTaskDetail, PullEvents, SplitMedia。

    名称 类型 必选 描述
    MediaName String 否 输出文件名，最长 64 个字符。缺省由系统指定生成文件名。
    示例值：""
    Type String 否 输出文件格式，可选值：mp4、hls。默认是 mp4。
    示例值：mp4
    ClassId Integer 否 分类ID，用于对媒体进行分类管理，可通过 创建分类 接口，创建分类，获得分类 ID。
  • 默认值：0，表示其他分类。

    • 示例值：1
    ExpireTime String 否 输出文件的过期时间，超过该时间文件将被删除，默认为永久不过期，格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。
    示例值：2020-09-07T00:00:00+08:00

    SplitMediaTask

    视频拆条任务信息，仅当 TaskType 为 SplitMedia，该字段有值。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：12xx-SplitMedia-xx
    Status String 任务流状态，取值：
  • PROCESSING：处理中；
  • FINISH：已完成。

    • 示例值：PROCESSING
    ErrCodeExt String 错误码，空字符串表示成功，其他值表示失败，取值请参考 视频处理类错误码 列表。
    示例值：""
    ErrCode Integer 错误码，0 表示成功，其他值表示失败（该字段已不推荐使用，建议使用新的错误码字段 ErrCodeExt）。
    示例值：0
    Message String 错误信息。
    示例值：""
    FileInfoSet Array of SplitMediaTaskSegmentInfo 视频拆条任务详细信息列表。
    SessionContext String 来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。
    示例值：sessioncontext
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。
    示例值：sessionid
    Progress Integer 视频拆条任务进度，取值范围 [0-100] 。
    示例值：100

    SplitMediaTaskConfig

    视频拆条任务配置信息。

    被如下接口引用：SplitMedia。

    名称 类型 必选 描述
    StartTimeOffset Float 否 视频拆条起始的偏移时间，单位：秒。
  • 不填或填0，表示转码后的视频从原始视频的起始位置开始；
  • 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始；
  • 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。
    		•
    EndTimeOffset Float 否 视频拆条结束的偏移时间，单位：秒。
  • 不填或填0，表示转码后的视频持续到原始视频的末尾终止；
  • 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止；
  • 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。
    		•
    ProcedureName String 否 任务流模板名字，如果要对生成的新视频执行任务流时填写。
    OutputConfig SplitMediaOutputConfig 否 视频拆条输出信息。

    SplitMediaTaskInput

    视频拆条任务输入信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 视频的 ID。
    StartTimeOffset Float 视频拆条起始的偏移时间，单位：秒。
  • 不填或填0，表示转码后的视频从原始视频的起始位置开始；
  • 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始；
  • 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。
    		•
    EndTimeOffset Float 视频拆条结束的偏移时间，单位：秒。
  • 不填或填0，表示转码后的视频持续到原始视频的末尾终止；
  • 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止；
  • 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。
    		•
    ProcedureName String 任务流模板名字，如果要对生成的新视频执行任务流时填写。
    OutputConfig SplitMediaOutputConfig 视频拆条输出信息。

    SplitMediaTaskSegmentInfo

    视频拆条任务信息。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Input SplitMediaTaskInput 视频拆条任务输入信息。
    Output TaskOutputMediaInfo 视频拆条任务输出信息。
    注意：此字段可能返回 null，表示取不到有效值。
    ProcedureTaskId String 任务类型为 Procedure 的任务 ID。若发起视频拆条任务时，视频拆条任务信息列表指定了任务流模板(ProcedureName)，当该任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
    示例值：125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca
    ReviewAudioVideoTaskId String 任务类型为 ReviewAudioVideo 的任务 ID。若发起视频拆条任务时，视频拆条任务信息列表指定了任务流模板(ProcedureName)，当该任务流模板指定了 ReviewAudioVideoTask 时，发起该任务。
    示例值：125xxx65-ReviewAudioVideo-bffb15f07530b57bc1aabb01fac74bcb

    StatDataItem

    统计数据

    被如下接口引用：DescribeCDNStatDetails, DescribeCDNUsageData, DescribeClientUploadAccelerationUsageData, DescribeReviewDetails, DescribeStorageDetails。

    名称 类型 描述
    Time String 数据所在时间区间的开始时间，使用 ISO 日期格式。如：当时间粒度为天，2018-12-01T00:00:00+08:00，表示2018年12月1日（含）到2018年12月2日（不含）区间。
  • 表示小时级别数据时，2019-08-22T00:00:00+08:00表示2019-08-22日0点到1点的统计数据。
  • 表示天级别数据时，2019-08-22T00:00:00+08:00表示2019-08-22日的统计数据。

    • 示例值： 2020-09-07T00:00:00+08:00
    Value Integer 数据大小。
  • 存储空间的数据，单位是字节。
  • 转码时长的数据，单位是秒。
  • 流量数据，单位是字节。
  • 带宽数据，单位是比特每秒。
  • 直播剪辑数据，单位是秒。
  • 轮播数据，单位是秒。
  • 子应用数量数据，单位是个。
  • 日志服务用量数据，单位是条。

    • 示例值：60

    StickerTrackItem

    贴图轨上的贴图信息。

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    SourceMedia String 是 贴图片段的媒体素材来源，可以是：
  • 点播的媒体文件 ID；
  • 其他媒体文件的下载 URL。

    • 注意：当使用其他媒体文件的下载 URL 作为素材来源，且开启了访问控制（如防盗链）时，需要在 URL 携带访问控制参数（如防盗链签名）。
    Duration Float 是 贴图的持续时间，单位为秒。
    StartTime Float 否 贴图在轨道上的起始时间，单位为秒。
    CoordinateOrigin String 否 原点位置，取值有：
  • Center：坐标原点为中心位置，如画布中心。

    • 默认值：Center。
    XPos String 否 贴图原点距离画布原点的水平位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示贴图 XPos 为画布宽度指定百分比的位置，如 10% 表示 XPos 为画布宽度的 10%。
  • 当字符串以 px 结尾，表示贴图 XPos 单位为像素，如 100px 表示 XPos 为 100 像素。

    • 默认值：0px。
    YPos String 否 贴图原点距离画布原点的垂直位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示贴图 YPos 为画布高度指定百分比的位置，如 10% 表示 YPos 为画布高度的 10%。
  • 当字符串以 px 结尾，表示贴图 YPos 单位为像素，如 100px 表示 YPos 为 100 像素。

    • 默认值：0px。
    Width String 否 贴图的宽度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示贴图 Width 为画布宽度的百分比大小，如 10% 表示 Width 为画布宽度的 10%。
  • 当字符串以 px 结尾，表示贴图 Width 单位为像素，如 100px 表示 Width 为 100 像素。
  • 当 Width、Height 均为空，则 Width 和 Height 取贴图素材本身的 Width、Height。
  • 当 Width 为空0，Height 非空，则 Width 按比例缩放
  • 当 Width 非空，Height 为空，则 Height 按比例缩放。
    		•
    Height String 否 贴图的高度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示贴图 Height 为画布高度的百分比大小，如 10% 表示 Height 为画布高度的 10%。
  • 当字符串以 px 结尾，表示贴图 Height 单位为像素，如 100px 表示 Hieght 为 100 像素。
  • 当 Width、Height 均为空，则 Width 和 Height 取贴图素材本身的 Width、Height。
  • 当 Width 为空，Height 非空，则 Width 按比例缩放
  • 当 Width 非空，Height 为空，则 Height 按比例缩放。
    		•
    ImageOperations Array of ImageTransform 否 对贴图进行的操作，如图像旋转等。

    StorageRegionInfo

    存储地域信息

    被如下接口引用：DescribeStorageRegions。

    名称 类型 描述
    Region String 存储地域。
    示例值：ap-chongqing
    Description String 存储地域描述信息。
    示例值：重庆
    Status String 状态，是否开通，取值有：
  • opened：已经开通。
  • unopened：未开通。

    • 示例值：opened
    IsDefault Boolean 是否默认的存储地域，true：是；false：否。
    示例值：true
    Area String 存储区域，取值有：
  • Chinese Mainland：中国境内（不包含港澳台）。
  • Outside Chinese Mainland：中国境外。

    • 示例值：Chinese Mainland

    StorageStatData

    云点播存储用量的分区统计数据

    被如下接口引用：DescribeStorageData。

    名称 类型 描述
    Area String 点播存储的计费区域，可能值：
  • Chinese Mainland：中国境内（不包含港澳台）。
  • Outside Chinese Mainland：中国境外。

    • 示例值：Chinese Mainland
    TotalStorage Integer 当前总存储量，单位是字节。
    示例值：40000
    InfrequentStorage Integer 当前低频存储量，单位是字节。
    示例值：10000
    StandardStorage Integer 当前标准存储量，单位是字节。
    示例值：10000
    ArchiveStorage Integer 当前归档存储量，单位是字节。
    示例值：10000
    DeepArchiveStorage Integer 当前深度归档存储量，单位是字节。
    示例值：10000

    SubAppIdInfo

    子应用信息。

    被如下接口引用：DescribeSubAppIds。

    名称 类型 描述
    SubAppId Integer 子应用 ID。
    示例值：123
    SubAppIdName String 子应用名称。
    示例值：test
    Description String 子应用简介。
    示例值：MyAppId
    CreateTime String 子应用创建时间，采用 ISO 日期格式。
    示例值：2020-09-07T00:00:00+08:00
    Status String 子应用状态，有效值：
  • On：启用；
  • Off：停用。
  • Destroying：销毁中。
  • Destroyed：销毁完成。

    • 示例值：On
    Name String 子应用名称（该字段已不推荐使用，建议使用新的子应用名称字段 SubAppIdName）。
    示例值：test

    SubtitleFormatsOperation

    字幕格式列表操作。

    被如下接口引用：ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Type String 是 操作类型，取值范围：
  • add：添加 Formats 指定的格式列表；
  • delete：删除 Formats 指定的格式列表；<l/i>
  • reset：将已配置的格式列表重置为 Formats 指定的格式列表。

    • 示例值：add
    Formats Array of String 是 字幕格式列表，取值范围：
  • vtt：生成 WebVTT 字幕文件；
  • srt：生成 SRT 字幕文件。

    • 示例值：["vtt", "srt"]

    SuperResolutionInfo

    画面超分控制参数

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 画面超分控制开关，可选值：
  • ON：开启画面超分；
  • OFF：关闭画面超分。

    • 当开启画面超分时，默认2倍超分。
    示例值：ON
    Type String 否 画面超分类型，仅当画面超分控制开关为 ON 时有效，可选值：
  • lq：针对低清晰度有较多噪声视频的超分；
  • hq：针对高清晰度视频超分。

    • 默认值：lq。
    示例值：lq
    Size Integer 否 超分倍数，可选值：2。
    默认值：2。
    示例值：2

    SvgWatermarkInput

    SVG水印模板输入参数

    被如下接口引用：CreateWatermarkTemplate, DescribeWatermarkTemplates。

    名称 类型 必选 描述
    Width String 否 水印的宽度，支持 px，%，W%，H%，S%，L% 六种格式：
  • 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素；当填 0px 且
    Height 不为 0px 时，表示水印的宽度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的宽度取原始 SVG 图像的宽度；
  • 当字符串以 W% 结尾，表示水印 Width 为视频宽度的百分比大小，如 10W% 表示 Width 为视频宽度的 10%；
  • 当字符串以 H% 结尾，表示水印 Width 为视频高度的百分比大小，如 10H% 表示 Width 为视频高度的 10%；
  • 当字符串以 S% 结尾，表示水印 Width 为视频短边的百分比大小，如 10S% 表示 Width 为视频短边的 10%；
  • 当字符串以 L% 结尾，表示水印 Width 为视频长边的百分比大小，如 10L% 表示 Width 为视频长边的 10%；
  • 当字符串以 % 结尾时，含义同 W%。

    • 默认值为 10W%。
    Height String 否 水印的高度，支持 px，W%，H%，S%，L% 六种格式：
  • 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素；当填 0px 且
    Width 不为 0px 时，表示水印的高度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的高度取原始 SVG 图像的高度；
  • 当字符串以 W% 结尾，表示水印 Height 为视频宽度的百分比大小，如 10W% 表示 Height 为视频宽度的 10%；
  • 当字符串以 H% 结尾，表示水印 Height 为视频高度的百分比大小，如 10H% 表示 Height 为视频高度的 10%；
  • 当字符串以 S% 结尾，表示水印 Height 为视频短边的百分比大小，如 10S% 表示 Height 为视频短边的 10%；
  • 当字符串以 L% 结尾，表示水印 Height 为视频长边的百分比大小，如 10L% 表示 Height 为视频长边的 10%；
  • 当字符串以 % 结尾时，含义同 H%。

    • 默认值为 0px。

    SvgWatermarkInputForUpdate

    SVG水印模板输入参数

    被如下接口引用：ModifyWatermarkTemplate。

    名称 类型 必选 描述
    Width String 否 水印的宽度，支持 px，%，W%，H%，S%，L% 六种格式：
  • 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素；当填 0px 且
    Height 不为 0px 时，表示水印的宽度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的宽度取原始 SVG 图像的宽度；
  • 当字符串以 W% 结尾，表示水印 Width 为视频宽度的百分比大小，如 10W% 表示 Width 为视频宽度的 10%；
  • 当字符串以 H% 结尾，表示水印 Width 为视频高度的百分比大小，如 10H% 表示 Width 为视频高度的 10%；
  • 当字符串以 S% 结尾，表示水印 Width 为视频短边的百分比大小，如 10S% 表示 Width 为视频短边的 10%；
  • 当字符串以 L% 结尾，表示水印 Width 为视频长边的百分比大小，如 10L% 表示 Width 为视频长边的 10%；
  • 当字符串以 % 结尾时，含义同 W%。

    • 默认值为 10W%。
    Height String 否 水印的高度，支持 px，%，W%，H%，S%，L% 六种格式：
  • 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素；当填 0px 且
    Width 不为 0px 时，表示水印的高度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的高度取原始 SVG 图像的高度；
  • 当字符串以 W% 结尾，表示水印 Height 为视频宽度的百分比大小，如 10W% 表示 Height 为视频宽度的 10%；
  • 当字符串以 H% 结尾，表示水印 Height 为视频高度的百分比大小，如 10H% 表示 Height 为视频高度的 10%；
  • 当字符串以 S% 结尾，表示水印 Height 为视频短边的百分比大小，如 10S% 表示 Height 为视频短边的 10%；
  • 当字符串以 L% 结尾，表示水印 Height 为视频长边的百分比大小，如 10L% 表示 Height 为视频长边的 10%；
  • 当字符串以 % 结尾时，含义同 H%。
    默认值为 0px。
    		•
    CycleConfig WatermarkCycleConfigForUpdate 否 水印周期配置，用于配置水印周期性地显示与隐藏。
    主要使用场景是：为了视频防遮标，在视频多个地方设置水印，这些水印按固定顺序周期性地显示与隐藏。
    例如，设置 A、B、C、D 4 个水印分别位于视频的左上角、右上角、右下角、左下角处，视频开始时，{ A 显示 5 秒 -> B 显示 5 秒 -> C 显示 5 秒 -> D 显示 5 秒 } -> A 显示 5 秒 -> B 显示 5 秒 -> ...，任何时刻只显示一处水印。
    花括号 {} 表示由 A、B、C、D 4 个水印组成的大周期，可以看出每个大周期持续 20 秒。
    可以看出，A、B、C、D 都是周期性地显示 5 秒、隐藏 15 秒，且四者有固定的显示顺序。
    此配置项即用来描述单个水印的周期配置。
    注意：此字段可能返回 null，表示取不到有效值。

    TEHDConfig

    极速高清参数配置。

    被如下接口引用：CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate。

    名称 类型 必选 描述
    Type String 是 极速高清类型，可选值：
  • TEHD-100 表示极速高清-100;
  • OFF 表示关闭极速高清。
    • 不填表示 OFF。
    示例值：TEHD-100
    MaxVideoBitrate Integer 否 视频码率上限，当 Type 指定了极速高清类型时有效。
    不填或填0表示不设视频码率上限。
    示例值：0

    TEHDConfigForUpdate

    极速高清参数配置。

    被如下接口引用：ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Type String 否 极速高清类型，可选值：
  • TEHD-100 表示极速高清-100;
  • OFF 表示关闭极速高清。
    • 不填表示不修改。
    示例值：TEHD-100
    MaxVideoBitrate Integer 否 视频码率上限，不填代表不修改。
    示例值：1000

    TagConfigureInfo

    智能标签任务控制参数

    被如下接口引用：CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。

    名称 类型 必选 描述
    Switch String 是 智能标签任务开关，可选值：
  • ON：开启智能标签任务；
  • OFF：关闭智能标签任务。
    		•

    TagConfigureInfoForUpdate

    智能标签任务控制参数

    被如下接口引用：ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 否 智能标签任务开关，可选值：
  • ON：开启智能标签任务；
  • OFF：关闭智能标签任务。
    		•

    TaskOutputMediaInfo

    视频处理任务的输出媒体文件信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    FileId String 媒体文件 ID。
    MediaBasicInfo MediaBasicInfo 转拉完成后生成的媒体文件基础信息。

    TaskSimpleInfo

    任务概要信息

    被如下接口引用：DescribeTasks。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca
    Status String 任务状态。取值：WAITING（等待中）、PROCESSING（处理中）、FINISH（已完成）、ABORTED（已终止）。
    示例值：FINISH
    FileId String 视频 ID。
    示例值：123
    TaskType String 任务类型，取值：
  • Procedure：视频处理任务；
  • EditMedia：视频编辑任务；
  • ReduceMediaBitrate：降码率任务；
  • WechatDistribute：微信发布任务；
  • ReviewAudioVideo：音视频审核任务。

    • 兼容 2017 版的任务类型：
  • Transcode：视频转码任务；
  • SnapshotByTimeOffset：视频截图任务；
  • Concat：视频拼接任务；
  • Clip：视频剪辑任务；
  • ImageSprites：截取雪碧图任务。

    • 示例值：Procedure
    CreateTime String 任务创建时间，使用 ISO 日期格式。
    示例值：2020-09-07T00:00:00+08:00
    BeginProcessTime String 任务开始执行时间，使用 ISO 日期格式。若任务尚未开始，该字段为空。
    示例值：2020-09-07T00:00:00+08:00
    FinishTime String 任务结束时间，使用 ISO 日期格式。若任务尚未完成，该字段为空。
    示例值：2020-09-07T00:10:00+08:00
    SessionId String 用于去重的识别码，如果七天内曾有过相同的识别码的请求。
    示例值：123
    SessionContext String 来源上下文，用于透传用户请求信息。
    示例值：123

    TaskStatData

    视频处理任务统计数据。

    被如下接口引用：DescribeMediaProcessUsageData。

    名称 类型 描述
    TaskType String 任务类型。
  • Transcoding: 普通转码
  • Transcoding-TESHD: 极速高清转码
  • Editing: 视频编辑
  • Editing-TESHD: 极速高清视频编辑
  • AdaptiveBitrateStreaming: 自适应码流
  • ContentAudit: 内容审核
  • ContentRecognition: 内容识别
  • RemoveWatermark: 去水印
  • ExtractTraceWatermark: 提取水印
  • AddTraceWatermark: 添加水印
  • RebuildMedia: 音画质重生
  • QualityInspect: 音画质检测
  • Transcode: 转码，包含普通转码、极速高清和视频编辑（不推荐使用）

    • 示例值：Transcoding
    Summary Array of TaskStatDataItem 任务数统计数据概览，用量单位为秒。
    Details Array of SpecificationDataItem 不同规格任务统计数据详情。
    转码规格：
  • Remuxing: 转封装
  • Audio: 音频转码
  • Standard.H264.SD: H.264编码方式标清转码
  • Standard.H264.HD: H.264编码方式高清转码
  • Standard.H264.FHD: H.264编码方式全高清转码
  • Standard.H264.2K: H.264编码方式2K转码
  • Standard.H264.4K: H.264编码方式4K转码
  • Standard.H265.SD: H.265编码方式标清转码
  • Standard.H265.HD: H.265编码方式高清转码
  • Standard.H265.FHD: H.265编码方式全高清转码
  • Standard.H265.2K: H.265编码方式2K转码
  • Standard.H265.4K: H.265编码方式4K转码
  • TESHD-10.H264.SD: H.264编码方式标清极速高清转码
  • TESHD-10.H264.HD: H.264编码方式高清极速高清转码
  • TESHD-10.H264.FHD: H.264编码方式全高清极速高清转码
  • TESHD-10.H264.2K: H.264编码方式2K极速高清转码
  • TESHD-10.H264.4K: H.264编码方式4K极速高清转码
  • TESHD-10.H265.SD: H.265编码方式标清极速高清转码
  • TESHD-10.H265.HD: H.265编码方式高清极速高清转码
  • TESHD-10.H265.FHD: H.265编码方式全高清极速高清转码
  • TESHD-10.H265.2K: H.265编码方式2K极速高清转码
  • TESHD-10.H265.4K: H.265编码方式4K极速高清转码
  • Edit.Audio: 音频编辑
  • Edit.H264.SD: H.264编码方式标清视频编辑
  • Edit.H264.HD: H.264编码方式高清视频编辑
  • Edit.H264.FHD: H.264编码方式全高清视频编辑
  • Edit.H264.2K: H.264编码方式2K视频编辑
  • Edit.H264.4K: H.264编码方式4K视频编辑
  • Edit.H265.SD: H.265编码方式标清视频编辑
  • Edit.H265.HD: H.265编码方式高清视频编辑
  • Edit.H265.FHD: H.265编码方式全高清视频编辑
  • Edit.H265.2K: H.265编码方式2K视频编辑
  • Edit.H265.4K: H.265编码方式4K视频编辑
  • Edit.TESHD-10.H264.SD: H.264编码方式标清极速高清视频编辑
  • Edit.TESHD-10.H264.HD: H.264编码方式高清极速高清视频编辑
  • Edit.TESHD-10.H264.FHD: H.264编码方式全高清极速高清视频编辑
  • Edit.TESHD-10.H264.2K: H.264编码方式2K极速高清视频编辑
  • Edit.TESHD-10.H264.4K: H.264编码方式4K极速高清视频编辑
  • Edit.TESHD-10.H265.SD: H.265编码方式标清极速高清视频编辑
  • Edit.TESHD-10.H265.HD: H.265编码方式高清极速高清视频编辑
  • Edit.TESHD-10.H265.FHD: H.265编码方式全高清极速高清视频编辑
  • Edit.TESHD-10.H265.2K: H.265编码方式2K极速高清视频编辑
  • Edit.TESHD-10.H265.4K: H.265编码方式4K极速高清视频编辑

    • 去水印、音画质重生规格：
  • 480P: 短边 ≤ 480px
  • 720P: 短边 ≤ 720px
  • 1080P: 短边 ≤ 1080px
  • 2K: 短边 ≤ 1440px
  • 4K: 短边 ≤ 2160px
  • 8K: 短边 ≤ 4320px
  • Audio: 音频
    		•

    TaskStatDataItem

    任务统计数据，包括任务数和用量。

    被如下接口引用：DescribeMediaProcessUsageData。

    名称 类型 描述
    Time String 数据所在时间区间的开始时间，使用 ISO 日期格式。如：当时间粒度为天，2018-12-01T00:00:00+08:00，表示2018年12月1日（含）到2018年12月2日（不含）区间。
    Count Integer 任务数。
    Usage Integer 任务用量。

    TempCertificate

    临时凭证

    被如下接口引用：ApplyUpload。

    名称 类型 描述
    SecretId String 临时安全证书 Id。
    SecretKey String 临时安全证书 Key。
    Token String Token 值。
    ExpiredTime Integer 证书无效的时间，返回 Unix 时间戳，精确到秒。

    TerrorismConfigureInfo

    鉴别涉及令人不安全的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    ImgReviewInfo TerrorismImgReviewTemplateInfo 否 画面鉴别涉及令人不安全的信息的任务控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrReviewInfo TerrorismOcrReviewTemplateInfo 否 文字鉴别涉及令人不安全的信息的任务控制参数。
    注意：此字段可能返回 null，表示取不到有效值。

    TerrorismConfigureInfoForUpdate

    鉴别涉及令人不安全的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    ImgReviewInfo TerrorismImgReviewTemplateInfoForUpdate 否 画面鉴别涉及令人不安全的信息的任务控制参数。
    OcrReviewInfo TerrorismOcrReviewTemplateInfoForUpdate 否 文本鉴别涉及令人不安全的信息的任务控制参数。

    TerrorismImageResult

    图片画面审核涉及令人不安全的信息的任务结果类型

    被如下接口引用：ProcessImage, ReviewImage。

    名称 类型 描述
    Confidence Float 鉴别涉及令人不安全的信息的评分，分值为0到100。
    示例值：100
    Suggestion String 鉴别涉及令人不安全的信息的结果建议，取值范围：
  • pass；
  • review；
  • block。

    • 示例值：block
    Label String 鉴别涉及令人不安全的信息的结果标签，取值范围：
  • guns：武器枪支；
  • crowd：人群聚集；
  • police：警察部队；
  • bloody：血腥画面；
  • banners：暴恐旗帜；
  • explosion：爆炸火灾；
  • scenario：暴恐画面。

    • 示例值：guns

    TerrorismImgReviewTemplateInfo

    画面鉴别涉及令人不安全的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 画面鉴别涉及令人不安全的信息的任务开关，可选值：
  • ON：开启画面鉴别涉及令人不安全的信息的任务；
  • OFF：关闭画面鉴别涉及令人不安全的信息的任务。

    • 示例值：ON
    LabelSet Array of String 否 画面鉴别涉及令人不安全的信息的过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为：
  • guns：武器枪支；
  • crowd：人群聚集；
  • bloody：血腥画面；
  • police：警察部队；
  • banners：暴恐旗帜；
  • militant：武装分子；
  • explosion：爆炸火灾；
  • terrorists：暴恐人物；
  • scenario：暴恐画面。

    • 示例值：guns
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 90 分。取值范围：0~100。
    示例值：95
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 80 分。取值范围：0~100。
    示例值：80

    TerrorismImgReviewTemplateInfoForUpdate

    画面鉴别涉及令人不安全的信息的任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 画面鉴别涉及令人不安全的信息的任务开关，可选值：
  • ON：开启画面鉴别涉及令人不安全的信息的任务；
  • OFF：关闭画面鉴别涉及令人不安全的信息的任务。

    • 示例值：ON
    LabelSet Array of String 否 画面鉴别涉及令人不安全的信息的过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为：
  • guns：武器枪支；
  • crowd：人群聚集；
  • bloody：血腥画面；
  • police：警察部队；
  • banners：暴恐旗帜；
  • militant：武装分子；
  • explosion：爆炸火灾；
  • terrorists：暴恐人物；
  • scenario：暴恐画面。

    • 示例值：bloody
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：95
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：80

    TerrorismOcrReviewTemplateInfo

    文本鉴别涉及令人不安全的信息的任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 文本鉴别涉及令人不安全的信息的任务开关，可选值：
  • ON：开启文本鉴别涉及令人不安全的信息的任务；
  • OFF：关闭文本鉴别涉及令人不安全的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：80
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：75

    TerrorismOcrReviewTemplateInfoForUpdate

    文本鉴别涉及令人不安全的信息的任务控制参数

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 文本鉴别涉及令人不安全的信息的任务开关，可选值：
  • ON：开启文本鉴别涉及令人不安全的信息的任务；
  • OFF：关闭文本鉴别涉及令人不安全的信息的任务。

    • 示例值：ON
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：75
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：80

    TextWatermarkTemplateInput

    文字水印模板

    被如下接口引用：CreateWatermarkTemplate, DescribeWatermarkTemplates。

    名称 类型 必选 描述
    FontType String 是 字体类型，目前可以支持两种：
  • simkai.ttf：可以支持中文和英文；
  • arial.ttf：仅支持英文。
    		•
    FontSize String 是 字体大小，格式：Npx，N 为数值。
    FontColor String 是 字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。
    FontAlpha Float 是 文字透明度，取值范围：(0, 1]
  • 0：完全透明
  • 1：完全不透明

    • 默认值：1。

    TextWatermarkTemplateInputForUpdate

    文字水印模板

    被如下接口引用：ModifyWatermarkTemplate。

    名称 类型 必选 描述
    FontType String 否 字体类型，目前可以支持两种：
  • simkai.ttf：可以支持中文和英文；
  • arial.ttf：仅支持英文。
    		•
    FontSize String 否 字体大小，格式：Npx，N 为数值。
    FontColor String 否 字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。
    FontAlpha Float 否 文字透明度，取值范围：(0, 1]
  • 0：完全透明
  • 1：完全不透明
    		•

    TimeRange

    用于描述一个时间段的通用数据类型。

    被如下接口引用：DescribeRoundPlays, DescribeTasks, SearchMedia。

    名称 类型 必选 描述
    After String 否
  • 大于等于此时间（起始时间）。
  • 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。

    • 示例值：2020-09-07T00:00:00+08:00
    Before String 否
  • 小于此时间（结束时间）。
  • 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。

    • 示例值：2020-09-08T00:00:00+08:00

    TraceWatermarkInput

    溯源水印参数

    被如下接口引用：CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate。

    名称 类型 必选 描述
    Switch String 否 溯源水印任务开关，此字段必填，可选值：
  • ON：开启溯源水印；
  • OFF：关闭溯源水印。

    • 示例值：ON
    Definition Integer 否 该字段已废弃，请勿使用。
    示例值：100

    TranscodePlayInfo2017

    视频转码播放信息（2017 版）

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    Url String 播放地址。
    Definition Integer 转码规格 ID，参见转码参数模板。
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和， 单位：bps。
    Height Integer 视频流高度的最大值，单位：px。
    Width Integer 视频流宽度的最大值，单位：px。

    TranscodeTask2017

    视频转码任务信息，该结构仅用于对 2017 版视频转码接口发起的任务。

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 转码任务 ID。
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。
    		•
    Message String 错误信息。
    FileId String 被转码文件 ID。
    FileName String 被转码文件名称。
    Duration Integer 视频时长，单位：秒。
    CoverUrl String 封面地址。
    PlayInfoSet Array of TranscodePlayInfo2017 视频转码后生成的播放信息。

    TranscodeTaskInput

    转码任务输入参数类型

    被如下接口引用：CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 视频转码模板 ID。
    示例值：10000
    WatermarkSet Array of WatermarkInput 否 水印列表，支持多张图片或文字水印，最大可支持 10 张。
    TraceWatermark TraceWatermarkInput 否 溯源水印，该功能已不再支持使用。
    CopyRightWatermark CopyRightWatermarkInput 否 版权水印，该功能已不再支持使用。
    MosaicSet Array of MosaicInput 否 马赛克列表，最大可支持 10 张。
    HeadTailSet Array of HeadTailTaskInput 否 片头片尾列表，支持多片头片尾，最大可支持 10 个。
    StartTimeOffset Float 否 转码后的视频的起始时间偏移，单位：秒。
  • 不填或填0，表示转码后的视频从原始视频的起始位置开始；
  • 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始；
  • 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。

    • 示例值：2
    EndTimeOffset Float 否 转码后视频的终止时间偏移，单位：秒。
  • 不填或填0，表示转码后的视频持续到原始视频的末尾终止；
  • 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止；
  • 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。

    • 示例值：3

    TranscodeTemplate

    转码模板详情

    被如下接口引用：DescribeTranscodeTemplates。

    名称 类型 描述
    Definition String 转码模板唯一标识。
    示例值：101
    Container String 封装格式，取值：mp4、flv、hls、mp3、flac、ogg。
    示例值：hls
    Name String 转码模板名称。
    示例值：TestTemplate
    Comment String 模板描述信息。
    示例值：测试模版
    Type String 模板类型，取值：
  • Preset：系统预置模板；
  • Custom：用户自定义模板。

    • 示例值：Preset
    RemoveVideo Integer 是否去除视频数据，取值：
  • 0：保留；
  • 1：去除。

    • 示例值：0
    RemoveAudio Integer 是否去除音频数据，取值：
  • 0：保留；
  • 1：去除。

    • 示例值：0
    VideoTemplate VideoTemplateInfo 视频流配置参数，仅当 RemoveVideo 为 0，该字段有效。
    注意：此字段可能返回 null，表示取不到有效值。
    AudioTemplate AudioTemplateInfo 音频流配置参数，仅当 RemoveAudio 为 0，该字段有效 。
    注意：此字段可能返回 null，表示取不到有效值。
    TEHDConfig TEHDConfig 极速高清转码参数。
    注意：此字段可能返回 null，表示取不到有效值。
    ContainerType String 封装格式过滤条件，可选值：
  • Video：视频格式，可以同时包含视频流和音频流的封装格式；
  • PureAudio：纯音频格式，只能包含音频流的封装格式板。

    • 示例值：Video
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    示例值：2020-09-07T00:00:00+08:00
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    示例值：2020-09-07T00:00:00+08:00
    SegmentType String 切片类型，仅当 Container 为 hls 时有效。
    示例值：ts

    TransitionOperation

    转场操作

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    Type String 是 转场类型，取值有：

    • 图像的转场操作，用于两个视频片段图像间的转场处理：

      • ImageFadeInFadeOut：图像淡入淡出。
      • BowTieHorizontal：水平蝴蝶结。
      • BowTieVertical：垂直蝴蝶结。
      • ButterflyWaveScrawler：晃动。
      • Cannabisleaf：枫叶。
      • Circle：弧形收放。
      • CircleCrop：圆环聚拢。
      • Circleopen：椭圆聚拢。
      • Crosswarp：横向翘曲。
      • Cube：立方体。
      • DoomScreenTransition：幕布。
      • Doorway：门廊。
      • Dreamy：波浪。
      • DreamyZoom：水平聚拢。
      • FilmBurn：火烧云。
      • GlitchMemories：抖动。
      • Heart：心形。
      • InvertedPageCurl：翻页。
      • Luma：腐蚀。
      • Mosaic：九宫格。
      • Pinwheel：风车。
      • PolarFunction：椭圆扩散。
      • PolkaDotsCurtain：弧形扩散。
      • Radial：雷达扫描
      • RotateScaleFade：上下收放。
      • Squeeze：上下聚拢。
      • Swap：放大切换。
      • Swirl：螺旋。
      • UndulatingBurnOutSwirl：水流蔓延。
      • Windowblinds：百叶窗。
      • WipeDown：向下收起。
      • WipeLeft：向左收起。
      • WipeRight：向右收起。
      • WipeUp：向上收起。
      • ZoomInCircles：水波纹。


    • 音频的转场操作，用于两个音频片段间的转场处理：

      • AudioFadeInFadeOut：声音淡入淡出。




    示例值：ImageFadeInFadeOut

    TrtcRecordInfo

    TRTC伴生录制信息。

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 描述
    SdkAppId Integer TRTC 应用 ID。
    示例值：12345
    RoomId String TRTC 房间 ID。
    示例值：RoomId1
    TaskId String 录制任务 ID。
    示例值：TaskId1
    UserIds Array of String 参与录制的用户 ID 列表。
    示例值：["UserId1"]

    UrlSignatureAuthPolicy

    基于签名的 Key 防盗链信息

    被如下接口引用：DescribeVodDomains, ModifyVodDomainConfig。

    名称 类型 必选 描述
    Status String 是 Key 防盗链设置状态，可选值：
  • Enabled: 启用。
  • Disabled: 禁用。

    • 示例值：Enabled
    EncryptedKey String 否 Key 防盗链中用于生成签名的密钥。
    EncryptedKey 字符串的长度为8~40个字节，不能包含不可见字符。
    示例值：MyEncryptedKey

    UserDefineAsrTextReviewTemplateInfo

    用户自定义语音审核任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 用户自定语音审核任务开关，可选值：
  • ON：开启自定义语音审核任务；
  • OFF：关闭自定义语音审核任务。

    • 示例值：ON
    LabelSet Array of String 否 用户自定义语音过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义语音关键词素材时需要添加对应标签。
    标签个数最多 10 个，每个标签长度最多 16 个字符。
    示例值：["过滤标签1"]
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：75
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：75

    UserDefineAsrTextReviewTemplateInfoForUpdate

    用户自定义语音审核任务控制参数

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 用户自定语音审核任务开关，可选值：
  • ON：开启自定义语音审核任务；
  • OFF：关闭自定义语音审核任务。

    • 示例值：ON
    LabelSet Array of String 否 用户自定义语音过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义语音关键词素材时需要添加对应标签。
    标签个数最多 10 个，每个标签长度最多 16 个字符。
    示例值：["语音过滤标签1"]
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：75
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：75

    UserDefineConfigureInfo

    用户自定义音视频审核任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    FaceReviewInfo UserDefineFaceReviewTemplateInfo 否 用户自定义人物音视频审核控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfo 否 用户自定义语音音视频审核控制参数。
    注意：此字段可能返回 null，表示取不到有效值。
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfo 否 用户自定义文本音视频审核控制参数。
    注意：此字段可能返回 null，表示取不到有效值。

    UserDefineConfigureInfoForUpdate

    用户自定义音视频审核任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    FaceReviewInfo UserDefineFaceReviewTemplateInfoForUpdate 否 用户自定义人物音视频审核控制参数。
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfoForUpdate 否 用户自定义语音音视频审核控制参数。
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfoForUpdate 否 用户自定义文本音视频审核控制参数。

    UserDefineFaceReviewTemplateInfo

    用户自定义人物音视频审核任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 用户自定义人物音视频审核任务开关，可选值：
  • ON：开启自定义人物音视频审核任务；
  • OFF：关闭自定义人物音视频审核任务。

    • 示例值：ON
    LabelSet Array of String 否 用户自定义人物过滤标签，音视频审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义人物库的时，需要添加对应人物标签。
    标签个数最多 10 个，每个标签长度最多 16 个字符。
    示例值：["人物过滤标签1"]
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 97 分。取值范围：0~100。
    示例值：75
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 95 分。取值范围：0~100。
    示例值：75

    UserDefineFaceReviewTemplateInfoForUpdate

    用户自定义人物音视频审核任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 用户自定义人物音视频审核任务开关，可选值：
  • ON：开启自定义人物音视频审核任务；
  • OFF：关闭自定义人物音视频审核任务。

    • 示例值：ON
    LabelSet Array of String 否 用户自定义人物过滤标签，音视频审核结果包含选择的标签则返回结果，如果过滤标签为空，则音视频审核结果全部返回。如果要使用标签过滤功能，添加自定义人物库的时，需要添加对应人物标签。
    标签个数最多 10 个，每个标签长度最多 16 个字符。
    示例值：["人物过滤标签1"]
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当音视频审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：75
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当音视频审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：75

    UserDefineOcrTextReviewTemplateInfo

    用户自定义文本音视频审核任务控制参数

    被如下接口引用：CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 是 用户自定文本音视频审核任务开关，可选值：
  • ON：开启自定义文本音视频审核任务；
  • OFF：关闭自定义文本音视频审核任务。

    • 示例值：ON
    LabelSet Array of String 否 用户自定义文本过滤标签，音视频审核结果包含选择的标签则返回结果，如果过滤标签为空，则音视频审核结果全部返回。如果要使用标签过滤功能，添加自定义文本关键词素材时需要添加对应标签。
    标签个数最多 10 个，每个标签长度最多 16 个字符。
    示例值：["文本过滤标签1"]
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。
    示例值：75
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。
    示例值：75

    UserDefineOcrTextReviewTemplateInfoForUpdate

    用户自定义文本音视频审核任务控制参数。

    被如下接口引用：ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 否 用户自定文本音视频审核任务开关，可选值：
  • ON：开启自定义文本音视频审核任务；
  • OFF：关闭自定义文本音视频审核任务。

    • 示例值：ON
    LabelSet Array of String 否 用户自定义文本过滤标签，音视频审核结果包含选择的标签则返回结果，如果过滤标签为空，则音视频审核结果全部返回。如果要使用标签过滤功能，添加自定义文本关键词素材时需要添加对应标签。
    标签个数最多 10 个，每个标签长度最多 16 个字符。
    示例值：["过滤标签1"]
    BlockConfidence Integer 否 判定涉嫌违规的分数阈值，当审核达到该分数以上，认为涉嫌违规。取值范围：0~100。
    示例值：75
    ReviewConfidence Integer 否 判定需人工复核是否违规的分数阈值，当审核达到该分数以上，认为需人工复核。取值范围：0~100。
    示例值：75

    VideoConfigureInfo

    即时转码视频模板配置。

    被如下接口引用：CreateJustInTimeTranscodeTemplate, DescribeJustInTimeTranscodeTemplates。

    名称 类型 必选 描述
    Width Integer 否 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 1920]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。


    • 默认值：0。
    示例值：720
    Height Integer 否 视频流高度（或短边）的最大值，取值范围：0 和 [128, 1920]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。


    • 默认值：0。
    示例值：1080
    ResolutionAdaptive String 否 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。


    • 默认值：open。
    示例值：open
    Bitrate Integer 否 视频流的码率，取值范围：0 和 [128, 10000]，单位：kbps。
    当取值为 0，表示视频码率和原始视频保持一致。
    示例值：500

    VideoConfigureInfoForUpdate

    即时转码视频模板更新配置。

    被如下接口引用：ModifyJustInTimeTranscodeTemplate。

    名称 类型 必选 描述
    Width Integer 否 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 1920]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。


    • 默认值：0。
    示例值：720
    Height Integer 否 视频流高度（或短边）的最大值，取值范围：0 和 [128, 1920]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。


    • 默认值：0。
    示例值：1080
    ResolutionAdaptive String 否 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。


    • 默认值：open。
    示例值：open
    Bitrate Integer 否 视频流的码率，取值范围：0 和 [128, 10000]，单位：kbps。
    当取值为 0，表示视频码率和原始视频保持一致。
    示例值：500

    VideoDenoiseInfo

    视频降噪控制参数

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 视频降噪控制开关，可选值：
  • ON：开启视频降噪；
  • OFF：关闭视频降噪。

    • 示例值：ON
    Type String 否 视频降噪类型，仅当视频降噪控制开关为 ON 时有效，可选值：
  • weak：轻视频降噪；
  • strong：强视频降噪。

    • 默认值：weak。
    示例值：weak

    VideoFrameInterpolationInfo

    智能插帧控制参数

    被如下接口引用：CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia。

    名称 类型 必选 描述
    Switch String 是 智能插帧控制开关，可选值：
  • ON：开启智能插帧；
  • OFF：关闭智能插帧。

    • 示例值：ON
    Fps Integer 否 智能插帧帧率，帧率范围为 (0, 100]，仅当智能插帧控制开关为 ON 时有效。默认跟源文件帧率一致。
    示例值：25

    VideoTemplateInfo

    视频流配置参数

    被如下接口引用：CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate。

    名称 类型 必选 描述
    Codec String 是 视频流的编码格式，可选值：
  • libx264：H.264 编码；
  • libx265：H.265 编码；
  • av1：AOMedia Video 1 编码；
  • H.266：H.266 编码。

    • 注意：
  • av1，H.266 编码容器目前只支持 mp4 ；
  • H.266 目前只支持恒定 CRF 码率控制方式。

    • 示例值：libx264
    Fps Integer 是 视频帧率，取值范围：[0, 100]，单位：Hz。
    当取值为 0，表示帧率和原始视频保持一致。
    示例值：25
    Bitrate Integer 是 视频流的码率，取值范围：0 和 [128, 35000]，单位：kbps。
    当取值为 0，表示视频码率和原始视频保持一致。
    示例值：500
    ResolutionAdaptive String 否 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。

    • 默认值：open。
    示例值：open
    Width Integer 否 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 8192]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：0
    Height Integer 否 视频流高度（或短边）的最大值，取值范围：0 和 [128, 8192]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 默认值：0。
    示例值：0
    FillType String 否 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
  • white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
  • gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊填充。

    • 默认值：black 。
    示例值：stretch
    Vcrf Integer 否 视频恒定码率控制因子，取值范围为[1, 51]。

    注意：
  • 如果指定该参数，将使用 CRF 的码率控制方式做转码（视频码率将不再生效）；
  • 当指定视频流编码格式为 H.266 时，该字段必填，推荐值为 28；
  • 如果没有特殊需求，不建议指定该参数。

    • 示例值：23
    Gop Integer 否 关键帧 I 帧之间的间隔，取值范围：0 和 [1, 100000]，单位：帧数。
    当填 0 或不填时，系统将自动设置 gop 长度。
    示例值：25
    PreserveHDRSwitch String 否 当原始视频为 HDR（High Dynamic Range）时，转码输出是否依然保持 HDR。取值范围：
  • ON: 如果原始文件是 HDR，则转码输出保持 HDR；否则转码输出为 SDR （Standard Dynamic Range）。
  • OFF: 无论原始文件是 HDR 还是 SDR，转码输出均为 SDR。

    • 默认值：OFF。
    示例值：ON
    CodecTag String 否 编码标签，仅当视频流的编码格式为 H.265 编码时有效，可选值：
  • hvc1 表示 hvc1 标签；
  • hev1 表示 hev1 标签。

    • 默认值：hvc1。
    示例值：hev1

    VideoTemplateInfoForUpdate

    视频流配置参数

    被如下接口引用：ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Codec String 否 视频流的编码格式，可选值：
  • libx264：H.264 编码；
  • libx265：H.265 编码；
  • av1：AOMedia Video 1 编码；
  • H.266：H.266 编码。

    • 注意：
  • av1，H.266 编码容器目前只支持 mp4 ；
  • H.266 目前只支持恒定 CRF 码率控制方式。

    • 示例值：libx264
    Fps Integer 否 视频帧率，取值范围：[0, 100]，单位：Hz。
    当取值为 0，表示帧率和原始视频保持一致。
    示例值：25
    Bitrate Integer 否 视频流的码率，取值范围：0 和 [128, 35000]，单位：kbps。
    当取值为 0，表示视频码率和原始视频保持一致。
    示例值：500
    ResolutionAdaptive String 否 分辨率自适应，可选值：
  • open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
  • close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。

    • 示例值：open
    Width Integer 否 视频流宽度（或长边）的最大值，取值范围：0 和 [128, 8192]，单位：px。
  • 当 Width、Height 均为 0，则分辨率同源；
  • 当 Width 为 0，Height 非 0，则 Width 按比例缩放；
  • 当 Width 非 0，Height 为 0，则 Height 按比例缩放；
  • 当 Width、Height 均非 0，则分辨率按用户指定。

    • 示例值：0
    Height Integer 否 视频流高度（或短边）的最大值，取值范围：0 和 [128, 8192]，单位：px。
    示例值：0
    FillType String 否 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
  • stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
  • black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
  • white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
  • gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊填充。

    • 示例值：stretch
    Vcrf Integer 否 视频恒定码率控制因子，取值范围为[1, 51]，填 0 表示禁用该参数。

    注意：
  • 如果指定该参数，将使用 CRF 的码率控制方式做转码（视频码率将不再生效）；
  • 当指定视频流编码格式为 H.266 时，该字段必填，推荐值为 28；
  • 如果没有特殊需求，不建议指定该参数。

    • 示例值：23
    Gop Integer 否 关键帧 I 帧之间的间隔，取值范围：0 和 [1, 100000]，单位：帧数。
    当填 0 或不填时，系统将自动设置 gop 长度。
    示例值：25
    PreserveHDRSwitch String 否 当原始视频为 HDR（High Dynamic Range）时，转码输出是否依然保持 HDR。取值范围：
  • ON: 如果原始文件是 HDR，则转码输出保持 HDR；否则转码输出为 SDR （Standard Dynamic Range）。
  • OFF: 无论原始文件是 HDR 还是 SDR，转码输出均为 SDR。

    • 示例值：ON
    CodecTag String 否 编码标签，仅当视频流的编码格式为 H.265 编码时有效，可选值：
  • hvc1 表示 hvc1 标签；
  • hev1 表示 hev1 标签。

    • 默认值：hvc1。
    示例值：hev1

    VideoTrackItem

    视频轨的视频片段信息。

    被如下接口引用：ComposeMedia。

    名称 类型 必选 描述
    SourceMedia String 是 视频片段的媒体素材来源，可以是：
  • 点播的媒体文件 ID；
  • 其他媒体文件的下载 URL。

    • 注意：当使用其他媒体文件的下载 URL 作为素材来源，且开启了访问控制（如防盗链）时，需要在 URL 携带访问控制参数（如防盗链签名）。
    示例值：123
    SourceMediaStartTime Float 否 视频片段取自素材文件的起始时间，单位为秒。默认为0。
    示例值：1
    Duration Float 否 视频片段时长，单位为秒。默认取视频素材本身长度，表示截取全部素材。如果源文件是图片，Duration需要大于0。
    示例值：2
    TargetDuration Float 否 视频片段目标时长，单位为秒。
  • 当 TargetDuration 不填或填0时，表示目标时长和 Duration 一致；
  • 当 TargetDuration 取大于0的值时，将对视频片段做快进或慢放等处理，使得输出片段的时长等于 TargetDuration。

    • 示例值：2
    CoordinateOrigin String 否 视频原点位置，取值有：
  • Center：坐标原点为中心位置，如画布中心。

    • 默认值 ：Center。
    示例值：Center
    XPos String 否 视频片段原点距离画布原点的水平位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 XPos 为画布宽度指定百分比的位置，如 10% 表示 XPos 为画布口宽度的 10%。
  • 当字符串以 px 结尾，表示视频片段 XPos 单位为像素，如 100px 表示 XPos 为100像素。

    • 默认值：0px。
    示例值：10%
    YPos String 否 视频片段原点距离画布原点的垂直位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 YPos 为画布高度指定百分比的位置，如 10% 表示 YPos 为画布高度的 10%。
  • 当字符串以 px 结尾，表示视频片段 YPos 单位为像素，如 100px 表示 YPos 为100像素。

    • 默认值：0px。
    示例值：10%
    Width String 否 视频片段的宽度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 Width 为画布宽度的百分比大小，如 10% 表示 Width 为画布宽度的 10%。
  • 当字符串以 px 结尾，表示视频片段 Width 单位为像素，如 100px 表示 Width 为100像素。
  • 当 Width、Height 均为空，则 Width 和 Height 取视频素材本身的 Width、Height。
  • 当 Width 为空，Height 非空，则 Width 按比例缩放
  • 当 Width 非空，Height 为空，则 Height 按比例缩放。

    • 示例值：10%
    Height String 否 视频片段的高度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 Height 为画布高度的百分比大小，如 10% 表示 Height 为画布高度的 10%；
  • 当字符串以 px 结尾，表示视频片段 Height 单位为像素，如 100px 表示 Height 为100像素。
  • 当 Width、Height 均为空，则 Width 和 Height 取视频素材本身的 Width、Height。
  • 当 Width 为空，Height 非空，则 Width 按比例缩放
  • 当 Width 非空，Height 为空，则 Height 按比例缩放。

    • 示例值：10%
    AudioOperations Array of AudioTransform 否 对音频进行操作，如静音等。
    ImageOperations Array of ImageTransform 否 对图像进行的操作，如图像旋转等。

    VoiceConfigureInfo

    音频（静音、低音、爆音）检测的控制参数。

    被如下接口引用：CreateQualityInspectTemplate, DescribeQualityInspectTemplates。

    名称 类型 必选 描述
    Switch String 是 音频（静音、低音、爆音）检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    VoiceConfigureInfoForUpdate

    音频（静音、低音、爆音）检测的控制参数。

    被如下接口引用：ModifyQualityInspectTemplate。

    名称 类型 必选 描述
    Switch String 否 音频（静音、低音、爆音）检测开关，可选值：
  • ON：开启；
  • OFF：关闭。

    • 示例值：ON

    WatermarkConfigureData

    即时转码水印模板配置。

    被如下接口引用：DescribeJustInTimeTranscodeTemplates。

    名称 类型 描述
    Switch String 是否启用水印。可取值：
  • ON：表示启用水印；
  • OFF：表示关闭水印。

    • 示例值：ON
    Url String 水印 Url。
    示例值：1234
    Width String 水印的宽度。
  • 字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%；

    • 示例值：10%
    Height String 水印的高度。
  • 字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%；

    • 示例值：10%
    XPos String 水印原点距离视频图像坐标原点的水平位置。字符串以 % 结尾，表示水印 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%；
    示例值：10%
    YPos String 水印原点距离视频图像坐标原点的垂直位置。当字符串以 % 结尾，表示水印 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%。
    示例值：10%

    WatermarkConfigureInfo

    即时转码水印模板配置。

    被如下接口引用：CreateJustInTimeTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 是 是否启用水印。可取值：
  • ON：表示启用水印；
  • OFF：表示关闭水印。

    • 示例值：ON
    ImageContent String 否 水印图片 Base64 编码后的字符串。支持 jpeg、png 图片格式。
    示例值：1234
    Width String 否 水印的宽度。
  • 字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%；

    • 示例值：10%
    Height String 否 水印的高度。
  • 字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%；

    • 示例值：10%
    XPos String 否 水印原点距离视频图像坐标原点的水平位置。字符串以 % 结尾，表示水印 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%；
    示例值：10%
    YPos String 否 水印原点距离视频图像坐标原点的垂直位置。当字符串以 % 结尾，表示水印 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%。
    示例值：10%

    WatermarkConfigureInfoForUpdate

    即时转码水印模板更新配置。

    被如下接口引用：ModifyJustInTimeTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 否 是否启用水印。可取值：
  • ON：表示启用水印；
  • OFF：表示关闭水印。

    • 示例值：ON
    ImageContent String 否 水印图片 Base64 编码后的字符串。支持 jpeg、png 图片格式。
    示例值：1234
    Width String 否 水印的宽度。
  • 字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%；

    • 示例值：10%
    Height String 否 水印的高度。
  • 字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%；

    • 示例值：10%
    XPos String 否 水印原点距离视频图像坐标原点的水平位置。字符串以 % 结尾，表示水印 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%；
    示例值：10%
    YPos String 否 水印原点距离视频图像坐标原点的垂直位置。当字符串以 % 结尾，表示水印 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%。
    示例值：10%

    WatermarkCycleConfigForUpdate

    水印周期配置。

    被如下接口引用：ModifyWatermarkTemplate。

    名称 类型 必选 描述
    StartTime Float 否 水印在视频里第一次出现的播放时间点，单位：秒。
    DisplayDuration Float 否 在一个水印周期内，水印显示的持续时间，单位：秒。
    CycleDuration Float 否 一个水印周期的持续时间，单位：秒。
    填 0 表示水印只持续一个水印周期（即在整个视频里只显示 DisplayDuration 秒）。

    WatermarkInput

    视频处理任务中的水印参数类型

    被如下接口引用：CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate。

    名称 类型 必选 描述
    Definition Integer 是 水印模板 ID。
    TextContent String 否 文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。
    文字水印不支持截图打水印。
    SvgContent String 否 SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。
    SVG 水印不支持截图打水印。
    StartTimeOffset Float 否 水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。
  • 不填或填0，表示水印从画面开始就出现；
  • 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现；
  • 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。
    		•
    EndTimeOffset Float 否 水印的结束时间偏移，单位：秒。
  • 不填或填0，表示水印持续到画面结束；
  • 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失；
  • 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。
    		•

    WatermarkTemplate

    水印模板详情

    被如下接口引用：DescribeWatermarkTemplates。

    名称 类型 描述
    Definition Integer 水印模板唯一标识。
    Type String 水印类型，取值：
  • image：图片水印；
  • text：文字水印。
    		•
    Name String 水印模板名称。
    Comment String 模板描述信息。
    XPos String 水印图片原点距离视频图像原点的水平位置。
  • 当字符串以 % 结尾，表示水印 Left 为视频宽度指定百分比的位置，如 10% 表示 Left 为视频宽度的 10%；
  • 当字符串以 px 结尾，表示水印 Left 为视频宽度指定像素的位置，如 100px 表示 Left 为 100 像素。
    		•
    YPos String 水印图片原点距离视频图像原点的垂直位置。
  • 当字符串以 % 结尾，表示水印 Top 为视频高度指定百分比的位置，如 10% 表示 Top 为视频高度的 10%；
  • 当字符串以 px 结尾，表示水印 Top 为视频高度指定像素的位置，如 100px 表示 Top 为 100 像素。
    		•
    ImageTemplate ImageWatermarkTemplate 图片水印模板，仅当 Type 为 image，该字段有效。
    注意：此字段可能返回 null，表示取不到有效值。
    TextTemplate TextWatermarkTemplateInput 文字水印模板，仅当 Type 为 text，该字段有效。
    注意：此字段可能返回 null，表示取不到有效值。
    SvgTemplate SvgWatermarkInput SVG 水印模板，当 Type 为 svg，该字段有效。
    注意：此字段可能返回 null，表示取不到有效值。
    CreateTime String 模板创建时间，使用 ISO 日期格式。
    UpdateTime String 模板最后修改时间，使用 ISO 日期格式。
    CoordinateOrigin String 原点位置，可选值：
  • topLeft：表示坐标原点位于视频图像左上角，水印原点为图片或文字的左上角；
  • topRight：表示坐标原点位于视频图像的右上角，水印原点为图片或文字的右上角；
  • bottomLeft：表示坐标原点位于视频图像的左下角，水印原点为图片或文字的左下角；
  • bottomRight：表示坐标原点位于视频图像的右下角，水印原点为图片或文字的右下。；
    		•

    WebPageRecordInfo

    全景录制信息

    被如下接口引用：DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia。

    名称 类型 必选 描述
    RecordUrl String 否 全景录制地址。
    示例值：RecordUrl
    RecordTaskId String 否 全景录制任务 ID。
    示例值：RecordTaskId1

    WechatMiniProgramPublishTask

    微信小程序发布任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值：15000xxxxx-wechat-mini-program-publish-b7e430d49d733a7bd55e261488e4cb4ctt0
    Status String 任务状态，取值：
    WAITING：等待中；
    PROCESSING：处理中；
    FINISH：已完成。
    示例值：FINISH
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。

    • 示例值：0
    Message String 错误信息。
    示例值：SUCCESS
    FileId String 发布视频文件 ID。
    示例值：123
    SourceDefinition Integer 发布视频所对应的转码模板 ID，为 0 代表原始视频。
    示例值：0
    PublishResult String 微信小程序视频发布状态，取值：
  • Pass：发布成功；
  • Failed：发布失败；
  • Rejected：音视频审核未通过。

    • 示例值：Pass

    WechatMiniProgramPublishTaskInput

    微信小程序发布任务类型

    被如下接口引用：DescribeProcedureTemplates。

    名称 类型 必选 描述
    SourceDefinition Integer 是 发布视频所对应的转码模板 ID，为 0 代表原始视频。

    WechatPublishTask

    微信发布任务信息

    被如下接口引用：DescribeTaskDetail, PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    Status String 任务状态，取值：
    WAITING：等待中；
    PROCESSING：处理中；
    FINISH：已完成。
    ErrCode Integer 错误码
  • 0：成功；
  • 其他值：失败。
    		•
    Message String 错误信息。
    FileId String 发布视频文件 ID。
    Definition Integer 微信发布模板 ID。
    SourceDefinition Integer 发布视频所对应的转码模板 ID，为 0 代表原始视频。
    WechatStatus String 微信发布状态，取值：
  • FAIL：失败；
  • SUCCESS：成功；
  • AUDITNOTPASS：审核未通过；
  • NOTTRIGGERED：尚未发起微信发布。
    		•
    WechatVid String 微信 Vid。
    WechatUrl String 微信地址。
    中国站
    文档反馈
    文档活动
    message-icon联系我们
    目录