数据结构

最近更新时间:2019-03-14 20:01:31

AiAnalysisResult

智能分析结果

被如下接口引用:DescribeTaskDetail、PullEvents。

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

    AiAnalysisTaskClassificationInput

    智能分类任务输入类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 视频智能分类模板 ID ,固定为 10 。

    AiAnalysisTaskClassificationOutput

    智能分类结果信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    ClassificationSet Array of MediaAiAnalysisClassificationItem 视频智能分类列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskClassificationResult

    智能分类任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiAnalysisTaskClassificationInput 智能分类任务输入。
    Output AiAnalysisTaskClassificationOutput 智能分类任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskCoverInput

    智能分类任务输入类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 视频智能封面模板 ID ,固定为 10 。

    AiAnalysisTaskCoverOutput

    智能封面结果信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    CoverSet Array of MediaAiAnalysisCoverItem 智能封面列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskCoverResult

    智能封面结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiAnalysisTaskCoverInput 智能封面任务输入。
    Output AiAnalysisTaskCoverOutput 智能分类任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskInput

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

    被如下接口引用:ProcessMedia、ProcessMediaByUrl。

    名称 类型 必选 描述
    Definition Integer 视频内容分析模板 ID ,固定为 10,同时进行智能分类、智能标签分析、智能封面分析。

    AiAnalysisTaskTagInput

    智能标签任务输入类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 视频智能分类模板 ID ,固定为 10 。

    AiAnalysisTaskTagOutput

    智能标签结果信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    TagSet MediaAiAnalysisTagItem 视频智能标签列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskTagResult

    智能标签结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiAnalysisTaskTagInput 智能标签任务输入。
    Output Array of AiAnalysisTaskTagOutput 智能标签任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiContentReviewResult

    内容审核结果

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Type String 任务的类型,可以取的值有:
  • Porn:图片鉴黄
  • Terrorism:图片鉴恐
  • Political:图片鉴政
  • Porn.Asr:Asr 文字鉴黄
  • Porn.Ocr:Ocr 文字鉴黄
  • Political.Asr:Asr 文字鉴政
  • Political.Ocr:Ocr 文字鉴政
  • 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,表示取不到有效值。

    AiContentReviewTaskInput

    智能内容审核任务类型

    被如下接口引用:ProcessMedia、ProcessMediaByUrl。

    名称 类型 必选 描述
    Definition Integer 视频内容审核模板 ID,可以填 10 和 20。
  • 10:对视频画面进行鉴黄、鉴暴、鉴政审核;
  • 20:对视频画面进行鉴黄、鉴暴、鉴政审核,并对 Asr 和 Ocr 文字进行鉴黄、鉴政审核。
  • AiReviewPoliticalAsrTaskInput

    内容审核 Asr 文字鉴政、敏感任务输入参数类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 鉴政模板 ID。

    AiReviewPoliticalAsrTaskOutput

    Asr 文字涉政信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Confidence Float Asr 文字涉政、敏感评分,分值为0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String Asr 文字涉政、敏感结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉政、敏感嫌疑的视频片段列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewPoliticalOcrTaskInput

    内容审核 Ocr 文字鉴政任务输入参数类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 鉴政模板 ID。

    AiReviewPoliticalOcrTaskOutput

    Ocr 文字涉政信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Confidence Float Ocr 文字涉政、敏感评分,分值为0到100。
    Suggestion String Ocr 文字涉政、敏感结果建议,取值范围:
  • pass。
  • review。
  • block。
  • SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉政、敏感嫌疑的视频片段列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewPoliticalTaskInput

    内容审核鉴政任务输入参数类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 鉴政模板 ID。

    AiReviewPoliticalTaskOutput

    涉政信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Confidence Float 视频涉政评分,分值为0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String 涉政结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Label String 视频鉴政结果标签,取值范围:
  • politician:政治人物。
  • violation_photo:违规图标。

  • 注意:此字段可能返回 null,表示取不到有效值。
    SegmentSet Array of MediaContentReviewPoliticalSegmentItem 有涉政嫌疑的视频片段列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewPornAsrTaskInput

    内容审核 Asr 文字鉴黄任务输入参数类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 鉴黄模板 ID。

    AiReviewPornAsrTaskOutput

    Asr 文字涉黄信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Confidence Float Asr 文字涉黄评分,分值为0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String Asr 文字涉黄结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉黄嫌疑的视频片段列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewPornOcrTaskInput

    内容审核 Ocr 文字鉴黄任务输入参数类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 鉴黄模板 ID。

    AiReviewPornOcrTaskOutput

    Ocr 文字涉黄信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Confidence Float Ocr 文字涉黄评分,分值为0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String Ocr 文字涉黄结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉黄嫌疑的视频片段列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewPornTaskInput

    内容审核鉴黄任务输入参数类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 必选 描述
    Definition Integer 鉴黄模板 ID。

    AiReviewPornTaskOutput

    鉴黄结果信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Confidence Float 视频鉴黄评分,分值为0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String 鉴黄结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Label String 视频鉴黄结果标签,取值范围:
  • porn:色情。
  • sexy:性感。
  • vulgar:低俗。
  • intimacy:亲密行为。

  • 注意:此字段可能返回 null,表示取不到有效值。
    SegmentSet Array of MediaContentReviewSegmentItem 有涉黄嫌疑的视频片段列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewTaskPoliticalAsrResult

    内容审核 Asr 文字鉴政、敏感任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiReviewPoliticalAsrTaskInput 内容审核 Asr 文字鉴政任务输入。
    Output AiReviewPoliticalAsrTaskOutput 内容审核 Asr 文字鉴政任务输出。

    AiReviewTaskPoliticalOcrResult

    内容审核 Ocr 文字鉴政、敏感任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiReviewPoliticalOcrTaskInput 内容审核 Ocr 文字鉴政任务输入。
    Output AiReviewPoliticalOcrTaskOutput 内容审核 Ocr 文字鉴政任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewTaskPoliticalResult

    内容审核鉴政任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiReviewPoliticalTaskInput 内容审核鉴政任务输入。
    Output AiReviewPoliticalTaskOutput 内容审核鉴政任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewTaskPornAsrResult

    内容审核 Asr 文字鉴黄任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiReviewPornAsrTaskInput 内容审核 Asr 文字鉴黄任务输入。
    Output AiReviewPornAsrTaskOutput 内容审核 Asr 文字鉴黄任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewTaskPornOcrResult

    内容审核 Ocr 文字鉴黄任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiReviewPornOcrTaskInput 内容审核 Ocr 文字鉴黄任务输入。
    Output AiReviewPornOcrTaskOutput 内容审核 Ocr 文字鉴黄任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewTaskPornResult

    内容审核鉴黄任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiReviewPornTaskInput 内容审核鉴黄任务输入。
    Output AiReviewPornTaskOutput 内容审核鉴黄任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewTaskTerrorismResult

    内容审核鉴恐任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AiReviewTerrorismTaskInput 内容审核鉴恐任务输入。
    Output AiReviewTerrorismTaskOutput 内容审核鉴恐任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    AiReviewTerrorismTaskInput

    内容审核鉴恐任务输入参数类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Definition Integer 鉴恐模板 ID。

    AiReviewTerrorismTaskOutput

    暴恐信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Confidence Float 视频暴恐评分,分值为0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String 暴恐结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Label String 视频暴恐结果标签,取值范围:
  • guns:武器枪支。
  • crowd:人群聚集。
  • police:警察部队。
  • bloody:血腥画面。
  • banners:暴恐旗帜。
  • militant:武装分子。
  • explosion:爆炸火灾。
  • terrorists:暴恐人物。

  • 注意:此字段可能返回 null,表示取不到有效值。
    SegmentSet Array of MediaContentReviewSegmentItem 有暴恐嫌疑的视频片段列表。
    注意:此字段可能返回 null,表示取不到有效值。

    AnimatedGraphicTaskInput

    转动图任务类型

    被如下接口引用:DescribeTaskDetail、ProcessMedia、PullEvents。

    名称 类型 必选 描述
    Definition Integer 视频转动图模板 ID
    StartTimeOffset Float 动图在视频中的开始时间,单位为秒。
    EndTimeOffset Float 动图在视频中的结束时间,单位为秒。

    AudioTemplateInfo

    音频流配置参数

    被如下接口引用:CreateTranscodeTemplate、DescribeTranscodeTemplates、ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Codec String 音频流的编码格式,可选值:
  • libfdk_aac:更适合 mp4 和 hls;
  • libmp3lame:更适合 flv;
  • mp2。
  • Bitrate Integer 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。
    当取值为 0,表示音频码率和原始音频保持一致。
    SampleRate Integer 音频流的采样率,可选值:
  • 32000
  • 44100
  • 48000

  • 单位:Hz。
    AudioChannel Integer 音频通道方式,可选值:
  • 1:单通道
  • 2:双通道
  • 6:立体声

  • 默认值:2。

    ClipFileInfo2017

    视频裁剪结果文件信息(2017 版)

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message Float 错误描述。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 输出目标文件的文件 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    FileUrl String 输出目标文件的文件地址。
    注意:此字段可能返回 null,表示取不到有效值。
    FileType String 输出目标文件的文件类型。
    注意:此字段可能返回 null,表示取不到有效值。

    ClipTask2017

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

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

    ConcatFileInfo2017

    视频拼接源文件信息(2017 版)

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 视频拼接源文件的 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    FileUrl String 视频拼接源文件的地址。
    注意:此字段可能返回 null,表示取不到有效值。
    FileType String 视频拼接源文件的格式。
    注意:此字段可能返回 null,表示取不到有效值。

    ConcatTask2017

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

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

    CoverBySnapshotTaskInput

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

    被如下接口引用:DescribeTaskDetail、ProcessMedia、PullEvents。

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

    CoverBySnapshotTaskOutput

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

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

    CreateImageSpriteTask2017

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    TaskId String 截图雪碧图任务 ID。
    ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 截取雪碧图文件 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    Definition Integer 雪碧图规格,参见雪碧图截图模板
    注意:此字段可能返回 null,表示取不到有效值。
    TotalCount Integer 雪碧图小图总数量。
    注意:此字段可能返回 null,表示取不到有效值。
    ImageSpriteUrlSet Array of String 截取雪碧图输出的地址。
    注意:此字段可能返回 null,表示取不到有效值。
    WebVttUrl String 雪碧图子图位置与时间关系 WebVtt 文件地址。
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaFileInfo

    编辑点播视频文件信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 必选 描述
    FileId String 视频的 ID。
    StartTimeOffset Float 视频剪辑的起始偏移时间偏移,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTimeOffset Float 视频剪辑的起始结束时间偏移,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaStreamInfo

    编辑视频流信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 必选 描述
    StreamId String 录制的流 ID
    StartTime String 流剪辑的起始时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    EndTime String 流剪辑的结束时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaTask

    编辑视频任务信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    Status String 任务流状态,取值:
  • PROCESSING:处理中;
  • FINISH:已完成。

  • 注意:此字段可能返回 null,表示取不到有效值。
    ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input EditMediaTaskInput 视频编辑任务的输入。
    注意:此字段可能返回 null,表示取不到有效值。
    Output EditMediaTaskOutput 视频编辑任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    ProcedureTaskId String 若发起视频编辑任务时指定了视频处理流程,则该字段为流程任务 ID。
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaTaskInput

    编辑视频任务的输入。

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    InputType String 输入视频的来源类型,可以取的值为 File,Stream 两种。
    FileInfoSet Array of EditMediaFileInfo 输入的视频文件信息,当 InputType 为 File 时,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    StreamInfoSet Array of EditMediaStreamInfo 输入的流信息,当 InputType 为 Stream 时,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaTaskOutput

    编辑视频任务的输出

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    FileType String 文件类型,例如 mp4、flv 等。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 媒体文件 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    FileUrl String 媒体文件播放地址。
    注意:此字段可能返回 null,表示取不到有效值。

    EventContent

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

    被如下接口引用:PullEvents。

    名称 类型 描述
    EventHandle String 事件句柄,调用方必须调用 ConfirmEvents 来确认消息已经收到,确认有效时间 30 秒。失效后,事件可重新被获取。
    EventType String 支持事件类型:
  • NewFileUpload:视频上传完成;
  • ProcedureStateChanged:任务流状态变更;
  • FileDeleted:视频删除完成;
  • PullComplete:视频转拉完成;
  • EditMediaComplete:视频编辑完成;
  • WechatPublishComplete:微信发布完成。

  • 兼容 2017 版的事件类型:
  • TranscodeComplete:视频转码完成;
  • ConcatComplete:视频拼接完成;
  • ClipComplete:视频剪辑完成;
  • CreateImageSpriteComplete:视频截取雪碧图完成;
  • CreateSnapshotByTimeOffsetComplete:视频按时间点截图完成。
  • FileUploadEvent FileUploadTask 视频上传完成事件,当事件类型为 NewFileUpload 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    ProcedureStateChangeEvent ProcedureTask 任务流状态变更事件,当事件类型为 ProcedureStateChanged 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    FileDeleteEvent FileDeleteTask 文件删除事件,当事件类型为 FileDeleted 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    PullCompleteEvent PullFileTask 视频转拉完成事件,当事件类型为 PullComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    EditMediaCompleteEvent EditMediaTask 视频编辑完成事件,当事件类型为 EditMediaComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    WechatPublishComplete WechatPublishTask 微信发布完成事件,当事件类型为 WechatPublishComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    TranscodeCompleteEvent TranscodeTask2017 视频转码完成事件,当事件类型为 TranscodeComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    ConcatCompleteEvent ConcatTask2017 视频拼接完成事件,当事件类型为 ConcatComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    ClipCompleteEvent ClipTask2017 视频剪辑完成事件,当事件类型为 ClipComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateImageSpriteCompleteEvent CreateImageSpriteTask2017 视频截取雪碧图完成事件,当事件类型为 CreateImageSpriteComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotByTimeOffsetCompleteEvent SnapshotByTimeOffsetTask2017 视频按时间点截图完成事件,当事件类型为 CreateSnapshotByTimeOffsetComplete 时有效。
    注意:此字段可能返回 null,表示取不到有效值。

    FileDeleteTask

    文件删除任务

    被如下接口引用:PullEvents。

    名称 类型 描述
    FileIdSet Array of String 删除文件 ID 列表。

    FileUploadTask

    文件上传任务信息

    被如下接口引用:PullEvents。

    名称 类型 描述
    FileId String 文件唯一 ID。
    MediaBasicInfo MediaBasicInfo 上传完成后生成的媒体文件基础信息。
    ProcedureTaskId String 若视频上传时指定了视频处理流程,则该字段为流程任务 ID。
    注意:此字段可能返回 null,表示取不到有效值。

    ImageSpriteTaskInput

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

    被如下接口引用:DescribeTaskDetail、ProcessMedia、PullEvents。

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

    ImageWatermarkInput

    图片水印模板输入参数

    被如下接口引用:CreateWatermarkTemplate、ModifyWatermarkTemplate。

    名称 类型 必选 描述
    ImageContent String 水印图片 Base64 编码后的字符串。支持 jpeg、png 图片格式。
    Width String 水印的宽度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示水印 Width 为视频宽度的百分比大小,如 10% 表示 Width 为视频宽度的 10%;
  • 当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素。

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

  • 默认值:0px,表示 Height 按照 Width 对视频宽度的比例缩放。

    ImageWatermarkTemplate

    图片水印模板

    被如下接口引用:DescribeWatermarkTemplates。

    名称 类型 描述
    ImageUrl String 水印图片地址。
    Width String 水印的宽度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示水印 Width 为视频宽度的百分比大小,如 10% 表示 Width 为视频宽度的 10%;
  • 当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素。
  • Height String 水印的高度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示水印 Height 为视频高度的百分比大小,如 10% 表示 Height 为视频高度的 10%;
  • 当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;

  • 0px:表示 Height 按照 Width 对视频宽度的比例缩放。

    MediaAiAnalysisClassificationItem

    智能分类结果

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Classification String 智能分类的类别名称。
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 智能分类的可信度,取值范围是 0 到 100。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaAiAnalysisCoverItem

    智能封面信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    CoverUrl String 智能封面地址。
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 智能封面的可信度,取值范围是 0 到 100。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaAiAnalysisTagItem

    智能标签结果信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Tag String 标签名称。
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 标签的可信度,取值范围是 0 到 100。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaAnimatedGraphicsInfo

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

    被如下接口引用:DescribeMediaInfos、SearchMedia。

    名称 类型 描述
    AnimatedGraphicsSet Array of MediaAnimatedGraphicsItem 视频转动图结果信息
    注意:此字段可能返回 null,表示取不到有效值。

    MediaAnimatedGraphicsItem

    视频转动图结果信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia。

    名称 类型 描述
    Url String 转动图的文件地址。
    注意:此字段可能返回 null,表示取不到有效值。
    Definition Integer 转动图模板 ID,参见转动图参数模板
    注意:此字段可能返回 null,表示取不到有效值。
    Container String 动图格式,如 gif。
    注意:此字段可能返回 null,表示取不到有效值。
    Height Integer 动图的高度,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Width Integer 动图的宽度,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Bitrate Integer 动图码率,单位:bps。
    注意:此字段可能返回 null,表示取不到有效值。
    Size Integer 动图大小,单位:字节。
    注意:此字段可能返回 null,表示取不到有效值。
    Md5 String 动图的md5值。
    注意:此字段可能返回 null,表示取不到有效值。
    StartTimeOffset Float 动图在视频中的起始时间偏移,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTimeOffset Float 动图在视频中的结束时间偏移,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaAudioStreamItem

    点播文件音频流信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia、SimpleHlsClip。

    名称 类型 描述
    Bitrate Integer 音频流的码率,单位:bps。
    注意:此字段可能返回 null,表示取不到有效值。
    SamplingRate Integer 音频流的采样率,单位:hz。
    注意:此字段可能返回 null,表示取不到有效值。
    Codec String 音频流的编码格式,例如 aac。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaBasicInfo

    点播媒体文件基础信息

    被如下接口引用:DescribeMediaInfos、PullEvents、SearchMedia。

    名称 类型 描述
    Name String 媒体文件名称。
    注意:此字段可能返回 null,表示取不到有效值。
    Description String 媒体文件描述。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 媒体文件的创建时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime String 媒体文件的最近更新时间(如修改视频属性、发起视频处理等会触发更新媒体文件信息的操作),使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    ExpireTime String 媒体文件的过期时间,使用 ISO 日期格式。过期后该媒体文件及其相关资源(转码结果、雪碧图等)将被永久删除。“9999-12-31T23:59:59Z”表示永不过期。
    注意:此字段可能返回 null,表示取不到有效值。
    ClassId Integer 媒体文件的分类 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    ClassName String 媒体文件的分类名称。
    注意:此字段可能返回 null,表示取不到有效值。
    ClassPath String 媒体文件的分类路径,分类间以“-”分隔,如“新的一级分类 - 新的二级分类”。
    注意:此字段可能返回 null,表示取不到有效值。
    CoverUrl String 媒体文件的封面图片地址。
    注意:此字段可能返回 null,表示取不到有效值。
    Type String 媒体文件的封装格式,例如 mp4、flv 等。
    注意:此字段可能返回 null,表示取不到有效值。
    MediaUrl String 原始媒体文件的 URL 地址。
    注意:此字段可能返回 null,表示取不到有效值。
    SourceInfo MediaSourceData 该媒体文件的来源信息。
    注意:此字段可能返回 null,表示取不到有效值。
    StorageRegion String 媒体文件存储地区,如 ap-guangzhou,参见地域列表
    注意:此字段可能返回 null,表示取不到有效值。
    TagSet Array of String 媒体文件的标签信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Vid String 直播录制文件的唯一标识
    注意:此字段可能返回 null,表示取不到有效值。

    MediaClassInfo

    分类信息描述

    被如下接口引用:DescribeAllClass。

    名称 类型 描述
    ClassId Integer 分类 ID
    ParentId Integer 父类 ID,一级分类的父类 ID 为 -1。
    ClassName String 分类名称
    Level Integer 分类级别,一级分类为 0,最大值为 3,即最多允许 4 级分类层次。
    SubClassIdSet Array of Integer 当前分类的第一级子类 ID 集合
    注意:此字段可能返回 null,表示取不到有效值。

    MediaContentReviewAsrTextSegmentItem

    内容审核 Asr 文字审核嫌疑片段

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 嫌疑片段置信度。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String 嫌疑片段审核结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    KeywordSet Array of String 嫌疑关键词列表。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaContentReviewOcrTextSegmentItem

    内容审核 Ocr 文字审核嫌疑片段

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 嫌疑片段置信度。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String 嫌疑片段审核结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    KeywordSet Array of String 嫌疑关键词列表。
    注意:此字段可能返回 null,表示取不到有效值。
    AreaCoordSet Array of Integer 嫌疑文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaContentReviewPoliticalSegmentItem

    内容审核涉政嫌疑片段

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 嫌疑片段涉政分数。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String 嫌疑片段鉴政结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Name String 涉政人物、违规图标名字。
    注意:此字段可能返回 null,表示取不到有效值。
    Label String 嫌疑片段鉴政结果标签。
    注意:此字段可能返回 null,表示取不到有效值。
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    注意:此字段可能返回 null,表示取不到有效值。
    AreaCoordSet Array of Integer 涉政人物、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    注意:此字段可能返回 null,表示取不到有效值。
    PicUrlExpireTimeStamp Integer 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。

    MediaContentReviewSegmentItem

    内容审核涉黄/暴恐嫌疑片段

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 嫌疑片段涉黄分数。
    注意:此字段可能返回 null,表示取不到有效值。
    Label String 嫌疑片段鉴黄结果标签。
    注意:此字段可能返回 null,表示取不到有效值。
    Suggestion String 嫌疑片段鉴黄结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    注意:此字段可能返回 null,表示取不到有效值。
    PicUrlExpireTimeStamp Integer 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。

    MediaDeleteItem

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

    被如下接口引用:DeleteMedia。

    名称 类型 必选 描述
    Type String 所指定的删除部分。如果未填写该字段则参数无效。可选值有:
  • TranscodeFiles(删除转码文件)。
  • WechatPublishFiles(删除微信发布文件)。
  • Definition Integer 删除由Type参数指定的种类下的视频模板号,模板定义参见转码模板
    默认值为0,表示删除参数Type指定种类下所有的视频。

    MediaImageSpriteInfo

    点播文件雪碧图信息

    被如下接口引用:DescribeMediaInfos、SearchMedia。

    名称 类型 描述
    ImageSpriteSet Array of MediaImageSpriteItem 特定规格的雪碧图信息集合,每个元素代表一套相同规格的雪碧图。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaImageSpriteItem

    雪碧图信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia。

    名称 类型 描述
    Definition Integer 雪碧图规格,参见雪碧图参数模板
    注意:此字段可能返回 null,表示取不到有效值。
    Height Integer 雪碧图小图的高度。
    注意:此字段可能返回 null,表示取不到有效值。
    Width Integer 雪碧图小图的宽度。
    注意:此字段可能返回 null,表示取不到有效值。
    TotalCount Integer 每一张雪碧图大图里小图的数量。
    注意:此字段可能返回 null,表示取不到有效值。
    ImageUrlSet Array of String 每一张雪碧图大图的地址。
    注意:此字段可能返回 null,表示取不到有效值。
    WebVttUrl String 雪碧图子图位置与时间关系的 WebVtt 文件地址。WebVtt 文件表明了各个雪碧图小图对应的时间点,以及在在雪碧大图里的坐标位置,一般被播放器用于实现预览。
    注意:此字段可能返回 null,表示取不到有效值。

    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,表示取不到有效值。
    FileId String 媒体文件唯一标识 ID。

    MediaInputInfo

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

    被如下接口引用:ProcessMediaByUrl。

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

    MediaKeyFrameDescInfo

    视频打点信息

    被如下接口引用:DescribeMediaInfos、SearchMedia。

    名称 类型 描述
    KeyFrameDescSet Array of MediaKeyFrameDescItem 视频打点信息数组。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaKeyFrameDescItem

    视频打点信息

    被如下接口引用:DescribeMediaInfos、ModifyMediaInfo、SearchMedia。

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

    MediaMetaData

    点播媒体文件元信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia、SimpleHlsClip。

    名称 类型 描述
    Size Integer 上传的媒体文件大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。
    注意:此字段可能返回 null,表示取不到有效值。
    Container String 容器类型,例如 m4a,mp4 等。
    注意:此字段可能返回 null,表示取不到有效值。
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和,单位:bps。
    注意:此字段可能返回 null,表示取不到有效值。
    Height Integer 视频流高度的最大值,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Width Integer 视频流宽度的最大值,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Duration Float 视频时长,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Rotate Integer 视频拍摄时的选择角度,单位:度。
    注意:此字段可能返回 null,表示取不到有效值。
    VideoStreamSet Array of MediaVideoStreamItem 视频流信息。
    注意:此字段可能返回 null,表示取不到有效值。
    AudioStreamSet Array of MediaAudioStreamItem 音频流信息。
    注意:此字段可能返回 null,表示取不到有效值。
    VideoDuration Float 视频时长,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    AudioDuration Float 音频时长,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaOutputInfo

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

    被如下接口引用:ProcessMediaByUrl。

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

    MediaProcessTaskAnimatedGraphicResult

    转动图任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input AnimatedGraphicTaskInput 转动图任务的输入。
    Output MediaAnimatedGraphicsItem 转动图任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaProcessTaskCoverBySnapshotResult

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input CoverBySnapshotTaskInput 对视频截图做封面任务的输入。
    Output CoverBySnapshotTaskOutput 对视频截图做封面任务的输出。

    MediaProcessTaskImageSpriteResult

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input ImageSpriteTaskInput 对视频截雪碧图任务的输入。
    Output MediaImageSpriteItem 对视频截雪碧图任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaProcessTaskInput

    视频处理任务类型

    被如下接口引用:ProcessMedia。

    名称 类型 必选 描述
    TranscodeTaskSet Array of TranscodeTaskInput 视频转码任务列表。
    注意:此字段可能返回 null,表示取不到有效值。
    AnimatedGraphicTaskSet Array of AnimatedGraphicTaskInput 视频转动图任务列表。
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotByTimeOffsetTaskSet Array of SnapshotByTimeOffsetTaskInput 对视频按时间点截图任务列表。
    注意:此字段可能返回 null,表示取不到有效值。
    SampleSnapshotTaskSet Array of SampleSnapshotTaskInput 对视频采样截图任务列表。
    注意:此字段可能返回 null,表示取不到有效值。
    ImageSpriteTaskSet Array of ImageSpriteTaskInput 对视频截雪碧图任务列表。
    注意:此字段可能返回 null,表示取不到有效值。
    CoverBySnapshotTaskSet Array of CoverBySnapshotTaskInput 对视频截图做封面任务列表。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaProcessTaskResult

    任务查询结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

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

    MediaProcessTaskSampleSnapshotResult

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input SampleSnapshotTaskInput 对视频做采样截图任务输入。
    Output MediaSampleSnapshotItem 对视频做采样截图任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaProcessTaskSnapshotByTimeOffsetResult

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

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input SnapshotByTimeOffsetTaskInput 对视频按指定时间点截图任务输入。
    Output MediaSnapshotByTimeOffsetItem 对视频按指定时间点截图任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaProcessTaskTranscodeResult

    转码任务结果类型

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    ErrCode Integer 错误码,0:成功,其他值:失败。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input TranscodeTaskInput 转码任务的输入。
    Output MediaTranscodeItem 转码任务的输出。

    MediaSampleSnapshotInfo

    点播文件采样截图信息

    被如下接口引用:DescribeMediaInfos、SearchMedia。

    名称 类型 描述
    SampleSnapshotSet Array of MediaSampleSnapshotItem 特定规格的采样截图信息集合,每个元素代表一套相同规格的采样截图。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaSampleSnapshotItem

    采样截图信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia。

    名称 类型 描述
    Definition Integer 采样截图规格 ID,参见采样截图参数模板
    注意:此字段可能返回 null,表示取不到有效值。
    SampleType String 采样方式,取值范围:
  • Percent:根据百分比间隔采样。
  • Time:根据时间间隔采样。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Interval Integer 采样间隔
  • 当 SampleType 为 Percent 时,该值表示多少百分比一张图。
  • 当 SampleType 为 Time 时,该值表示多少时间间隔一张图,单位秒, 第一张图均为视频首帧。

  • 注意:此字段可能返回 null,表示取不到有效值。
    ImageUrlSet Array of String 生成的截图 url 列表。
    注意:此字段可能返回 null,表示取不到有效值。
    WaterMarkDefinition Array of Integer 截图如果被打上了水印,被打水印的模板 ID 列表。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaSnapshotByTimeOffsetInfo

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

    被如下接口引用:DescribeMediaInfos、SearchMedia。

    名称 类型 描述
    SnapshotByTimeOffsetSet Array of MediaSnapshotByTimeOffsetItem 特定规格的指定时间点截图信息集合。目前每种规格只能有一套截图。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaSnapshotByTimeOffsetItem

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

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia。

    名称 类型 描述
    Definition Integer 指定时间点截图规格,参见指定时间点截图参数模板
    注意:此字段可能返回 null,表示取不到有效值。
    PicInfoSet Array of MediaSnapshotByTimePicInfoItem 同一规格的截图信息集合,每个元素代表一张截图。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaSnapshotByTimePicInfoItem

    指定时间点截图信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia。

    名称 类型 描述
    TimeOffset Float 该张截图对应视频文件中的时间偏移,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Url String 该张截图的 URL 地址。
    注意:此字段可能返回 null,表示取不到有效值。
    WaterMarkDefinition Array of Integer 截图如果被打上了水印,被打水印的模板 ID 列表。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaSourceData

    来源文件信息

    被如下接口引用:DescribeMediaInfos、PullEvents、SearchMedia。

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

  • 注意:此字段可能返回 null,表示取不到有效值。
    SourceContext String 用户创建文件时透传的字段
    注意:此字段可能返回 null,表示取不到有效值。

    MediaTranscodeInfo

    点播文件转码信息

    被如下接口引用:DescribeMediaInfos、SearchMedia。

    名称 类型 描述
    TranscodeSet Array of MediaTranscodeItem 各规格的转码信息集合,每个元素代表一个规格的转码结果。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaTranscodeItem

    转码信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia。

    名称 类型 描述
    Url String 转码后的视频文件地址。
    注意:此字段可能返回 null,表示取不到有效值。
    Definition Integer 转码规格 ID,参见转码参数模板
    注意:此字段可能返回 null,表示取不到有效值。
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和, 单位:bps。
    注意:此字段可能返回 null,表示取不到有效值。
    Height Integer 视频流高度的最大值,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Width Integer 视频流宽度的最大值,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Size Integer 媒体文件总大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。
    注意:此字段可能返回 null,表示取不到有效值。
    Duration Float 视频时长,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Container String 容器类型,例如 m4a,mp4 等。
    注意:此字段可能返回 null,表示取不到有效值。
    Md5 String 视频的 md5 值。
    注意:此字段可能返回 null,表示取不到有效值。
    AudioStreamSet Array of MediaAudioStreamItem 音频流信息。
    注意:此字段可能返回 null,表示取不到有效值。
    VideoStreamSet Array of MediaVideoStreamItem 视频流信息。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaVideoStreamItem

    点播文件视频流信息

    被如下接口引用:DescribeMediaInfos、DescribeTaskDetail、PullEvents、SearchMedia、SimpleHlsClip。

    名称 类型 描述
    Bitrate Integer 视频流的码率,单位:bps。
    注意:此字段可能返回 null,表示取不到有效值。
    Height Integer 视频流的高度,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Width Integer 视频流的宽度,单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    Codec String 视频流的编码格式,例如 h264。
    注意:此字段可能返回 null,表示取不到有效值。
    Fps Integer 帧率,单位:hz。
    注意:此字段可能返回 null,表示取不到有效值。

    ProcedureTask

    视频处理任务信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    TaskId String 视频处理任务 ID。
    Status String 任务流状态,取值:
  • PROCESSING:处理中;
  • FINISH:已完成。
  • ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 媒体文件 ID
  • 若流程由 ProcessMedia 发起,该字段表示 MediaInfo 的 FileId;
  • 若流程由 ProcessMediaByUrl 发起,该字段表示 MediaInputInfo 的 Id。

  • 注意:此字段可能返回 null,表示取不到有效值。
    FileName String 媒体文件名称
  • 若流程由 ProcessMedia 发起,该字段表示 MediaInfo 的 BasicInfo.Name;
  • 若流程由 ProcessMediaByUrl 发起,该字段表示 MediaInputInfo 的 Name。

  • 注意:此字段可能返回 null,表示取不到有效值。
    FileUrl String 媒体文件地址
  • 若流程由 ProcessMedia 发起,该字段表示 MediaInfo 的 BasicInfo.MediaUrl;
  • 若流程由 ProcessMediaByUrl 发起,该字段表示 MediaInputInfo 的 Url。
  • MetaData MediaMetaData 原始视频的元信息。
    MediaProcessResultSet Array of MediaProcessTaskResult 视频处理任务的执行状态与结果。
    注意:此字段可能返回 null,表示取不到有效值。
    AiContentReviewResultSet Array of AiContentReviewResult 视频内容审核任务的执行状态与结果。
    注意:此字段可能返回 null,表示取不到有效值。
    AiAnalysisResultSet Array of AiAnalysisResult 视频内容分析任务的执行状态与结果。
    注意:此字段可能返回 null,表示取不到有效值。
    TasksPriority Integer 任务流的优先级,取值范围为 [-10, 10]。
    注意:此字段可能返回 null,表示取不到有效值。
    TasksNotifyMode String 任务流状态变更通知模式。
  • Finish:只有当任务流全部执行完毕时,才发起一次事件通知;
  • Change:只要任务流中每个子任务的状态发生变化,都进行事件通知;
  • None:不接受该任务流回调。

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

    PullFileTask

    视频转拉任务信息

    被如下接口引用:PullEvents。

    名称 类型 描述
    TaskId String 转拉上传任务 ID。
    ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 转拉上传完成后生成的视频 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    FileUrl String 转拉上传完成后生成的播放地址。
    注意:此字段可能返回 null,表示取不到有效值。
    ProcedureTaskId String 若转拉上传时指定了视频处理流程,则该参数为流程任务 ID。
    注意:此字段可能返回 null,表示取不到有效值。

    SampleSnapshotTaskInput

    对视频做采样截图任务输入参数类型

    被如下接口引用:DescribeTaskDetail、ProcessMedia、PullEvents。

    名称 类型 必选 描述
    Definition Integer 采样截图模板 ID。
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    注意:此字段可能返回 null,表示取不到有效值。

    SnapshotByTimeOffset2017

    截图输出信息(2017 版)

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    ErrCode String 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    TimeOffset Integer 截图的具体时间点,单位:毫秒。
    注意:此字段可能返回 null,表示取不到有效值。
    Url String 截图输出文件地址。
    注意:此字段可能返回 null,表示取不到有效值。

    SnapshotByTimeOffsetTask2017

    视频指定时间点截图任务信息,该结构仅用于 2017 版指定时间点截图接口发起的任务。

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    TaskId String 截图任务 ID。
    FileId String 截图文件 ID。
    Definition Integer 截图规格,参见指定时间点截图参数模板
    SnapshotInfoSet Array of SnapshotByTimeOffset2017 截图结果信息。

    SnapshotByTimeOffsetTaskInput

    对视频按指定时间点截图任务输入参数类型

    被如下接口引用:DescribeTaskDetail、ProcessMedia、PullEvents。

    名称 类型 必选 描述
    Definition Integer 指定时间点截图模板 ID。
    TimeOffsetSet Array of Float 截图时间点列表,单位为秒。
    注意:此字段可能返回 null,表示取不到有效值。
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    注意:此字段可能返回 null,表示取不到有效值。

    SortBy

    排序依据

    被如下接口引用:SearchMedia。

    名称 类型 描述
    Field String 排序字段
    Order String 排序方式,可选值:Asc(升序)、Desc(降序)

    TaskSimpleInfo

    任务概要信息

    被如下接口引用:DescribeTasks。

    名称 类型 描述
    TaskId String 任务 ID。
    TaskType String 任务类型,取值:
  • Procedure:视频处理任务;
  • EditMedia:视频编辑任务
  • WechatDistribute:微信发布任务。

  • 兼容 2017 版的任务类型:
  • Transcode:视频转码任务;
  • SnapshotByTimeOffset:视频截图任务;
  • Concat:视频拼接任务;
  • Clip:视频剪辑任务;
  • ImageSprites:截取雪碧图任务。
  • CreatTime String 任务创建时间,使用 ISO 日期格式
    BeginProcessTime String 任务开始执行时间,使用 ISO 日期格式。若任务尚未开始,该字段为空。
    注意:此字段可能返回 null,表示取不到有效值。
    FinishTime String 任务结束时间,使用 ISO 日期格式。若任务尚未完成,该字段为空。
    注意:此字段可能返回 null,表示取不到有效值。

    TempCertificate

    临时凭证

    被如下接口引用:ApplyUpload。

    名称 类型 描述
    SecretId String 临时安全证书 Id。
    SecretKey String 临时安全证书 Key。
    Token String Token 值。
    ExpiredTime Integer 证书无效的时间,返回 Unix 时间戳,精确到秒。

    TextWatermarkTemplate

    文字水印模板

    被如下接口引用:CreateWatermarkTemplate、DescribeWatermarkTemplates、ModifyWatermarkTemplate。

    名称 类型 必选 描述
    FontType String 字体类型,目前仅支持 arial.ttf。
    FontSize String 字体大小,格式:Npx,N 为数值。
    FontColor String 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(黑色)。
    FontAlpha Float 文字透明度,取值范围:(0, 1]
  • 0:完全透明
  • 1:完全不透明

  • 默认值:1。

    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:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 被转码文件 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    FileName String 被转码文件名称。
    注意:此字段可能返回 null,表示取不到有效值。
    Duration Integer 视频时长,单位:秒。
    注意:此字段可能返回 null,表示取不到有效值。
    CoverUrl String 封面地址。
    注意:此字段可能返回 null,表示取不到有效值。
    PlayInfoSet Array of TranscodePlayInfo2017 视频转码后生成的播放信息。
    注意:此字段可能返回 null,表示取不到有效值。

    TranscodeTaskInput

    转码任务输入参数类型

    被如下接口引用:DescribeTaskDetail、ProcessMedia、PullEvents。

    名称 类型 必选 描述
    Definition Integer 视频转码模板 ID。
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    注意:此字段可能返回 null,表示取不到有效值。

    TranscodeTemplate

    转码模板详情

    被如下接口引用:DescribeTranscodeTemplates。

    名称 类型 描述
    Definition String 转码模板唯一标识。
    Container String 封装格式,取值:mp4、flv、hls、mp3、flac、ogg。
    Name String 转码模板名称。
    注意:此字段可能返回 null,表示取不到有效值。
    Comment String 模板描述信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Type String 模板类型,取值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • RemoveVideo Integer 是否去除视频数据,取值:
  • 0:保留;
  • 1:去除。
  • RemoveAudio Integer 是否去除音频数据,取值:
  • 0:保留;
  • 1:去除。
  • VideoTemplate VideoTemplateInfo 视频流配置参数,仅当 RemoveVideo 为 0,该字段有效。
    注意:此字段可能返回 null,表示取不到有效值。
    AudioTemplate AudioTemplateInfo 音频流配置参数,仅当 RemoveAudio 为 0,该字段有效 。
    注意:此字段可能返回 null,表示取不到有效值。
    ContainerType String 封装格式过滤条件,可选值:
  • Video:视频格式,可以同时包含视频流和音频流的封装格式;
  • PureAudio:纯音频格式,只能包含音频流的封装格式板。
  • CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式

    VideoTemplateInfo

    视频流配置参数

    被如下接口引用:CreateTranscodeTemplate、DescribeTranscodeTemplates、ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Codec String 视频流的编码格式,可选值:
  • libx264:H.264 编码
  • libx265:H.265 编码

  • 目前 H.265 编码必须指定分辨率,并且需要在 640*480 以内。
    Fps Integer 视频帧率,取值范围:[0, 60],单位:Hz。
    当取值为 0,表示帧率和原始视频保持一致。
    Bitrate Integer 视频流的码率,取值范围:0 和 [128, 35000],单位:kbps。
    当取值为 0,表示视频码率和原始视频保持一致。
    ResolutionAdaptive String 分辨率自适应,可选值:
  • open:开启,此时,Width 代表视频的宽度,Height 表示视频的高度;
  • close:关闭,此时,Width 代表视频的长边,Height 表示视频的短边。

  • 默认值:open。
    注意:此字段可能返回 null,表示取不到有效值。
    Width Integer 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    注意:此字段可能返回 null,表示取不到有效值。
    Height Integer 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    注意:此字段可能返回 null,表示取不到有效值。

    WatermarkInput

    视频处理任务中的水印参数类型

    被如下接口引用:DescribeTaskDetail、ProcessMedia、PullEvents。

    名称 类型 必选 描述
    Definition Integer 水印模板 ID。
    TextContent String 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。

    WatermarkTemplate

    水印模板详情

    被如下接口引用:DescribeWatermarkTemplates。

    名称 类型 描述
    Definition Integer 水印模板唯一标识。
    Type String 水印类型,取值:
  • image:图片水印;
  • text:文字水印。
  • Name String 水印模板名称。
    注意:此字段可能返回 null,表示取不到有效值。
    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 TextWatermarkTemplate 文字水印模板,仅当 Type 为 text,该字段有值。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    CoordinateOrigin String 原点位置,可选值:
  • topLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;
  • topRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
  • bottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
  • bottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下。;
  • WechatPublishTask

    微信发布任务信息

    被如下接口引用:DescribeTaskDetail、PullEvents。

    名称 类型 描述
    TaskId String 任务 ID。
    Status String 任务状态,取值:
    WAITING:等待中;
    PROCESSING:处理中;
    FINISH:已完成。
    ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    FileId String 发布视频文件 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    Definition Integer 微信发布模板 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    SourceDefinition Integer 发布视频所对应的转码模板 ID,为 0 代表原始视频。
    注意:此字段可能返回 null,表示取不到有效值。
    WechatStatus String 微信发布状态,取值:
  • FAIL:失败;
  • SUCCESS:成功;
  • AUDITNOTPASS:审核未通过;
  • NOTTRIGGERED:尚未发起微信发布。

  • 注意:此字段可能返回 null,表示取不到有效值。
    WechatVid String 微信 Vid。
    注意:此字段可能返回 null,表示取不到有效值。
    WechatUrl String 微信地址。
    注意:此字段可能返回 null,表示取不到有效值。