有奖捉虫:云通信与企业服务文档专题,速来> HOT

AIAnalysisTemplateItem

AI 智能分析模板详情

被如下接口引用:DescribeAIAnalysisTemplates。

名称 类型 描述
Definition Integer 智能分析模板唯一标识。
示例值:0
Name String 智能分析模板名称。
示例值:“”
Comment String 智能分析模板描述信息。
示例值:“”
ClassificationConfigure ClassificationConfigureInfo 智能分类任务控制参数。
注意:此字段可能返回 null,表示取不到有效值。
TagConfigure TagConfigureInfo 智能标签任务控制参数。
注意:此字段可能返回 null,表示取不到有效值。
CoverConfigure CoverConfigureInfo 智能封面任务控制参数。
注意:此字段可能返回 null,表示取不到有效值。
FrameTagConfigure FrameTagConfigureInfo 智能按帧标签任务控制参数。
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 模板创建时间,使用 ISO 日期格式
示例值:“”
UpdateTime String 模板最后修改时间,使用 ISO 日期格式
示例值:“”
Type String 模板类型,取值范围:
* Preset:系统预置模板;
* Custom:用户自定义模板。
注意:此字段可能返回 null,表示取不到有效值。
示例值:“”

AIRecognitionTemplateItem

视频内容识别模板详情

被如下接口引用:DescribeAIRecognitionTemplates。

名称 类型 描述
Definition Integer 视频内容识别模板唯一标识。
示例值:0
Name String 视频内容识别模板名称。
示例值:“”
Comment String 视频内容识别模板描述信息。
示例值:“”
FaceConfigure FaceConfigureInfo 人脸识别控制参数。
OcrFullTextConfigure OcrFullTextConfigureInfo 文本全文识别控制参数。
OcrWordsConfigure OcrWordsConfigureInfo 文本关键词识别控制参数。
AsrFullTextConfigure AsrFullTextConfigureInfo 语音全文识别控制参数。
AsrWordsConfigure AsrWordsConfigureInfo 语音关键词识别控制参数。
TranslateConfigure TranslateConfigureInfo 语音翻译控制参数。
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 模板创建时间,使用 ISO 日期格式
示例值:“”
UpdateTime String 模板最后修改时间,使用 ISO 日期格式
示例值:“”
Type String 模板类型,取值范围:
* Preset:系统预置模板;
* Custom:用户自定义模板。
注意:此字段可能返回 null,表示取不到有效值。
示例值:“”

ActionConfigInfo

动作识别参数配置

被如下接口引用:RecognizeMediaForZhiXue。

名称 类型 必选 描述
Switch String 动作识别任务开关,可选值:
  • ON:开启;
  • OFF:关闭。
  • Activity

    编排原子任务

    被如下接口引用:CreateSchedule, DescribeSchedules, ModifySchedule。

    名称 类型 必选 描述
    ActivityType String 原子任务类型:
  • input: 起始节点
  • output:终止节点
  • action-trans:转码
  • action-samplesnapshot:采样截图
  • action-AIAnalysis: 分析
  • action-AIRecognition:识别
  • action-aiReview:审核
  • action-animated-graphics:转动图
  • action-image-sprite:雪碧图
  • action-snapshotByTimeOffset: 时间点截图
  • action-adaptive-substream:自适应码流

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:input
    ReardriveIndex Array of Integer 后驱节点索引数组
    注意:此字段可能返回 null,表示取不到有效值。
    ActivityPara ActivityPara 原子任务参数
    注意:此字段可能返回 null,表示取不到有效值。

    ActivityPara

    编排原子任务

    被如下接口引用:CreateSchedule, ModifySchedule。

    名称 类型 必选 描述
    TranscodeTask TranscodeTaskInput 视频转码任务
    注意:此字段可能返回 null,表示取不到有效值。
    AnimatedGraphicTask AnimatedGraphicTaskInput 视频转动图任务
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotByTimeOffsetTask SnapshotByTimeOffsetTaskInput 视频按时间点截图任务
    注意:此字段可能返回 null,表示取不到有效值。
    SampleSnapshotTask SampleSnapshotTaskInput 视频采样截图任务
    注意:此字段可能返回 null,表示取不到有效值。
    ImageSpriteTask ImageSpriteTaskInput 视频截雪碧图任务
    注意:此字段可能返回 null,表示取不到有效值。
    AdaptiveDynamicStreamingTask AdaptiveDynamicStreamingTaskInput 转自适应码流任务
    注意:此字段可能返回 null,表示取不到有效值。
    AiContentReviewTask AiContentReviewTaskInput 视频内容审核类型任务
    注意:此字段可能返回 null,表示取不到有效值。
    AiAnalysisTask AiAnalysisTaskInput 视频内容分析类型任务
    注意:此字段可能返回 null,表示取不到有效值。
    AiRecognitionTask AiRecognitionTaskInput 视频内容识别类型任务
    注意:此字段可能返回 null,表示取不到有效值。

    ActivityResItem

    编排子任务输出

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    TranscodeTask MediaProcessTaskTranscodeResult 转码任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AnimatedGraphicTask MediaProcessTaskAnimatedGraphicResult 转动图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    SnapshotByTimeOffsetTask MediaProcessTaskSnapshotByTimeOffsetResult 时间点截图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    SampleSnapshotTask MediaProcessTaskSampleSnapshotResult 采样截图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    ImageSpriteTask MediaProcessTaskImageSpriteResult 雪碧图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult 自适应码流任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    RecognitionTask ScheduleRecognitionTaskResult 识别任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    ReviewTask ScheduleReviewTaskResult 审核任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AnalysisTask ScheduleAnalysisTaskResult 分析任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    ActivityResult

    编排任务输出

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    ActivityType String 原子任务类型。
  • Transcode:转码。
  • SampleSnapshot:采样截图。
  • AnimatedGraphics:转动图。
  • SnapshotByTimeOffset:时间点截图。
  • ImageSprites:雪碧图。
  • AdaptiveDynamicStreaming:自适应码流。
  • AiContentReview:内容审核。
  • AIRecognition:智能识别。
  • AIAnalysis:智能分析。

  • 示例值:""
    ActivityResItem ActivityResItem 原子任务输出。
    示例值:NULL

    AdaptiveDynamicStreamingInfoItem

    转自适应码流信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 转自适应码流规格。
    Package String 打包格式,可能为 HLS和 MPEG-DASH 两种。
    Path String 播放路径。
    Storage TaskOutputStorage 自适应码流文件的存储位置。

    AdaptiveDynamicStreamingTaskInput

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

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 转自适应码流模板 ID。
    示例值:10
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    OutputStorage TaskOutputStorage 转自适应码流后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 转自适应码流后,manifest 文件的输出路径,可以为相对路径或者绝对路径。如果不填,则默认为相对路径:{inputName}_adaptiveDynamicStreaming_{definition}.{format}
    示例值:{inputName}adaptiveDynamicStreaming{definition}.{format}
    SubStreamObjectName String 转自适应码流后,子流文件的输出路径,只能为相对路径。如果不填,则默认为相对路径:{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}
    示例值:{inputName}adaptiveDynamicStreaming{definition}_{subStreamNumber}.{format}
    SegmentObjectName String 转自适应码流(仅 HLS)后,分片文件的输出路径,只能为相对路径。如果不填,则默认为相对路径:{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}
    示例值:{inputName}adaptiveDynamicStreaming{definition}{subStreamNumber}{segmentNumber}.{format}
    AddOnSubtitles Array of AddOnSubtitle 要插入的字幕文件。
    注意:此字段可能返回 null,表示取不到有效值。
    DrmInfo DrmInfo Drm信息。
    注意:此字段可能返回 null,表示取不到有效值。

    AdaptiveDynamicStreamingTemplate

    转自适应码流模板详情

    被如下接口引用:DescribeAdaptiveDynamicStreamingTemplates。

    名称 类型 描述
    Definition Integer 转自适应码流模板唯一标识。
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • Name String 转自适应码流模板名称。
    Comment String 转自适应码流模板描述信息。
    Format String 转自适应码流格式,取值范围:
  • HLS,
  • MPEG-DASH。
  • StreamInfos Array of AdaptiveStreamTemplate 转自适应码流输入流参数信息,最多输入10路流。
    DisableHigherVideoBitrate Integer 是否禁止视频低码率转高码率,取值范围:
  • 0:否,
  • 1:是。
  • DisableHigherVideoResolution Integer 是否禁止视频分辨率转高分辨率,取值范围:
  • 0:否,
  • 1:是。
  • CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式

    AdaptiveStreamTemplate

    自适应转码流参数模板

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

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

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

  • 示例值:0

    AddOnSubtitle

    外挂字幕。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Type String 插入形式,可选值:
  • subtitle-stream:插入字幕轨道
  • close-caption-708:CEA-708字幕编码到SEI帧
  • close-caption-608:CEA-608字幕编码到SEI帧

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

    AiAnalysisResult

    智能分析结果

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Type String 任务的类型,可以取的值有:
  • Classification:智能分类
  • Cover:智能封面
  • Tag:智能标签
  • FrameTag:智能按帧标签
  • Highlight:智能精彩集锦
  • DeLogo:智能去水印
  • Description:大模型摘要

  • 示例值:Classification
    ClassificationTask AiAnalysisTaskClassificationResult 视频内容分析智能分类任务的查询结果,当任务类型为 Classification 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    CoverTask AiAnalysisTaskCoverResult 视频内容分析智能封面任务的查询结果,当任务类型为 Cover 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    TagTask AiAnalysisTaskTagResult 视频内容分析智能标签任务的查询结果,当任务类型为 Tag 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    FrameTagTask AiAnalysisTaskFrameTagResult 视频内容分析智能按帧标签任务的查询结果,当任务类型为 FrameTag 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    HighlightTask AiAnalysisTaskHighlightResult 视频内容分析集锦任务的查询结果,当任务类型为 Highlight时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    DeLogoTask AiAnalysisTaskDelLogoResult 视频内容分析去水印任务的查询结果,当任务类型为 DeLogo 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    DescriptionTask AiAnalysisTaskDescriptionResult 视频内容分析摘要任务的查询结果,当任务类型为 Description 时有效。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskClassificationInput

    智能分类任务输入类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskClassificationOutput

    智能分类结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    ClassificationSet Array of MediaAiAnalysisClassificationItem 视频智能分类列表。

    AiAnalysisTaskClassificationResult

    智能分类任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiAnalysisTaskClassificationInput 智能分类任务输入。
    示例值:NULL
    Output AiAnalysisTaskClassificationOutput 智能分类任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiAnalysisTaskCoverInput

    智能分类任务输入类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskCoverOutput

    智能封面结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    CoverSet Array of MediaAiAnalysisCoverItem 智能封面列表。
    OutputStorage TaskOutputStorage 智能封面的存储位置。

    AiAnalysisTaskCoverResult

    智能封面结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiAnalysisTaskCoverInput 智能封面任务输入。
    示例值:NULL
    Output AiAnalysisTaskCoverOutput 智能封面任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiAnalysisTaskDelLogoInput

    智能去水印任务输入类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskDelLogoOutput

    智能去水印结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Path String 去水印后文件的路径。
    OutputStorage TaskOutputStorage 去水印后文件的存储位置。

    AiAnalysisTaskDelLogoResult

    智能去水印结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskDescriptionInput

    智能分类任务输入类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskDescriptionOutput

    智能描述结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    DescriptionSet Array of MediaAiAnalysisDescriptionItem 视频智能描述列表。

    AiAnalysisTaskDescriptionResult

    智能描述结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskFrameTagInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskFrameTagOutput

    智能按帧标签结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    SegmentSet Array of MediaAiAnalysisFrameTagSegmentItem 视频按帧标签列表。

    AiAnalysisTaskFrameTagResult

    智能按帧标签结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiAnalysisTaskFrameTagInput 智能按帧标签任务输入。
    示例值:NULL
    Output AiAnalysisTaskFrameTagOutput 智能按帧标签任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiAnalysisTaskHighlightInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskHighlightOutput

    智能精彩片段结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    HighlightSet Array of MediaAiAnalysisHighlightItem 视频智能精彩片段列表。
    OutputStorage TaskOutputStorage 精彩片段的存储位置。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskHighlightResult

    智能精彩片段结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiAnalysisTaskInput

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

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 视频内容分析模板 ID。
    示例值:0
    ExtendedParameter String 扩展参数,其值为序列化的 json字符串。
    注意:此参数为定制需求参数,需要线下对接。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”

    AiAnalysisTaskTagInput

    智能标签任务输入类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 视频智能标签模板 ID。
    示例值:0

    AiAnalysisTaskTagOutput

    智能标签结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    TagSet Array of MediaAiAnalysisTagItem 视频智能标签列表。

    AiAnalysisTaskTagResult

    智能标签结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiAnalysisTaskTagInput 智能标签任务输入。
    示例值:NULL
    Output AiAnalysisTaskTagOutput 智能标签任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiContentReviewResult

    内容审核结果

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    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 文字鉴违禁

  • 示例值:"Political"
    SampleRate Float 采样频率,即对视频每秒截取进行审核的帧数。
    示例值:0
    Duration Float 审核的视频时长,单位:秒。
    示例值:0
    PornTask AiReviewTaskPornResult 视频内容审核智能画面鉴黄任务的查询结果,当任务类型为 Porn 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    TerrorismTask AiReviewTaskTerrorismResult 视频内容审核智能画面敏感任务的查询结果,当任务类型为 Terrorism 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    PoliticalTask AiReviewTaskPoliticalResult 视频内容审核智能画面敏感任务的查询结果,当任务类型为 Political 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    PornAsrTask AiReviewTaskPornAsrResult 视频内容审核 Asr 文字鉴黄任务的查询结果,当任务类型为 Porn.Asr 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    PornOcrTask AiReviewTaskPornOcrResult 视频内容审核 Ocr 文字鉴黄任务的查询结果,当任务类型为 Porn.Ocr 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    PoliticalAsrTask AiReviewTaskPoliticalAsrResult 视频内容审核 Asr 文字敏感任务的查询结果,当任务类型为 Political.Asr 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    PoliticalOcrTask AiReviewTaskPoliticalOcrResult 视频内容审核 Ocr 文字敏感任务的查询结果,当任务类型为 Political.Ocr 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    TerrorismOcrTask AiReviewTaskTerrorismOcrResult 视频内容审核 Ocr 文字敏感任务的查询结果,当任务类型为 Terrorism.Ocr 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    ProhibitedAsrTask AiReviewTaskProhibitedAsrResult 视频内容审核 Asr 文字鉴违禁任务的查询结果,当任务类型为 Prohibited.Asr 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    ProhibitedOcrTask AiReviewTaskProhibitedOcrResult 视频内容审核 Ocr 文字鉴违禁任务的查询结果,当任务类型为 Prohibited.Ocr 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiContentReviewTaskInput

    智能内容审核任务类型

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 视频内容审核模板 ID。
    示例值:10

    AiParagraphInfo

    分段信息。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Summary String 分段摘要
    注意:此字段可能返回 null,表示取不到有效值。
    StartTimeOffset Float 分段起始时间点,秒
    注意:此字段可能返回 null,表示取不到有效值。
    EndTimeOffset Float 分段结束时间点,秒
    注意:此字段可能返回 null,表示取不到有效值。

    AiQualityControlTaskInput

    视频质检输入参数类型

    被如下接口引用:DescribeTaskDetail, ParseNotification, ProcessLiveStream, ProcessMedia。

    名称 类型 必选 描述
    Definition Integer 视频质检模板 ID 。暂时可以直接使用 预设模板ID 10,后面控制台支持用户配置自定义模板。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    ChannelExtPara String 渠道扩展参数json序列化字符串。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""

    AiRecognitionResult

    智能识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Type String 任务的类型,取值范围:
  • FaceRecognition:人脸识别,
  • AsrWordsRecognition:语音关键词识别,
  • OcrWordsRecognition:文本关键词识别,
  • AsrFullTextRecognition:语音全文识别,
  • OcrFullTextRecognition:文本全文识别。
  • TransTextRecognition:语音翻译。

  • 示例值:FaceRecognition
    FaceTask AiRecognitionTaskFaceResult 人脸识别结果,当 Type 为
    FaceRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AsrWordsTask AiRecognitionTaskAsrWordsResult 语音关键词识别结果,当 Type 为
    AsrWordsRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AsrFullTextTask AiRecognitionTaskAsrFullTextResult 语音全文识别结果,当 Type 为
    AsrFullTextRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    OcrWordsTask AiRecognitionTaskOcrWordsResult 文本关键词识别结果,当 Type 为
    OcrWordsRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    OcrFullTextTask AiRecognitionTaskOcrFullTextResult 文本全文识别结果,当 Type 为
    OcrFullTextRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    TransTextTask AiRecognitionTaskTransTextResult 翻译结果,当 Type 为

    TransTextRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    ObjectTask AiRecognitionTaskObjectResult 物体识别结果,当Type 为

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

    AiRecognitionTaskAsrFullTextResult

    语音全文识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiRecognitionTaskAsrFullTextResultInput 语音全文识别任务输入信息。
    示例值:NULL
    Output AiRecognitionTaskAsrFullTextResultOutput 语音全文识别任务输出信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    Progress Integer 任务进度。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100

    AiRecognitionTaskAsrFullTextResultInput

    语音全文识别的输入。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskAsrFullTextResultOutput

    语音全文识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    SegmentSet Array of AiRecognitionTaskAsrFullTextSegmentItem 语音全文识别片段列表。
    SubtitlePath String 字幕文件地址。
    示例值:http://lily-1256342427.cos.ap-shanghai.myqcloud.com/3109868718.vtt

    AiRecognitionTaskAsrFullTextSegmentItem

    语音全文识别片段。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskAsrWordsResult

    语音关键词识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiRecognitionTaskAsrWordsResultInput 语音关键词识别任务输入信息。
    示例值:NULL
    Output AiRecognitionTaskAsrWordsResultOutput 语音关键词识别任务输出信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiRecognitionTaskAsrWordsResultInput

    语音关键词识别输入。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskAsrWordsResultItem

    语音关键词识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskAsrWordsResultOutput

    语音关键词识别输出。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskAsrWordsResultItem 语音关键词识别结果集。

    AiRecognitionTaskAsrWordsSegmentItem

    语音识别片段。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskFaceResult

    人脸识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiRecognitionTaskFaceResultInput 人脸识别任务输入信息。
    示例值:NULL
    Output AiRecognitionTaskFaceResultOutput 人脸识别任务输出信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiRecognitionTaskFaceResultInput

    人脸识别输入。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskFaceResultItem

    人脸识别结果

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Id String 人物唯一标识 ID。
    示例值:9527
    Type String 人物库类型,表示识别出的人物来自哪个人物库:
  • Default:默认人物库;
  • UserDefine:用户自定义人物库。

  • 示例值:Default
    Name String 人物名称。
    示例值:张三
    SegmentSet Array of AiRecognitionTaskFaceSegmentItem 人物出现的片段结果集。
    示例值:NULL
    Gender String 人物性别:
  • Male:男性;
  • Female:女性。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:Male
    Birthday String 人物出生日期。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1953年6月
    Profession String 人物职业或者职务。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:歌手
    SchoolOfGraduation String 人物毕业院校。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:清华大学
    Abstract String 人物简介。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    PlaceOfBirth String 人物出生地或者籍贯。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:湖北武汉
    PersonType String 人物类型:
  • Politician:官员;
  • Artist:艺人。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:Politician
    Remark String 敏感度标注:
  • Normal:正常;
  • Sensitive:敏感。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:Normal
    Url String 截图链接
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""

    AiRecognitionTaskFaceResultOutput

    智能人脸识别输出。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskFaceResultItem 智能人脸识别结果集。

    AiRecognitionTaskFaceSegmentItem

    人脸识别结果片段

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskInput

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

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow。

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

    AiRecognitionTaskObjectResult

    物体识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskObjectResultInput

    物体识别任务输入类型。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskObjectResultItem

    单个物体识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskObjectResultOutput

    智能物体识别输出。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskObjectResultItem 智能物体识别结果集。

    AiRecognitionTaskObjectSeqmentItem

    物体识别结果片段。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskOcrFullTextResult

    文本全文识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiRecognitionTaskOcrFullTextResultInput 文本全文识别任务输入信息。
    示例值:NULL
    Output AiRecognitionTaskOcrFullTextResultOutput 文本全文识别任务输出信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiRecognitionTaskOcrFullTextResultInput

    文本全文识别输入。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskOcrFullTextResultOutput

    文本全文识别输出。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    SegmentSet Array of AiRecognitionTaskOcrFullTextSegmentItem 文本全文识别结果集。

    AiRecognitionTaskOcrFullTextSegmentItem

    文本全文识别片段。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskOcrFullTextSegmentTextItem

    文本全文识别片段。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskOcrWordsResult

    文本关键识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiRecognitionTaskOcrWordsResultInput 文本关键词识别任务输入信息。
    示例值:NULL
    Output AiRecognitionTaskOcrWordsResultOutput 文本关键词识别任务输出信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiRecognitionTaskOcrWordsResultInput

    文本关键词识别输入。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskOcrWordsResultItem

    文本关键词识别结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskOcrWordsResultOutput

    文本关键词识别输出。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    ResultSet Array of AiRecognitionTaskOcrWordsResultItem 文本关键词识别结果集。

    AiRecognitionTaskOcrWordsSegmentItem

    文本识别片段。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiRecognitionTaskTransTextResult

    翻译结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiRecognitionTaskTransTextResultInput 翻译任务输入信息。
    示例值:NULL
    Output AiRecognitionTaskTransTextResultOutput 翻译任务输出信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    Progress Integer 任务进度。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100

    AiRecognitionTaskTransTextResultInput

    翻译的输入。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 翻译模板 ID。
    示例值:123

    AiRecognitionTaskTransTextResultOutput

    翻译结果。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    SegmentSet Array of AiRecognitionTaskTransTextSegmentItem 翻译片段列表。
    示例值:NULL
    SubtitlePath String 字幕文件地址。
    示例值:http://lily-1256342427.cos.ap-shanghai.myqcloud.com/3109868718.vtt

    AiRecognitionTaskTransTextSegmentItem

    翻译片段。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float 识别片段置信度。取值:0~100。
    示例值:100
    StartTimeOffset Float 识别片段起始的偏移时间,单位:秒。
    示例值:17.45
    EndTimeOffset Float 识别片段终止的偏移时间,单位:秒。
    示例值:29.99
    Text String 识别文本。
    示例值:你好
    Trans String 翻译文本。
    示例值:Hello

    AiReviewPoliticalAsrTaskInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 模板 ID。
    示例值:0

    AiReviewPoliticalAsrTaskOutput

    Asr 文字敏感信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float Asr 文字敏感评分,分值为0到100。
    示例值:0
    Suggestion String Asr 文字敏感结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 示例值:“”
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字敏感嫌疑的视频片段列表。

    AiReviewPoliticalOcrTaskInput

    内容审核 Ocr 文字敏感任务输入参数类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 模板 ID。
    示例值:0

    AiReviewPoliticalOcrTaskOutput

    Ocr 文字敏感信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float Ocr 文字敏感评分,分值为0到100。
    示例值:0
    Suggestion String Ocr 文字敏感结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 示例值:""
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有敏感嫌疑的视频片段列表。

    AiReviewPoliticalTaskInput

    内容审核敏感任务输入参数类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 模板 ID。
    示例值:0

    AiReviewPoliticalTaskOutput

    涉敏信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float 视频涉敏评分,分值为0到100。
    示例值:0
    Suggestion String 涉敏结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 示例值:""
    Label String 视频涉敏结果标签。内容审核模板画面涉敏任务控制参数里 LabelSet 参数与此参数取值范围的对应关系:
    violation_photo:
  • violation_photo:违规图标。

  • 其他(即 politician/entertainment/sport/entrepreneur/scholar/celebrity/military):
  • politician:涉敏人物。

  • 示例值:""
    SegmentSet Array of MediaContentReviewPoliticalSegmentItem 有涉敏嫌疑的视频片段列表。

    AiReviewPornAsrTaskInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiReviewPornAsrTaskOutput

    Asr 文字涉黄信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float Asr 文字涉黄评分,分值为0到100。
    Suggestion String Asr 文字涉黄结果建议,取值范围:
  • pass。
  • review。
  • block。
  • SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉黄嫌疑的视频片段列表。

    AiReviewPornOcrTaskInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiReviewPornOcrTaskOutput

    Ocr 文字涉黄信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float Ocr 文字涉黄评分,分值为0到100。
    Suggestion String Ocr 文字涉黄结果建议,取值范围:
  • pass。
  • review。
  • block。
  • SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉黄嫌疑的视频片段列表。

    AiReviewPornTaskInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 必选 描述
    Definition Integer 鉴黄模板 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10

    AiReviewPornTaskOutput

    鉴黄结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float 视频鉴黄评分,分值为0到100。
    Suggestion String 鉴黄结果建议,取值范围:
  • pass。
  • review。
  • block。
  • Label String 视频鉴黄结果标签,取值范围:
  • porn:色情。
  • sexy:性感。
  • vulgar:低俗。
  • intimacy:亲密行为。
  • SegmentSet Array of MediaContentReviewSegmentItem 有涉黄嫌疑的视频片段列表。

    AiReviewProhibitedAsrTaskInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiReviewProhibitedAsrTaskOutput

    Asr 文字涉违禁信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float Asr 文字涉违禁评分,分值为0到100。
    Suggestion String Asr 文字涉违禁结果建议,取值范围:
  • pass。
  • review。
  • block。
  • SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉违禁嫌疑的视频片段列表。

    AiReviewProhibitedOcrTaskInput

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    AiReviewProhibitedOcrTaskOutput

    Ocr 文字涉违禁信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Confidence Float Ocr 文字涉违禁评分,分值为0到100。
    Suggestion String Ocr 文字涉违禁结果建议,取值范围:
  • pass。
  • review。
  • block。
  • SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉违禁嫌疑的视频片段列表。

    AiReviewTaskPoliticalAsrResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:""
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:""
    Input AiReviewPoliticalAsrTaskInput 内容审核 Asr 文字敏感任务输入。
    Output AiReviewPoliticalAsrTaskOutput 内容审核 Asr 文字敏感任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskPoliticalOcrResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS,FAIL 三种。
    示例值:""
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:""
    Input AiReviewPoliticalOcrTaskInput 内容审核 Ocr 文字敏感任务输入。
    Output AiReviewPoliticalOcrTaskOutput 内容审核 Ocr 文字敏感任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskPoliticalResult

    内容审核涉敏任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:""
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:""
    Input AiReviewPoliticalTaskInput 内容审核涉敏任务输入。
    Output AiReviewPoliticalTaskOutput 内容审核涉敏任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskPornAsrResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiReviewPornAsrTaskInput 内容审核 Asr 文字鉴黄任务输入。
    示例值:NULL
    Output AiReviewPornAsrTaskOutput 内容审核 Asr 文字鉴黄任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskPornOcrResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiReviewPornOcrTaskInput 内容审核 Ocr 文字鉴黄任务输入。
    示例值:NULL
    Output AiReviewPornOcrTaskOutput 内容审核 Ocr 文字鉴黄任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskPornResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiReviewPornTaskInput 内容审核鉴黄任务输入。
    示例值:NULL
    Output AiReviewPornTaskOutput 内容审核鉴黄任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskProhibitedAsrResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiReviewProhibitedAsrTaskInput 内容审核 Asr 文字鉴违禁任务输入。
    示例值:NULL
    Output AiReviewProhibitedAsrTaskOutput 内容审核 Asr 文字鉴违禁任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskProhibitedOcrResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AiReviewProhibitedOcrTaskInput 内容审核 Ocr 文字鉴违禁任务输入。
    示例值:NULL
    Output AiReviewProhibitedOcrTaskOutput 内容审核 Ocr 文字鉴违禁任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskTerrorismOcrResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:""
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:""
    Input AiReviewTerrorismOcrTaskInput 内容审核 Ocr 文字敏感任务输入。
    示例值:NULL
    Output AiReviewTerrorismOcrTaskOutput 内容审核 Ocr 文字敏感任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTaskTerrorismResult

    内容审核涉敏任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:""
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:""
    Input AiReviewTerrorismTaskInput 内容审核涉敏任务输入。
    示例值:NULL
    Output AiReviewTerrorismTaskOutput 内容审核涉敏任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AiReviewTerrorismOcrTaskInput

    内容审核 Ocr 文字敏感任务输入参数类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 模板 ID。
    示例值:0

    AiReviewTerrorismOcrTaskOutput

    Ocr 文字涉敏信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

  • 示例值:""
    SegmentSet Array of MediaContentReviewOcrTextSegmentItem Ocr 文字有涉敏嫌疑的视频片段列表。
    示例值:NULL

    AiReviewTerrorismTaskInput

    内容审核涉敏任务输入参数类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 模板 ID。
    示例值:0

    AiReviewTerrorismTaskOutput

    涉敏信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    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 有涉敏嫌疑的视频片段列表。
    示例值:[]

    AiSampleFaceInfo

    AI 样本管理,人脸信息。

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

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

    AiSampleFaceOperation

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

    被如下接口引用:ModifyPersonSample。

    名称 类型 必选 描述
    Type String 操作类型,可选值:add(添加)、delete(删除)、reset(重置)。重置操作将清空该人物已有人脸数据,并添加 FaceContents 指定人脸数据。
    FaceIds Array of String 人脸 ID 集合,当 Type为delete 时,该字段必填。
    FaceContents Array of String 人脸图片 Base64 编码后的字符串集合。
  • 当 Type为add 或 reset 时,该字段必填;
  • 数组长度限制:5 张图片。

  • 注意:图片必须是单人像正面人脸较清晰的照片,像素不低于 200*200。

    AiSampleFailFaceInfo

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

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

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

    AiSamplePerson

    AI 样本管理,人物信息。

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

    名称 类型 描述
    PersonId String 人物 ID。
    示例值:9527
    Name String 人物名称。
    示例值:Default
    Description String 人物描述。
    示例值:张三
    FaceInfoSet Array of AiSampleFaceInfo 人脸信息。
    示例值:NULL
    TagSet Array of String 人物标签。
    示例值:NULL
    UsageSet Array of String 应用场景。
    示例值:NULL
    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

    转动图任务类型。

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 视频转动图模板 ID。
    StartTimeOffset Float 动图在视频中的开始时间,单位为秒。
    EndTimeOffset Float 动图在视频中的结束时间,单位为秒。
    OutputStorage TaskOutputStorage 转动图后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 转动图后文件的输出路径,可以为相对路径或者绝对路径。如果不填,则默认为相对路径:{inputName}_animatedGraphic_{definition}.{format}

    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 日期格式

    ArtifactRepairConfig

    去伪影(毛刺)配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • weak
  • strong

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

    AsrFullTextConfigureInfo

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

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

    名称 类型 必选 描述
    Switch String 语音全文识别任务开关,可选值:
  • ON:开启智能语音全文识别任务;
  • OFF:关闭智能语音全文识别任务。
  • SubtitleFormat String 生成的字幕文件格式,不填或者填空字符串表示不生成字幕文件,可选值:
  • vtt:生成 WebVTT 字幕文件。
  • SourceLanguage String 视频源语言。

    AsrFullTextConfigureInfoForUpdate

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

    被如下接口引用:ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 语音全文识别任务开关,可选值:
  • ON:开启智能语音全文识别任务;
  • OFF:关闭智能语音全文识别任务。
  • SubtitleFormat String 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值:
  • vtt:生成 WebVTT 字幕文件。
  • SourceLanguage String 视频源语言。

    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 个字符。

    AudioBeautifyConfig

    音量美化配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Types Array of String 类型,可多选,可选值:
  • declick:杂音去除
  • deesser:齿音压制

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

    AudioDenoiseConfig

    音频降噪配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”

    AudioEnhanceConfig

    音频增强配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Denoise AudioDenoiseConfig 音频降噪配置。
    注意:此字段可能返回 null,表示取不到有效值。
    Separate AudioSeparateConfig 音频分离配置。
    注意:此字段可能返回 null,表示取不到有效值。
    VolumeBalance VolumeBalanceConfig 音量均衡配置。
    注意:此字段可能返回 null,表示取不到有效值。
    Beautify AudioBeautifyConfig 音频美化配置。
    注意:此字段可能返回 null,表示取不到有效值。

    AudioSeparateConfig

    音频分离配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 场景类型,可选值:
  • normal:人声背景声场景
  • music:演唱伴奏场景

  • 默认值:normal。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”
    Track String 输出音轨,可选值:
  • vocal:输出人声
  • background:应用场景为normal时输出背景声,应用场景为music时输出伴奏

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

    AudioTemplateInfo

    音频流配置参数

    被如下接口引用:CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Codec String 音频流的编码格式。
    当不需要对音频进行转码时,可选值为:
  • copy。

  • 当外层参数 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;
  • libmp3lame。

  • 示例值:libfdk_aac
    Bitrate Integer 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。
    当取值为 0,表示音频码率和原始音频保持一致。
    示例值:0
    SampleRate Integer 音频流的采样率,可选值:
  • 32000
  • 44100
  • 48000

  • 单位:Hz。
    示例值:44100
    AudioChannel Integer 音频通道方式,可选值:
  • 1:单通道
  • 2:双通道
  • 6:5.1声道

  • 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为5.1声道。
    默认值:2。
    示例值:2

    AudioTemplateInfoForUpdate

    音频流配置参数

    被如下接口引用:CreateWorkflow, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Codec String 音频流的编码格式。
    当不需要对音频进行转码时,可选值为:
  • copy。

  • 当外层参数 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;
  • libmp3lame。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:libmp3lame
    Bitrate Integer 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SampleRate Integer 音频流的采样率,可选值:
  • 32000
  • 44100
  • 48000

  • 单位:Hz。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:44100
    AudioChannel Integer 音频通道方式,可选值:
  • 1:单通道
  • 2:双通道
  • 6:5.1声道

  • 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为5.1声道。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    StreamSelects Array of Integer 指定输出要保留的音频轨道。默认是全部保留源的。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    AwsS3FileUploadTrigger

    AWS S3 文件是上传触发器。

    被如下接口引用:CreateSchedule, CreateWorkflow, ModifySchedule, ResetWorkflow。

    名称 类型 必选 描述
    S3Bucket String 绑定的 AWS S3 存储桶。
    示例值:test
    S3Region String 绑定的桶所在 AWS 区域,目前支持:
    us-east-1
    eu-west-3
    Dir String 绑定的输入路径目录,必须为绝对路径,即以 / 开头和结尾。如/movie/201907/,不填代表根目录/
    Formats Array of String 允许触发的文件格式列表,如 ["mp4", "flv", "mov"]。不填代表所有格式的文件都可以触发工作流。
    S3SecretId String 绑定的 AWS S3 存储桶的秘钥ID。
    注意:此字段可能返回 null,表示取不到有效值。
    S3SecretKey String 绑定的 AWS S3 存储桶的秘钥Key。
    注意:此字段可能返回 null,表示取不到有效值。
    AwsSQS AwsSQS 绑定的 AWS S3 存储桶对应的 SQS事件队列。
    注意:队列和桶需要在同一区域。
    注意:此字段可能返回 null,表示取不到有效值。

    AwsSQS

    Aws SQS 队列信息

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, EditMedia, ModifySchedule, ProcessMedia, ResetWorkflow, WithdrawsWatermark。

    名称 类型 必选 描述
    SQSRegion String SQS 队列区域。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-southeast-1
    SQSQueueName String SQS 队列名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    S3SecretId String 读写SQS的秘钥id。
    注意:此字段可能返回 null,表示取不到有效值。
    S3SecretKey String 读写SQS的秘钥key。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx

    ClassificationConfigureInfo

    智能分类任务控制参数

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

    名称 类型 必选 描述
    Switch String 智能分类任务开关,可选值:
  • ON:开启智能分类任务;
  • OFF:关闭智能分类任务。
  • ClassificationConfigureInfoForUpdate

    智能分类任务控制参数

    被如下接口引用:ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 智能分类任务开关,可选值:
  • ON:开启智能分类任务;
  • OFF:关闭智能分类任务。
  • ColorEnhanceConfig

    色彩增强配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • weak
  • normal
  • strong

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

    ComposeAudioItem

    视频编辑/合成任务 音频元素信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    SourceMedia ComposeSourceMedia 元素对应媒体信息。
    TrackTime ComposeTrackTime 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。
    AudioOperations Array of ComposeAudioOperation 对音频进行操作,如静音等。

    ComposeAudioOperation

    视频编辑/合成任务 音频操作。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Type String 音频操作类型,取值有:
  • Volume:音量调节。
  • Volume Float 当 Type = Volume 时有效。音量调节参数,取值范围: 0~5。
  • 0 表示静音。
  • 小于1 表示降低音量。
  • 1 表示不变。
  • 大于1表示升高音量。
  • ComposeAudioStream

    视频编辑/合成任务 音频流信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Codec String 音频流的编码方式,可选值:
  • AAC:AAC 编码(默认),用于容器为 mp4。
  • MP3:mp3 编码,用于容器为 mp3。
  • SampleRate Integer 音频流的采样率,单位:Hz,可选值:
  • 16000(默认)
  • 32000
  • 44100
  • 48000
  • AudioChannel Integer 声道数,可选值:
  • 1:单声道 。
  • 2:双声道(默认)。
  • Bitrate Integer 参考码率,单位 kbps,范围:26~10000。
    如果设置,编码时会尽量按该码率进行编码。
    如果不设置,服务将根据音频参数自动采用合适的码率。

    ComposeCanvas

    视频编辑/合成任务画布信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Color String 背景颜色对应的 RGB 参考值,取值格式: #RRGGBB,如 #F0F0F0 。
    默认值:#000000(黑色)。
    Width Integer 画布宽度,即输出视频的宽度,取值范围:0~ 3840,单位:px。
    默认值:0,表示和第一个视频宽度一致。
    Height Integer 画布高度,即输出视频的高度,取值范围:0~ 3840,单位:px。
    默认值:0,表示和第一个视频高度一致。

    ComposeEmptyItem

    视频编辑/合成任务 空白占位元素信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Duration String 元素时长,时间支持:
  • 以 s 结尾,表示时间点单位为秒,如 3.5s 表示时间点为第3.5秒。
  • ComposeImageItem

    视频编辑/合成任务 图片元素信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    SourceMedia ComposeSourceMedia 元素对应媒体信息。
    TrackTime ComposeTrackTime 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。
    XPos String 元素中心点距离画布原点的水平位置。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 XPos 为画布宽度指定百分比的位置,如 10% 表示 XPos 为画布宽度的 10%。
  • 当字符串以 px 结尾,表示元素 XPos 单位为像素,如 100px 表示 XPos 为100像素。

  • 默认:50%。
    YPos String 元素中心点距离画布原点的垂直位置。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 YPos 为画布高度指定百分比的位置,如 10% 表示 YPos 为画布高度的 10%。
  • 当字符串以 px 结尾,表示元素 YPos 单位为像素,如 100px 表示 YPos 为100像素。

  • 默认:50%。
    Width String 视频片段的宽度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 Width 为画布宽度的百分比大小,如 10% 表示 Width 为画布宽度的 10%。
  • 当字符串以 px 结尾,表示元素 Width 单位为像素,如 100px 表示 Width 为100像素。

  • 为空(或0) 的场景:
  • 当 Width、Height 均为空,则 Width 和 Height 取源素材本身的 Width、Height。
  • 当 Width 为空,Height 非空,则 Width 按源素材比例缩放。
  • 当 Width 非空,Height 为空,则 Height 按源素材比例缩放。
  • Height String 元素的高度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 Height 为画布高度的百分比大小,如 10% 表示 Height 为画布高度的 10%。
  • 当字符串以 px 结尾,表示元素 Height 单位为像素,如 100px 表示 Height 为100像素。

  • 为空(或0) 的场景:
  • 当 Width、Height 均为空,则 Width 和 Height 取源素材本身的 Width、Height。
  • 当 Width 为空,Height 非空,则 Width 按源素材比例缩放。
  • 当 Width 非空,Height 为空,则 Height 按源素材比例缩放。
  • ImageOperations Array of ComposeImageOperation 对图像画面进行的操作,如图像旋转等。

    ComposeImageOperation

    视频编辑/合成任务 视频图像转换操作。

    被如下接口引用:EditMedia。

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

    视频编辑/合成任务 信息。

    关于 轨道、元素、时间轴 关系示意图:

    image

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    TargetInfo ComposeTargetInfo 合成目标视频信息。
    Canvas ComposeCanvas 合成目标视频的画布信息。
    Styles Array of ComposeStyles 全局样式,和轨道 Tracks 配合使用,用于定于样式,如字幕样式。
    Tracks Array of ComposeMediaTrack 用于描述合成视频的轨道列表,包括:视频、音频、图片、文字等元素组成的多个轨道信息。关于轨道和时间:
    • 轨道时间轴即为目标视频时间轴。
    • 时间轴上相同时间点的不同轨道上的元素会重叠:
      • 视频、图片、文字:按轨道顺序进行图像的叠加,轨道顺序靠前的在上面。
      • 音频 :进行混音。
    注意:同一轨道中各个元素(除字幕元素外)的轨道时间不能重叠。

    ComposeMediaItem

    视频编辑/合成任务 轨道元素信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Type String 元素类型。取值有:
  • Video:视频元素。
  • Audio:音频元素。
  • Image:图片元素。
  • Transition:转场元素。
  • Subtitle:字幕元素。
  • Empty:空白元素。
  • Video ComposeVideoItem 视频元素,当 Type = Video 时有效。
    Audio ComposeAudioItem 音频元素,当 Type = Audio 时有效。
    Image ComposeImageItem 图片元素,当 Type = Image 时有效。
    Transition ComposeTransitionItem 转场元素,当 Type = Transition 时有效。
    Subtitle ComposeSubtitleItem 字幕元素,当 Type = Subtitle 是有效。
    Empty ComposeEmptyItem 空白元素,当 Type = Empty 时有效。用于时间轴的占位。

    ComposeMediaTrack

    视频编辑/合成任务 轨道信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Type String 轨道类型,取值有:
    • Video :视频轨道。视频轨道可由以下元素组成:
      • Video 元素
      • Image 元素
      • Transition 元素
      • Empty 元素
    • Audio :音频轨道。音频轨道可由以下元素组成:
      • Audio 元素
      • Transition 元素
      • Empty 元素
    • Title:文字轨道。文字轨道可由以下元素组成:
      • Subtitle 元素
    Items Array of ComposeMediaItem 轨道上的元素列表。

    ComposeSourceMedia

    视频编辑/合成任务 媒体素材源信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    FileId String 媒体对应的素材ID,即 FileInfos 列表中对应素材的 ID。
    StartTime String 媒体位于素材的起始时间,时间点支持 s、% 两种格式:
  • 当字符串以 s 结尾,表示时间点单位为秒,如 3.5s 表示时间点为第3.5秒;
  • 当字符串以 % 结尾,表示时间点为素材时长的百分比大小,如10%表示时间点为素材第10% 的时刻。

  • 默认:0s
    EndTime String 媒体位于素材的结束时间,和 StartTime 构成媒体在源素材的时间区间,时间点支持 s、% 两种格式:
  • 当字符串以 s 结尾,表示时间点单位为秒,如 3.5s 表示时间点为第3.5秒;
  • 当字符串以 % 结尾,表示时间点为素材时长的百分比大小,如10%表示时间点为素材第10%的时间。

  • 默认:如果对应轨道时长有设置,则默认轨道时长,否则为素材时长,无时长的素材默认为 1 秒。
    注意:至少需要大于 StartTime 0.02 秒。

    ComposeStyles

    视频编辑/合成任务 样式信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Id String 样式 Id,用于和轨道元素中的样式关联。
    注意:允许字母、数字、-、_ 组合,最长 32 字符。
    Type String 样式类型,取值有:
  • Subtitle:字幕样式。
  • Subtitle ComposeSubtitleStyle 字幕样式信息,当 Type = Subtitle 时有效。

    ComposeSubtitleItem

    视频编辑/合成任务 字幕元素信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    StyleId String 字幕样式,Styles 列表中对应的 Subtitle样式的 ID。
    Text String 字幕文本。
    TrackTime ComposeTrackTime 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。

    ComposeSubtitleStyle

    视频编辑/合成任务 字幕样式。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Height String 字幕高度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示为画布高度的百分比大小,如 10% 表示为画布高度的 10%。
  • 当字符串以 px 结尾,表示单位为像素,如 100px 表示为100像素。

  • 默认为 FontSize 大小。
    MarginBottom String 字幕距离下边框距离,支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示为画布高度的百分比大小,如 10% 表示为画布高度的 10%。
  • 当字符串以 px 结尾,表示单位为像素,如 100px 表示为100像素。

  • 默认:0px
    FontType String 字体类型,支持:
  • SimHei:黑体(默认)。
  • SimSun:宋体。
  • FontSize String 字体大小,支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示为画布高度的百分比大小,如 10% 表示为画布高度的 10%。
  • 当字符串以 px 结尾,表示单位为像素,如 100px 表示为100像素。

  • 默认:2%
    FontBold Integer 是否使用粗体,和字体相关,可选值:
  • 0:否(默认)。
  • 1:是。
  • FontItalic Integer 是否使用斜体,和字体相关,可选值:
  • 0:否(默认)。
  • 1:是。
  • FontColor String 字体颜色,格式:#RRGGBBAA。
    默认值:0x000000FF(黑色)。
    注意:其中 AA 部分指的是透明度,为可选。
    FontAlign String 文字对齐方式:
  • Center:居中(默认)。
  • Left:左对齐。
  • Right:右对齐。
  • FontAlignMargin String 用于字幕对齐留白:
  • FontAlign=Left 时,表示距离左边距离。
  • FontAlign=Right时,表示距离右边距离。

  • 支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示为画布宽度的百分比大小,如 10% 表示为画布宽度的 10%。
  • 当字符串以 px 结尾,表示单位为像素,如 100px 表示为100像素。
  • BorderWidth String 字体边框宽度,支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示为画布高度的百分比大小,如 10% 表示为画布高度的 10%。
  • 当字符串以 px 结尾,表示单位为像素,如 100px 表示为100像素。

  • 默认: 0,表示不需要边框。
    BorderColor String 边框颜色,当 BorderWidth 不为 0 时生效,其值格式和 FontColor 一致。
    BottomColor String 文字底色,其值格式和 FontColor 一致。
    默认为空, 表示不使用底色。

    ComposeTargetInfo

    视频编辑/合成任务 目标视频信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Container String 封装容器格式,可选值:
  • mp4:视频文件(默认)。
  • mp3:纯音频文件。
  • RemoveVideo Integer 是否去除视频数据,可选值:
  • 0:保留(默认)。
  • 1:去除。
  • RemoveAudio Integer 是否去除音频数据,可选值:
  • 0:保留(默认)。
  • 1:去除。
  • VideoStream ComposeVideoStream 输出视频流信息。
    AudioStream ComposeAudioStream 输出音频流信息。

    ComposeTrackTime

    视频编辑/合成任务 对应元素在目标视频轨道上的时间信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Start String 元素在轨道上的起始时间,时间点支持:
  • 以 s 结尾,表示时间点单位为秒,如 3.5s 表示时间点为第3.5秒;

  • 注意:不填则默认为前一个元素的结束时间,此时可以通过 ComposeEmptyItem 元素来进行占位,实现轨道起始时间设置。
    Duration String 元素时长,时间支持:
  • 以 s 结尾,表示时间点单位为秒,如 3.5s 表示时间点为第3.5秒;

  • 默认:取对应 ComposeSourceMedia 媒体的有效时长(即 EndTime-StartTime),没有 ComposeSourceMedia 则默认为 1 秒。

    ComposeTransitionItem

    视频编辑/合成任务 转场元素信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Duration String 元素时长,时间支持:
  • 以 s 结尾,表示时间点单位为秒,如 3s 表示时间点为第3秒。

  • 默认:1s
    注意:
  • 必须是整数s,否则向下取整。
  • 转场 前后必须紧挨着两个不为 Empty 的元素。
  • 转场 Duration 必须小于前一个元素的 Duration,同时必须小于后一个元素的 Duration。
  • 进行转场处理的两个元素,第二个元素在轨道上的起始时间会自动调整为前一个元素的结束时间减去转场的 Duration。
  • Transitions Array of ComposeTransitionOperation 转场操作列表。
    默认:淡入淡出。
    注意:图像转场操作和音频转场操作各自最多支持一个。

    ComposeTransitionOperation

    视频编辑/合成任务 元素转场信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    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:声音淡入淡出。
  • ComposeVideoItem

    视频编辑/合成任务 视频元素信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    SourceMedia ComposeSourceMedia 元素对应媒体信息。
    TrackTime ComposeTrackTime 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。
    XPos String 元素中心点距离画布原点的水平位置。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 XPos 为画布宽度指定百分比的位置,如 10% 表示 XPos 为画布宽度的 10%。
  • 当字符串以 px 结尾,表示元素 XPos 单位为像素,如 100px 表示 XPos 为100像素。

  • 默认:50%。
    YPos String 元素中心点距离画布原点的垂直位置。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 YPos 为画布高度指定百分比的位置,如 10% 表示 YPos 为画布高度的 10%。
  • 当字符串以 px 结尾,表示元素 YPos 单位为像素,如 100px 表示 YPos 为100像素。

  • 默认:50%。
    Width String 视频片段的宽度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 Width 为画布宽度的百分比大小,如 10% 表示 Width 为画布宽度的 10%。
  • 当字符串以 px 结尾,表示元素 Width 单位为像素,如 100px 表示 Width 为100像素。

  • 为空(或0) 的场景:
  • 当 Width、Height 均为空,则 Width 和 Height 取源素材本身的 Width、Height。
  • 当 Width 为空,Height 非空,则 Width 按源素材比例缩放。
  • 当 Width 非空,Height 为空,则 Height 按源素材比例缩放。
  • Height String 元素的高度。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示元素 Height 为画布高度的百分比大小,如 10% 表示 Height 为画布高度的 10%。
  • 当字符串以 px 结尾,表示元素 Height 单位为像素,如 100px 表示 Height 为100像素。

  • 为空(或0) 的场景:
  • 当 Width、Height 均为空,则 Width 和 Height 取源素材本身的 Width、Height。
  • 当 Width 为空,Height 非空,则 Width 按源素材比例缩放。
  • 当 Width 非空,Height 为空,则 Height 按源素材比例缩放。
  • ImageOperations Array of ComposeImageOperation 对图像画面进行的操作,如图像旋转等。
    AudioOperations Array of ComposeAudioOperation 对音频进行操作,如静音等。

    ComposeVideoStream

    视频编辑/合成任务 视频流信息。

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Codec String 视频流的编码方式,可选值:
  • H.264:H.264 编码(默认)。
  • Fps Integer 视频帧率,取值范围:[0, 60],单位:Hz。
    默认值:0,表示和第一个视频帧率一致。
    Bitrate Integer 参考码率,单位 kbps,范围:50~35000。
    如果设置,编码时会尽量按该码率进行编码。
    如果不设置,服务将通过画面复杂度自动采用合适的码率。

    ContentReviewTemplateItem

    内容审核模板详情

    被如下接口引用:DescribeContentReviewTemplates。

    名称 类型 描述
    Definition Integer 内容审核模板唯一标识。
    示例值:0
    Name String 内容审核模板名称,长度限制:64 个字符。
    示例值:""
    Comment String 内容审核模板描述信息,长度限制:256 个字符。
    示例值:""
    PornConfigure PornConfigureInfo 鉴黄控制参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    TerrorismConfigure TerrorismConfigureInfo 涉敏控制参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    PoliticalConfigure PoliticalConfigureInfo 涉敏控制参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    ProhibitedConfigure ProhibitedConfigureInfo 违禁控制参数。违禁内容包括:
  • 谩骂;
  • 涉毒违法。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    UserDefineConfigure UserDefineConfigureInfo 用户自定义内容审核控制参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:""
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:""
    Type String 模板类型,取值范围:
    * Preset:系统预置模板;
    * Custom:用户自定义模板。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”

    CosFileUploadTrigger

    绑定到 COS 的输入规则。

    被如下接口引用:CreateSchedule, CreateWorkflow, ModifySchedule, ResetWorkflow。

    名称 类型 必选 描述
    Bucket String 工作流绑定的 COS Bucket 名,如 TopRankVideo-125xxx88。
    Region String 工作流绑定的 COS Bucket 所属园区,如 ap-chongiqng。
    Dir String 工作流绑定的输入路径目录,必须为绝对路径,即以 / 开头和结尾。如/movie/201907/,不填代表根目录/
    Formats Array of String 工作流允许触发的文件格式列表,如 ["mp4", "flv", "mov"]。不填代表所有格式的文件都可以触发工作流。

    CosInputInfo

    媒体处理 COS 对象信息。

    被如下接口引用:DescribeMediaMetaData, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。

    名称 类型 必选 描述
    Bucket String 媒体处理对象文件所在的 COS Bucket 名,如 TopRankVideo-125xxx88。
    示例值:NULL
    Region String 媒体处理对象文件所在的 COS Bucket 所属园区,如 ap-chongqing。
    示例值:NULL
    Object String 媒体处理对象文件的输入路径,如/movie/201907/WildAnimal.mov
    示例值:NULL

    CosOutputStorage

    媒体处理 COS 输出对象信息。

    被如下接口引用:CreateSchedule, CreateWorkflow, EditMedia, ModifySchedule, ProcessLiveStream, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Bucket String 媒体处理生成的文件输出的目标 Bucket 名,如 TopRankVideo-125xxx88。如果不填,表示继承上层。
    示例值:NULL
    Region String 媒体处理生成的文件输出的目标 Bucket 的园区,如 ap-chongqing。如果不填,表示继承上层。
    示例值:NULL

    CoverConfigureInfo

    智能封面任务控制参数

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

    名称 类型 必选 描述
    Switch String 智能封面任务开关,可选值:
  • ON:开启智能封面任务;
  • OFF:关闭智能封面任务。
  • CoverConfigureInfoForUpdate

    智能封面任务控制参数

    被如下接口引用:ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 智能封面任务开关,可选值:
  • ON:开启智能封面任务;
  • OFF:关闭智能封面任务。
  • CreateInput

    创建输入的配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput。

    名称 类型 必选 描述
    InputName String 输入名称,可填大小写、数字和下划线,长度为[1, 32]。
    示例值:input
    Protocol String 输入的协议,可选[SRT|RTP|RTMP|RTMP_PULL]。
    示例值:SRT
    Description String 输入描述,长度为[0, 255]。
    示例值:input description
    AllowIpList Array of String 输入的IP白名单,格式为CIDR。
    示例值:0.0.0.0/0
    SRTSettings CreateInputSRTSettings 输入的SRT配置信息。
    示例值:0
    RTPSettings CreateInputRTPSettings 输入的RTP配置信息。
    示例值:0
    FailOver String 输入的主备开关,可选[OPEN|CLOSE],默认为CLOSE。
    示例值:CLOSE
    RTMPPullSettings CreateInputRTMPPullSettings 输入的RTMP_PULL配置信息。
    RTSPPullSettings CreateInputRTSPPullSettings 输入的RTSP_PULL配置信息。
    HLSPullSettings CreateInputHLSPullSettings 输入的HLS_PULL配置信息。
    ResilientStream ResilientStreamConf 延播平滑吐流配置信息。
    SecurityGroupIds Array of String 绑定的输入安全组 ID。

    CreateInputHLSPullSettings

    创建的输入HLS拉流的配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    SourceAddresses Array of HLSPullSourceAddress HLS源站的源站地址,有且只能有一个。

    CreateInputRTMPPullSettings

    创建的输入RTMP拉流的配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    SourceAddresses Array of RTMPPullSourceAddress RTMP源站的源站地址,有且只能有一个。

    CreateInputRTPSettings

    创建输入的RTP配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    FEC String 默认为“none”,可选值['none']。
    示例值:none
    IdleTimeout Integer 空闲超时时间,默认5000,单位ms,范围为[1000, 10000]。
    示例值:1000

    CreateInputRTSPPullSettings

    创建的输入RTSP拉流的配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    SourceAddresses Array of RTSPPullSourceAddress RTSP源站的源站地址,有且只能有一个。

    CreateInputSRTSettings

    创建的输入SRT的配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    Mode String SRT模式,可选[LISTENER|CALLER],默认为LISTENER。
    示例值:LISTENER
    StreamId String 流Id,可选大小写字母、数字和特殊字符(.#!:&,=_-),长度为0~512。具体格式可以参考:https://github.com/Haivision/srt/blob/master/docs/features/access-control.md#standard-keys。
    示例值:streamId
    Latency Integer 延迟,默认0,单位ms,范围为[0, 3000]。
    示例值:0
    RecvLatency Integer 接收延迟,默认120,单位ms,范围为[0, 3000]。
    示例值:120
    PeerLatency Integer 对端延迟,默认0,单位ms,范围为[0, 3000]。
    示例值:0
    PeerIdleTimeout Integer 对端超时时间,默认5000,单位ms,范围为[1000, 10000]。
    示例值:5000
    Passphrase String 解密密钥,默认为空,表示不加密。只可填ascii码值,长度为[10, 79]。
    PbKeyLen Integer 密钥长度,默认为0,可选[0|16|24|32]。
    示例值:0
    SourceAddresses Array of SRTSourceAddressReq SRT对端地址,当Mode为CALLER时必填,且只能填1组。

    CreateOutputInfo

    创建输出的配置信息。

    被如下接口引用:CreateStreamLinkOutputInfo。

    名称 类型 必选 描述
    OutputName String 输出的名称。
    示例值:OutputName
    Description String 输出描述。
    示例值:OutputName
    Protocol String 输出协议,可选[SRT|RTP|RTMP|RTMP_PULL]。
    示例值:SRT
    OutputRegion String 输出地区。
    示例值:ap-hongkong
    SRTSettings CreateOutputSRTSettings 输出的SRT的配置。
    示例值:0
    RTMPSettings CreateOutputRTMPSettings 输出的RTMP的配置。
    示例值:0
    RTPSettings CreateOutputInfoRTPSettings 输出的RTP的配置。
    示例值:0
    AllowIpList Array of String IP白名单列表,格式为CIDR,如0.0.0.0/0。
    当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。
    示例值:0
    MaxConcurrent Integer 最大拉流并发数,最大4,默认4。
    示例值:1
    SecurityGroupIds Array of String 绑定的输入安全组 ID。

    CreateOutputInfoRTPSettings

    创建媒体传输流的输出的RTP配置。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    Destinations Array of CreateOutputRTPSettingsDestinations 转推的目标地址,可填1~2个。
    示例值:0
    FEC String 只能填none。
    示例值:none
    IdleTimeout Integer 空闲超时时间,单位ms。
    示例值:1000

    CreateOutputRTMPSettings

    创建媒体传输流的输出的RTMP配置。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    Destinations Array of CreateOutputRtmpSettingsDestinations 转推的目标地址,可填1~2个。
    示例值:your address
    ChunkSize Integer RTMP的Chunk大小,范围为[4096, 40960]。
    示例值:4096

    CreateOutputRTPSettingsDestinations

    创建媒体传输流的输出的RTP的目标地址。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    Ip String 转推的目标IP。
    示例值:ip
    Port Integer 转推的目标端口。
    示例值:port

    CreateOutputRtmpSettingsDestinations

    创建媒体传输流的输出的RTMP的目标地址。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    Url String 转推的URL,格式如:rtmp://domain/live。
    示例值:your url
    StreamKey String 转推的StreamKey,格式如:stream?key=value。
    示例值:test

    CreateOutputSRTSettings

    创建媒体传输流的输出的SRT配置。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    Destinations Array of CreateOutputSRTSettingsDestinations 转推的目标地址,当Mode为CALLER时必填,且只能填1组。
    StreamId String 转推SRT的流Id,可选大小写字母、数字和特殊字符(.#!:&,=_-),长度为0~512。
    示例值:StreamId
    Latency Integer 转推SRT的总延迟,默认0,单位ms,范围为[0, 3000]。
    示例值:0
    RecvLatency Integer 转推SRT的接收延迟,默认120,单位ms,范围为[0, 3000]。
    示例值:120
    PeerLatency Integer 转推SRT的对端延迟,默认0,单位ms,范围为[0, 3000]。
    示例值:0
    PeerIdleTimeout Integer 转推SRT的对端空闲超时时间,默认5000,单位ms,范围为[1000, 10000]。
    示例值:5000
    Passphrase String 转推SRT的加密密钥,默认为空,表示不加密。只可填ascii码值,长度为[10, 79]。
    PbKeyLen Integer 转推SRT的密钥长度,默认为0,可选[0|16|24|32]。
    示例值:0
    Mode String SRT模式,可选[LISTENER|CALLER],默认为CALLER。
    示例值:CALLER

    CreateOutputSRTSettingsDestinations

    创建媒体传输流的输出SRT的目标地址。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    Ip String 输出的IP。
    示例值:test
    Port Integer 输出的端口。
    示例值:test

    DescribeEvent

    查询Event的配置信息。

    被如下接口引用:CreateStreamLinkEvent, DescribeStreamLinkEvent, DescribeStreamLinkEvents。

    名称 类型 描述
    EventName String Event的名称。
    示例值:eventnametest
    EventId String Event的Id,唯一标识一个event。
    示例值:eventidtest
    CreateTime String Event创建时间,格式为yyyy-MM-ddTHH:mm:ssZ。
    示例值:2022-12-01T20:00:00Z
    Description String Event的描述。
    示例值:descri
    Status Integer Event的状态信息
    0:未运行
    1:运行中
    示例值:0
    AttachedFlowGroup Array of DescribeFlowId Event关联的Flow列表。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeFlow

    查询Flow的配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows。

    名称 类型 描述
    FlowId String 流Id。
    FlowName String 流名称。
    State String 流状态,目前有IDLE/RUNNING。
    示例值:IDLE
    MaxBandwidth Integer 最大带宽值。
    InputGroup Array of DescribeInput 输入组。
    OutputGroup Array of DescribeOutput 输出组。
    注意:此字段可能返回 null,表示取不到有效值。
    EventId String 该Flow关联的媒体传输事件EventId。
    示例值:eventid
    Region String 媒体传输输入流所属的区域,取值和InputRegion相同。
    示例值:ap-shanghai

    DescribeFlowId

    Event管理的Flow列表

    被如下接口引用:CreateStreamLinkEvent, DescribeStreamLinkEvent, DescribeStreamLinkEvents。

    名称 类型 必选 描述
    FlowId String FlowId,唯一标识一个flow。
    示例值:flowidtest
    Region String flow所在的区域名称。
    示例值:ap-shanghai

    DescribeHLSPullSourceAddress

    查询输入的HLS配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    Url String HLS源站的Url地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://domain[:port]/server_URL

    DescribeInput

    查询输入配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    InputId String 输入Id。
    示例值:id
    InputName String 输入名称。
    示例值:inputName
    Description String 输入描述。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:description
    Protocol String 输入协议。
    示例值:SRT
    InputAddressList Array of InputAddress 输入地址列表。
    示例值:0
    AllowIpList Array of String 输入IP白名单列表。
    示例值:0
    SRTSettings DescribeInputSRTSettings 输入的SRT配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    RTPSettings DescribeInputRTPSettings 输入的RTP配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    InputRegion String 输入的地区。
    示例值:ap-hongkong
    RTMPSettings DescribeInputRTMPSettings 输入的RTMP配置信息。
    示例值:0
    FailOver String 输入的主备开关。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CLOSE
    RTMPPullSettings DescribeInputRTMPPullSettings 输入的RTMP_PULL配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    RTSPPullSettings DescribeInputRTSPPullSettings 输入的RTSP_PULL配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    HLSPullSettings DescribeInputHLSPullSettings 输入的HLS_PULL配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    ResilientStream ResilientStreamConf 延播平滑吐流配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    SecurityGroupIds Array of String 绑定的输入安全组 ID。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeInputHLSPullSettings

    查询输入的HLS配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    SourceAddresses Array of DescribeHLSPullSourceAddress HLS源站地址信息。

    DescribeInputRTMPPullSettings

    查询输入的RTMP配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    SourceAddresses Array of DescribeRTMPPullSourceAddress RTMP源站地址信息。
    示例值:streamKey

    DescribeInputRTMPSettings

    查询输入的RTMP配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    AppName String RTMP的推流路径。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:live_appid
    StreamKey String RTMP的推流StreamKey。
    RTMP的推流地址拼接规则为:rtmp://Ip:1935/AppName/StreamKey
    示例值:inputid_index

    DescribeInputRTPSettings

    查询输入的RTP配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    FEC String 是否FEC。
    示例值:FEC
    IdleTimeout Integer 空闲超时时间。
    示例值:timeout

    DescribeInputRTSPPullSettings

    查询输入的RTSP配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    SourceAddresses Array of DescribeRTSPPullSourceAddress RTSP源站地址信息。

    DescribeInputSRTSettings

    查询输入的SRT配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    Mode String SRT模式。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:LISTENER
    StreamId String 流Id。
    示例值:StreamId
    Latency Integer 延迟。
    示例值:0
    RecvLatency Integer 接收延迟。
    示例值:120
    PeerLatency Integer 对端延迟。
    示例值:0
    PeerIdleTimeout Integer 对端空闲超时时间。
    示例值:5000
    Passphrase String 解密密钥。
    PbKeyLen Integer 密钥长度。
    示例值:0
    SourceAddresses Array of SRTSourceAddressResp SRT对端地址。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeOutput

    查询输出的配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    OutputId String 输出Id。
    示例值:AB342ED131CE
    OutputName String 输出名称。
    示例值:OutputName
    OutputType String 输出类型。
    示例值:Internet
    Description String 输出描述。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Description
    Protocol String 输出协议。
    示例值:RTMP
    OutputAddressList Array of OutputAddress 输出的出口地址信息列表。
    OutputRegion String 输出的地区。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-shanghai
    SRTSettings DescribeOutputSRTSettings 输出的SRT配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    RTPSettings DescribeOutputRTPSettings 输出的RTP配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    RTMPSettings DescribeOutputRTMPSettings 输出的RTMP配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    RTMPPullSettings DescribeOutputRTMPPullSettings 输出的RTMP拉流配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    AllowIpList Array of String CIDR白名单列表。
    当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。
    注意:此字段可能返回 null,表示取不到有效值。
    RTSPPullSettings DescribeOutputRTSPPullSettings 输出的RTSP拉流配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    HLSPullSettings DescribeOutputHLSPullSettings 输出的HLS拉流配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    MaxConcurrent Integer 最大拉流并发数,最大为4,默认4。
    示例值:1
    SecurityGroupIds Array of String 绑定的安全组 ID。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeOutputHLSPullServerUrl

    查询输出的HLS拉流URL信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Url String HLS拉流地址的Url。
    示例值:http://domain[port]/server_URL

    DescribeOutputHLSPullSettings

    查询输出的HLS拉流配置信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    ServerUrls Array of DescribeOutputHLSPullServerUrl HLS拉流地址列表。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeOutputRTMPPullServerUrl

    查询输出的RTMP拉流URL信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    TcUrl String RTMP拉流地址的tcUrl。
    示例值:rtmp://1.1.1.1:1/live
    StreamKey String RTMP拉流地址的流key。
    示例值:AB342ED131CE

    DescribeOutputRTMPPullSettings

    查询输出的RTMP拉流配置信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    ServerUrls Array of DescribeOutputRTMPPullServerUrl 拉流地址列表。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeOutputRTMPSettings

    查询输出的RTMP配置信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    IdleTimeout Integer 空闲超时时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:60
    ChunkSize Integer Chunk大小。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1024
    Destinations Array of RTMPAddressDestination 转推RTMP的目标地址信息列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:address

    DescribeOutputRTPSettings

    查询输出的RTP配置信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Destinations Array of RTPAddressDestination 转推RTP的目标地址信息列表。
    注意:此字段可能返回 null,表示取不到有效值。
    FEC String 是否FEC。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:FEC
    IdleTimeout Integer 空闲超时时间。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeOutputRTSPPullServerUrl

    查询输出的RTSP拉流URL信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Url String RTSP拉流地址的Url。
    示例值:rtsp://ip_or_domain[:rtsp_port]/server_URL

    DescribeOutputRTSPPullSettings

    查询输出的RTSP拉流配置信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    ServerUrls Array of DescribeOutputRTSPPullServerUrl RTSP拉流地址列表。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeOutputSRTSettings

    查询输出的SRT配置信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Destinations Array of SRTAddressDestination 转推的目标的地址信息列表,SRT模式为CALLER时使用。
    注意:此字段可能返回 null,表示取不到有效值。
    StreamId String 流Id。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:StreamId
    Latency Integer 延迟。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    RecvLatency Integer 接收延迟。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:120
    PeerLatency Integer 对端延迟。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    PeerIdleTimeout Integer 对端空闲超时时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5000
    Passphrase String 加密密钥。
    注意:此字段可能返回 null,表示取不到有效值。
    PbKeyLen Integer 加密密钥长度。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Mode String SRT模式。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CALLER
    SourceAddresses Array of OutputSRTSourceAddressResp 服务器监听地址,SRT模式为LISTENER时使用。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeRTMPPullSourceAddress

    查询输入的RTMP配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    TcUrl String RTMP源站的TcUrl地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:rtmp://domain/live
    StreamKey String RTMP源站的StreamKey。
    RTMP源站地址拼接规则为:$TcUrl/$StreamKey。
    示例值:streamKey

    DescribeRTSPPullSourceAddress

    查询输入的RTSP配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    Url String RTSP源站的Url地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:rtsp://ip_or_domain[:rtsp_port]/server_URL

    DiagnoseResult

    诊断结果项。

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Category String 诊断出的异常类别。
    注意:此字段可能返回 null,表示取不到有效值。
    Type String 诊断出的具体异常类型。
    注意:此字段可能返回 null,表示取不到有效值。
    Timestamp Float 诊断出异常开始的PTS时间戳。
    注意:此字段可能返回 null,表示取不到有效值。
    Description String 诊断出的异常描述。
    注意:此字段可能返回 null,表示取不到有效值。
    DateTime String 诊断到异常的北京时间,采用 ISO 日期格式。
    注意:此字段可能返回 null,表示取不到有效值。
    SeverityLevel String 诊断出的异常级别。
    注意:此字段可能返回 null,表示取不到有效值。

    DrmInfo

    Drm 加密信息。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Type String 加密类型:
  • simpleaes: aes-128 加密

  • 注意:此字段可能返回 null,表示取不到有效值。
    SimpleAesDrm SimpleAesDrm SimpleAes 加密信息。
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaFileInfo

    编辑点播视频文件信息

    被如下接口引用:DescribeTaskDetail, EditMedia, ParseNotification。

    名称 类型 必选 描述
    InputInfo MediaInputInfo 视频的输入信息。
    StartTimeOffset Float 【剪辑】任务生效,视频剪辑的起始时间偏移,单位:秒。
    EndTimeOffset Float 【剪辑】任务生效,视频剪辑的结束时间偏移,单位:秒。
    Id String 【合成】任务必选,用于轨道元素中媒体关联源素材 ID。

    注意:允许字母、数字、-、_ ,最长 32 字符
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaOutputConfig

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Container String 封装格式,可选值:mp4、hls、mov、flv、avi。默认是 mp4。
    注意:此字段可能返回 null,表示取不到有效值。
    Type String 剪辑模式,可选值 normal、fast。默认是精确剪辑 normal
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:fast

    EditMediaTask

    编辑视频任务信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    TaskId String 任务 ID。
    Status String 任务状态,取值:
  • PROCESSING:处理中;
  • FINISH:已完成。
  • ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。
  • Message String 错误信息。
    Input EditMediaTaskInput 视频编辑任务的输入。
    Output EditMediaTaskOutput 视频编辑任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。

    EditMediaTaskInput

    编辑视频任务的输入。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    FileInfoSet Array of EditMediaFileInfo 输入的视频文件信息。

    EditMediaTaskOutput

    编辑视频任务的输出

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    OutputStorage TaskOutputStorage 编辑后文件的目标存储。
    Path String 编辑后的视频文件路径。
    示例值:/xx.mp4
    MetaData MediaMetaData 编辑后的视频文件元信息。
    注意:此字段可能返回 null,表示取不到有效值。

    EnhanceConfig

    音视频增强配置

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

    名称 类型 必选 描述
    VideoEnhance VideoEnhanceConfig 视频增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    AudioEnhance AudioEnhanceConfig 音频增强配置。
    注意:此字段可能返回 null,表示取不到有效值。

    ExpressionConfigInfo

    表情识别参数配置

    被如下接口引用:RecognizeMediaForZhiXue。

    名称 类型 必选 描述
    Switch String 表情识别任务开关,可选值:
  • ON:开启;
  • OFF:关闭。
  • FaceConfigureInfo

    人脸识别任务控制参数

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

    名称 类型 必选 描述
    Switch String 人脸识别任务开关,可选值:
  • ON:开启智能人脸识别任务;
  • OFF:关闭智能人脸识别任务。
  • Score Float 人脸识别过滤分数,当识别结果达到该分数以上,返回识别结果。默认 95 分。取值范围:0 - 100。
    DefaultLibraryLabelSet Array of String 默认人物过滤标签,指定需要返回的默认人物的标签。如果未填或者为空,则全部默认人物结果都返回。标签可选值:
  • entertainment:娱乐明星;
  • sport:体育明星;
  • politician:敏感人物。
  • UserDefineLibraryLabelSet Array of String 用户自定义人物过滤标签,指定需要返回的用户自定义人物的标签。如果未填或者为空,则全部自定义人物结果都返回。
    标签个数最多 100 个,每个标签长度最多 16 个字符。
    FaceLibrary String 人物库选择,可选值:
  • Default:使用默认人物库;
  • UserDefine:使用用户自定义人物库。
  • All:同时使用默认人物库和用户自定义人物库。

  • 默认值:All,使用系统默认人物库及用户自定义人物库。

    FaceConfigureInfoForUpdate

    人脸识别任务控制参数

    被如下接口引用:ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 人脸识别任务开关,可选值:
  • ON:开启智能人脸识别任务;
  • OFF:关闭智能人脸识别任务。
  • Score Float 人脸识别过滤分数,当识别结果达到该分数以上,返回识别结果。取值范围:0-100。
    DefaultLibraryLabelSet Array of String 默认人物过滤标签,指定需要返回的默认人物的标签。如果未填或者为空,则全部默认人物结果都返回。标签可选值:
  • entertainment:娱乐明星;
  • sport:体育明星;
  • politician:敏感人物。
  • UserDefineLibraryLabelSet Array of String 用户自定义人物过滤标签,指定需要返回的用户自定义人物的标签。如果未填或者为空,则全部自定义人物结果都返回。
    标签个数最多 100 个,每个标签长度最多 16 个字符。
    FaceLibrary String 人物库选择,可选值:
  • Default:使用默认人物库;
  • UserDefine:使用用户自定义人物库。
  • All:同时使用默认人物库和用户自定义人物库。
  • FaceEnhanceConfig

    人脸增强配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Intensity Float 强度,取值范围:0.0~1.0。
    默认:0.0。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    FlowAudio

    流的音频数据。

    被如下接口引用:DescribeStreamLinkFlowStatistics。

    名称 类型 描述
    Fps Integer 帧率。
    示例值:30
    Rate Integer 码率,单位是bps。
    示例值:1000
    Pid Integer 音频Pid。
    示例值:256

    FlowLogInfo

    传输流日志信息。

    被如下接口引用:DescribeStreamLinkFlowLogs。

    名称 类型 描述
    Timestamp Integer 时间戳,单位为秒。
    示例值:12
    Type String 输入输出类型(input/output)。
    示例值: input
    InputOutputId String 输入或输出Id。
    示例值: 12478
    Protocol String 协议。
    示例值: RTMP
    EventCode String 事件代码。
    示例值: 10224
    EventMessage String 事件信息。
    示例值: test
    RemoteIp String 对端IP。
    示例值: ip
    RemotePort String 对端端口。
    示例值: port
    Pipeline String 主备通道,0为主通道,1为备通道。
    示例值: 1
    InputOutputName String 输入或输出的名称。
    示例值: name

    FlowMediaAudio

    传输流媒体的音频数据。

    被如下接口引用:DescribeStreamLinkFlowMediaStatistics。

    名称 类型 描述
    Fps Integer 帧率。
    示例值:30
    Rate Integer 码率,单位是bps。
    示例值:1477
    Pid Integer 音频Pid。
    示例值:10227
    SessionId String 标志同一次推流。
    示例值:20147

    FlowMediaInfo

    传输流的媒体数据。

    被如下接口引用:DescribeStreamLinkFlowMediaStatistics。

    名称 类型 描述
    Timestamp Integer 时间戳,单位是秒。
    示例值:1610954100
    Network Integer 总带宽。
    示例值:2824932
    Video Array of FlowMediaVideo 传输流的视频数据。
    示例值:0
    Audio Array of FlowMediaAudio 传输流的音频数据。
    示例值:0
    SessionId String 标志同一次推流。
    示例值:412573995
    ClientIp String 客户端IP。
    示例值:1.1.1.1

    FlowMediaVideo

    传输流媒体的视频数据。

    被如下接口引用:DescribeStreamLinkFlowMediaStatistics。

    名称 类型 描述
    Fps Integer 帧率。
    示例值:30
    Rate Integer 码率,单位是bps。
    示例值:1477
    Pid Integer 视频Pid。
    示例值:10251
    SessionId String 标志同一次推流。
    示例值:14557

    FlowRealtimeStatusCommon

    实时流状态查询的通用状态信息。

    被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。

    名称 类型 描述
    State String 当前连接状态,Connected|Waiting|Idle。
    示例值:Connected
    Mode String 连接模式,Listener|Caller。
    示例值:Listener
    ConnectedTime Integer 已连接时长,单位为ms。
    示例值:1
    Bitrate Integer 实时码率,单位为bps。
    示例值:1
    Reconnections Integer 重试次数。
    示例值:1

    FlowRealtimeStatusItem

    流状态实时查询接口的流状态信息

    被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。

    名称 类型 描述
    Type String 类型,Input|Output。
    示例值:Input
    InputId String 输入Id,如果Type为Input,此字段不为空。
    示例值:0176ac7f1af30956b92d2aad1e6e
    OutputId String 输出Id,如果Type为Output,此字段不为空。
    示例值:2176ac7f1af20956b92d2aad1234
    FlowId String 流Id。
    示例值:asd5ac7f1af20956b92d2aadq231
    Protocol String 协议, SRT | RTMP。
    示例值:SRT
    CommonStatus FlowRealtimeStatusCommon 共同状态信息。
    SRTStatus FlowRealtimeStatusSRT 如果是SRT协议则有此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    RTMPStatus FlowRealtimeStatusRTMP 如果是RTMP协议则有此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    ConnectServerIP String 服务器IP。
    示例值:121.23.56.99
    RTPStatus FlowRealtimeStatusRTP 如果是RTP协议则有此字段。
    注意:此字段可能返回 null,表示取不到有效值。

    FlowRealtimeStatusRTMP

    流状态实时查询接口的RTMP信息。

    被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。

    名称 类型 描述
    VideoFPS Integer 视频帧率。
    示例值:25
    AudioFPS Integer 音频帧率。
    示例值:48

    FlowRealtimeStatusRTP

    流状态实时查询接口的RTP流状态信息

    被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。

    名称 类型 描述
    Packets Integer 传输的包个数
    示例值:30

    FlowRealtimeStatusSRT

    流状态实时查询接口的SRT信息。

    被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。

    名称 类型 描述
    Latency Integer 延迟,单位为ms。
    示例值:1
    RTT Integer RTT,单位为ms。
    示例值:1
    Packets Integer 实时发包数或者收包数。
    示例值:1
    PacketLossRate Float 丢包率。
    示例值:0.01
    RetransmitRate Float 重传率。
    示例值:0.01
    DroppedPackets Integer 实时丢包数。
    示例值:1
    Encryption String 是否加密,On|Off。
    示例值:On

    FlowSRTInfo

    传输流的SRT质量数据。

    被如下接口引用:DescribeStreamLinkFlowSRTStatistics。

    名称 类型 描述
    Timestamp Integer 时间戳,单位是秒。
    示例值:1611288000
    SendPacketLossRate Integer 发送丢包率。
    示例值:0
    SendRetransmissionRate Integer 发送重传率。
    示例值:0
    RecvPacketLossRate Integer 接收丢包率。
    示例值:0
    RecvRetransmissionRate Integer 接收重传率。
    示例值:0
    RTT Integer 与对端的RTT时延。
    示例值:100
    SessionId String 标志同一次推流。
    示例值:15346848
    SendPacketDropNumber Integer 发送弃包数。
    示例值:0
    RecvPacketDropNumber Integer 接收弃包数。
    示例值:0

    FlowStatistics

    流的统计数据。

    被如下接口引用:DescribeStreamLinkFlowStatistics。

    名称 类型 描述
    SessionId String 会话Id。
    示例值:1564865
    ClientIp String 对端IP。
    示例值:1.1.1.1
    Network Integer 总带宽。
    示例值:2000
    Video Array of FlowVideo 视频数据。
    示例值:0
    Audio Array of FlowAudio 音频数据。
    示例值:0

    FlowStatisticsArray

    流的统计数据列表。

    被如下接口引用:DescribeStreamLinkFlowStatistics。

    名称 类型 描述
    Timestamp Integer 时间戳。
    示例值:1611288000
    FlowStatistics Array of FlowStatistics 每个会话的统计数据。
    示例值:0

    FlowVideo

    流的视频数据。

    被如下接口引用:DescribeStreamLinkFlowStatistics。

    名称 类型 描述
    Fps Integer 帧率。
    示例值:30
    Rate Integer 码率,单位是bps。
    示例值:1000
    Pid Integer 音频Pid。
    示例值:257

    FrameRateConfig

    插帧帧率配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Fps Integer 帧率,取值范围:[0, 100],单位:Hz。
    默认值 0。
    注意:对于转码,该参数会覆盖 VideoTemplate 内部的 Fps。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    FrameTagConfigureInfo

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

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

    名称 类型 必选 描述
    Switch String 智能按帧标签任务开关,可选值:
  • ON:开启智能按帧标签任务;
  • OFF:关闭智能按帧标签任务。
  • FrameTagConfigureInfoForUpdate

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

    被如下接口引用:ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 智能按帧标签任务开关,可选值:
  • ON:开启智能按帧标签任务;
  • OFF:关闭智能按帧标签任务。
  • HLSPullSourceAddress

    创建的输入HLS拉流源站配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    Url String HLS源站的Url地址。
    示例值:http://testdomain.com:8806/live/streamname

    HdrConfig

    HDR配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • HDR10
  • HLG

  • 默认值:HDR10。
    注意:video的编码方式需要为libx265;
    注意:视频编码位深为10。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”

    HeadTailParameter

    片头片尾参数

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    HeadSet Array of MediaInputInfo 片头列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[ { "Type": "URL", "UrlInputInfo": { "Url": "htt
    TailSet Array of MediaInputInfo 片尾列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[ { "Type": "URL", "UrlInputInfo": { "Url": "htt

    HighlightSegmentItem

    智能精彩集锦片段列表。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    ImageQualityEnhanceConfig

    综合增强配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • weak
  • normal
  • strong

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

    ImageSpriteTaskInput

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

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 雪碧图模板 ID。
    OutputStorage TaskOutputStorage 截取雪碧图后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 截取雪碧图后,雪碧图图片文件的输出路径,可以为相对路径或者绝对路径。如果不填,则默认为相对路径:{inputName}_imageSprite_{definition}_{number}.{format}
    WebVttObjectName String 截取雪碧图后,Web VTT 文件的输出路径,只能为相对路径。如果不填,则默认为相对路径:{inputName}_imageSprite_{definition}.{format}
    ObjectNumberFormat NumberFormat 截取雪碧图后输出路径中的{number}变量的规则。
    注意:此字段可能返回 null,表示取不到有效值。

    ImageSpriteTemplate

    雪碧图模板详情

    被如下接口引用:DescribeImageSpriteTemplates。

    名称 类型 描述
    Definition Integer 雪碧图模板唯一标识。
    示例值:0
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • 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。
    示例值: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
    ResolutionAdaptive String 分辨率自适应,可选值:
  • open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
  • close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。

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

  • 默认值:black 。
    示例值:“”
    Comment String 模板描述信息。
    示例值:“”
    Format String 图片格式。
    示例值:“”

    ImageWatermarkInput

    图片水印模板输入参数

    被如下接口引用:CreateWatermarkTemplate。

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

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

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

    图片水印模板输入参数

    被如下接口引用:ModifyWatermarkTemplate。

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

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

    图片水印模板

    被如下接口引用:DescribeWatermarkTemplates。

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

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

    输入地址信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 描述
    Ip String 输入地址的IP。
    示例值:ip
    Port Integer 输入地址的端口。
    示例值:port

    LiveActivityResItem

    直播编排子任务输出

    被如下接口引用:DescribeTaskDetail。

    名称 类型 描述
    LiveRecordTask LiveScheduleLiveRecordTaskResult 直播录制任务输出
    注意:此字段可能返回 null,表示取不到有效值。

    LiveActivityResult

    直播编排任务输出

    被如下接口引用:DescribeTaskDetail。

    名称 类型 描述
    ActivityType String 原子任务类型。
  • LiveRecord:直播录制。

  • 注意:此字段可能返回 null,表示取不到有效值。
    LiveActivityResItem LiveActivityResItem 原子任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    LiveRecordFile

    直播录制输出文件信息

    被如下接口引用:DescribeTaskDetail。

    名称 类型 描述
    Url String 直播录制文件地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    Size Integer 直播录制文件大小
    注意:此字段可能返回 null,表示取不到有效值。
    Duration Integer 直播录制文件时长
    注意:此字段可能返回 null,表示取不到有效值。
    StartTime String 直播录制文件开始时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    EndTime String 直播录制文件结束时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。

    LiveRecordResult

    直播录制结果

    被如下接口引用:DescribeTaskDetail。

    名称 类型 描述
    OutputStorage TaskOutputStorage 直播录制文件的目标存储。
    注意:此字段可能返回 null,表示取不到有效值。
    FileList Array of LiveRecordFile 直播录制文件列表
    注意:此字段可能返回 null,表示取不到有效值。

    LiveRecordTaskInput

    直播录制任务输入参数类型

    被如下接口引用:DescribeTaskDetail。

    名称 类型 必选 描述
    Definition Integer 直播录制模板 ID。
    示例值:10
    OutputStorage TaskOutputStorage 直播录制后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 直播录制后文件的输出路径。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”

    LiveScheduleLiveRecordTaskResult

    直播编排直播录制任务结果类型

    被如下接口引用:DescribeTaskDetail。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:PROCESSING
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    注意:此字段可能返回 null,表示取不到有效值。
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Input LiveRecordTaskInput 直播录制任务的输入。
    注意:此字段可能返回 null,表示取不到有效值。
    Output LiveRecordResult 直播录制任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。

    LiveScheduleTask

    直播编排任务信息

    被如下接口引用:DescribeTaskDetail。

    名称 类型 描述
    TaskId String 直播编排任务 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    Status String 任务流状态,取值:
  • PROCESSING:处理中;
  • FINISH:已完成。

  • 注意:此字段可能返回 null,表示取不到有效值。
    ErrCode Integer 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。
    注意:此字段可能返回 null,表示取不到有效值。
    Message String 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。
    注意:此字段可能返回 null,表示取不到有效值。
    Url String 直播流 URL。
    注意:此字段可能返回 null,表示取不到有效值。
    LiveActivityResultSet Array of LiveActivityResult 直播编排任务输出。
    注意:此字段可能返回 null,表示取不到有效值。

    LiveStreamAiAnalysisResultInfo

    直播流分析结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    ResultSet Array of LiveStreamAiAnalysisResultItem 直播分析子任务结果,暂时只支持直播拆条。
    注意:此字段可能返回 null,表示取不到有效值。

    LiveStreamAiAnalysisResultItem

    直播流 AI 分析结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Type String 结果的类型,取值范围:
  • SegmentRecognition:拆条。

  • 示例值:SegmentRecognition
    SegmentResultSet Array of SegmentRecognitionItem 拆条结果,当 Type 为
    SegmentRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    LiveStreamAiQualityControlResultInfo

    直播流质检结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    QualityControlResults Array of QualityControlResult 质检结果列表。
    注意:此字段可能返回 null,表示取不到有效值。
    DiagnoseResults Array of DiagnoseResult 格式诊断结果列表。
    注意:此字段可能返回 null,表示取不到有效值。

    LiveStreamAiRecognitionResultInfo

    直播流 AI 识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    ResultSet Array of LiveStreamAiRecognitionResultItem 内容识别结果列表。

    LiveStreamAiRecognitionResultItem

    直播流 AI 识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Type String 结果的类型,取值范围:
  • FaceRecognition:人脸识别,
  • AsrWordsRecognition:语音关键词识别,
  • OcrWordsRecognition:文本关键词识别,
  • AsrFullTextRecognition:语音全文识别,
  • OcrFullTextRecognition:文本全文识别。
  • TransTextRecognition:语音翻译。
  • TagRecognition:精彩打点。

  • 示例值:FaceRecognition
    FaceRecognitionResultSet Array of LiveStreamFaceRecognitionResult 人脸识别结果,当 Type 为
    FaceRecognition 时有效。
    示例值:NULL
    AsrWordsRecognitionResultSet Array of LiveStreamAsrWordsRecognitionResult 语音关键词识别结果,当 Type 为
    AsrWordsRecognition 时有效。
    示例值:NULL
    OcrWordsRecognitionResultSet Array of LiveStreamOcrWordsRecognitionResult 文本关键词识别结果,当 Type 为
    OcrWordsRecognition 时有效。
    示例值:NULL
    AsrFullTextRecognitionResultSet Array of LiveStreamAsrFullTextRecognitionResult 语音全文识别结果,当 Type 为
    AsrFullTextRecognition 时有效。
    示例值:NULL
    OcrFullTextRecognitionResultSet Array of LiveStreamOcrFullTextRecognitionResult 文本全文识别结果,当 Type 为
    OcrFullTextRecognition 时有效。
    示例值:NULL
    TransTextRecognitionResultSet Array of LiveStreamTransTextRecognitionResult 翻译结果,当Type 为 TransTextRecognition 时有效。
    示例值:NULL
    TagRecognitionResultSet Array of LiveStreamTagRecognitionResult 打点结果,当Type 为 TagRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    LiveStreamAiReviewImagePoliticalResult

    直播 AI 内容审核图片敏感结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    StartPtsTime Float 嫌疑片段起始的 PTS 时间,单位:秒。
    示例值:0
    EndPtsTime Float 嫌疑片段结束的 PTS 时间,单位:秒。
    示例值:0
    Confidence Float 嫌疑片段敏感分数。
    示例值:0
    Suggestion String 嫌疑片段鉴黄结果建议,取值范围:
  • pass
  • review
  • block

  • 示例值:""
    Label String 视频敏感结果标签,取值范围:
  • politician:敏感人物。
  • violation_photo:违规图标。

  • 示例值:""
    Name String 敏感人物、违规图标名字。
    示例值:""
    AreaCoordSet Array of Integer 敏感人物、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    示例值:0
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:""
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:""

    LiveStreamAiReviewImagePornResult

    直播 AI 内容审核图片鉴黄结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    StartPtsTime Float 嫌疑片段起始的 PTS 时间,单位:秒。
    EndPtsTime Float 嫌疑片段结束的 PTS 时间,单位:秒。
    Confidence Float 嫌疑片段涉黄分数。
    Suggestion String 嫌疑片段鉴黄结果建议,取值范围:
  • pass
  • review
  • block
  • Label String 视频鉴黄结果标签,取值范围:
  • porn:色情。
  • sexy:性感。
  • vulgar:低俗。
  • intimacy:亲密行为。
  • Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式

    LiveStreamAiReviewImageTerrorismResult

    直播 AI 内容审核图片涉敏结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    StartPtsTime Float 嫌疑片段起始的 PTS 时间,单位:秒。
    示例值:0
    EndPtsTime Float 嫌疑片段结束的 PTS 时间,单位:秒。
    示例值:0
    Confidence Float 嫌疑片段涉敏分数。
    示例值:0
    Suggestion String 嫌疑片段涉敏结果建议,取值范围:
  • pass
  • review
  • block

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

  • 示例值:""
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:""
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:""

    LiveStreamAiReviewResultInfo

    直播流 AI 审核结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    ResultSet Array of LiveStreamAiReviewResultItem 内容审核结果列表。

    LiveStreamAiReviewResultItem

    直播流 AI 审核结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Type String 审核结果的类型,可以取的值有:
  • ImagePorn:图片鉴黄
  • ImageTerrorism:图片涉敏
  • ImagePolitical:图片涉敏
  • VoicePorn:声音违规

  • 示例值:""
    ImagePornResultSet Array of LiveStreamAiReviewImagePornResult 图片鉴黄的结果,当 Type 为 ImagePorn 时有效。
    ImageTerrorismResultSet Array of LiveStreamAiReviewImageTerrorismResult 图片涉敏的结果,当 Type 为 ImageTerrorism 时有效。
    ImagePoliticalResultSet Array of LiveStreamAiReviewImagePoliticalResult 图片涉敏的结果,当 Type 为 ImagePolitical 时有效。
    VoicePornResultSet Array of LiveStreamAiReviewVoicePornResult 声音违规的结果,当 Type 为 VoicePorn 时有效。

    LiveStreamAiReviewVoicePornResult

    直播 AI 内容审核声音鉴黄结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    StartPtsTime Float 嫌疑片段起始的 PTS 时间,单位:秒。
    EndPtsTime Float 嫌疑片段结束的 PTS 时间,单位:秒。
    Confidence Float 嫌疑片段涉黄分数。
    Suggestion String 嫌疑片段鉴黄结果建议,取值范围:
  • pass
  • review
  • block
  • Label String 视频鉴黄结果标签,取值范围:
  • sexual_moan:呻吟。
  • LiveStreamAsrFullTextRecognitionResult

    直播识别 Asr 全文识别

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Text String 识别文本。
    示例值:你好
    StartPtsTime Float 识别片段起始的 PTS 时间,单位:秒。
    示例值:123.301
    EndPtsTime Float 识别片段终止的 PTS 时间,单位:秒。
    示例值:125.301
    Confidence Float 识别片段置信度。取值:0~100。
    示例值:99
    StartTime String 识别开始UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTime String 识别结束UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    SteadyState Boolean 稳态标记。
    注意:此字段可能返回 null,表示取不到有效值。

    LiveStreamAsrWordsRecognitionResult

    直播 AI Asr 单词识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Word String 语音关键词。
    StartPtsTime Float 识别片段起始的 PTS 时间,单位:秒。
    EndPtsTime Float 识别片段终止的 PTS 时间,单位:秒。
    Confidence Float 识别片段置信度。取值:0~100。

    LiveStreamFaceRecognitionResult

    直播 AI 人脸识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Id String 人物唯一标识 ID。
    Name String 人物名称。
    Type String 人物库类型,表示识别出的人物来自哪个人物库:
  • Default:默认人物库;
  • UserDefine:用户自定义人物库。
  • StartPtsTime Float 识别片段起始的 PTS 时间,单位:秒。
    EndPtsTime Float 识别片段终止的 PTS 时间,单位:秒。
    Confidence Float 识别片段置信度。取值:0~100。
    AreaCoordSet Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。

    LiveStreamOcrFullTextRecognitionResult

    直播识别 Ocr 全文识别

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamOcrWordsRecognitionResult

    直播 AI Ocr 单词识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Word String 文本关键词。
    StartPtsTime Float 识别片段起始的 PTS 时间,单位:秒。
    EndPtsTime Float 识别片段终止的 PTS 时间,单位:秒。
    Confidence Float 识别片段置信度。取值:0~100。
    AreaCoords Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。

    LiveStreamProcessErrorInfo

    直播流处理错误信息

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    ErrCode Integer 错误码:
  • 0表示没有错误;
  • 非0表示错误,请参考 Message 错误信息。
  • Message String 错误信息。

    LiveStreamProcessTask

    直播处理任务信息

    被如下接口引用:DescribeTaskDetail。

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

  • 示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Url String 直播流 URL。
    示例值:NULL

    LiveStreamTagRecognitionResult

    直播 AI 打点识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Id String 打点事件。
    示例值:击杀黑暗暴君
    StartPtsTime Float 识别片段起始的 PTS 时间,单位:秒。
    示例值:899.916
    EndPtsTime Float 识别片段终止的 PTS 时间,单位:秒。
    示例值:899.916
    Confidence Float 识别片段置信度。取值:0~100。
    示例值:100

    LiveStreamTaskNotifyConfig

    任务处理的事件通知配置。

    被如下接口引用:ProcessLiveStream。

    名称 类型 必选 描述
    NotifyType String 通知类型,默认CMQ,指定URL时HTTP回调推送到 NotifyUrl 指定的地址。

    注:不填或为空时默认 CMQ,如需采用其他类型需填写对应类型值。
    示例值:URL
    CmqModel String CMQ 的模型,有 Queue 和 Topic 两种,目前仅支持 Queue。
    示例值:Queue
    CmqRegion String CMQ 的园区,如 sh,bj 等。
    示例值:sh
    QueueName String 当模型为 Queue 时有效,表示接收事件通知的 CMQ 的队列名。
    示例值:test
    TopicName String 当模型为 Topic 时有效,表示接收事件通知的 CMQ 的主题名。
    示例值:test
    NotifyUrl String HTTP回调地址,NotifyType为URL时必填。
    示例值:http://www.qq.com/callback

    LiveStreamTransTextRecognitionResult

    直播实时翻译结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Text String 识别文本。
    示例值:Hello
    StartPtsTime Float 翻译片段起始的 PTS 时间,单位:秒。
    示例值:0.0
    EndPtsTime Float 翻译片段终止的 PTS 时间,单位:秒。
    示例值:1.0
    Confidence Float 翻译片段置信度。取值:0~100。
    示例值:99
    Trans String 翻译文本。
    示例值:你好
    StartTime String 翻译开始UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    EndTime String 翻译结束UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    SteadyState Boolean 稳态标记。
    注意:此字段可能返回 null,表示取不到有效值。

    LowLightEnhanceConfig

    低光照增强配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • normal

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

    MediaAiAnalysisClassificationItem

    智能分类结果

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    MediaAiAnalysisCoverItem

    智能封面信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    CoverPath String 智能封面存储路径。
    Confidence Float 智能封面的可信度,取值范围是 0 到 100。

    MediaAiAnalysisDescriptionItem

    智能描述信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    MediaAiAnalysisFrameTagItem

    智能按帧标签结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    MediaAiAnalysisFrameTagSegmentItem

    按帧标签片段列表

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    MediaAiAnalysisHighlightItem

    智能精彩片段信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    HighlightPath String 智能精彩集锦地址。
    CovImgPath String 智能精彩集锦封面地址。
    Confidence Float 智能精彩集锦的可信度,取值范围是 0 到 100。
    Duration Float 智能精彩集锦持续时间。
    SegmentSet Array of HighlightSegmentItem 智能精彩集锦子片段列表。

    MediaAiAnalysisTagItem

    智能标签结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    MediaAnimatedGraphicsItem

    视频转动图结果信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Storage TaskOutputStorage 转动图文件的存储位置。
    Path 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

    点播文件音频流信息

    被如下接口引用:DescribeMediaMetaData, DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Bitrate Integer 音频流的码率,单位:bps。
    示例值:8000
    SamplingRate Integer 音频流的采样率,单位:hz。
    示例值:8000
    Codec String 音频流的编码格式,例如 aac。
    示例值:aac
    Channel Integer 音频声道数,例如 2。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    Codecs String 音频Codecs。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:mp4a.40.2
    Loudness Float 音频响度。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaContentReviewAsrTextSegmentItem

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    Confidence Float 嫌疑片段置信度。
    Suggestion String 嫌疑片段审核结果建议,取值范围:
  • pass。
  • review。
  • block。
  • KeywordSet Array of String 嫌疑关键词列表。

    MediaContentReviewOcrTextSegmentItem

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    Confidence Float 嫌疑片段置信度。
    Suggestion String 嫌疑片段审核结果建议,取值范围:
  • pass。
  • review。
  • block。
  • KeywordSet Array of String 嫌疑关键词列表。
    AreaCoordSet Array of Integer 嫌疑文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式

    MediaContentReviewPoliticalSegmentItem

    内容审核涉敏嫌疑片段

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    示例值:0
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    示例值:0
    Confidence Float 嫌疑片段涉敏分数。
    示例值:0
    Suggestion String 嫌疑片段涉敏结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 示例值:""
    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:敏感军事人物。

  • 示例值:""
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:""
    AreaCoordSet Array of Integer 涉敏人物、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    示例值:0
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:""

    MediaContentReviewSegmentItem

    内容审核涉黄/涉敏嫌疑片段

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    示例值:0
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    示例值:0
    Confidence Float 嫌疑片段涉黄分数。
    示例值:0
    Label String 嫌疑片段鉴黄结果标签。
    示例值:""
    Suggestion String 嫌疑片段鉴黄结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 示例值:""
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:""
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:""

    MediaImageSpriteItem

    雪碧图信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    MediaInputInfo

    媒体处理的输入对象信息。

    被如下接口引用:CreateWorkflow, DescribeMediaMetaData, DescribeTaskDetail, EditMedia, ParseNotification, ProcessMedia, RecognizeMediaForZhiXue, ResetWorkflow, WithdrawsWatermark。

    名称 类型 必选 描述
    Type String 输入来源对象的类型,支持:
  • COS:COS源
  • URL:URL源
  • AWS-S3:AWS 源,目前只支持转码任务

  • 示例值:NULL
    CosInputInfo CosInputInfo 当 Type 为 COS 时有效,则该项为必填,表示媒体处理 COS 对象信息。
    示例值:NULL
    UrlInputInfo UrlInputInfo 当 Type 为 URL 时有效,则该项为必填,表示媒体处理 URL 对象信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    S3InputInfo S3InputInfo 当 Type 为 AWS-S3 时有效,则该项为必填,表示媒体处理 AWS S3 对象信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    MediaMetaData

    点播媒体文件元信息

    被如下接口引用:DescribeMediaMetaData, DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Size Integer 上传的媒体文件大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。
    示例值:3771548
    Container String 容器类型,例如 m4a,mp4 等。
    示例值:flv
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和,单位:bps。
    示例值:611594
    Height Integer 视频流高度的最大值,单位:px。
    示例值:480
    Width Integer 视频流宽度的最大值,单位:px。
    示例值:854
    Duration Float 视频时长,单位:秒。
    示例值:49.334
    Rotate Integer 视频拍摄时的选择角度,单位:度。
    示例值:0
    VideoStreamSet Array of MediaVideoStreamItem 视频流信息。
    AudioStreamSet Array of MediaAudioStreamItem 音频流信息。
    VideoDuration Float 视频时长,单位:秒。
    示例值:49.334
    AudioDuration Float 音频时长,单位:秒。
    示例值:49.334

    MediaProcessTaskAdaptiveDynamicStreamingResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AdaptiveDynamicStreamingTaskInput 对视频转自适应码流任务的输入。
    示例值:NULL
    Output AdaptiveDynamicStreamingInfoItem 对视频转自适应码流任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    MediaProcessTaskAnimatedGraphicResult

    转动图任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input AnimatedGraphicTaskInput 转动图任务的输入。
    示例值:NULL
    Output MediaAnimatedGraphicsItem 转动图任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    MediaProcessTaskImageSpriteResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input ImageSpriteTaskInput 对视频截雪碧图任务的输入。
    示例值:NULL
    Output MediaImageSpriteItem 对视频截雪碧图任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    MediaProcessTaskInput

    媒体处理任务类型

    被如下接口引用:CreateWorkflow, DescribeWorkflows, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    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
    AdaptiveDynamicStreamingTaskSet Array of AdaptiveDynamicStreamingTaskInput 转自适应码流任务列表。
    示例值:NULL

    MediaProcessTaskResult

    任务查询结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    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,表示取不到有效值。
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult 转自适应码流任务查询结果,当任务类型为 AdaptiveDynamicStreaming 时有效。
    注意:此字段可能返回 null,表示取不到有效值。

    MediaProcessTaskSampleSnapshotResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input SampleSnapshotTaskInput 对视频做采样截图任务输入。
    示例值:NULL
    Output MediaSampleSnapshotItem 对视频做采样截图任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    MediaProcessTaskSnapshotByTimeOffsetResult

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:NULL
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:NULL
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:NULL
    Message String 错误信息。
    示例值:NULL
    Input SnapshotByTimeOffsetTaskInput 对视频按指定时间点截图任务输入。
    示例值:NULL
    Output MediaSnapshotByTimeOffsetItem 对视频按指定时间点截图任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    MediaProcessTaskTranscodeResult

    转码任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:PROCESSING
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:"xx"
    Input TranscodeTaskInput 转码任务的输入。
    示例值:NULL
    Output MediaTranscodeItem 转码任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    Progress Integer 转码进度,取值范围 [0-100]
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    MediaSampleSnapshotItem

    采样截图信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

    MediaSnapshotByTimeOffsetItem

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

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Definition Integer 指定时间点截图规格,参见指定时间点截图参数模板
    PicInfoSet Array of MediaSnapshotByTimePicInfoItem 同一规格的截图信息集合,每个元素代表一张截图。
    Storage TaskOutputStorage 指定时间点截图文件的存储位置。

    MediaSnapshotByTimePicInfoItem

    指定时间点截图信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    TimeOffset Float 该张截图对应视频文件中的时间偏移,单位为秒。
    示例值:0
    Path String 该张截图的路径。
    示例值:""
    WaterMarkDefinition Array of Integer 截图如果被打上了水印,被打水印的模板 ID 列表。
    示例值:NULL

    MediaTranscodeItem

    转码信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    OutputStorage TaskOutputStorage 转码后文件的目标存储。
    Path String 转码后的视频文件路径。
    Definition Integer 转码规格 ID,参见转码参数模板
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和, 单位:bps。
    Height Integer 视频流高度的最大值,单位:px。
    Width Integer 视频流宽度的最大值,单位:px。
    Size Integer 媒体文件总大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。
    Duration Float 视频时长,单位:秒。
    Container String 容器类型,例如 m4a,mp4 等。
    Md5 String 视频的 md5 值。
    AudioStreamSet Array of MediaAudioStreamItem 音频流信息。
    VideoStreamSet Array of MediaVideoStreamItem 视频流信息。

    MediaVideoStreamItem

    点播文件视频流信息

    被如下接口引用:DescribeMediaMetaData, DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Bitrate Integer 视频流的码率,单位:bps。
    示例值:100000
    Height Integer 视频流的高度,单位:px。
    示例值:1920
    Width Integer 视频流的宽度,单位:px。
    示例值:1080
    Codec String 视频流的编码格式,例如 h264。
    示例值:h264
    Fps Integer 帧率,单位:hz。
    示例值:30
    ColorPrimaries String 色彩空间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:bt470bg
    ColorSpace String 色彩空间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:gbr
    ColorTransfer String 色彩空间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:bt709
    HdrType String HDR类型。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:sdr
    Codecs String 视频Codecs。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:avc1.ffe100

    ModifyInput

    修改输入信息的参数。

    被如下接口引用:ModifyStreamLinkInput。

    名称 类型 必选 描述
    InputId String 输入Id。
    示例值:InputId
    InputName String 输入名称。
    示例值:InputName
    Description String 输入描述。
    示例值:Description
    AllowIpList Array of String 允许的推流的IP,CIDR格式。
    示例值:["0.0.0.0/0"]
    SRTSettings CreateInputSRTSettings SRT的配置信息。
    示例值:0
    RTPSettings CreateInputRTPSettings RTP的配置信息。
    示例值:0
    Protocol String 输入的协议,可选[SRT|RTP|RTMP]。
    当输出包含RTP时,输入只能是RTP。
    当输出包含RTMP时,输入可以是SRT/RTMP。
    当输出包含SRT时,输入只能是SRT。
    示例值:SRT
    FailOver String 输入的主备开关,可选[OPEN|CLOSE]。
    示例值:CLOSE
    RTMPPullSettings CreateInputRTMPPullSettings RTMP_PULL的配置信息。
    示例值:0
    RTSPPullSettings CreateInputRTSPPullSettings RTSP_PULL的配置信息。
    HLSPullSettings CreateInputHLSPullSettings HLS_PULL的配置信息。
    ResilientStream ResilientStreamConf 延播平滑吐流配置信息。
    SecurityGroupIds Array of String 绑定的输入安全组 ID。 仅支持关联一组安全组。

    ModifyOutputInfo

    修改Output配置。

    被如下接口引用:ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    OutputId String 需要修改的Output的Id。
    示例值:AB342ED131CE
    OutputName String 输出的名称。
    示例值:OutputName
    Description String 输出的描述。
    示例值:Description
    Protocol String 输出的转推协议,支持SRT|RTP|RTMP。
    示例值:SRT
    SRTSettings CreateOutputSRTSettings 转推SRT的配置。
    RTPSettings CreateOutputInfoRTPSettings 转推RTP的配置。
    RTMPSettings CreateOutputRTMPSettings 转推RTMP的配置。
    AllowIpList Array of String IP白名单列表,格式为CIDR,如0.0.0.0/0。
    当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。
    MaxConcurrent Integer 最大拉流并发数,最大4,默认4。
    示例值:1
    SecurityGroupIds Array of String 绑定的安全组 ID。 仅支持关联一组安全组。

    MosaicInput

    媒体处理任务中的马赛克参数类型

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

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

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

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

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

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

  • 默认值:10%。
    示例值:NULL
    StartTimeOffset Float 马赛克的起始时间偏移,单位:秒。不填或填0,表示马赛克从画面出现时开始显现。
  • 不填或填0,表示马赛克从画面开始就出现;
  • 当数值大于0时(假设为 n),表示马赛克从画面开始的第 n 秒出现;
  • 当数值小于0时(假设为 -n),表示马赛克从离画面结束 n 秒前开始出现。

  • 示例值:NULL
    EndTimeOffset Float 马赛克的结束时间偏移,单位:秒。
  • 不填或填0,表示马赛克持续到画面结束;
  • 当数值大于0时(假设为 n),表示马赛克持续到第 n 秒时消失;
  • 当数值小于0时(假设为 -n),表示马赛克持续到离画面结束 n 秒前消失。

  • 示例值:NULL

    NumberFormat

    输出文件名的{number}变量的规则。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    InitialValue Integer {number}变量的起始值,默认为0。
    Increment Integer {number}变量的增长步长,默认为1。
    MinLength Integer {number}变量的最小长度,不足时补占位符。默认为1。
    PlaceHolder String {number}变量的长度不足时,补充的占位符。默认为"0"。

    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 个字符。

    OutputAddress

    输出的出口的地址。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Ip String 出口IP。
    示例值:ip

    OutputSRTSourceAddressResp

    SRT输出的监听地址。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    Ip String 监听IP。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.1.1.1
    Port Integer 监听端口。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:65535

    OverrideTranscodeParameter

    自定义转码的规格参数。用于覆盖模板中对应参数值。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Container String 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a。其中,mp3、flac、ogg、m4a 为纯音频文件。
    示例值:mp4
    RemoveVideo Integer 是否去除视频数据,取值:
  • 0:保留;
  • 1:去除。

  • 示例值:0
    RemoveAudio Integer 是否去除音频数据,取值:
  • 0:保留;
  • 1:去除。

  • 示例值:0
    VideoTemplate VideoTemplateInfoForUpdate 视频流配置参数。
    示例值:NULL
    AudioTemplate AudioTemplateInfoForUpdate 音频流配置参数。
    示例值:NULL
    TEHDConfig TEHDConfigForUpdate 极速高清转码参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    SubtitleTemplate SubtitleTemplate 字幕流配置参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AddonAudioStream Array of MediaInputInfo 外挂音轨参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    StdExtInfo String 转码扩展字段。
    注意:此字段可能返回 null,表示取不到有效值。
    AddOnSubtitles Array of AddOnSubtitle 要插入的字幕文件。
    注意:此字段可能返回 null,表示取不到有效值。

    PoliticalAsrReviewTemplateInfo

    语音涉敏任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 语音涉敏任务开关,可选值:
  • ON:开启语音涉敏任务;
  • OFF:关闭语音涉敏任务。

  • 示例值:ON
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    示例值:100
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
    示例值:75

    PoliticalAsrReviewTemplateInfoForUpdate

    语音涉敏任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 语音涉敏任务开关,可选值:
  • ON:开启语音涉敏任务;
  • OFF:关闭语音涉敏任务。

  • 示例值:""
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    示例值:0
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
    示例值:0

    PoliticalConfigureInfo

    涉敏任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    ImgReviewInfo PoliticalImgReviewTemplateInfo 画面涉敏控制参数。
    AsrReviewInfo PoliticalAsrReviewTemplateInfo 语音涉敏控制参数。
    OcrReviewInfo PoliticalOcrReviewTemplateInfo 文本涉敏控制参数。

    PoliticalConfigureInfoForUpdate

    涉敏任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    ImgReviewInfo PoliticalImgReviewTemplateInfoForUpdate 画面涉敏控制参数。
    示例值:NULL
    AsrReviewInfo PoliticalAsrReviewTemplateInfoForUpdate 语音涉敏控制参数。
    示例值:NULL
    OcrReviewInfo PoliticalOcrReviewTemplateInfoForUpdate 文本涉敏控制参数。
    示例值:NULL

    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。
    示例值:0
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
    示例值:0

    PoliticalOcrReviewTemplateInfo

    文本涉敏任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 文本涉敏任务开关,可选值:
  • ON:开启文本涉敏任务;
  • OFF:关闭文本涉敏任务。

  • 示例值:ON
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    示例值:0
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
    示例值:0

    PoliticalOcrReviewTemplateInfoForUpdate

    文本涉敏任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 文本涉敏任务开关,可选值:
  • ON:开启文本涉敏任务;
  • OFF:关闭文本涉敏任务。

  • 示例值:ON
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    示例值:0
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
    示例值:0

    PornAsrReviewTemplateInfo

    语音鉴黄任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 语音鉴黄任务开关,可选值:
  • ON:开启语音鉴黄任务;
  • OFF:关闭语音鉴黄任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    PornAsrReviewTemplateInfoForUpdate

    语音鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 语音鉴黄任务开关,可选值:
  • ON:开启语音鉴黄任务;
  • OFF:关闭语音鉴黄任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。

    PornConfigureInfo

    鉴黄任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    ImgReviewInfo PornImgReviewTemplateInfo 画面鉴黄控制参数。
    AsrReviewInfo PornAsrReviewTemplateInfo 语音鉴黄控制参数。
    OcrReviewInfo PornOcrReviewTemplateInfo 文本鉴黄控制参数。

    PornConfigureInfoForUpdate

    鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    ImgReviewInfo PornImgReviewTemplateInfoForUpdate 画面鉴黄控制参数。
    AsrReviewInfo PornAsrReviewTemplateInfoForUpdate 语音鉴黄控制参数。
    OcrReviewInfo PornOcrReviewTemplateInfoForUpdate 文本鉴黄控制参数。

    PornImgReviewTemplateInfo

    画面鉴黄任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 画面鉴黄任务开关,可选值:
  • ON:开启画面鉴黄任务;
  • OFF:关闭画面鉴黄任务。
  • LabelSet Array of String 画面鉴黄过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为:
  • porn:色情;
  • vulgar:低俗;
  • intimacy:亲密行为;
  • sexy:性感。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 90 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 0 分。取值范围:0~100。

    PornImgReviewTemplateInfoForUpdate

    画面鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 画面鉴黄任务开关,可选值:
  • ON:开启画面鉴黄任务;
  • OFF:关闭画面鉴黄任务。
  • LabelSet Array of String 画面鉴黄过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为:
  • porn:色情;
  • vulgar:低俗;
  • intimacy:亲密行为;
  • sexy:性感。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。

    PornOcrReviewTemplateInfo

    文本鉴黄任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 文本鉴黄任务开关,可选值:
  • ON:开启文本鉴黄任务;
  • OFF:关闭文本鉴黄任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    PornOcrReviewTemplateInfoForUpdate

    文本鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 文本鉴黄任务开关,可选值:
  • ON:开启文本鉴黄任务;
  • OFF:关闭文本鉴黄任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。

    ProhibitedAsrReviewTemplateInfo

    语音违禁任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 语音违禁任务开关,可选值:
  • ON:开启语音违禁任务;
  • OFF:关闭语音违禁任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    ProhibitedAsrReviewTemplateInfoForUpdate

    语音违禁任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 语音违禁任务开关,可选值:
  • ON:开启语音违禁任务;
  • OFF:关闭语音违禁任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    ProhibitedConfigureInfo

    违禁任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    AsrReviewInfo ProhibitedAsrReviewTemplateInfo 语音违禁控制参数。
    注意:此字段可能返回 null,表示取不到有效值。
    OcrReviewInfo ProhibitedOcrReviewTemplateInfo 文本违禁控制参数。
    注意:此字段可能返回 null,表示取不到有效值。

    ProhibitedConfigureInfoForUpdate

    违禁任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    AsrReviewInfo ProhibitedAsrReviewTemplateInfoForUpdate 语音违禁控制参数。
    OcrReviewInfo ProhibitedOcrReviewTemplateInfoForUpdate 文本违禁控制参数。

    ProhibitedOcrReviewTemplateInfo

    文本违禁任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 文本违禁任务开关,可选值:
  • ON:开启文本违禁任务;
  • OFF:关闭文本违禁任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    ProhibitedOcrReviewTemplateInfoForUpdate

    文本违禁任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 文本违禁任务开关,可选值:
  • ON:开启文本违禁任务;
  • OFF:关闭文本违禁任务。
  • BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    QualityControlData

    质检结果输出。

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    NoAudio Boolean 为true时表示视频无音频轨。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    NoVideo Boolean 为true时表示视频无视频轨。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    QualityEvaluationScore Integer 视频无参考质量打分,百分制。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:95
    QualityControlResultSet Array of QualityControlResult 质检检出异常项。
    注意:此字段可能返回 null,表示取不到有效值。

    QualityControlItem

    质检结果项

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Confidence Integer 置信度,取值范围是 0 到 100。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100
    StartTimeOffset Float 出现的起始时间戳,秒。
    示例值:12.3
    EndTimeOffset Float 出现的结束时间戳,秒。
    示例值:15.7
    AreaCoordSet Array of Integer 区域坐标(px),即左上角坐标、右下角坐标。
    注意:此字段可能返回 null,表示取不到有效值。

    QualityControlResult

    质检异常项。

    被如下接口引用:DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification。

    名称 类型 描述
    Type String 异常类型,取值范围:
    Jitter:抖动,
    Blur:模糊,
    LowLighting:低光照,
    HighLighting:过曝,
    CrashScreen:花屏,
    BlackWhiteEdge:黑白边,
    SolidColorScreen:纯色屏,
    Noise:噪点,
    Mosaic:马赛克,
    QRCode:二维码,
    AppletCode:小程序码,
    BarCode:条形码,
    LowVoice:低音,
    HighVoice:爆音,
    NoVoice:静音,
    LowEvaluation:无参考打分低于阈值。
    示例值:""
    QualityControlItems Array of QualityControlItem 质检结果项。

    RTMPAddressDestination

    RTMP转推的目标地址信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Url String 转推RTMP的目标Url,格式如'rtmp://domain/live'。
    示例值:url
    StreamKey String 转推RTMP的目标StreamKey,格式如'steamid?key=value'。
    示例值:streamkey

    RTMPPullSourceAddress

    创建的输入RTMP拉流源站配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    TcUrl String RTMP源站的TcUrl地址。
    示例值:rtmp://domain/live
    StreamKey String RTMP源站的StreamKey信息。
    示例值:streamKey

    RTPAddressDestination

    转推的RTP目标地址信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Ip String 转推的目标地址的IP。
    示例值:ip
    Port Integer 转推的目标地址的端口。
    示例值:port

    RTSPPullSourceAddress

    创建的输入RTSP拉流源站配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    Url String RTSP源站的Url地址。
    示例值:rtsp://9.223.70.41:8806/live/streamname

    RawImageWatermarkInput

    图片水印模板输入参数

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

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

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

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

  • 示例值:repeat

    RawTranscodeParameter

    自定义转码的规格参数。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Container String 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a。其中,mp3、flac、ogg、m4a 为纯音频文件。
    RemoveVideo Integer 是否去除视频数据,取值:
  • 0:保留;
  • 1:去除。

  • 默认值:0。
    RemoveAudio Integer 是否去除音频数据,取值:
  • 0:保留;
  • 1:去除。

  • 默认值:0。
    VideoTemplate VideoTemplateInfo 视频流配置参数,当 RemoveVideo 为 0,该字段必填。
    AudioTemplate AudioTemplateInfo 音频流配置参数,当 RemoveAudio 为 0,该字段必填。
    TEHDConfig TEHDConfig 极速高清转码参数。

    RawWatermarkParameter

    自定义水印规格参数。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Type String 水印类型,可选值:
  • image:图片水印。
  • 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。
    ImageTemplate RawImageWatermarkInput 图片水印模板,当 Type 为 image,该字段必填。当 Type 为 text,该字段无效。

    RegionInfo

    地区信息。

    被如下接口引用:DescribeStreamLinkRegions。

    名称 类型 描述
    Name String 地区名称。
    示例值:ap-mumbai

    ResilientStreamConf

    延播平滑吐流配置。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 必选 描述
    Enable Boolean 是否开启延播平滑吐流,true开启,false不开启,默认不开启。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    BufferTime Integer 延播时间,单位秒,目前支持的范围为10~300秒。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:133

    S3InputInfo

    AWS S3存储输入

    被如下接口引用:DescribeMediaMetaData, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。

    名称 类型 必选 描述
    S3Bucket String S3 bucket。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    S3Region String S3 bucket 对应的区域,目前支持:
    us-east-1
    eu-west-3

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-southeast-1
    S3Object String S3 bucket 中的媒体资源路径。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/test.mp4
    S3SecretId String AWS 内网访问 媒体资源的秘钥id。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    S3SecretKey String AWS 内网访问 媒体资源的秘钥key。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""

    S3OutputStorage

    AWS S3 输出位置

    被如下接口引用:CreateSchedule, CreateWorkflow, EditMedia, ModifySchedule, ProcessLiveStream, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    S3Bucket String S3 bucket。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    S3Region String S3 bucket 对应的区域。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-southeast-1
    S3SecretId String AWS 内网上传 媒体资源的秘钥id。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    S3SecretKey String AWS 内网上传 媒体资源的秘钥key。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""

    SRTAddressDestination

    转推的目标地址信息。

    被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。

    名称 类型 描述
    Ip String 目标地址的IP。
    示例值:ip
    Port Integer 目标地址的端口。
    示例值:port

    SRTSourceAddressReq

    SRT输入源地址。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。

    名称 类型 必选 描述
    Ip String 对端IP。
    示例值:1.1.1.1
    Port Integer 对端端口。
    示例值:65535

    SRTSourceAddressResp

    SRT输入源地址。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。

    名称 类型 必选 描述
    Ip String 对端IP。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.1.1.1
    Port Integer 对端端口。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:65535

    SampleSnapshotTaskInput

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

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 采样截图模板 ID。
    示例值:10
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    OutputStorage TaskOutputStorage 采样截图后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 采样截图后图片文件的输出路径,可以为相对路径或者绝对路径。如果不填,则默认为相对路径:{inputName}_sampleSnapshot_{definition}_{number}.{format}
    ObjectNumberFormat NumberFormat 采样截图后输出路径中的{number}变量的规则。
    注意:此字段可能返回 null,表示取不到有效值。

    SampleSnapshotTemplate

    采样截图模板详情

    被如下接口引用:DescribeSampleSnapshotTemplates。

    名称 类型 描述
    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 图片格式。
    SampleType String 采样截图类型。
    SampleInterval Integer 采样间隔。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊。

  • 默认值:black 。

    ScheduleAnalysisTaskResult

    编排视频分析任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:PROCESSING
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:"xx"
    Input AiAnalysisTaskInput 分析任务的输入。
    示例值:NULL
    Output Array of AiAnalysisResult 分析任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    ScheduleQualityControlTaskResult

    质检任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:PROCESSING
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:"xx"
    Input AiQualityControlTaskInput 质检任务的输入。
    示例值:NULL
    Output QualityControlData 质检任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    ScheduleRecognitionTaskResult

    编排视频识别任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:PROCESSING
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:"xx"
    Input AiRecognitionTaskInput 识别任务的输入。
    示例值:NULL
    Output Array of AiRecognitionResult 识别任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    ScheduleReviewTaskResult

    编排视频审核任务结果类型

    被如下接口引用:DescribeTaskDetail, ParseNotification。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:PROCESSING
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:""
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:"xx"
    Input AiContentReviewTaskInput 审核任务的输入。
    示例值:NULL
    Output Array of AiContentReviewResult 审核任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2019-07-16T06:21:46Z

    ScheduleTask

    编排任务信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

  • 示例值:NULL
    ErrCode Integer 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。
    示例值:0
    Message String 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。
    InputInfo MediaInputInfo 媒体处理的目标文件信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    MetaData MediaMetaData 原始视频的元信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    ActivityResultSet Array of ActivityResult 编排任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    SchedulesInfo

    编排详情。

    被如下接口引用:DescribeSchedules。

    名称 类型 描述
    ScheduleId Integer 编排唯一标识。
    示例值:0
    ScheduleName String 编排名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”
    Type String 编排类型,可选值:
  • Preset:系统预置编排;
  • Custom:用户自定义编排。

  • 注意:此字段可能返回 null,表示取不到有效值。
    Status String 编排状态,取值范围:
    Enabled:已启用,
    Disabled:已禁用。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”
    Trigger WorkflowTrigger 编排绑定的触发规则。
    注意:此字段可能返回 null,表示取不到有效值。
    Activities Array of Activity 编排任务列表。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputStorage TaskOutputStorage 媒体处理的文件输出存储位置。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputDir String 媒体处理生成的文件输出的目标目录。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”
    TaskNotifyConfig TaskNotifyConfig 任务的事件通知配置。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 创建时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”
    UpdateTime String 最后编辑时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”
    ResourceId String 资源ID,对于没有关联资源ID的,用账号主资源ID填充。
    注意:此字段可能返回 null,表示取不到有效值。

    ScratchRepairConfig

    去划痕配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Intensity Float 强度,取值范围:0.0~1.0。
    默认:0.0。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    SegmentRecognitionItem

    智能拆条片段。

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Confidence Float 置信度。
    StartTimeOffset Float 片段起始时间偏移。
    EndTimeOffset Float 片段结束时间偏移。
    SegmentUrl String 拆条片段URL。
    注意:此字段可能返回 null,表示取不到有效值。

    SharpEnhanceConfig

    细节增强配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Intensity Float 强度,取值范围:0.0~1.0。
    默认:0.0。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    SimpleAesDrm

    SimpleAes 加密信息。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Uri String 请求解密秘钥uri地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://test.qq.com?vid=xxx
    Key String 加密key(32字节字符串)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:14367588ab31370e32ae000544bd007d
    Vector String 加密初始化向量(32字节字符串)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:452ac1553f19b846e2f2c4cffd8f4a9b

    SnapshotByTimeOffsetTaskInput

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

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    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 张。
    OutputStorage TaskOutputStorage 时间点截图后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 时间点截图后图片文件的输出路径,可以为相对路径或者绝对路径。如果不填,则默认为相对路径:{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}
    ObjectNumberFormat NumberFormat 时间点截图后输出路径中的{number}变量的规则。
    注意:此字段可能返回 null,表示取不到有效值。

    SnapshotByTimeOffsetTemplate

    时间点截图模板详情

    被如下接口引用:DescribeSnapshotByTimeOffsetTemplates。

    名称 类型 描述
    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 图片格式。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • black:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • black:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊。

  • 默认值:black 。

    StreamLinkRegionInfo

    媒体传输的地区信息。

    被如下接口引用:DescribeStreamLinkRegions。

    名称 类型 描述
    Regions Array of RegionInfo 媒体直传输的地区信息列表。

    SubtitleTemplate

    字幕流配置参数。

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Path String 要压制到视频中的字幕文件地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    StreamIndex Integer 指定要压制到视频中的字幕轨道,如果有指定Path,则Path 优先级更高。Path 和 StreamIndex 至少指定一个。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3
    FontType String 字体类型,
  • hei.ttf:黑体
  • song.ttf:宋体
  • simkai.ttf:楷体
  • arial.ttf:仅支持英文

  • 默认hei.ttf
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:simhei.ttf
    FontSize String 字体大小,格式:Npx,N 为数值,不指定则以字幕文件中为准。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5px
    FontColor String 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0xRRGGBB
    FontAlpha Float 文字透明度,取值范围:(0, 1]
  • 0:完全透明
  • 1:完全不透明

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

    SuperResolutionConfig

    超分配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • lq:针对低清晰度有较多噪声视频的超分;
  • hq:针对高清晰度视频超分。

  • 默认值:lq。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:“”
    Size Integer 超分倍数,可选值:
  • 2:目前只支持 2 倍超分。

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

    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。
  • TEHDConfig

    极速高清参数配置。

    被如下接口引用:CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Type String 极速高清类型,可选值:
  • TEHD-100:极速高清-100(视频极速高清)。
  • TEHD-200:极速高清-200(音频极速高清)。

  • 不填代表不启用极速高清。
    示例值:TEHD-100
    MaxVideoBitrate Integer 视频码率上限,当 Type 指定了极速高清类型时有效。
    不填或填0表示不设视频码率上限。
    示例值:0

    TEHDConfigForUpdate

    极速高清参数配置。

    被如下接口引用:CreateWorkflow, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Type String 极速高清类型,可选值:
  • TEHD-100:极速高清-100(视频极速高清)。
  • TEHD-200:极速高清-200(音频极速高清)。

  • 不填代表不修改。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:TEHD-100
    MaxVideoBitrate Integer 视频码率上限,不填代表不修改。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    TagConfigureInfo

    智能标签任务控制参数

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

    名称 类型 必选 描述
    Switch String 智能标签任务开关,可选值:
  • ON:开启智能标签任务;
  • OFF:关闭智能标签任务。
  • TagConfigureInfoForUpdate

    智能标签任务控制参数

    被如下接口引用:ModifyAIAnalysisTemplate。

    名称 类型 必选 描述
    Switch String 智能标签任务开关,可选值:
  • ON:开启智能标签任务;
  • OFF:关闭智能标签任务。
  • TaskNotifyConfig

    任务的事件通知配置。

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeSchedules, DescribeTaskDetail, DescribeWorkflows, EditMedia, ModifySchedule, ProcessMedia, ResetWorkflow, WithdrawsWatermark。

    名称 类型 必选 描述
    NotifyType String 通知类型,可选值:
  • CMQ:已下线,建议切换到TDMQ-CMQ
  • TDMQ-CMQ:消息队列
  • URL:指定URL时HTTP回调推送到 NotifyUrl 指定的地址,回调协议http+json,包体内容同解析事件通知接口的输出参数
  • SCF:不推荐使用,需要在控制台额外配置SCF
  • AWS-SQS:AWS 队列,只适用于 AWS 任务,且要求同区域

  • 注:不填或为空时默认 CMQ,如需采用其他类型需填写对应类型值。
    示例值:URL
    NotifyMode String 工作流通知的模式,可取值有 Finish 和 Change,不填代表 Finish。
    示例值:Finish
    NotifyUrl String HTTP回调地址,NotifyType为URL时必填。
    示例值:http://www.qq.com/callback
    CmqModel String CMQ或TDMQ-CMQ 的模型,有 Queue 和 Topic 两种。
    示例值:Queue
    CmqRegion String CMQ或TDMQ-CMQ 的园区,如 sh,bj 等。
    示例值:sh
    TopicName String 当模型为 Topic 时有效,表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。
    示例值:test
    QueueName String 当模型为 Queue 时有效,表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。
    示例值:""
    AwsSQS AwsSQS AWS SQS 回调,NotifyType为 AWS-SQS 时必填。

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    NotifyKey String 用于生成回调签名的key。
    注意:此字段可能返回 null,表示取不到有效值。

    TaskOutputStorage

    媒体处理输出对象信息。

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeSchedules, DescribeTaskDetail, DescribeWorkflows, EditMedia, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Type String 媒体处理输出对象存储位置的类型,支持:
  • COS:COS存储
  • AWS-S3:AWS 存储,只适用于AWS任务,且要求同区域

  • 示例值:NULL
    CosOutputStorage CosOutputStorage 当 Type 为 COS 时有效,则该项为必填,表示媒体处理 COS 输出位置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    S3OutputStorage S3OutputStorage 当 Type 为 AWS-S3 时有效,则该项为必填,表示媒体处理 AWS S3 输出位置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    TaskSimpleInfo

    任务概要信息

    被如下接口引用:DescribeTasks。

    名称 类型 描述
    TaskId String 任务 ID。
    TaskType String 任务类型,包含:
  • WorkflowTask:工作流处理任务;
  • EditMediaTask:视频编辑任务;
  • LiveProcessTask:直播处理任务。
  • CreateTime String 任务创建时间,使用 ISO 日期格式
    BeginProcessTime String 任务开始执行时间,使用 ISO 日期格式。若任务尚未开始,该字段为:0000-00-00T00:00:00Z。
    FinishTime String 任务结束时间,使用 ISO 日期格式。若任务尚未完成,该字段为:0000-00-00T00:00:00Z。
    SubTaskTypes Array of String 子任务类型。

    TerrorismConfigureInfo

    涉敏任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 描述
    ImgReviewInfo TerrorismImgReviewTemplateInfo 画面涉敏任务控制参数。
    示例值:NULL
    OcrReviewInfo TerrorismOcrReviewTemplateInfo 文本涉敏任务控制参数。
    示例值:NULL

    TerrorismConfigureInfoForUpdate

    涉敏任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    ImgReviewInfo TerrorismImgReviewTemplateInfoForUpdate 画面涉敏任务控制参数。
    示例值:NULL
    OcrReviewInfo TerrorismOcrReviewTemplateInfoForUpdate 文本涉敏任务控制参数。
    示例值:NULL

    TerrorismImgReviewTemplateInfo

    画面涉敏任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 画面涉敏任务开关,可选值:
  • ON:开启画面涉敏任务;
  • OFF:关闭画面涉敏任务。

  • 示例值:ON
    LabelSet Array of String 画面涉敏过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为:
  • guns:武器枪支;
  • crowd:人群聚集;
  • bloody:血腥画面;
  • police:警察部队;
  • banners:涉敏旗帜;
  • militant:武装分子;
  • explosion:爆炸火灾;
  • terrorists:涉敏人物;
  • scenario:涉敏画面。

  • 示例值:bloody
    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:涉敏画面。

  • 示例值:guns
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    示例值:95
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
    示例值:80

    TerrorismOcrReviewTemplateInfo

    文本涉敏任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 文本涉敏任务开关,可选值:
  • ON:开启文本涉敏任务;
  • OFF:关闭文本涉敏任务。

  • 示例值:ON
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    示例值:0
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
    示例值:0

    TerrorismOcrReviewTemplateInfoForUpdate

    文本涉敏任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 文本涉敏任务开关,可选值:
  • ON:开启文本涉敏任务;
  • OFF:关闭文本涉敏任务。

  • 示例值:ON
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    示例值:0
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
    示例值:0

    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:完全不透明
  • TranscodeTaskInput

    转码任务输入参数类型

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 视频转码模板 ID。
    示例值:20
    RawParameter RawTranscodeParameter 视频转码自定义参数,当 Definition 填 0 时有效。
    该参数用于高度定制场景,建议您优先使用 Definition 指定转码参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    OverrideParameter OverrideTranscodeParameter 视频转码自定义参数,当 Definition 不填 0 时有效。
    当填写了该结构中的部分转码参数时,将使用填写的参数覆盖转码模板中的参数。
    该参数用于高度定制场景,建议您仅使用 Definition 指定转码参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    MosaicSet Array of MosaicInput 马赛克列表,最大可支持 10 张。
    示例值:null
    StartTimeOffset Float 转码后的视频的起始时间偏移,单位:秒。
  • 不填或填0,表示转码后的视频从原始视频的起始位置开始;
  • 当数值大于0时(假设为 n),表示转码后的视频从原始视频的第 n 秒位置开始;
  • 当数值小于0时(假设为 -n),表示转码后的视频从原始视频结束 n 秒前的位置开始。

  • 示例值:null
    EndTimeOffset Float 转码后视频的终止时间偏移,单位:秒。
  • 不填或填0,表示转码后的视频持续到原始视频的末尾终止;
  • 当数值大于0时(假设为 n),表示转码后的视频持续到原始视频第 n 秒时终止;
  • 当数值小于0时(假设为 -n),表示转码后的视频持续到原始视频结束 n 秒前终止。

  • 示例值:null
    OutputStorage TaskOutputStorage 转码后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    OutputObjectPath String 转码后主文件的输出路径,可以为相对路径或者绝对路径。如果不填,则默认为相对路径:{inputName}_transcode_{definition}.{format}
    示例值:null
    SegmentObjectName String 转码后分片文件的输出路径(转码 HLS 时 ts 的路径),只能为相对路径。如果不填,则默认为:{inputName}_transcode_{definition}_{number}.{format}
    示例值:null
    ObjectNumberFormat NumberFormat 转码后输出路径中的{number}变量的规则。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    HeadTailParameter HeadTailParameter 片头片尾参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{ "HeadSet": [ { "Type": "URL", "UrlInputInfo"

    TranscodeTemplate

    转码模板详情

    被如下接口引用:DescribeTranscodeTemplates。

    名称 类型 描述
    Definition String 转码模板唯一标识。
    示例值:0
    Container String 封装格式,取值:mp4、flv、hls、mp3、flac、ogg。
    示例值:“”
    Name String 转码模板名称。
    示例值:“”
    Comment String 模板描述信息。
    示例值:“”
    Type String 模板类型,取值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:“”
    RemoveVideo Integer 是否去除视频数据,取值:
  • 0:保留;
  • 1:去除。

  • 示例值:0
    RemoveAudio Integer 是否去除音频数据,取值:
  • 0:保留;
  • 1:去除。

  • 示例值:0
    VideoTemplate VideoTemplateInfo 视频流配置参数,仅当 RemoveVideo 为 0,该字段有效。
    AudioTemplate AudioTemplateInfo 音频流配置参数,仅当 RemoveAudio 为 0,该字段有效 。
    TEHDConfig TEHDConfig 极速高清转码参数。
    注意:此字段可能返回 null,表示取不到有效值。
    ContainerType String 封装格式过滤条件,可选值:
  • Video:视频格式,可以同时包含视频流和音频流的封装格式;
  • PureAudio:纯音频格式,只能包含音频流的封装格式板。

  • 示例值:“”
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:“”
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:“”
    EnhanceConfig EnhanceConfig 音视频增强配置。
    注意:此字段可能返回 null,表示取不到有效值。

    TranslateConfigureInfo

    语音翻译任务控制参数

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

    名称 类型 必选 描述
    Switch String 语音翻译任务开关,可选值:
  • ON:开启智能语音翻译任务;
  • OFF:关闭智能语音翻译任务。
  • SourceLanguage String 视频源语言。
    DestinationLanguage String 翻译目标语言。

    TranslateConfigureInfoForUpdate

    语音翻译任务控制参数

    被如下接口引用:ModifyAIRecognitionTemplate。

    名称 类型 必选 描述
    Switch String 语音翻译任务开关,可选值:
  • ON:开启智能语音翻译任务;
  • OFF:关闭智能语音翻译任务。
  • SourceLanguage String 视频源语言。
    DestinationLanguage String 翻译目标语言。

    UrlInputInfo

    媒体处理 URL 对象信息。

    被如下接口引用:DescribeMediaMetaData, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。

    名称 类型 必选 描述
    Url String 视频的 URL。
    示例值:NULL

    UserDefineAsrTextReviewTemplateInfo

    用户自定义语音审核任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 用户自定语音审核任务开关,可选值:
  • ON:开启自定义语音审核任务;
  • OFF:关闭自定义语音审核任务。
  • LabelSet Array of String 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    UserDefineAsrTextReviewTemplateInfoForUpdate

    用户自定义语音审核任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 用户自定语音审核任务开关,可选值:
  • ON:开启自定义语音审核任务;
  • OFF:关闭自定义语音审核任务。
  • LabelSet Array of String 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。

    UserDefineConfigureInfo

    用户自定义审核任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    FaceReviewInfo UserDefineFaceReviewTemplateInfo 用户自定义人物审核控制参数。
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfo 用户自定义语音审核控制参数。
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfo 用户自定义文本审核控制参数。

    UserDefineConfigureInfoForUpdate

    用户自定义审核任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    FaceReviewInfo UserDefineFaceReviewTemplateInfoForUpdate 用户自定义人物审核控制参数。
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfoForUpdate 用户自定义语音审核控制参数。
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfoForUpdate 用户自定义文本审核控制参数。

    UserDefineFaceReviewTemplateInfo

    用户自定义人物审核任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 用户自定义人物审核任务开关,可选值:
  • ON:开启自定义人物审核任务;
  • OFF:关闭自定义人物审核任务。
  • LabelSet Array of String 用户自定义人物过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 97 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 95 分。取值范围:0~100。

    UserDefineFaceReviewTemplateInfoForUpdate

    用户自定义人物审核任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 用户自定义人物审核任务开关,可选值:
  • ON:开启自定义人物审核任务;
  • OFF:关闭自定义人物审核任务。
  • LabelSet Array of String 用户自定义人物过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。

    UserDefineOcrTextReviewTemplateInfo

    用户自定义文本审核任务控制参数

    被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。

    名称 类型 必选 描述
    Switch String 用户自定文本审核任务开关,可选值:
  • ON:开启自定义文本审核任务;
  • OFF:关闭自定义文本审核任务。
  • LabelSet Array of String 用户自定义文本过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。

    UserDefineOcrTextReviewTemplateInfoForUpdate

    用户自定义文本审核任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 用户自定文本审核任务开关,可选值:
  • ON:开启自定义文本审核任务;
  • OFF:关闭自定义文本审核任务。
  • LabelSet String 用户自定义文本过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。

    VideoDenoiseConfig

    视频降噪配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • weak
  • strong

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

    VideoEnhanceConfig

    视频增强配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    FrameRate FrameRateConfig 插帧帧率配置。
    注意:此字段可能返回 null,表示取不到有效值。
    SuperResolution SuperResolutionConfig 超分配置。
    注意:此字段可能返回 null,表示取不到有效值。
    Hdr HdrConfig HDR配置。
    注意:此字段可能返回 null,表示取不到有效值。
    Denoise VideoDenoiseConfig 视频降噪配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ImageQualityEnhance ImageQualityEnhanceConfig 综合增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ColorEnhance ColorEnhanceConfig 色彩增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    SharpEnhance SharpEnhanceConfig 细节增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    FaceEnhance FaceEnhanceConfig 人脸增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    LowLightEnhance LowLightEnhanceConfig 低光照增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ScratchRepair ScratchRepairConfig 去划痕配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ArtifactRepair ArtifactRepairConfig 去伪影(毛刺)配置。
    注意:此字段可能返回 null,表示取不到有效值。

    VideoTemplateInfo

    视频流配置参数

    被如下接口引用:CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate, ProcessMedia, ResetWorkflow。

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

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

  • 默认值:open。
    注意:自适应模式时,Width不能小于Height。
    示例值: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
    Gop Integer 关键帧 I 帧之间的间隔,取值范围:0 和 [1, 100000],单位:帧数。
    当填 0 或不填时,系统将自动设置 gop 长度。
    示例值:0
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊填充。

  • 默认值:black 。
    注意:自适应码流只支持 stretch、black。
    示例值:black
    Vcrf Integer 视频恒定码率控制因子,取值范围为[1, 51]。
    如果指定该参数,将使用 CRF 的码率控制方式做转码(视频码率将不再生效)。
    如果没有特殊需求,不建议指定该参数。
    示例值:1

    VideoTemplateInfoForUpdate

    视频流配置参数

    被如下接口引用:CreateWorkflow, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。

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

  • 注意:目前 H.265 编码必须指定分辨率,并且需要在 640*480 以内。
    注意:av1 编码容器目前只支持 mp4 。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:libx264
    Fps Integer 视频帧率,取值范围:[0, 120],单位:Hz。
    当取值为 0,表示帧率和原始视频保持一致。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Bitrate Integer 视频流的码率,取值范围:0 和 [128, 35000],单位:kbps。
    当取值为 0,表示视频码率和原始视频保持一致。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ResolutionAdaptive String 分辨率自适应,可选值:
  • open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
  • close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。

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

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Height Integer 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Gop Integer 关键帧 I 帧之间的间隔,取值范围:0 和 [1, 100000],单位:帧数。当填 0 时,系统将自动设置 gop 长度。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊填充。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:stretch
    Vcrf Integer 视频恒定码率控制因子。取值范围为[0, 51],填0表示禁用该参数。
    如果没有特殊需求,不建议指定该参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ContentAdaptStream Integer 内容自适应编码。可选值:
  • 0:不开启
  • 1:开启

  • 默认值: 0. 当开启该参数时,将会自适应生成多个不同分辨率,不同码率的码流, 其中VideoTemplate的宽和高为多个码流中的最大分辨率,VideoTemplate中的码率为多个码流中的最高码率, VideoTemplate中的vcrf为多个码流中的最高质量。 当不设置分辨率、码率和vcrf时, ContentAdaptStream 参数生成的最高分辨率为视频源的分辨率,视频质量为接近vmaf95分。 若要开启该参数或了解计费细节, 请联系您的腾讯云商务。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    VolumeBalanceConfig

    音量均衡配置

    被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:“”
    Type String 类型,可选值:
  • loudNorm:响度标准化
  • gainControl:减小突变

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

    WatermarkInput

    媒体处理任务中的水印参数类型

    被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Definition Integer 水印模板 ID。
    示例值:NULL
    RawParameter RawWatermarkParameter 水印自定义参数,当 Definition 填 0 时有效。
    该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。
    水印自定义参数不支持截图打水印。
    示例值:NULL
    TextContent String 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。
    文字水印不支持截图打水印。
    示例值:NULL
    SvgContent String SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。
    SVG 水印不支持截图打水印。
    示例值:NULL
    StartTimeOffset Float 水印的起始时间偏移,单位:秒。不填或填0,表示水印从画面出现时开始显现。
  • 不填或填0,表示水印从画面开始就出现;
  • 当数值大于0时(假设为 n),表示水印从画面开始的第 n 秒出现;
  • 当数值小于0时(假设为 -n),表示水印从离画面结束 n 秒前开始出现。

  • 示例值:NULL
    EndTimeOffset Float 水印的结束时间偏移,单位:秒。
  • 不填或填0,表示水印持续到画面结束;
  • 当数值大于0时(假设为 n),表示水印持续到第 n 秒时消失;
  • 当数值小于0时(假设为 -n),表示水印持续到离画面结束 n 秒前消失。

  • 示例值:NULL

    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:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下。;
  • WorkflowInfo

    工作流信息详情。

    被如下接口引用:DescribeWorkflows。

    名称 类型 描述
    WorkflowId Integer 工作流 ID。
    示例值:NULL
    WorkflowName String 工作流名称。
    示例值:NULL
    Status String 工作流状态,取值范围:
  • Enabled:已启用,
  • Disabled:已禁用。

  • 示例值:NULL
    Trigger WorkflowTrigger 工作流绑定的输入规则,当上传视频命中该规则到该对象时即触发工作流。
    示例值:NULL
    OutputStorage TaskOutputStorage 媒体处理的文件输出存储位置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    MediaProcessTask MediaProcessTaskInput 媒体处理类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AiContentReviewTask AiContentReviewTaskInput 视频内容审核类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AiAnalysisTask AiAnalysisTaskInput 视频内容分析类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AiRecognitionTask AiRecognitionTaskInput 视频内容识别类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    TaskNotifyConfig TaskNotifyConfig 任务的事件通知信息,不填代表不获取事件通知。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    TaskPriority Integer 任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
    示例值:NULL
    OutputDir String 媒体处理生成的文件输出的目标目录,如/movie/201907/
    示例值:NULL
    CreateTime String 工作流创建时间,使用 ISO 日期格式
    示例值:NULL
    UpdateTime String 工作流最后修改时间,使用 ISO 日期格式
    示例值:NULL

    WorkflowTask

    媒体处理任务信息

    被如下接口引用:DescribeTaskDetail, ParseNotification。

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

  • 示例值:NULL
    ErrCode Integer 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。
    示例值:NULL
    Message String 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。
    示例值:NULL
    InputInfo MediaInputInfo 媒体处理的目标文件信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    MetaData MediaMetaData 原始视频的元信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    MediaProcessResultSet Array of MediaProcessTaskResult 媒体处理任务的执行状态与结果。
    示例值:NULL
    AiContentReviewResultSet Array of AiContentReviewResult 视频内容审核任务的执行状态与结果。
    示例值:NULL
    AiAnalysisResultSet Array of AiAnalysisResult 视频内容分析任务的执行状态与结果。
    示例值:NULL
    AiRecognitionResultSet Array of AiRecognitionResult 视频内容识别任务的执行状态与结果。
    示例值:NULL
    AiQualityControlTaskResult ScheduleQualityControlTaskResult 视频质检任务的执行状态与结果。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    WorkflowTrigger

    输入规则,当上传视频命中该规则时,即触发工作流。

    被如下接口引用:CreateSchedule, CreateWorkflow, DescribeSchedules, DescribeWorkflows, ModifySchedule, ResetWorkflow。

    名称 类型 必选 描述
    Type String 触发器的类型,可选值:
  • CosFileUpload:COS触发
  • AwsS3FileUpload:AWS触发,目前只支持转码任务。只有编排支持,工作流不支持。


  • CosFileUploadTrigger CosFileUploadTrigger 当 Type 为 CosFileUpload 时必填且有效,为 COS 触发规则。
    注意:此字段可能返回 null,表示取不到有效值。
    AwsS3FileUploadTrigger AwsS3FileUploadTrigger 当 Type 为 AwsS3FileUpload 时必填且有效,为 AWS S3 触发规则。

    注意:目前AWS的S3、对应触发队列SQS、回调队列SQS的秘钥需要一致。
    注意:此字段可能返回 null,表示取不到有效值。