数据结构

最近更新时间:2026-05-29 16:44:53

我的收藏

AIAnalysisTemplateItem

AI 智能分析模板详情

被如下接口引用:DescribeAIAnalysisTemplates。

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

AIRecognitionTemplateItem

视频内容识别模板详情

被如下接口引用:DescribeAIRecognitionTemplates。

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

ActionConfigInfo

动作识别参数配置

被如下接口引用:RecognizeMediaForZhiXue。

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

  • 示例值:ON

    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:自适应码流
  • action-AIQualityControl:媒体质检
  • action-SmartSubtitles:智能字幕
  • action-exec-rules:判断规则
  • action-SmartErase:智能擦除




  • 示例值:input
    ReardriveIndex Array of Integer 后驱节点索引数组
    示例值:[3]
    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,表示取不到有效值。
    QualityControlTask AiQualityControlTaskInput 媒体质检任务
    注意:此字段可能返回 null,表示取不到有效值。
    ExecRulesTask ExecRulesTask 任务条件判断
    注意:此字段可能返回 null,表示取不到有效值。
    SmartSubtitlesTask SmartSubtitlesTaskInput 智能字幕任务
    注意:此字段可能返回 null,表示取不到有效值。
    SmartEraseTask SmartEraseTaskInput 智能擦除任务
    注意:此字段可能返回 null,表示取不到有效值。

    ActivityResItem

    编排子任务输出

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

    名称 类型 描述
    TranscodeTask MediaProcessTaskTranscodeResult 转码任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    AnimatedGraphicTask MediaProcessTaskAnimatedGraphicResult 转动图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotByTimeOffsetTask MediaProcessTaskSnapshotByTimeOffsetResult 时间点截图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    SampleSnapshotTask MediaProcessTaskSampleSnapshotResult 采样截图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    ImageSpriteTask MediaProcessTaskImageSpriteResult 雪碧图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult 自适应码流任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    RecognitionTask ScheduleRecognitionTaskResult 识别任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    ReviewTask ScheduleReviewTaskResult 审核任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    AnalysisTask ScheduleAnalysisTaskResult 分析任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    QualityControlTask ScheduleQualityControlTaskResult 媒体质检任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    ExecRuleTask ScheduleExecRuleTaskResult 条件判断任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    SmartSubtitlesTask ScheduleSmartSubtitleTaskResult 智能字幕任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    SmartEraseTask SmartEraseTaskResult 智能擦除任务输出
    注意:此字段可能返回 null,表示取不到有效值。

    ActivityResult

    编排任务输出

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

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

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

    AdBreakInfo

    AdBreakInfo。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms, ModifyStreamPackageLinearAssemblyProgram。

    名称 类型 必选 描述
    SourceLocationId String SourceLocationId。
    示例值:698557DC1D3EA60266EB
    VodSourceName String VodSourceName。
    示例值:source_name
    Offset Integer Offset。
    示例值:64000
    MessageType String MessageType,分SpliceInsert和TimeSignal。
    示例值:SpliceInsert
    TimeSignalConf TimeSignalInfo TimeSignalConf。
    SpliceInsertConf SpliceInsertInfo SpliceInsertConf。
    Metadatas Array of Metadata Metadatas。
    SourceLocationName String SourceLocationName。
    示例值:ad_location

    AdaptiveDynamicStreamingInfoItem

    转自适应码流信息

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

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

    AdaptiveDynamicStreamingTaskInput

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

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

    名称 类型 必选 描述
    Definition Integer 转自适应码流模板 ID。
    示例值:10
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    BlindWatermark BlindWatermarkInput 数字水印参数
    注意:此字段可能返回 null,表示取不到有效值。
    OutputStorage TaskOutputStorage 转自适应码流后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 转自适应码流后,manifest 文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明
    相对路径示例:
  • 文件名_{变量名}.{format}
  • 文件名.{format}

  • 绝对路径示例:
  • /自定义路径/文件名_{变量名}.{format}

  • 如果不填,则默认为相对路径:{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,表示取不到有效值。
    DefinitionType String 自适应转码模板类型:
    Common:音视频类型
    PureAudio:纯音频类型
    示例值:Common
    SubtitleTemplate SubtitleTemplate 硬字幕(压制字幕)功能,指定字幕来源、字体大小、位置等字幕参数。
    注意:此字段可能返回 null,表示取不到有效值。
    StdExtInfo String 转码参数扩展字段
    示例值:{"audio_info": {"codec": "vivid"}}
    KeyPTSList Array of Integer 指定pts时间的帧设为关键帧,并切片。单位毫秒(允许相对偏差<=1ms)。当同时指定gop和切片时长时,会共同作用。注意需开启RawPts,保持帧率随源,并确保传入的pts时间在源中是有对应帧的。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1000, 2000]

    AdaptiveDynamicStreamingTemplate

    转自适应码流模板详情

    被如下接口引用:DescribeAdaptiveDynamicStreamingTemplates。

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

  • 示例值:Custom
    Name String 转自适应码流模板名称。
    示例值:转自适应码流模板
    Comment String 转自适应码流模板描述信息。
    示例值:转自适应码流模板
    Format String 转自适应码流格式,取值范围:
  • HLS,
  • MPEG-DASH。

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

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

  • 示例值:0
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2024-12-27T09:06:08Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2024-12-27T09:06:08Z
    PureAudio Integer 是否为纯音频,0表示视频,1表示纯音频
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SegmentType String hls 分片类型,可选值:
  • ts-segment:HLS+TS 切片
  • ts-byterange:HLS+TS byte range
  • mp4-segment:HLS+MP4 切片
  • mp4-byterange:HLS+MP4 byte range
  • ts-packed-audio:TS+Packed Audio
  • mp4-packed-audio:MP4+Packed Audio

  • 默认值:ts-segment

    注:自适应码流的hls分片格式已此字段为准
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ts-segment

    AdaptiveStreamTemplate

    自适应转码流参数模板

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

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

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

  • 示例值:0
    AudioList Array of AudioTemplateInfo 音频参数信息列表。
    注意:参数只在自适应转码使用音轨合并多音轨时使用, 参数数组长度最大为64。
    注意:此字段可能返回 null,表示取不到有效值。

    AddBlindWatermarkConfig

    增加盲水印配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

  • 默认值:ON。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ON
    EmbedInfo BlindWatermarkEmbedInfo 盲水印嵌入数据
    注意:此字段可能返回 null,表示取不到有效值。

    AddOnImageInput

    图片处理编排中使用的输入参数。

    被如下接口引用:ProcessImage。

    名称 类型 必选 描述
    Type String

    图片类型。


    示例值:mask
    Image MediaInputInfo

    图片路径。

    AddOnParameter

    图片处理附加输入参数。

    被如下接口引用:ProcessImage。

    名称 类型 必选 描述
    ImageSet Array of AddOnImageInput 附加图片输入。
    OutputConfig ImageProcessOutputConfig 图片处理输出配置。
    ExtPrompt Array of ImageProcessPrompt 图片处理附加 prompt,只针对某些场景可用。

    AddOnSubtitle

    外挂字幕。

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

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

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:subtitle-stream
    Subtitle MediaInputInfo 字幕文件。
    注意:此字段可能返回 null,表示取不到有效值。
    SubtitleName String 字幕名称 。
    注意:仅支持中文、英文、数字、空格、下划线(_)、短横线(-)、句点(.)和中英文括号,长度不能超过64个字符。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:字幕1
    OutputFormat String 字幕输出格式。取值{"WebVTT","TTML"}。
    默认值:"WebVTT"
    示例值:WebVTT
    DefaultTrack Boolean 默认字幕轨道。为true时指定当前字幕为默认字幕轨道,最多可指定1条默认字幕轨道。
    默认值:false
    示例值:false

    AdvancedSuperResolutionConfig

    超分配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

  • 默认值:ON。
    示例值:ON
    Type String 类型,可选值:
  • standard:通用超分
  • super:高级超分super版。
  • ultra:高级超分ultra版。

  • 默认值:standard。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:standard
    Mode String 输出图片模式,默认percent。
  • aspect: 超分至指定宽高的较大矩形。
  • fixed: 超分至固定宽高,强制缩放。
  • percent: 超分倍率,可以为小数。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:percent
    Percent Float 超分倍率,可以为小数。
    注意:当Mode等于percent时使用。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2.0
    Width Integer 目标图片宽度,不能超过4096。
    注意:当Mode等于aspect或fixed时,优先使用此配置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1280
    Height Integer 目标图片高度,不能超过4096。
    注意:当Mode等于aspect或fixed时,优先使用此配置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:720
    LongSide Integer 目标图片长边长度,不能超过4096。
    注意:当Mode等于aspect或fixed,且未配置Width和Height字段时使用此配置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1280
    ShortSide Integer 目标图片短边长度,不能超过4096。
    注意:当Mode等于aspect或fixed,且未配置Width和Height字段时使用此配置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1280

    AiAnalysisResult

    智能分析结果

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

    名称 类型 描述
    Type String 任务的类型,可以取的值有:
  • Classification:智能分类
  • Cover:智能封面
  • Tag:智能标签
  • FrameTag:智能按帧标签
  • Highlight:智能精彩集锦
  • DeLogo:智能擦除
  • Description:大模型摘要
  • Dubbing:智能译制
  • VideoRemake: 视频去重
  • VideoComprehension: 视频(音频)理解
  • Cutout:视频抠图
  • Reel:智能成片

  • 示例值: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,表示取不到有效值。
    SegmentTask AiAnalysisTaskSegmentResult 视频内容分析拆条任务的查询结果,当任务类型为 SegmentRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    HeadTailTask AiAnalysisTaskHeadTailResult 视频内容分析片头片尾任务的查询结果,当任务类型为 HeadTailRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    DescriptionTask AiAnalysisTaskDescriptionResult 视频内容分析摘要任务的查询结果,当任务类型为 Description 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    HorizontalToVerticalTask AiAnalysisTaskHorizontalToVerticalResult 视频内容分析横转竖任务的查询结果,当任务类型为 HorizontalToVertical 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    DubbingTask AiAnalysisTaskDubbingResult 视频内容分析译制任务的查询结果,当任务类型为 Dubbing 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    VideoRemakeTask AiAnalysisTaskVideoRemakeResult 视频内容分析去重任务的查询结果,当任务类型为 VideoRemake 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    VideoComprehensionTask AiAnalysisTaskVideoComprehensionResult 视频(音频)理解任务的查询结果,当任务类型为 VideoComprehension 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    CutoutTask AiAnalysisTaskCutoutResult 视频内容分析智能抠图任务的查询结果,当任务类型为Cutout时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    ReelTask AiAnalysisTaskReelResult 视频内容分析AI解说二创任务的查询结果,当任务类型为Reel时有效。
    注意:此字段可能返回 null,表示取不到有效值。

    AiAnalysisTaskClassificationInput

    智能分类任务输入类型

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

    名称 类型 描述
    Definition Integer

    视频智能分类模板 ID。


    示例值:10
    ExtendedParameter String

    扩展参数。


    示例值:{"class":""}

    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。


    示例值:10
    ExtendedParameter String

    扩展参数。


    示例值:{"cover":""}

    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

    AiAnalysisTaskCutoutInput

    智能抠图任务输入类型

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

    名称 类型 必选 描述
    Definition Integer

    视频智能抠图模板 ID。


    示例值:34
    ExtendedParameter String

    扩展参数。


    示例值:{"cutout":""}

    AiAnalysisTaskCutoutOutput

    视频抠图结果信息

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

    名称 类型 描述
    Path String 视频智能抠图文件路径。
    示例值:/output/htv-process-result.mp4
    OutputStorage TaskOutputStorage 视频智能抠图的存储位置。

    AiAnalysisTaskCutoutResult

    视频智能抠图结果数据结构

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSINGSUCCESSFAIL 三种
    示例值:SUCCESS
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:InvalidInput
    Message String 错误信息
    示例值:SUCCESS
    Input AiAnalysisTaskCutoutInput 抠图任务输入
    Output AiAnalysisTaskCutoutOutput 抠图任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    Progress Integer 任务进度
    示例值:100
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式。
    示例值:2025-03-25T06:16:39Z
    FinishTime String 任务结束执行的时间,采用 ISO 日期格式。
    示例值:2025-03-25T06:17:10Z

    AiAnalysisTaskDelLogoInput

    智能擦除任务输入类型

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

    名称 类型 描述
    Definition Integer

    视频智能擦除模板 ID。


    示例值:293034
    ExtendedParameter String

    扩展参数。


    示例值:{"delogo":""}

    AiAnalysisTaskDelLogoOutput

    智能擦除结果信息

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

    名称 类型 描述
    Path String

    擦除后文件的路径。


    示例值:/output/test-result.mp4
    OutputStorage TaskOutputStorage

    擦除后文件的存储位置。

    OriginSubtitlePath String

    基于画面提取的字幕文件路径。


    示例值:/output/1869644145.vtt
    TranslateSubtitlePath String

    基于画面提取的字幕翻译文件路径。


    示例值:/output/1869644146.vtt
    SubtitlePos SubtitlePosition

    擦除的字幕位置。注意:仅对字幕提取且开启返回字幕位置时有效。


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

    音色克隆后的视频文件地址


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/output/delogo-result-0.mp4
    VoiceClonedMarkFile String

    音色克隆的标注文件地址


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/output/delogo-result-0.json

    AiAnalysisTaskDelLogoResult

    智能擦除结果类型

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

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

    AiAnalysisTaskDescriptionInput

    智能分类任务输入类型

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

    名称 类型 描述
    Definition Integer

    视频智能描述模板 ID。


    示例值:10
    ExtendedParameter String

    扩展参数。


    示例值:{"des":""}

    AiAnalysisTaskDescriptionOutput

    智能描述结果信息

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

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

    AiAnalysisTaskDescriptionResult

    智能描述结果类型

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

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

    AiAnalysisTaskDubbingInput

    智能译制任务输入类型

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

    名称 类型 描述
    Definition Integer

    视频译制模板 ID。


    示例值:32
    ExtendedParameter String

    扩展参数。


    示例值:{"dubb":""}

    AiAnalysisTaskDubbingOutput

    智能译制结果信息

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

    名称 类型 描述
    VideoPath String

    译制视频路径。


    示例值:/output/dub-result-0.mp4
    SpeakerPath String

    标记文件路径


    示例值:/output/dub-result-0.json
    VoiceId String

    音色id


    示例值:v1_cjYJK5SMrD583Pa28RJIGirQltxJz2M7opo7kX9OaPi3zqUitPkBTfSWSZw=
    OutputStorage TaskOutputStorage

    译制视频存储位置。

    AiAnalysisTaskDubbingResult

    智能译制结果类型

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

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

    AiAnalysisTaskFrameTagInput

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

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

    名称 类型 描述
    Definition Integer

    视频智能按帧标签模板 ID。


    示例值:20
    ExtendedParameter String

    扩展参数。


    示例值:{"frame":""}

    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

    AiAnalysisTaskHeadTailInput

    片头片尾任务输入类型

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

    名称 类型 描述
    Definition Integer

    片头片尾识别模板 ID。


    示例值:319919
    ExtendedParameter String

    扩展参数。


    示例值:{"seek":""}

    AiAnalysisTaskHeadTailOutput

    片头片尾结果信息

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

    名称 类型 描述
    HeadTimeOffset Float 片头pts。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    TailTimeOffset Float 片尾pts。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    AiAnalysisTaskHeadTailResult

    片头片尾结果类型

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

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

    AiAnalysisTaskHighlightInput

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

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

    名称 类型 描述
    Definition Integer

    视频智能精彩片段模板 ID。


    示例值:26
    ExtendedParameter String

    扩展参数。


    示例值:{"hht":""}

    AiAnalysisTaskHighlightOutput

    智能精彩片段结果信息

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

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

    AiAnalysisTaskHighlightResult

    智能精彩片段结果类型

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

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

    AiAnalysisTaskHorizontalToVerticalInput

    智能横转竖任务输入类型

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

    名称 类型 描述
    Definition Integer

    视频智能横转竖模板 ID


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

    扩展参数。


    示例值:{"htv":""}

    AiAnalysisTaskHorizontalToVerticalOutput

    智能横转竖结果信息

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

    名称 类型 描述
    Path String 视频智能横转竖列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/output/htv-process-result.mp4
    OutputStorage TaskOutputStorage 智能横转竖视频的存储位置
    注意:此字段可能返回 null,表示取不到有效值。
    Confidence Float 置信度。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    AiAnalysisTaskHorizontalToVerticalResult

    智能横转竖结果类型

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

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

    AiAnalysisTaskInput

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

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

    名称 类型 必选 描述
    Definition Integer 视频内容分析模板 ID。
    示例值:28
    ExtendedParameter String 扩展参数,其值为序列化的 json字符串。
    注意:此参数为定制需求参数,参考如下:
    智能檫除
    智能拆条
    高光集锦
    智能横转竖
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"{"htv": {} }"

    AiAnalysisTaskReelInput

    智能成片任务输入类型

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

    名称 类型 描述
    Definition Integer

    智能成片模板 ID。


    示例值:10
    ExtendedParameter String

    扩展参数。


    示例值:{"aianaly":"task"}

    AiAnalysisTaskReelOutput

    AI解说二创结果信息

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

    名称 类型 描述
    VideoPath String 解说视频路径。
    示例值:/output/dub-result-0.mp4
    VideoPaths Array of String 解说视频路径列表。

    注意
    1. 当返回一个文件时,VideoPath返回一个文件路径,VideoPaths也会填充同样路径的一个元素。
    2. 当返回多个文件时,VideoPath返回为空字符串,VideoPaths返回多文件路径列表。
    示例值:["/output/dub-result-0.mp4", "/output/dub-result-1.mp4"]
    ScriptPath String 脚本文件路径

    示例值:/output/dub-result-0.json
    OutputStorage TaskOutputStorage 解说视频存储位置。

    AiAnalysisTaskReelResult

    AI解说二创结果类型

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:SUCCESS
    ErrCode Integer 错误码,0:成功,其他值:失败。
    示例值:0
    Message String 错误信息。
    示例值:SUCCESS
    Input AiAnalysisTaskReelInput AI解说二创任务输入。
    Output AiAnalysisTaskReelOutput AI解说二创任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:InvalidInput
    Progress Integer 任务进度。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2024-05-25T02:55:55Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2024-05-25T02:56:19Z

    AiAnalysisTaskSegmentInput

    拆条任务输入类型

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

    名称 类型 描述
    Definition Integer

    拆条任务模板 ID。


    示例值:27
    ExtendedParameter String

    扩展参数。


    示例值:{"segment":""}

    AiAnalysisTaskSegmentOutput

    智能拆条结果信息

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

    名称 类型 描述
    SegmentSet Array of SegmentRecognitionItem 智能拆条子片段列表。
    Abstract String 视频摘要,离线场景用。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:This video introduces Tencent cloud streaming products, including Stream Live, Stream Link, and Stream Package.

    AiAnalysisTaskSegmentResult

    拆条结果类型

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

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

    AiAnalysisTaskTagInput

    智能标签任务输入类型

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

    名称 类型 描述
    Definition Integer

    视频智能标签模板 ID。


    示例值:20
    ExtendedParameter String

    扩展参数。


    示例值:{"tag":""}

    AiAnalysisTaskTagOutput

    智能标签结果信息

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

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

    AiAnalysisTaskTagResult

    智能标签结果类型

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

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

    AiAnalysisTaskVideoComprehensionInput

    视频(音频)理解任务输入

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

    名称 类型 描述
    Definition Integer

    视频(音频)理解模板ID


    示例值:33
    ExtendedParameter String

    扩展参数。


    示例值:{"compre":""}

    AiAnalysisTaskVideoComprehensionOutput

    视频(音频)理解输出内容结果信息

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

    名称 类型 描述
    VideoComprehensionAnalysisResult String 视频(音频)理解内容详情
    示例值:您好!作为一名专业的音乐分析师,非常荣幸能为您分析这段《梦中的婚礼》的钢琴弹奏。这是一首非常优美且广为人知的曲子,能选择它来练习,说明您对音乐有很好的品味和追求....
    VideoComprehensionExtInfo String 视频(音频)理解扩展信息
    示例值:{"reasoningContent":"Okay, here's how I would summarize this video, reflecting my thought process as I would analyze the scene:\n\nAs a seasoned observer of human dynamics"}
    VideoComprehensionResultList Array of VideoComprehensionResultItem 视频分镜理解结果

    AiAnalysisTaskVideoComprehensionResult

    视频(音频)理解结果

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSINGSUCCESSFAIL 三种。
    示例值:SUCCESS
    ErrCode Integer 错误码,0:成功,其他值:失败
    示例值:0
    Message String 错误信息
    示例值:SUCCESS
    Input AiAnalysisTaskVideoComprehensionInput 视频(音频)理解输入
    Output AiAnalysisTaskVideoComprehensionOutput 视频(音频)理解输出
    注意:此字段可能返回 null,表示取不到有效值。
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表
    示例值:InvalidInput
    Progress Integer 任务进度
    示例值:100
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式。
    示例值:2024-05-25T02:55:55Z
    FinishTime String 任务执行完毕时间,采用 ISO 日期格式。
    示例值:2024-05-25T02:55:58Z

    AiAnalysisTaskVideoRemakeInput

    视频去重任务输入类型

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

    名称 类型 描述
    Definition Integer

    视频智能去重模板 ID


    示例值:28
    ExtendedParameter String

    扩展参数。


    示例值:{"remake":""}

    AiAnalysisTaskVideoRemakeOutput

    视频去重结果信息

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

    名称 类型 描述
    Path String 视频智能去重文件路径
    示例值:/output/htv-process-result.mp4
    OutputStorage TaskOutputStorage 智能视频去重的存储位置

    AiAnalysisTaskVideoRemakeResult

    视频去重结果数据结构

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSINGSUCCESSFAIL 三种
    示例值:SUCCESS
    ErrCode Integer 错误码,0:成功,其他值:失败
    示例值:0
    Message String 错误信息
    示例值:SUCCESS
    Input AiAnalysisTaskVideoRemakeInput 去重任务输入
    Output AiAnalysisTaskVideoRemakeOutput 去重任务输出
    注意:此字段可能返回 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,表示取不到有效值。
    示例值:This video highlights the live streaming services provided by Ten Cent Cloud Media Services
    Title String 分段标题
    示例值:Tencent Cloud Media Services: Streamlining Live Streaming Solutions
    Keywords Array of String 分段关键词
    示例值:["words1","words2"]
    StartTimeOffset Float 分段起始时间点,秒
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2.532
    EndTimeOffset Float 分段结束时间点,秒
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5.532

    AiQualityControlTaskInput

    媒体质检输入参数类型

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

    名称 类型 必选 描述
    Definition Integer 媒体质检模板 ID 。
    可以直接使用预设模板,也可以在控制台自定义模板。预设模板如下:
    - 10:开启所有质检项;
    - 20:仅开启格式诊断对应质检项;
    - 30:仅开启无参考打分对应质检项;
    - 40:仅开启画面质量对应质检项。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    ChannelExtPara String 渠道扩展参数json序列化字符串。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"OutputDir":"/test/output/1abc***12345/"}

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

    AiRecognitionTaskAsrFullTextResultInput

    语音全文识别的输入。

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

    名称 类型 描述
    Definition Integer 语音全文识别模板 ID。
    示例值:10101

    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。


    示例值:100
    StartTimeOffset Float

    识别片段起始的偏移时间,单位:秒。


    示例值:3.204
    EndTimeOffset Float

    识别片段终止的偏移时间,单位:秒。


    示例值:7.204
    Text String

    识别文本。


    示例值:腾讯云媒体处理
    Wordlist Array of WordResult

    字词时间戳信息。

    AiRecognitionTaskAsrWordsResult

    语音关键词识别结果。

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

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

    AiRecognitionTaskAsrWordsResultInput

    语音关键词识别输入。

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

    名称 类型 描述
    Definition Integer 语音关键词识别模板 ID。
    示例值:20

    AiRecognitionTaskAsrWordsResultItem

    语音关键词识别结果。

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

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

    AiRecognitionTaskAsrWordsResultOutput

    语音关键词识别输出。

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

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

    AiRecognitionTaskAsrWordsSegmentItem

    语音识别片段。

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

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

    AiRecognitionTaskFaceResult

    人脸识别结果。

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

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

    AiRecognitionTaskFaceResultInput

    人脸识别输入。

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

    名称 类型 描述
    Definition Integer 人脸识别模板 ID。
    示例值:10

    AiRecognitionTaskFaceResultItem

    人脸识别结果

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

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

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

  • 示例值:Male
    Birthday String 人物出生日期。
    示例值:1953年6月
    Profession String 人物职业或者职务。
    示例值:歌手
    SchoolOfGraduation String 人物毕业院校。
    示例值:清华大学
    Abstract String 人物简介。
    示例值:知名歌手,代表作xxx
    PlaceOfBirth String 人物出生地或者籍贯。
    示例值:湖北武汉
    PersonType String 人物类型:
  • Politician:官员;
  • Artist:艺人。

  • 示例值:Politician
    Remark String 敏感度标注:
  • Normal:正常;
  • Sensitive:敏感。

  • 示例值:Normal
    Url String 截图链接
    示例值:https://test-result.com/face-recognition-person1.jpg

    AiRecognitionTaskFaceResultOutput

    智能人脸识别输出。

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

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

    AiRecognitionTaskFaceSegmentItem

    人脸识别结果片段

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

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

    AiRecognitionTaskInput

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

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

    名称 类型 必选 描述
    Definition Integer 视频智能识别模板 ID 。
    示例值:10
    UserExtPara String 用户扩展字段,一般场景不用填。
    示例值:{"ParaTest":"test"}

    AiRecognitionTaskObjectResult

    物体识别结果。

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

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

    AiRecognitionTaskObjectResultInput

    物体识别任务输入类型。

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

    名称 类型 描述
    Definition Integer 物体识别模板 ID。
    示例值:20

    AiRecognitionTaskObjectResultItem

    单个物体识别结果。

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

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

    AiRecognitionTaskObjectResultOutput

    智能物体识别输出。

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

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

    AiRecognitionTaskObjectSeqmentItem

    物体识别结果片段。

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

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

    AiRecognitionTaskOcrFullTextResult

    文本全文识别结果。

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

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

    AiRecognitionTaskOcrFullTextResultInput

    文本全文识别输入。

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

    名称 类型 描述
    Definition Integer 文本全文识别模板 ID。
    示例值:20

    AiRecognitionTaskOcrFullTextResultOutput

    文本全文识别输出。

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

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

    AiRecognitionTaskOcrFullTextSegmentItem

    文本全文识别片段。

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

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

    AiRecognitionTaskOcrFullTextSegmentTextItem

    文本全文识别片段。

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

    名称 类型 描述
    Confidence Float

    识别片段置信度。取值:0~100。


    示例值:100
    AreaCoordSet Array of Integer

    识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。


    示例值:[1592,84,1774,131]
    Text String

    识别文本。


    示例值:腾讯云

    AiRecognitionTaskOcrWordsResult

    文本关键识别结果。

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

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

    AiRecognitionTaskOcrWordsResultInput

    文本关键词识别输入。

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

    名称 类型 描述
    Definition Integer 文本关键词识别模板 ID。
    示例值:10

    AiRecognitionTaskOcrWordsResultItem

    文本关键词识别结果。

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

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

    AiRecognitionTaskOcrWordsResultOutput

    文本关键词识别输出。

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

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

    AiRecognitionTaskOcrWordsSegmentItem

    文本识别片段。

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

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

    AiRecognitionTaskTransTextResult

    翻译结果。

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

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

    AiRecognitionTaskTransTextResultInput

    翻译的输入。

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

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

    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
    Wordlist Array of WordResult

    字词时间戳信息。

    AiReviewPoliticalAsrTaskInput

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

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

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

    AiReviewPoliticalAsrTaskOutput

    Asr 文字敏感信息

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

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

  • 示例值:review
    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。

  • 示例值:review
    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。

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

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

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

    AiReviewPornAsrTaskInput

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

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

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

    AiReviewPornAsrTaskOutput

    Asr 文字涉黄信息

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

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

  • 示例值:review
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉黄嫌疑的视频片段列表。

    AiReviewPornOcrTaskInput

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

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

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

    AiReviewPornOcrTaskOutput

    Ocr 文字涉黄信息

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

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

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

    AiReviewPornTaskInput

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

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

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

    AiReviewPornTaskOutput

    鉴黄结果信息

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

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

  • 示例值:review
    Label String 视频鉴黄结果标签,取值范围:
  • porn:色情。
  • sexy:性感。
  • vulgar:低俗。
  • intimacy:亲密行为。

  • 示例值:porn
    SegmentSet Array of MediaContentReviewSegmentItem 有涉黄嫌疑的视频片段列表。

    AiReviewProhibitedAsrTaskInput

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

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

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

    AiReviewProhibitedAsrTaskOutput

    Asr 文字涉违禁信息

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

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

  • 示例值:review
    SegmentSet Array of MediaContentReviewAsrTextSegmentItem Asr 文字有涉违禁嫌疑的视频片段列表。

    AiReviewProhibitedOcrTaskInput

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

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

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

    AiReviewProhibitedOcrTaskOutput

    Ocr 文字涉违禁信息

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

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

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

    AiReviewTaskPoliticalAsrResult

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

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

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

    AiReviewTaskPoliticalOcrResult

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

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

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

    AiReviewTaskPoliticalResult

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

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

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

    AiReviewTaskPornAsrResult

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

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

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

    AiReviewTaskPornOcrResult

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

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

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

    AiReviewTaskPornResult

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

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

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

    AiReviewTaskProhibitedAsrResult

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

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

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

    AiReviewTaskProhibitedOcrResult

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

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

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

    AiReviewTaskTerrorismOcrResult

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

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

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

    AiReviewTaskTerrorismResult

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

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:SUCCESS
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:InvalidInput
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:SUCCESS
    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。

  • 示例值:review
    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。
    示例值:151***
    Url String 人脸图片地址。
    示例值:http://1234567.vod2.myqcloud.com/****/95f****d-****-****-****-132c8****9c73.jpeg

    AiSampleFaceOperation

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

    被如下接口引用:ModifyPersonSample。

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

  • 注意:图片必须是单人像正面人脸较清晰的照片,像素不低于 200200。
    示例值:["/9j/4***
    SkZJRg****SABIAAD"]

    AiSampleFailFaceInfo

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

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

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

  • 示例值:501
    Message String 错误描述。
    示例值:remote call error

    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 日期格式
    示例值:2025-03-25T06:16:39Z
    UpdateTime String 最后修改时间,使用 ISO 日期格式
    示例值:2025-03-25T06:16:39Z

    AiSampleTagOperation

    AI 样本管理,标签操作。

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

    名称 类型 必选 描述
    Type String 操作类型,可选值:add(添加)、delete(删除)、reset(重置)。
    示例值:add
    Tags Array of String 标签,长度限制:128 个字符。
    示例值:明星

    AiSampleWord

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

    被如下接口引用:DescribeWordSamples。

    名称 类型 描述
    Keyword String 关键词。
    示例值:张三
    TagSet Array of String 关键词标签。
    示例值: ["明星","艺人"]
    UsageSet Array of String 关键词应用场景。
    示例值:["Recognition.Ocr", "Recognition.Asr"]
    CreateTime String 创建时间,使用 ISO 日期格式
    示例值:2018-10-01T10:00:00Z
    UpdateTime String 最后修改时间,使用 ISO 日期格式
    示例值:2018-10-01T10:00:00Z

    AiSampleWordInfo

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

    被如下接口引用:CreateWordSamples。

    名称 类型 必选 描述
    Keyword String 关键词,长度限制:20 个字符。
    示例值:张三
    Tags Array of String 关键词标签
  • 数组长度限制:20 个标签;
  • 单个标签长度限制:128 个字符。

  • 示例值:["明星","艺人"]

    AigcImageExtraParam

    用于AIGC创作图片时用到的扩展参数信息。

    被如下接口引用:CreateAigcImageTask。

    名称 类型 必选 描述
    AspectRatio String

    指定所生成视频的宽高比。

    不同模型支持的宽高比:

    1. Kling 2.1支持:16:9、9:16、1:1、4:3、3:4、3:2、2:3、21:9。
    2. Kling 3.0支持:16:9、9:16、1:1、4:3、3:4、3:2、2:3、21:9。
    3. Kling 3.0-Omni支持:16:9、9:16、1:1、4:3、3:4、3:2、2:3、21:9。
    4. Kling O1支持:16:9、9:16、1:1、4:3、3:4、3:2、2:3、21:9。
    5. Vidu q2支持:16:9、9:16、1:1、3:4、4:3、21:9、2:3、3:2。
    6. MJ v7的宽高比需要在 prompt 中进行指定。

    注:具体模型的宽高比参数,可查看相应模型官网获取更完整描述。


    示例值:16:9
    Resolution String

    指定图片输出分辨率。

    支持该参数的模型:
    支持选择: 720P, 1080P, 2K, 4K。


    示例值:1080P
    LogoAdd Integer

    是否添加图标水印。默认不加。1-添加,0-不添加。

    取值范围:[0, 1]

    默认值:0


    示例值:0
    OutputFormat String

    指定图片的输出格式,支持jpeg, png。


    示例值:png

    AigcImageInfo

    用于AIGC创作的图片信息。

    被如下接口引用:CreateAigcImageTask。

    名称 类型 必选 描述
    ImageUrl String 用于指导视频生成的图片 URL。该URL需外网可访问。同时允许爬虫拉取。
    示例值:https://*.vod-qcloud.com/6cd2c44bvodcq1500039689/179cafb25145403699605999621/ClcE6jcA.png
    ReferenceType String 参考类型。
    注意:
    1. 当模型使用Vidu的q2多参考生图时,也可用于指定主体id。
    2. 当使用GV模型时,可作为参考方式,可选asset(素材)、style(风格)。
    示例值:asset

    AigcStoreCosParam

    Aigc结果文件上传COS时,需传入的信息。 需创建并授权MPS_QcsRole角色。

    被如下接口引用:CreateAigcImageTask, CreateAigcVideoTask。

    名称 类型 必选 描述
    CosBucketName String 存储至 cos 的 bucket 桶名称。需要cos存储时,该值必填。 示例值:bucket。
    示例值:aigc-test-video-1303333058
    CosBucketRegion String 存储至 cos 的 bucket 区域。与bucket所属区域相同,上传cos时必填。 示例值:ap-guangzhou
    示例值:ap-guangzhou
    CosBucketPath String 存储至 cos 的 bucket 路径。
    可选。
    示例值:my_file
    示例值:my_cos_file

    AigcVideoExtraParam

    用于AIGC创作视频时用到的扩展参数信息。

    被如下接口引用:CreateAigcVideoTask。

    名称 类型 必选 描述
    Resolution String

    生成视频的分辨率,分辨率与选择模型及设置的视频时长相关。

    不同模型支持的分辨率选项:

    1. Kling 720P(默认),1080P。Kling 3.0、Kling 3.0-Omni 支持 4K。
    2. Hailuo 768P(默认),1080P。
    3. Vidu 540P,720P(默认),1080P。
    4. PixVerse 540P,720P(默认),1080P。
    5. H2 720P,1080P(默认)。

    注意:除模型可支持的分辨率外,还可以生成 2K、4K分辨率。


    示例值:720P
    AspectRatio String

    指定所生成视频的宽高比。

    不同模型对于此参数的支持:

    1. Kling 仅文生视频支持, 16:9(默认值)、9:16、 1:1。
    2. Hailuo 暂不支持。
    3. Vidu 仅文生和参考图生视频支持 [16:9、9:16、4:3、3:4、1:1],其中仅 q2 支持 4:3、3:4。
    4. PixVerse 仅文生和参考图生视频支持 [16:9、9:16、4:3、3:4、1:1、2:3、3:2、21:9],其中仅 v6、c1 支持 2:3、3:2、21:9。
    5. H2 仅文生和参考图生视频支持 [16:9、9:16、4:3、3:4、4:5、5:4、1:1、21:9、9:21]。

    注:关于具体模型支持的宽高比例,可查看具体模型官网介绍获取更完整描述。


    示例值:16:9
    LogoAdd Integer

    是否添加图标水印。

    1. Hailuo 支持此参数。
    2. Kling 支持此参数。
    3. Vidu 支持此参数。
    4. H2 支持此参数。

    示例值:0
    EnableAudio Boolean

    为视频生成音频。接受的值包括 true 或 false。

    支持此参数的模型:

    1. Vidu,仅 q3 系列模型支持该参数,默认 false。
    2. PixVerse,默认 false。
    3. Kling,默认 false。

    示例值:false
    OffPeak Boolean

    错峰模型,目前仅支持Vidu模型。
    错峰模式下提交的任务,会在48小时内生成,未能完成的任务会被自动取消。


    示例值:false
    EnableBgm Boolean

    是否为生成的视频添加背景音乐。默认:false,可选值 true 、false。
    注意:部分模型的版本支持。


    示例值:false

    AigcVideoReferenceImageInfo

    用于AIGC生视频创作的参考图片信息。

    被如下接口引用:CreateAigcVideoTask。

    名称 类型 必选 描述
    ImageUrl String 用于指导视频生成的图片 URL。该URL需外网可访问。同时允许爬虫拉取。
    示例值:http://myimage.com/mps/image.png
    ReferenceType String 参考类型。
    注意:
    1. 当使用GV模型时,可作为参考方式,可选asset(素材)、style(风格)。
    示例值:asset

    AigcVideoReferenceVideoInfo

    用于AIGC视频生成的参考视频素材。

    被如下接口引用:CreateAigcVideoTask。

    名称 类型 必选 描述
    VideoUrl String 参考视频url。需要外网可访问。
    可作为特征参考视频,也可作为待编辑视频,默认为待编辑视频;可选择性保留视频原声
    通过ReferType参数区分参考视频类型:feature为特征参考视频,base为待编辑视频
    参考视频为待编辑视频时,不能定义视频首尾帧。
    ReferType String 通过ReferType参数区分参考视频类型:feature为特征参考视频,base为待编辑视频。
    KeepOriginalSound String 通过KeepOriginalSound参数选择是否保留视频原声,yes为保留,no为不保留;当前参数对特征参考视频(feature)也生效。

    AliasValueConf

    Alias-value配置信息。

    被如下接口引用:CreateStreamPackageSSAIChannel, ModifyStreamPackageSSAIChannel。

    名称 类型 必选 描述
    Alias String Alias。
    示例值:india
    Value String Value。
    示例值:ap-mumbai

    AnimatedGraphicTaskInput

    转动图任务类型。

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

    名称 类型 必选 描述
    Definition Integer

    视频转动图模板 ID。


    示例值:20000
    StartTimeOffset Float

    动图在视频中的开始时间,单位为秒。


    示例值:1.5
    EndTimeOffset Float

    动图在视频中的结束时间,单位为秒。


    示例值:11.2
    OutputStorage TaskOutputStorage

    转动图后文件的目标存储,不填则继承上层的 OutputStorage 值。


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

    转动图后文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明
    相对路径示例:

  • 文件名_{变量名}.{format}
  • 文件名.{format}
  • 绝对路径示例:
  • /自定义路径/文件名_{变量名}.{format}
  • 如果不填,则默认为相对路径:{inputName}_animatedGraphic_{definition}.{format}
    示例值:文件名_{变量名}.{format}
    ExtInfo String

    扩展参数。


    示例值:{"ainmated":""}

    AnimatedGraphicsTemplate

    转动图模板详情。

    被如下接口引用:DescribeAnimatedGraphicsTemplates。

    名称 类型 描述
    Definition Integer 转动图模板唯一标识。
    示例值:20001
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:Preset
    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。
    示例值: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。
    示例值:close
    Format String 动图格式。
    示例值:gif
    Fps Integer 帧率。
    示例值:2
    Quality Float 图片质量。
    示例值:75
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2016-12-31T16:00:00Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2016-12-31T16:00:00Z

    ArtifactRepairConfig

    去伪影(毛刺)配置

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

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

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

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

    AsrFullTextConfigureInfo

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

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

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

  • 示例值:ON
    SubtitleFormat String 生成的字幕文件格式,不填或者填空字符串表示不生成字幕文件,可选值:
  • vtt:生成 WebVTT 字幕文件。

  • 示例值:vtt
    SourceLanguage String 视频源语言。
    示例值:zh

    AsrFullTextConfigureInfoForUpdate

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

    被如下接口引用:ModifyAIRecognitionTemplate。

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

  • 示例值:ON
    SubtitleFormat String 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值:
  • vtt:生成 WebVTT 字幕文件。

  • 示例值:vtt
    SourceLanguage String 视频源语言。
    示例值:zh

    AsrHotWordsConfigure

    智能字幕热词参数

    被如下接口引用:BatchProcessMedia, CreateSmartSubtitleTemplate, DescribeSmartSubtitleTemplates, ModifySmartSubtitleTemplate, ProcessMedia。

    名称 类型 必选 描述
    Switch String 热词开关
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ON
    LibraryId String 热词库ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hwd-2670a776bb5eccccc324

    AsrHotwordsSet

    热词库查询返回结果集

    被如下接口引用:DescribeAsrHotwordsList。

    名称 类型 描述
    HotwordsId String 热词库 Id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hwd-aftgxxx
    Status Integer 当前热词库状态,数值表示绑定该热词库的智能字幕模板数量。
    Status 为 0 ,表示该热词库没有被智能字幕模板引用可以删除;
    Status 不为 0,表示该热词库不能被删除。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Name String 热词库名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hotwordname
    WordCount Integer 热词库中的热词数量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    FileName String 热词文件上传时的文件名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hwd.txt
    CreateTime String 热词库创建时间 ISOUTC 时间格式 2006-01-02T15:04:05Z
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2006-01-02T15:04:05Z
    UpdateTime String 热词库创建时间 ISOUTC 时间格式 2006-01-02T15:04:05Z
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2006-01-02T15:04:05Z
    Type Integer 0:临时热词库
    1:文件热词库
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    AsrHotwordsSetItem

    单个热词信息

    被如下接口引用:DescribeAsrHotwords。

    名称 类型 描述
    Id Integer 热词的序号
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5
    Text String 热词文本
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:腾讯云
    Weight Integer 词语权重,取值范围 1-10,11,100
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10

    AsrWordsConfigureInfo

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

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

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

  • 示例值:ON
    LabelSet Array of String 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["明星","艺人"]

    AsrWordsConfigureInfoForUpdate

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

    被如下接口引用:ModifyAIRecognitionTemplate。

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

  • 示例值:ON
    LabelSet Array of String 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["明星","艺人"]

    AssemblyUsageDetail

    线性组装信息查询

    被如下接口引用:DescribeStreamPackageLinearAssemblyUsage。

    名称 类型 必选 描述
    ChannelID String

    频道id


    示例值:69CA28574083B064D4BB
    Date String

    日期


    示例值:2026-02-10
    StartTime String

    查询开始时间


    示例值:2026-02-10T11:00:00+08:00
    EndTime String

    查询结束时间


    示例值:2026-02-10T11:20:00+08:00
    Duration Integer

    持续时间


    示例值:60
    ChannelTier String

    频道类型


    示例值:Basic
    ChannelName String

    频道名称


    示例值:test_channel

    AssemblyUsageInfo

    线性组装用量查询响应

    被如下接口引用:DescribeStreamPackageLinearAssemblyUsage。

    名称 类型 必选 描述
    AssemblyUsageDetails Array of AssemblyUsageDetail 频道线性组装用量明细
    SumBasicChannelDuration Integer Basic频道类型总时长
    示例值:0
    SumStandardChannelDuration Integer Standard频道类型总时长
    示例值:0

    AudioBeautifyConfig

    音量美化配置

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

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

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

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

    AudioDenoiseConfig

    音频降噪配置

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

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

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

    AudioEnhanceConfig

    音频增强配置

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

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

    AudioSeparateConfig

    音频分离配置

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

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

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

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

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

    AudioTemplateInfo

    音频流配置参数

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

    名称 类型 必选 描述
    Codec String

    音频流的编码格式。
    当不需要对音频进行转码时,可选值为:

  • copy。
  • 当外层参数 Container 为 mp3 时,可选值为:
  • mp3。
  • 当外层参数 Container 为 ogg 或 flac 时,可选值为:
  • flac。
  • 当外层参数 Container 为 m4a 时,可选值为:
  • aac;
  • ac3。
  • 当外层参数 Container 为 mp4 或 flv 时,可选值为:
  • aac:更适合 mp4;
  • mp3:更适合 flv;
  • mp2。
  • 当外层参数 Container 为 hls 时,可选值为:
  • aac;
  • mp3;
  • eac3:自适应转码音轨合并时使用。
  • 当外层参数 Container 为 wav时,可选值为:
  • pcm16, pcm24;

  • 示例值:aac
    Bitrate Integer

    音频流的码率,取值范围:0 和 [26, 256],单位:kbps。
    当取值为 0,表示音频码率和原始音频保持一致。
    注意:如果使用自适应转码音轨合并TrackChannelInfo参数,取值范围:
    1)、不能填0;
    2)、Codec为:aac时,取值范围:[26, 256];
    3)、Codec为:ac3时,取值范围:[26, 640];
    4)、Codec为:eac3时,取值范围:[26, 6144],备注:当SampleRate为44100HZ,最大值为:5644,当SampleRate为48000HZ,最大值为:6144,


    示例值:0
    SampleRate Integer

    音频流的采样率,不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。
    详细参考音频采样率支持范围文档
    单位:Hz
    注意:请确保源音频流的采样率在上述选项范围内,否则可能导致转码失败!


    示例值:44100
    AudioChannel Integer

    音频通道方式,可选值:

  • 0:声道数随源
  • 1:单通道
  • 2:双通道
  • 6:5.1声道
  • 当媒体的封装格式是音频格式(mp3)时,声道数不允许设为5.1声道。

    默认值:2。
    注意:设置音频声道随源时,如果转码音频编码格式不支持当前声道,转码任务可能会失败。


    示例值:2
    TrackChannelInfo AudioTrackChannelInfo

    合并音轨信息。
    注意:此字段只是自适应转码生效,


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

    AudioTemplateInfoForUpdate

    音频流配置参数

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

    名称 类型 必选 描述
    Codec String

    音频流的编码格式。
    当不需要对音频进行转码时,可选值为:

  • copy。
  • 当外层参数 Container 为 mp3 时,可选值为:
  • mp3。
  • 当外层参数 Container 为 ogg 或 flac 时,可选值为:
  • flac。
  • 当外层参数 Container 为 m4a 时,可选值为:
  • aac;
  • ac3。
  • 当外层参数 Container 为 mp4 或 flv 时,可选值为:
  • aac:更适合 mp4;
  • mp3:更适合 flv;
  • mp2。
  • 当外层参数 Container 为 hls 时,可选值为:
  • aac;
  • mp3。
  • 当外层参数 Container 为 wav时,可选值为:
  • pcm16, pcm24;

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

    音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。


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

    音频流的采样率,不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。
    详细参考音频采样率支持范围文档
    单位:Hz
    注意:请确保源音频流的采样率在上述选项范围内,否则可能导致转码失败!


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

    音频通道方式,可选值:

  • 0:声道数随源
  • 1:单通道
  • 2:双通道
  • 6:5.1声道
  • 当媒体的封装格式是音频格式(mp3)时,声道数不允许设为5.1声道。

    默认值:2。
    注意:设置音频声道随源时,如果转码音频编码格式不支持当前声道,转码任务可能会失败。


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    StreamSelects Array of Integer

    指定输出要保留的音频轨道。默认是全部保留源的。


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

    AudioTrackChannelInfo

    音轨信息

    被如下接口引用:CreateTranscodeTemplate。

    名称 类型 必选 描述
    ChannelsRemix Integer 是否开启混音,可选值:
    0:表示不开启混音
    1:表示开启混音
    默认值:0
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SelectType String 合并音轨输入类型,可选值:
    track:表示使用音轨id;
    track_channel: 表示使用音轨id和声道id;
    默认:track。
    注意:如果原视频是多声道,建议使用track_channel。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:track
    InputTrackInfo Array of TrackInfo 音轨信息
    注意:此字段可能返回 null,表示取不到有效值。

    AwsS3FileUploadTrigger

    AWS S3 文件是上传触发器。

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

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

    AwsSQS

    Aws SQS 队列信息

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateVideoDatabaseEntryTask, CreateVideoSearchTask, CreateWorkflow, DescribeBatchTaskDetail, DescribeTaskDetail, EditMedia, ExtractBlindWatermark, ModifySchedule, ProcessMedia, ResetWorkflow, WithdrawsWatermark。

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

    BatchSmartSubtitlesResult

    智能字幕结果。

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

    名称 类型 描述
    Input SmartSubtitleTaskResultInput 智能字幕任务输入信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Outputs Array of SmartSubtitleTaskBatchOutput 智能字幕输出信息
    注意:此字段可能返回 null,表示取不到有效值。

    BatchSubTaskResult

    批量任务子任务结果

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

    名称 类型 描述
    InputInfos Array of MediaInputInfo 批量任务输入信息
    注意:此字段可能返回 null,表示取不到有效值。
    Metadatas Array of MediaMetaData 原始视频的元信息。
    注意:此字段可能返回 null,表示取不到有效值。
    SmartSubtitlesTaskResult BatchSmartSubtitlesResult 智能字幕任务的执行结果
    注意:此字段可能返回 null,表示取不到有效值。

    BeautyConfig

    美颜配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    BeautyEffectItems Array of BeautyEffectItemConfig 美颜效果
    BeautyFilterItems Array of BeautyFilterItemConfig 美颜滤镜

    BeautyEffectItemConfig

    美颜效果配置项

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    Type String 类型名称。取值如下:
  • Whiten:美白
  • BlackAlpha1:美黑
  • BlackAlpha2:较强美黑
  • FoundationAlpha2:美白-粉白
  • Clear:清晰度
  • Sharpen:锐化
  • Smooth:磨皮
  • BeautyThinFace:瘦脸
  • NatureFace:自然脸型
  • VFace:V脸
  • EnlargeEye:大眼
  • EyeLighten:亮眼
  • RemoveEyeBags:祛眼袋
  • ThinNose:瘦鼻
  • RemoveLawLine:祛法令纹
  • CheekboneThin:瘦颧骨
  • FaceFeatureLipsLut:口红
  • ToothWhiten:牙齿美白
  • FaceFeatureSoftlight:柔光
  • Makeup:美妆

  • 示例值:Whiten
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:ON
    Value Integer 效果强度,值范围:[0, 100]。
    示例值:40
    ResourcePath String 附加资源路径。
    示例值:/makeupRes/video_makeup_mitao
    ExtInfo String 自定义参数。
    示例值:{"Color":"#ff0000"}

    BeautyFilterItemConfig

    美颜滤镜配置项

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    Type String 类型名称。取值如下:

  • Dongjing:东京
  • Qingjiaopian:轻胶片
  • Meiwei:美味

  • 示例值:Qingjiaopian
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    示例值:ON
    Value Integer 效果强度,值范围:[-100, 100]。
    示例值:70

    BlindWatermarkConfig

    盲水印配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    AddBlindWatermark AddBlindWatermarkConfig 增加盲水印
    注意:此字段可能返回 null,表示取不到有效值。
    ExtractBlindWatermark ExtractBlindWatermarkConfig 提取盲水印
    注意:此字段可能返回 null,表示取不到有效值。
    RemoveBlindWatermark RemoveBlindWatermarkConfig 移除盲水印
    注意:此字段可能返回 null,表示取不到有效值。

    BlindWatermarkEmbedInfo

    嵌入盲水印配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    EmbedText String 盲水印文字,经过URL安全的Base64编码的4Byte数据。Base64解码之后,少于4Byte将会填充0x00到4Byte,超过4Byte将会截断为4Byte。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:dGVzdA==

    BlindWatermarkInput

    媒体处理任务中的数字水印参数类型

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

    名称 类型 必选 描述
    Definition Integer 数字水印模板ID
    示例值:10

    BlindWatermarkTemplate

    数字水印模板详情

    被如下接口引用:DescribeBlindWatermarkTemplates。

    名称 类型 描述
    Definition Integer 数字水印模板唯一标识。
    示例值:10
    Type String 数字水印类型,可选值:
  • blind-basic:基础版权数字水印;
  • blind-nagra:NAGRA取证水印;

  • 示例值:blind-basic
    Name String 数字水印模板名称。
    示例值:数字水印模板1
    TextContent String 数字水印模板文本内容,长度不超过64个字符。
    示例值:水印文本内容
    Comment String 数字水印模板描述信息。
    示例值:数字水印模板
    CreateTime String 数字水印模板创建时间,使用 ISO 日期格式
    示例值:2025-08-01T18:00:00+08:00
    UpdateTime String 数字水印模板最后修改时间,使用 ISO 日期格式
    示例值:2025-08-01T18:00:00+08:00
    Strength String 数字水印强度。 default: 默认,高清画质和抗性平衡 stronger:画质清晰,抗性较强 strongest:画质一般,抗性最强
    示例值:default

    ChannelAlertResp

    线性组装频道告警返回信息。

    被如下接口引用:DescribeStreamPackageLinearAssemblyChannelAlerts。

    名称 类型 描述
    ProgramAlertCounts Array of ProgramAlertCounts Program告警聚合信息。
    ProgramAlertInfos Array of ProgramAlertInfos Program告警明细信息。

    ClassificationConfigureInfo

    智能分类任务控制参数

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

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

  • 示例值:ON

    ClassificationConfigureInfoForUpdate

    智能分类任务控制参数

    被如下接口引用:ModifyAIAnalysisTemplate。

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

  • 示例值:ON

    ClipRangeInfo

    垫片配置。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms, ModifyStreamPackageLinearAssemblyProgram。

    名称 类型 必选 描述
    Type String vod类型有效,内容有效起始时间,可选Entire和SpecifyTimeRange。
    示例值:Entire
    Offset Integer 偏移量,Type为SpecifyTimeRange时有效。
    示例值:20
    StartOffset Integer 开始偏移量,Type为SpecifyTimeRange时有效。
    示例值:0
    EndOffset Integer 结束偏移量,Type为SpecifyTimeRange时有效。
    示例值:10

    ColorEnhanceConfig

    色彩增强配置

    被如下接口引用:CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage。

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

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

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

    ComposeAudioItem

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

    被如下接口引用:EditMedia。

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

    ComposeAudioOperation

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Type String 音频操作类型,取值有:
  • Volume:音量调节。

  • 示例值:Volume
    Volume Float 当 Type = Volume 时有效。音量调节参数,取值范围: 0~5。
  • 0 表示静音。
  • 小于1 表示降低音量。
  • 1 表示不变。
  • 大于1表示升高音量。

  • 示例值:1

    ComposeAudioStream

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Codec String 音频流的编码方式,可选值:
  • AAC:AAC 编码(默认),用于容器为 mp4。
  • MP3:mp3 编码,用于容器为 mp3。

  • 示例值:AAC
    SampleRate Integer 音频流的采样率,单位:Hz,可选值:
  • 16000(默认)
  • 32000
  • 44100
  • 48000

  • 示例值:16000
    AudioChannel Integer 声道数,可选值:
  • 1:单声道 。
  • 2:双声道(默认)。

  • 示例值:2
    Bitrate Integer 参考码率,单位 kbps,范围:26~10000。
    如果设置,编码时会尽量按该码率进行编码。
    如果不设置,服务将根据音频参数自动采用合适的码率。
    示例值:128

    ComposeCanvas

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

    被如下接口引用:EditMedia。

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

    ComposeEmptyItem

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

    被如下接口引用:EditMedia。

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

  • 示例值:3.5s

    ComposeImageItem

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

    被如下接口引用:EditMedia。

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

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

  • 默认:50%。
    示例值:100px
    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 按源素材比例缩放。

  • 示例值:10%
    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 按源素材比例缩放。

  • 示例值:100px
    ImageOperations Array of ComposeImageOperation 对图像画面进行的操作,如图像旋转等。

    ComposeImageOperation

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Type String 类型,取值有:
  • Rotate:图像旋转。
  • Flip:图像翻转。

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

  • 示例值:Horizental

    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
    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 元素

    示例值:Video
    Items Array of ComposeMediaItem 轨道上的元素列表。

    ComposeSourceMedia

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

    被如下接口引用:EditMedia。

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

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

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

    示例值:12.2s

    ComposeStyles

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

    被如下接口引用:EditMedia。

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

  • 示例值:Subtitle
    Subtitle ComposeSubtitleStyle 字幕样式信息,当 Type = Subtitle 时有效。

    ComposeSubtitleItem

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    StyleId String 字幕样式,Styles 列表中对应的 Subtitle样式的 ID。
    示例值:s1
    Text String 字幕文本。
    注:长文本可能超出画面范围,建议使用 \n 进行换行。
    示例值:测试字幕中文
    TrackTime ComposeTrackTime 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。

    ComposeSubtitleStyle

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

    被如下接口引用:EditMedia。

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

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

  • 默认:0px
    示例值:10px
    FontType String 字体类型,支持:
  • SimHei:黑体(默认)。
  • SimSun:宋体。

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

  • 默认:2%
    示例值:2%
    FontBold Integer 是否使用粗体,和字体相关,可选值:
  • 0:否(默认)。
  • 1:是。

  • 示例值:0
    FontItalic Integer 是否使用斜体,和字体相关,可选值:
  • 0:否(默认)。
  • 1:是。

  • 示例值:0
    FontColor String 字体颜色,格式:#RRGGBBAA。
    默认值:0x000000FF(黑色)。
    注意:其中 AA 部分指的是透明度,为可选。

    示例值:0x000000FF
    FontAlign String 文字对齐方式:
  • Center:居中(默认)。
  • Left:左对齐。
  • Right:右对齐。

  • 示例值:Center
    FontAlignMargin String 用于字幕对齐留白:
  • FontAlign=Left 时,表示距离左边距离。
  • FontAlign=Right时,表示距离右边距离。

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

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

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

    ComposeTargetInfo

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Container String 封装容器格式,可选值:
  • mp4:视频文件(默认)。
  • mp3:纯音频文件。

  • 示例值:mp4
    RemoveVideo Integer 是否去除视频数据,可选值:
  • 0:保留(默认)。
  • 1:去除。

  • 示例值:0
    RemoveAudio Integer 是否去除音频数据,可选值:
  • 0:保留(默认)。
  • 1:去除。

  • 示例值:0
    VideoStream ComposeVideoStream 输出视频流信息。
    AudioStream ComposeAudioStream 输出音频流信息。

    ComposeTrackTime

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

    被如下接口引用:EditMedia。

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

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

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

    ComposeTransitionItem

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

    被如下接口引用:EditMedia。

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

  • 默认:1s
    注意:
  • 必须是整数s,否则向下取整。
  • 转场 前后必须紧挨着两个不为 Empty 的元素。
  • 转场 Duration 必须小于前一个元素的 Duration,同时必须小于后一个元素的 Duration。
  • 进行转场处理的两个元素,第二个元素在轨道上的起始时间会自动调整为前一个元素的结束时间减去转场的 Duration。

  • 示例值:1s
    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:声音淡入淡出。

  • 示例值:ImageFadeInFadeOut

    ComposeVideoItem

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

    被如下接口引用:EditMedia。

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

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

  • 默认:50%。
    示例值:100px
    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 按源素材比例缩放。

  • 示例值:10%
    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 按源素材比例缩放。

  • 示例值:100px
    ImageOperations Array of ComposeImageOperation 对图像画面进行的操作,如图像旋转等。
    AudioOperations Array of ComposeAudioOperation 对音频进行操作,如静音等。

    ComposeVideoStream

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Codec String 视频流的编码方式,可选值:
  • H.264:H.264 编码(默认)。

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

    ConfigAliasesInfo

    参数配置。

    被如下接口引用:CreateStreamPackageSSAIChannel, ModifyStreamPackageSSAIChannel。

    名称 类型 必选 描述
    ParamName String 参数名。
    示例值:region
    AliasValueList Array of AliasValueConf alias-value配置。

    ContainerDiagnoseResultItem

    容器格式诊断结果

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

    名称 类型 描述
    Category String 诊断出的异常类别,取值范围:
    DecodeParamException:解码参数异常
    TimeStampException:时间戳异常
    FrameException: 帧率异常
    StreamStatusException:流状态异常
    StreamInfo:流信息异常
    StreamAbnormalCharacteristics:流特征异常
    DecodeException:解码异常
    HLSRequirements:HLS 格式异常
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:DecodeException
    Type String 诊断出的具体异常类型,取值如下:

    VideoResolutionChanged:视频分辨率变化
    AudioSampleRateChanged:音频采样率变化
    AudioChannelsChanged:音频通道数变化
    ParameterSetsChanged:流参数集信息发生变化
    DarOrSarInvalid:视频的宽高比异常
    TimestampFallback:DTS时间戳回退
    DtsJitter:DTS抖动过大
    PtsJitter:PTS抖动过大
    AACDurationDeviation:AAC帧时间戳间隔不合理
    AudioDroppingFrames:音频丢帧
    VideoDroppingFrames:视频丢帧
    AVTimestampInterleave:音视频交织不合理
    PtsLessThanDts:媒体流的 pts 小于 dts
    ReceiveFpsJitter:网络接收帧率抖动过大
    ReceiveFpsTooSmall:网络接收视频帧率过小
    FpsJitter:通过PTS计算得到的流帧率抖动过大
    StreamOpenFailed:流打开失败
    StreamEnd:流结束
    StreamParseFailed:流解析失败
    VideoFirstFrameNotIdr:首帧不是IDR帧
    StreamNALUError:NALU起始码错误
    TsStreamNoAud:mpegts的H26x流缺失 AUD NALU
    AudioStreamLack:无音频流
    VideoStreamLack:无视频流
    LackAudioRecover:缺失音频流恢复
    LackVideoRecover:缺失视频流恢复
    VideoBitrateOutofRange:视频流码率(kbps)超出范围
    AudioBitrateOutofRange:音频流码率(kbps)超出范围
    VideoDecodeFailed:视频解码错误
    AudioDecodeFailed:音频解码错误
    AudioOutOfPhase:双通道音频相位相反
    VideoDuplicatedFrame:视频流中存在重复帧
    AudioDuplicatedFrame:音频流中存在重复帧
    VideoRotation:视频画面旋转
    TsMultiPrograms:MPEG2-TS流有多个program
    Mp4InvalidCodecFourcc:MP4中codec fourcc不符合Apple HLS要求
    HLSBadM3u8Format:无效的m3u8文件
    HLSInvalidMasterM3u8:无效的main m3u8文件
    HLSInvalidMediaM3u8:无效的media m3u8文件
    HLSMasterM3u8Recommended:main m3u8缺少标准推荐的参数
    HLSMediaM3u8Recommended:media m3u8缺少标准推荐的参数
    HLSMediaM3u8DiscontinuityExist:media m3u8存在EXT-X-DISCONTINUITY
    HLSMediaSegmentsStreamNumChange:切片的流数目发生变化
    HLSMediaSegmentsPTSJitterDeviation:切片间PTS跳变且没有EXT-X-DISCONTINUITY
    HLSMediaSegmentsDTSJitterDeviation:切片间DTS跳变且没有EXT-X-DISCONTINUITY
    TimecodeTrackExist:MP4存在tmcd轨道
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:VideoDecodeFailed
    SeverityLevel String 诊断出的异常级别,取值范围:
    Fatal:影响后续播放和解析,
    Error: 可能会影响播放,
    Warning: 可能会有潜在风险,但不一定会影响播放,
    Notice:比较重要的流信息,
    Info:一般性的流信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Fatal
    DateTimeSet Array of String 警告出现的时间点,形式如 “2022-12-25T13:14:16Z”
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["2023-06-09T06:54:32Z","2023-06-09T06:54:32Z"]
    TimestampSet Array of Float 时间戳
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[4.783, 5.966]

    ContentReviewTemplateItem

    内容审核模板详情

    被如下接口引用:DescribeContentReviewTemplates。

    名称 类型 描述
    Definition Integer 内容审核模板唯一标识。
    示例值:0
    Name String 内容审核模板名称,长度限制:64 个字符。
    示例值:内容审核模板1
    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 日期格式
    示例值:2025-03-23T07:14:27+08:00
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2025-03-23T07:14:27+08:00
    Type String 模板类型,取值范围:
    * Preset:系统预置模板;
    * Custom:用户自定义模板。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Custom

    CosFileUploadTrigger

    绑定到 COS 的输入规则。

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

    名称 类型 必选 描述
    Bucket String 工作流绑定的 COS Bucket 名,如 TopRankVideo-125xxx88。
    示例值:CosVideoFile-125xxx88
    Region String 工作流绑定的 COS Bucket 所属园区,如 ap-chongiqng。
    示例值:ap-nanjing
    Dir String 工作流绑定的输入路径目录,必须为绝对路径,即以 / 开头和结尾。如/movie/201907/,不填代表根目录/
    示例值:/trigger-dir/
    Formats Array of String 支持的所有格式如下:

    - 视频文件扩展名,支持以下选择,共15种:
    .mp4.avi.mov.wmv.flv.mkv.mpg.mpeg.rm.rmvb.asf.3gp.webm.ts.m4v

    - 音频文件扩展名,支持以下选择,共7种:
    .mp3.wav.aac.flac.ogg.m4a.amr

    - 字幕文件扩展名,支持以下选择,共2种:
    .vtt.srt

    - *:支持任意文件格式

    - 不传或者传空列表:支持系统预设文件格式(视频:.mp4.ts.flv.wmv.asf.rm.rmvb.mpg.mpeg.3gp.mov.webm.mkv.avi.m4v,音频:.mp3.m4a.flac.ogg.wav.amr.aac,字幕:.vtt.srt

    注意
    1. 如果传入的格式列表中有*则表示为支持任意文件格式。
    2. 扩展名传入时带不带.都可以,比如 .mp4mp4 均支持。
    3. 自定义文件扩展名需满足数字、字母字符,长度在[1,64]范围内。
    示例值:["mp4","flv","mov"]

    CosInputInfo

    媒体处理 COS 对象信息。

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSubtitleEmbedTemplate, CreateVideoDatabaseEntryTask, DescribeImageTaskDetail, DescribeMediaMetaData, DetectVideoSubtitleArea, ExtractBlindWatermark, ModifySubtitleEmbedTemplate, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。

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

    CosOutputStorage

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

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

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

    CoverConfigureInfo

    智能封面任务控制参数

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

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

  • 示例值:ON

    CoverConfigureInfoForUpdate

    智能封面任务控制参数

    被如下接口引用:ModifyAIAnalysisTemplate。

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

  • 示例值:ON

    CreateInput

    创建输入的配置信息。

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

    名称 类型 必选 描述
    InputName String 输入名称,可填大小写、数字和下划线,长度为[1, 32]。
    示例值:input
    Protocol String 输入的协议,可选[SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST]。
    示例值:SRT
    Description String 输入描述,长度为[0, 255]。
    示例值:input description
    AllowIpList Array of String 输入的IP白名单,格式为CIDR。
    示例值:["0.0.0.0/0"]
    SRTSettings CreateInputSRTSettings 输入的SRT配置信息。
    RTPSettings CreateInputRTPSettings 输入的RTP配置信息。
    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。
    示例值:["01937702ecc509dc0f3269ca3420"]
    Zones Array of String 可用区,非必填,如果开启容灾必须输入两个不同的可用区,否则最多只允许输入一个可用区。
    示例值:["ap-shanghai-1"]
    RISTSettings CreateInputRISTSettings 输入的RIST配置信息。
    InputRegion String 输入节点的地区
    示例值:ap-mumbai
    FailOverOption FailOverOption 冷热备相关

    CreateInputHLSPullSettings

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

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

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

    CreateInputRISTSettings

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

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

    名称 类型 必选 描述
    Mode String RIST模式,可选[LISTENER],默认为LISTENER。
    示例值:LISTENER
    Profile String RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。
    示例值:MAIN
    Buffer Integer RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120
    示例值:120

    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 延迟,默认120,单位ms,范围为[0, 3000]。
    示例值:120
    RecvLatency Integer 接收延迟,默认120,单位ms,范围为[0, 3000]。
    示例值:0
    PeerLatency Integer 对端延迟,默认120,单位ms,范围为[0, 3000]。
    示例值:0
    PeerIdleTimeout Integer 对端超时时间,默认5000,单位ms,范围为[1000, 10000]。
    示例值:5000
    Passphrase String 解密密钥,默认为空,表示不加密。只可填ascii码值,长度为[10, 79]。
    示例值:passphrase
    PbKeyLen Integer 密钥长度,默认为0,可选[0|16|24|32]。
    示例值:0
    SourceAddresses Array of SRTSourceAddressReq SRT对端地址,当Mode为CALLER时必填,且只能填1组。
    FEC SRTFECSimpleOptions SRT FEC 设置

    CreateOutputInfo

    创建输出的配置信息。

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

    名称 类型 必选 描述
    OutputName String 输出的名称。
    示例值:OutputName
    Description String 输出描述。
    示例值:OutputName
    Protocol String 输出的转推协议,支持SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST。
    示例值:SRT
    OutputRegion String 输出地区。
    示例值:ap-hongkong
    OutputType String 输出类型:Internet/TencentCSS
    示例值:TencentCSS
    OutputKind String 输出模块类型,包括Pinpoint(单点输出,最多支持四路并发输出);MultiMesh(多路输出,支持大于四路的并发输出,目前可以达到200路)。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出
    示例值:Pinpoint
    SRTSettings CreateOutputSRTSettings 输出的SRT的配置。
    RTMPSettings CreateOutputRTMPSettings 输出的RTMP的配置。
    RTPSettings CreateOutputInfoRTPSettings 输出的RTP的配置。
    AllowIpList Array of String IP白名单列表,格式为CIDR,如0.0.0.0/0。
    当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。
    示例值:["0.0.0.0"]
    MaxConcurrent Integer 最大拉流并发数,最大4,默认4。
    示例值:1
    SecurityGroupIds Array of String 绑定的输入安全组 ID。
    示例值:["01937702c54509dc0f3269ca341f"]
    Zones Array of String 可用区,output最多只支持输入一个可用区。
    示例值:["ap-shanghai-1"]
    RISTSettings CreateOutputRistSettings 输出的RIST的配置。
    StreamSelector StreamSelector 对于含有多个音/视频轨的流,可以指定需要使用的轨道。PidSelector 与 TrackSelector 只能存在一个

    CreateOutputInfoRTPSettings

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

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

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

    CreateOutputRTMPSettings

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

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

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

    CreateOutputRTPSettingsDestinations

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

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

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

    CreateOutputRistSettings

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

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

    名称 类型 必选 描述
    Mode String RIST模式,可选[LISTENER|CALLER],默认为LISTENER。
    示例值:LISTENER
    Profile String RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。
    示例值:MAIN
    Buffer Integer RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120
    示例值:120

    CreateOutputRtmpSettingsDestinations

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

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

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

    CreateOutputSRTSettings

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

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

    名称 类型 必选 描述
    Destinations Array of CreateOutputSRTSettingsDestinations 转推的目标地址,当Mode为CALLER时必填,且只能填1组。
    StreamId String 转推SRT的流Id,可选大小写字母、数字和特殊字符(.#!:&,=_-),长度为0~512。
    示例值:StreamId
    Latency Integer 转推SRT的延迟,默认120,单位ms,范围为[0, 3000]。此参数同时设置了发送方和接收方的延迟(recvlatency和peerlatency)为相同的值。建议配置为至少3倍RTT,以确保在网络拥塞时能够有效处理数据包的重传和确认
    示例值:120
    RecvLatency Integer 转推SRT的接收延迟,默认120,单位ms,范围为[0, 3000]。 此参数表示接收方用于缓存数据包的时间长度
    示例值:0
    PeerLatency Integer 转推SRT的对端延迟,默认120,单位ms,范围为[0, 3000]。 此参数由发送方设置,用于告知接收方其期望的延迟缓冲时间
    示例值:0
    PeerIdleTimeout Integer 转推SRT的对端空闲超时时间,默认5000,单位ms,范围为[1000, 10000]。 如果连接在设定的超时时间内没有活动,将会被关闭
    示例值:5000
    Passphrase String 转推SRT的加密密钥,默认为空,表示不加密。只可填ascii码值,长度为[10, 79]。
    示例值:passphrase
    PbKeyLen Integer 转推SRT的密钥长度,默认为0,可选[0|16|24|32]。
    示例值:0
    Mode String SRT模式,可选[LISTENER|CALLER],默认为CALLER。
    示例值:CALLER
    FEC SRTFECFullOptions SRT FEC 设置

    CreateOutputSRTSettingsDestinations

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

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

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

    DashManifestInfo

    Type为DASH时manifest配置使用的字段。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel。

    名称 类型 必选 描述
    Windows Integer 每个清单的总持续时间(以秒为单位)。[30, 3600],类型:整数,默认值60。
    示例值:60
    MinBufferTime Integer 播放器在缓冲区中保持的最小缓存时间(以秒为单位)。[2, 60],类型:整数,默认值30。
    示例值:30
    MinUpdatePeriod Integer 播放器在请求更新清单之前应等待的最短时间(以秒为单位)。[2, 60],类型:整数,默认值2。
    示例值:10
    SuggestedPresentationDelay Integer 播放器启播时距离最新直播时间点的时间,是一个回退量(以秒为单位)。[2, 60],类型:整数,默认值10。
    示例值:10

    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。
    示例值:01937702c54509dc0f3269ca341f
    FlowName String 流名称。
    示例值:example-flow
    State String 流状态,目前有IDLE/RUNNING。
    示例值:IDLE
    MaxBandwidth Integer 最大带宽值。
    示例值:10000000
    InputGroup Array of DescribeInput 输入组。
    OutputGroup Array of DescribeOutput 输出组。
    注意:此字段可能返回 null,表示取不到有效值。
    EventId String 该Flow关联的媒体传输事件EventId。
    示例值:eventid
    Region String 媒体传输输入流所属的区域,取值和InputRegion相同。
    示例值:ap-shanghai
    AllowedInputProtocols Array of String 该Flow允许创建的输入协议
    示例值:[SRT, RTMP]
    AllowedOutputProtocols Array of String 该Flow允许创建的输出协议
    示例值:[SRT, RTMP]

    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,表示取不到有效值。
    示例值:["ff96r1fd7ab41ekj06497cdecbb0"]
    Zones Array of String 可用区配置,开启容灾情况下最多有两个,顺序和pipeline 0、1对应,否则最多只有一个可用区。
    示例值:["ap-shanghai-1"]
    RISTSettings DescribeInputRISTSettings 输入的RIST配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    StreamUrls Array of StreamUrlDetail 输入模块配置相关的URL信息,包含提供的推流地址,或者配置的第三方源流地址

    DescribeInputHLSPullSettings

    查询输入的HLS配置信息。

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

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

    DescribeInputRISTSettings

    查询输入的RIST配置信息。

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

    名称 类型 描述
    Mode String RIST模式,可选[LISTENER|CALLER],默认为LISTENER。
    示例值:LISTENER
    Profile String RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。
    示例值:MAIN
    Buffer Integer RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120
    示例值:120

    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 解密密钥。
    示例值:passphrase
    PbKeyLen Integer 密钥长度。
    示例值:0
    SourceAddresses Array of SRTSourceAddressResp SRT对端地址。
    注意:此字段可能返回 null,表示取不到有效值。
    FEC SRTFECSimpleOptions FEC 设置

    DescribeOutput

    查询输出的配置信息。

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

    名称 类型 描述
    OutputId String 输出Id。
    示例值:AB342ED131CE
    OutputName String 输出名称。
    示例值:OutputName
    OutputType String 输出类型。
    示例值:Internet
    OutputKind String 输出模块类型,包括Pinpoint(单点输出,最多支持四路并发输出);MultiMesh(多路输出,支持大于四路的并发输出,目前可以达到200路)。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出。
    示例值:Pinpoint
    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,表示取不到有效值。
    示例值:["0.0.0.0"]
    RTSPPullSettings DescribeOutputRTSPPullSettings 输出的RTSP拉流配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    HLSPullSettings DescribeOutputHLSPullSettings 输出的HLS拉流配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    MaxConcurrent Integer 最大拉流并发数,最大为4,默认4。
    示例值:1
    SecurityGroupIds Array of String 绑定的安全组 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["019202e96d9f09dc0f325e7f7a2a"]
    Zones Array of String 可用区,output目前最多只支持一个。
    示例值:["ap-shanghai"]
    RISTSettings DescribeOutputRISTSettings 输出的RIST配置信息。
    注意:此字段可能返回 null,表示取不到有效值。
    StreamUrls Array of StreamUrlDetail 输出模块配置,相关的URL,包括提供的拉流地址,或者配置的输出到第三方的转推地址
    StreamSelector StreamSelector 对于含有多个音/视频轨的流,可以指定需要使用的轨道

    DescribeOutputHLSPullServerUrl

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

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

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

    DescribeOutputHLSPullSettings

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

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

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

    DescribeOutputRISTSettings

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

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

    名称 类型 描述
    Mode String RIST模式,可选[LISTENER|CALLER],默认为LISTENER。
    示例值:LISTENER
    Profile String RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。
    示例值:MAIN
    Buffer Integer RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120
    示例值:120
    SourceAddresses Array of OutputRISTSourceAddressResp 服务器监听地址,RIST模式为LISTENER时使用。
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeOutputRTMPPullServerUrl

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

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

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

    DescribeOutputRTMPPullSettings

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

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

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

    DescribeOutputRTMPSettings

    查询输出的RTMP配置信息。

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

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

    DescribeOutputRTPSettings

    查询输出的RTP配置信息。

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

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

    DescribeOutputRTSPPullServerUrl

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

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

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

    DescribeOutputRTSPPullSettings

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

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

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

    DescribeOutputSRTSettings

    查询输出的SRT配置信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, 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,表示取不到有效值。
    FEC SRTFECFullOptions FEC 配置

    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 诊断出的异常类别,取值范围:
    DecodeParamException:解码参数异常
    TimeStampException:时间戳异常
    FrameException: 帧率异常
    StreamStatusException:流状态异常
    StreamInfo:流信息异常
    StreamAbnormalCharacteristics:流特征异常
    DecodeException:解码异常
    HLSRequirements:HLS 格式异常
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:DecodeException
    Type String 诊断出的具体异常类型,取值如下:

    VideoResolutionChanged:视频分辨率变化
    AudioSampleRateChanged:音频采样率变化
    AudioChannelsChanged:音频通道数变化
    ParameterSetsChanged:流参数集信息发生变化
    DarOrSarInvalid:视频的宽高比异常
    TimestampFallback:DTS时间戳回退
    DtsJitter:DTS抖动过大
    PtsJitter:PTS抖动过大
    AACDurationDeviation:AAC帧时间戳间隔不合理
    AudioDroppingFrames:音频丢帧
    VideoDroppingFrames:视频丢帧
    AVTimestampInterleave:音视频交织不合理
    PtsLessThanDts:媒体流的 pts 小于 dts
    ReceiveFpsJitter:网络接收帧率抖动过大
    ReceiveFpsTooSmall:网络接收视频帧率过小
    FpsJitter:通过PTS计算得到的流帧率抖动过大
    StreamOpenFailed:流打开失败
    StreamEnd:流结束
    StreamParseFailed:流解析失败
    VideoFirstFrameNotIdr:首帧不是IDR帧
    StreamNALUError:NALU起始码错误
    TsStreamNoAud:mpegts的H26x流缺失 AUD NALU
    AudioStreamLack:无音频流
    VideoStreamLack:无视频流
    LackAudioRecover:缺失音频流恢复
    LackVideoRecover:缺失视频流恢复
    VideoBitrateOutofRange:视频流码率(kbps)超出范围
    AudioBitrateOutofRange:音频流码率(kbps)超出范围
    VideoDecodeFailed:视频解码错误
    AudioDecodeFailed:音频解码错误
    AudioOutOfPhase:双通道音频相位相反
    VideoDuplicatedFrame:视频流中存在重复帧
    AudioDuplicatedFrame:音频流中存在重复帧
    VideoRotation:视频画面旋转
    TsMultiPrograms:MPEG2-TS流有多个program
    Mp4InvalidCodecFourcc:MP4中codec fourcc不符合Apple HLS要求
    HLSBadM3u8Format:无效的m3u8文件
    HLSInvalidMasterM3u8:无效的main m3u8文件
    HLSInvalidMediaM3u8:无效的media m3u8文件
    HLSMasterM3u8Recommended:main m3u8缺少标准推荐的参数
    HLSMediaM3u8Recommended:media m3u8缺少标准推荐的参数
    HLSMediaM3u8DiscontinuityExist:media m3u8存在EXT-X-DISCONTINUITY
    HLSMediaSegmentsStreamNumChange:切片的流数目发生变化
    HLSMediaSegmentsPTSJitterDeviation:切片间PTS跳变且没有EXT-X-DISCONTINUITY
    HLSMediaSegmentsDTSJitterDeviation:切片间DTS跳变且没有EXT-X-DISCONTINUITY
    TimecodeTrackExist:MP4存在tmcd轨道
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:VideoDecodeFailed
    Timestamp Float 诊断出异常开始的PTS时间戳。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5.966
    Description String 诊断出的异常描述。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Open url http://xxx.mp4 failed.
    DateTime String 诊断到异常的北京时间,采用 ISO 日期格式。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2023-06-09T06:54:32Z
    SeverityLevel String 诊断出的异常级别,取值范围:
    Fatal:影响后续播放和解析,
    Error: 可能会影响播放,
    Warning: 可能会有潜在风险,但不一定会影响播放,
    Notice:比较重要的流信息,
    Info:一般性的流信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Fatal

    DiffusionEnhanceConfig

    大模型增强

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

    名称 类型 必选 描述
    Switch String 能力配置开关,可选值:

    ON:开启;
    OFF:关闭。
    默认,OFF。
    示例值:ON
    Type String 强度类型,可选值:

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

    DrmInfo

    Drm 加密信息。

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

    名称 类型 必选 描述
    Type String 加密类型:

    - simpleaes
    只能用于HLS,切片格式支持ts和mp4
    只能使用切片模式,不能使用singlefile模式

    - fairplay:
    只能用于HLS,切片格式只能是mp4
    可以使用切片模式或singlefile模式

    - widevine:
    可以用于HLS和DASH,切片格式只能是mp4
    输出HLS:可以使用切片模式或singlefile模式
    输出DASH:只能singlefile模式

    - playready:
    可以用于HLS和DASH,切片格式只能是mp4
    输出HLS:可以使用切片模式或singlefile模式
    输出DASH:只能singlefile模式

    - widevine+fairplay,playready+fairplay,widevine+playready+fairplay:
    只能用于HLS,切片格式只能是mp4
    可以使用切片模式或singfile模式

    - widevine+playready:
    可用于HLS、MPEG-DASH,切片格式只能是mp4
    HLS格式时,可以使用切片模式或singfile模式
    MPEG-DASH时,只能使用singlefile模式
    示例值:widevine
    SimpleAesDrm SimpleAesDrm SimpleAes 加密信息。
    注意:此字段可能返回 null,表示取不到有效值。
    SpekeDrm SpekeDrm FairPlay,WideVine,PlayReady 加密信息。

    EditMediaFileInfo

    编辑点播视频文件信息

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

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

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

    EditMediaOutputConfig

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

    被如下接口引用:EditMedia。

    名称 类型 必选 描述
    Container String 封装格式,可选值:mp4、hls、mov、flv、avi。默认是 mp4。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:mp4
    Type String 剪辑模式,可选值:
    normal(默认):精准编辑
    fast:快速编辑,处理速度更快但精准度一定程度降低
    注意:fast只支持单文件,normal默认输出转码格式是h264
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:fast

    EditMediaTask

    编辑视频任务信息

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

    名称 类型 描述
    TaskId String 任务 ID。
    示例值:26xxxxxx12-EditMediaTask-28xxxxxxxxxx6batt6
    Status String 任务状态,取值:
  • PROCESSING:处理中;
  • FINISH:已完成。

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

  • 示例值:0
    Message String 错误信息。
    示例值:SUCCESS
    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, CreateWorkflow, DescribeTranscodeTemplates, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。

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

    EraseArea

    智能擦除,擦除区域坐标配置。
    区域由左上角与右下角点的坐标确定。
    坐标原点为画面左上角,坐标点可使用像素值或百分比单位指定。
    对自动擦除区域:
    当单位为%时,坐标范围为[0,1];
    当单位为px时,X值范围为 [0,视频画面宽度],Y值范围为 [0,视频画面高度]
    对指定擦除区域:
    当单位为%时,坐标范围为[0,1);
    当单位为px时,X值范围为 [0,视频画面宽度],Y值范围为 [0,视频画面高度]

    被如下接口引用:CreateSmartEraseTemplate, CreateSmartSubtitleTemplate, DetectVideoSubtitleArea, ModifySmartEraseTemplate, ModifySmartSubtitleTemplate, ProcessMedia。

    名称 类型 必选 描述
    LeftTopX Float 区域左上角X坐标。
    如当Unit取1即使用百分比单位时,0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。
    示例值:0.0500
    LeftTopY Float 区域左上角Y坐标。
    如当Unit取1即使用百分比单位时,0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。
    示例值:0.1000
    RightBottomX Float 区域右下角X坐标。
    如当Unit取1即使用百分比单位时,0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。
    示例值:0.7500
    RightBottomY Float 区域右下角Y坐标。
    如当Unit取1即使用百分比单位时,0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。
    示例值:0.9000
    Unit Integer 坐标单位
    - 1 百分比
    - 2 像素值
    示例值:1

    EraseTimeArea

    智能擦除,指定擦除区域配置。
    对指定时间段内的指定区域直接进行擦除。
    当BeginMs和EndMs均取0时对整个视频内的指定区域直接进行擦除。

    被如下接口引用:CreateSmartEraseTemplate, ModifySmartEraseTemplate, ProcessMedia。

    名称 类型 必选 描述
    BeginMs Integer 开始时间,单位:毫秒
    示例值:200
    EndMs Integer 结束时间,单位:毫秒
    示例值:3000
    Areas Array of EraseArea 时间段内擦除区域列表

    EvaluationMediaInputInfo

    视频评测任务的视频来源信息

    被如下接口引用:CreateMediaEvaluation。

    名称 类型 必选 描述
    SourceId String 对比视频的来源 ID,当评测任务的类型为 BD_RATE 且对比视频来自用户输入时有效;当对比视频来自转码模板时为空
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    InputInfo MediaInputInfo 对比视频的输入信息
    注意:此字段可能返回 null,表示取不到有效值。

    EvaluationTaskInput

    评测任务输入参数类型

    被如下接口引用:CreateMediaEvaluation。

    名称 类型 必选 描述
    TaskType String 评测任务类型,可选 NORMAL、BD_RATE
    示例值:NORMAL
    EvaluationTypeSet Array of String 评测类型,可选 PSNR、SSIM、VMAF、VMAF_NEG
    示例值:["PSNR"]
    EvaluationRangeType String 评测范围类型,可选 ALL(全部时长)、TIME(指定时长范围)、FRAME(指定帧数范围)
    示例值:ALL
    ContrastMediaSet Array of EvaluationMediaInputInfo 对比视频信息。
    ContrastTemplateSet Array of EvaluationTemplateInputInfo 对比转码模板信息。
    StartTime Integer 开始评测时间,单位秒,当 EvaluationRangeType 为 TIME 时有效。
    示例值:0
    EndTime Integer 结束评测时间,单位秒,当 EvaluationRangeType 为 TIME 时有效。
    示例值:10
    StartFrameIndex Integer 评测开始帧,默认从0开始,当 EvaluationRangeType 为FRAME 时有效。
    示例值:0
    EndFrameIndex Integer 评测结束帧,默认为视频中可以参与评测的最后一帧,当 EvaluationRangeType 为 FRAME 时有效。
    示例值:9
    ResolutionAlignmentMode String 分辨率对齐模式,默认对齐到低分辨率的视频,可选 ALIGN_HIGH_RESOLUTION、ALIGN_LOW_RESOLUTION
    示例值:ALIGN_HIGH_RESOLUTION
    BitrateSet Array of Integer 指定码率评测,当评测任务类型为 BD_RATE 有效。
    示例值:[1500,2000,2500,3000]
    VCRFSet Array of Integer 指定 vcrf 评测,当评测任务类型为 BD_RATE 有效。
    示例值:[20,24,30,34]

    EvaluationTemplateInputInfo

    在评测中使用的转码模板的信息

    被如下接口引用:CreateMediaEvaluation。

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

    ExecRuleTaskData

    条件判断输出

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

    名称 类型 描述
    RearDriveIndex Array of Integer 质检条件判断需要执行的节点索引。
    示例值:[2,3]

    ExecRulesTask

    任务判断条件

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

    名称 类型 必选 描述
    Rules Array of Rules 条件判断信息
    注意:此字段可能返回 null,表示取不到有效值。

    ExpressionConfigInfo

    表情识别参数配置

    被如下接口引用:RecognizeMediaForZhiXue。

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

  • 示例值:ON

    ExtractBlindWatermarkConfig

    提取盲水印配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

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

    ExtractBlindWatermarkTask

    提取视频数字水印任务信息

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

    名称 类型 描述
    TaskId String 媒体处理任务 ID。
    示例值:125xxx65-ExtractBlindWatermark-bffb15f07530b57bc1aabb01fac74bca
    Status String 任务流状态,取值:
  • WAITING:等待中;
  • PROCESSING:处理中;
  • FINISH:已完成。

  • 示例值:PROCESSING
    ErrCode Integer 错误码,0 表示成功,其他值表示失败。
    示例值:0
    Message String 错误信息。
    示例值:NULL
    InputInfo MediaInputInfo 媒体处理的目标文件信息。
    Type String 数字水印类型,可选值:
  • blind-basic:基础版权数字水印;
  • blind-ab:ab版权数字水印;

  • 示例值:blind-basic
    IsDetected Boolean 标记是否检测到水印,如果该参数为true, Result字段将返回水印提取结果,如果该参数为false,Result字段不会返回。
    示例值:false
    Result String 提取出的数字水印内容,当没有检测到水印时该字段不会返回。
    示例值:数字水印文本
    ExtractBlindWatermarkConfig ExtractBlindWatermarkTaskConfig 提取数字水印配置。

    ExtractBlindWatermarkTaskConfig

    提取视频转码数字水印任务配置

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

    名称 类型 必选 描述
    SegmentDuration Integer 当提取数字水印类型为blind-abseq时有效,用于指定输入视频的切片时长,单位:毫秒。
    如果不填默认切片时长为5秒。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5000

    FaceConfigureInfo

    人脸识别任务控制参数

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

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

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

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

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

    FaceConfigureInfoForUpdate

    人脸识别任务控制参数

    被如下接口引用:ModifyAIRecognitionTemplate。

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

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

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

  • 示例值:Default

    FaceEnhanceConfig

    人脸增强配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

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

    FailOverOption

    type FailOverOption struct
    { FailOverType string json:"FailOverType" // 新增 冷/热备 COLDSTANDBY、HOTSTANDBY }

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

    名称 类型 必选 描述
    FailOverType String 热备
    示例值:HOTSTANDBY

    FlowAudio

    流的音频数据。

    被如下接口引用:DescribeStreamLinkFlowStatistics。

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

    FlowInOutResp

    查询Flow的配置信息。

    被如下接口引用:DescribeGroupAttachFlowsById。

    名称 类型 描述
    FlowId String 流Id。
    示例值:01937702c54509dc0f3269ca341f
    FlowName String 流名称。
    示例值:019202e96d9f09dc0f325e7f7a2a
    EventId String 该Flow关联的媒体传输事件EventId。
    示例值:eventid
    FlowRegion String 媒体传输输入流所属的区域,取值和InputRegion相同。
    示例值:ap-shanghai
    OutputRegion String 当返回是输出类型时非空,output所在Region。
    示例值:ap-shanghai
    EventName String EventName。
    示例值:example-event
    InputName String InOutType为Input有效。
    示例值:studio-one
    OutputName String InOutType为Output有效。
    示例值:shanghai-ouput
    InOutId String Input或者Output的Id。
    示例值:065422a22c771ebd470401elkijg
    InOutType String 输入/输出类型,可选值:
    Input:输入
    Outpu:输出。
    示例值:Input

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

    FrameRateWithDenConfig

    新插帧配置,支持分数帧率

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

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

  • 默认值:ON。
    示例值:ON
    FpsNum Integer 帧率分子,取值范围:非负数,除以分母后小于120,单位:Hz。 默认值 0。 注意:对于转码,该参数会覆盖 VideoTemplate 内部的 Fps。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    FpsDen Integer 帧率分母,取值范围:大于等于1。 默认值 1。 注意:对于转码,该参数会覆盖 VideoTemplate 内部的 FpsDenominator。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    FrameTagConfigureInfo

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

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

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

  • 示例值:ON

    FrameTagConfigureInfoForUpdate

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

    被如下接口引用:ModifyAIAnalysisTemplate。

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

  • 示例值:ON

    HLSConfigureInfo

    HLS配置参数

    被如下接口引用:CreateLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate。

    名称 类型 必选 描述
    ItemDuration Integer 单个 TS 文件时长,单位:秒,取值范围 5-30 秒。

    不填默认为 30 秒。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    Interval Integer 录制周期,单位:秒,取值范围 10 分钟到 12 小时。

    不填默认为 10分钟(3600 秒)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3600
    ContinueTimeout Integer 续录等待时间,单位:秒。取值范围为60秒-1800秒。
    不填默认为0(不启用续录)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:60

    HLSPullSourceAddress

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

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

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

    HdrConfig

    HDR配置

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

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

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

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

    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

    智能精彩集锦片段列表。

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Confidence Float 置信度。
    示例值:80.55
    StartTimeOffset Float 片段起始时间偏移。
    示例值:10.05
    EndTimeOffset Float 片段结束时间偏移。
    示例值:20.05
    SegmentTags Array of String 片段标签
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["Goal"]
    BeginTime String 直播切片对应直播起始时间点,采用 ISO 日期格式。
    示例值:2024-10-21T17:18:34+08:00
    EndTime String 直播切片对应直播结束时间点,采用 ISO 日期格式。
    示例值:2024-10-21T17:26:19+08:00
    Title String 集锦标题。
    示例值:title
    Summary String 集锦概要。
    示例值:summary

    ImageAreaBoxInfo

    图片框选区域信息

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    Type String 图片框选区域类型,可选值:
  • logo:图标;
  • text:文字;

  • 默认值:logo。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:logo
    AreaCoordSet Array of Integer 图片框选区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。注意:该字段最大值为4096。
    示例值:[101, 85, 111, 95]
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[101, 85, 111, 95]
    BoundingBox Array of Float 图片框选区域坐标,[x1, y1, x2, y2],即左上角坐标、右下角坐标, 当AreaCoordSet未指定时生效。当表示像素时,该字段最大值为4096。
    - [0.1, 0.1, 0.3, 0.3] : 表示比例 (数值小于1)
    - [50, 50, 350, 280] : 表示像素 (数值大于等于1)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[0.1, 0.1, 0.2, 0.2]
    BoundingBoxUnitType Integer BoundingBox字段单位。设置为0时,按照该字段规则自动选择单位;设置为1时,单位为比例;设置为2时,单位为像素。
    示例值:0

    ImageDenoiseConfig

    图片降噪配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

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

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

    ImageEncodeConfig

    图片编码格式参数

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    Format String 图片格式,取值范围:JPEG、PNG、BMP、WebP,缺省为原图格式。不支持动画。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:JPEG
    Quality Integer 图片的相对质量,取值范围:1 - 100,数值以原图质量为标准,缺省为原图质量。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:50

    ImageEnhanceConfig

    图片增强参数

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    SuperResolution SuperResolutionConfig 超分配置。
    注意:此字段可能返回 null,表示取不到有效值。
    AdvancedSuperResolutionConfig AdvancedSuperResolutionConfig 高级超分配置。
    Denoise ImageDenoiseConfig 降噪配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ImageQualityEnhance ImageQualityEnhanceConfig 综合增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ColorEnhance ColorEnhanceConfig 色彩增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    SharpEnhance SharpEnhanceConfig 细节增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    FaceEnhance FaceEnhanceConfig 人脸增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    LowLightEnhance LowLightEnhanceConfig 低光照增强配置。
    注意:此字段可能返回 null,表示取不到有效值。

    ImageEraseConfig

    图片擦除参数

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    ImageEraseLogo ImageEraseLogoConfig 图标擦除配置。
    注意:此字段可能返回 null,表示取不到有效值。

    ImageEraseLogoConfig

    图标擦除配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

  • 默认值:ON。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ON
    ImageAreaBoxes Array of ImageAreaBoxInfo 需要擦除的多个框选区域,最多开启16个区域。
    注意:此字段可能返回 null,表示取不到有效值。
    注意:此字段可能返回 null,表示取不到有效值。
    DetectTypes Array of String 图片框选区域类型,可选值:
  • logo:图标;
  • text:文字;
  • watermark:水印;

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:["logo", "text"]

    ImageProcessOutputConfig

    图片处理编排输出配置。

    被如下接口引用:ProcessImage。

    名称 类型 必选 描述
    AspectRatio String 输出图片的宽高比。可以配合ImageWidth 和 ImageHeight 使用,规则如下:

    1. 仅指定 AspectRatio 时,根据原图输入进行自适应调整。
    2. 指定 AspectRatio 和 ImageWidth 时,ImageHeight 由两者计算得出,反亦是如此。
    3. 当AspectRatio、ImageWidth、ImageHeight 同时指定的时候,优先使用ImageWidth、ImageHeight。

    可取值:1:1、3:2、2:3、3:4、4:3、4:5、5:4、9:16、16:9、21:9

    支持该参数 ScheduleId: 30010(扩图)
    示例值:"16:9"
    ImageHeight Integer 图片输出高度,单位:像素。
    示例值:1920
    ImageWidth Integer 图片输出宽度,单位:像素。
    示例值:1080
    ImageSize String 图片输出分辨率,取值:1K/2K/4K。
    示例值:1K
    Format String 图片输出编码格式,可取值:PNG、JPG、WEBP、HEIF、AVIF。
    示例值:PNG
    Quality Integer 图片质量,对于某些输出格式可用,只有Format 有效的情况下生效,取值范围 0-100。
    示例值:75

    ImageProcessPrompt

    图片处理相关提示词。

    被如下接口引用:ProcessImage。

    名称 类型 必选 描述
    Prompt String 图片处理相关的prompt。
    示例值:one cat and one dog

    ImageProcessTaskOutput

    图片处理结果信息

    被如下接口引用:DescribeImageTaskDetail。

    名称 类型 描述
    Path String 输出文件的路径。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/output/test.jpeg
    OutputStorage TaskOutputStorage 输出文件的存储位置。
    注意:此字段可能返回 null,表示取不到有效值。
    SignedUrl String 输出文件的URL。
    示例值:https://abc123.com/output/test.jpeg
    Content String 图生文任务的处理结果。
    示例值:"图片中有一个美丽的女士"

    ImageProcessTaskResult

    图片处理任务结果类型

    被如下接口引用:DescribeImageTaskDetail。

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SUCCESS
    ErrMsg String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:InvalidParameterValue.FaceNotFound
    Message String 错误信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SUCCESS
    Output ImageProcessTaskOutput 转码任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    Progress Integer 转码进度,取值范围 [0-100]
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100

    ImageQualityEnhanceConfig

    综合增强配置

    被如下接口引用:CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage。

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

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

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

    ImageResizeConfig

    图片缩放配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

  • 默认值:ON。
    示例值:ON
    Mode String 输出图片模式,可选模式:
  • percent: 指定缩放倍率,可以为小数
  • mfit: 缩放至指定宽高的较大矩形
  • lfit: 缩放至指定宽高的较小矩形
  • fill: 缩放至指定宽高的较大矩形,并居中裁剪指定宽高
  • pad: 缩放至指定宽高的较小矩形,并填充到指定宽高
  • fixed: 缩放至固定宽高,强制缩放

  • 默认值:percent。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:percent
    Percent Float 缩放倍率,可以为小数,当Mode为percent时使用。

    默认值:1.0。
    取值范围:[0.1,10.0]
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    Width Integer 目标图片宽度。

    取值范围:[1,16384]。
    注意:此字段在Mode非percent时优先使用。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3840
    Height Integer 目标图片高度。

    取值范围:[1,16384]。
    注意:此字段在Mode非percent时优先使用。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2160
    LongSide Integer 目标图片长边。

    取值范围:[1,16384]。
    注意:此字段在Mode非percent且未配置Width和Height时使用。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3840
    ShortSide Integer 目标图片短边。

    取值范围:[1,16384]。
    注意:此字段在Mode非percent且未配置Width和Height时使用。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2160

    ImageSpriteTaskInput

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

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

    名称 类型 必选 描述
    Definition Integer

    雪碧图模板 ID。


    示例值:10001
    OutputStorage TaskOutputStorage

    截取雪碧图后文件的目标存储,不填则继承上层的 OutputStorage 值。


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

    截取雪碧图后,雪碧图图片文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明
    相对路径示例:

  • 文件名_{变量名}.{format}
  • 文件名.{format}
  • 绝对路径示例:
  • /自定义路径/文件名_{变量名}.{format}
  • 如果不填,则默认为相对路径:{inputName}_imageSprite_{definition}_{number}.{format}
    示例值:xxx_imageSprite_10001_0.png
    WebVttObjectName String

    截取雪碧图后,Web VTT 文件的输出路径,只能为相对路径。如果不填,则默认为相对路径:{inputName}_imageSprite_{definition}.{format}


    示例值:xxx_imageSprite_10001_0.vtt
    ObjectNumberFormat NumberFormat

    截取雪碧图后输出路径中的{number}变量的规则。


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

    扩展参数。


    示例值:{"image":""}

    ImageSpriteTemplate

    雪碧图模板详情

    被如下接口引用:DescribeImageSpriteTemplates。

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

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

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

    ImageTaskInput

    图片任务输入参数

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, DescribeProcessImageTemplates, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    EncodeConfig ImageEncodeConfig 图片编码配置。
    注意:此字段可能返回 null,表示取不到有效值。
    EnhanceConfig ImageEnhanceConfig 图片增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    EraseConfig ImageEraseConfig 图片擦除配置。
    注意:此字段可能返回 null,表示取不到有效值。
    BlindWatermarkConfig BlindWatermarkConfig 盲水印配置。
    注意:此字段可能返回 null,表示取不到有效值。
    BeautyConfig BeautyConfig 美颜配置。
    TransformConfig ImageTransformConfig 图片基础转换能力。

    ImageTransformConfig

    图片基础转换能力

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

    名称 类型 必选 描述
    ImageResize ImageResizeConfig 图片缩放配置。
    注意:此字段可能返回 null,表示取不到有效值。

    ImageWatermarkInput

    图片水印模板输入参数

    被如下接口引用:CreateWatermarkTemplate。

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

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

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

  • 示例值:once

    ImageWatermarkInputForUpdate

    图片水印模板输入参数

    被如下接口引用:ModifyWatermarkTemplate。

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

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


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

  • 示例值:once

    ImageWatermarkTemplate

    图片水印模板

    被如下接口引用:DescribeWatermarkTemplates。

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

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

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

  • 示例值:repeat

    InputAddress

    输入地址信息。

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

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

    LinearAssemblyChannelInfo

    线性组装频道信息。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels。

    名称 类型 必选 描述
    Name String

    线性组装频道名称。


    示例值:test_channel2
    Tier String

    定义channel的特性,Standard支持直播和点播源,Basic只支持点播源编排。


    示例值:Standard
    PlaybackMode String

    频道中的source切换的模式,分Linear线性和Loop循环,直播只支持Linear。


    示例值:Linear
    TimeShiftConf TimeShiftInfo

    时移配置,vod有效。

    SlateConf SlateInfo

    垫片配置。

    Outputs Array of OutputInfo

    output信息。

    AttachedPrograms Array of String

    该channel绑定的program列表。


    示例值:["67CA28574083B064D4CB"]
    ProgramSchedules Array of ProgramScheduleInfo

    program信息。

    Id String

    Id。


    示例值:69CA28574083B064D4BB
    Region String

    Region。


    示例值:ap-mumbai
    State String

    State。


    示例值:IDLE
    TimeShiftEnable Boolean

    时移开启开关。


    示例值:true
    CreateTime Integer

    channel创建时间,unix秒时间戳。


    示例值:1774856279

    LinearAssemblyProgramInfo

    频道线性组装program信息。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms。

    名称 类型 必选 描述
    Name String

    program名称。


    示例值:test_program5
    SourceType String

    编排的目标source的类型,分直播和点播。


    示例值:VOD
    SourceLocationId String

    关联的source location id。


    示例值:698557DC1D3EA60266EB
    SourceId String

    SourceId,唯一标识一个source。


    示例值:6985B2641D3EA53D16FD
    SourceName String

    关联的直播or点播,source名称,location下全局唯一。


    示例值:test_source
    AttachedChannel String

    绑定的channel。


    示例值:698A9F401D3EA6831FD9
    PlaybackConf PlaybackInfo

    播放配置。

    AdBreaks Array of AdBreakInfo

    AdBreaks。

    Id String

    Id。


    示例值:698BFB151D3EA5656164
    Region String

    Region。


    示例值:ap-shanghai
    SourceLocationName String

    SourceLocation名称。


    示例值:location_name
    VodAcquisitionMethod String

    VOD获取方式,支持PreCaching和DynamicUpdating,默认PreCaching,仅Linear频道支持


    示例值:PreCaching

    LiveActivityResItem

    直播编排子任务输出

    被如下接口引用:DescribeTaskDetail。

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

    LiveActivityResult

    直播编排任务输出

    被如下接口引用:DescribeTaskDetail。

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

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

    LiveAiAnalysisDescriptionItem

    直播摘要结果信息。

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Paragraphs Array of LiveAiParagraphInfo 分段结果。
    注意:此字段可能返回 null,表示取不到有效值。

    LiveAiParagraphInfo

    分段信息。

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Summary String 分段摘要
    示例值:summary
    Title String 分段标题
    示例值:title
    Keywords Array of String 分段关键词
    示例值:["words1","words2"]
    StartTimeOffset Float 分段起始时间点,秒
    示例值:10.05
    EndTimeOffset Float 分段结束时间点,秒
    示例值:20.05
    BeginTime String 直播切片对应直播起始时间点,采用 ISO 日期格式。
    示例值:2025-11-06T15:54:21+08:00
    EndTime String 直播切片对应直播结束时间点,采用 ISO 日期格式。
    示例值:2025-11-06T16:54:21+08:00

    LiveRecordFile

    直播录制输出文件信息

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

    名称 类型 描述
    Url String 直播录制文件地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://xxx.m3u8
    Size Integer 直播录制文件大小
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1024
    Duration Integer 直播录制文件时长
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    StartTime String 直播录制文件开始时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2025-03-23T07:14:27+08:00
    EndTime String 直播录制文件结束时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2025-03-23T07:16:17+08:00

    LiveRecordResult

    直播录制结果

    被如下接口引用:DescribeTaskDetail。

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

    LiveRecordTaskInput

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

    被如下接口引用:DescribeTaskDetail。

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

    LiveRecordTemplate

    直播录制模板详情

    被如下接口引用:DescribeLiveRecordTemplates。

    名称 类型 描述
    Definition Integer 录制模板唯一标识。
    示例值:20001
    HLSConfigure HLSConfigureInfo HLS 配置参数
    示例值:hls
    MP4Configure MP4ConfigureInfo MP4配置参数
    示例值:{"interval":600}
    Name String 录制模板名称。
    示例值:录制模板
    Comment String 模板描述信息。
    示例值:默认录制模板
    Type String 模板类型,取值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:Preset或Custom
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2023-10-23T22:30:00+08:00
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2023-10-23T22:30:00+08:00
    RecordType String 录制类型,取值为video(音视频录制)、audio(纯音频录制)、auto(自动探测)。
    示例值:video

    LiveScheduleLiveRecordTaskResult

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

    被如下接口引用:DescribeTaskDetail。

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

    LiveScheduleTask

    直播编排任务信息

    被如下接口引用:DescribeTaskDetail。

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

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

    LiveSmartSubtitleResult

    直播智能字幕结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Text String 识别文本。
    示例值:Hello
    StartPTSTime Float 翻译片段起始的 PTS 时间,单位:秒。
    示例值:8.764
    EndPTSTime Float 翻译片段终止的 PTS 时间,单位:秒。
    示例值:15.977
    Trans String 翻译文本。
    示例值:你好
    StartTime String 翻译开始UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2025-03-21T10:11:52Z
    EndTime String 翻译结束UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2025-03-21T10:12:52Z
    SteadyState Boolean 稳态标记。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    UserId String websocket与trtc实时翻译的UserId
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:bot

    LiveSmartSubtitlesTaskInput

    直播智能字幕输入结构体

    被如下接口引用:ProcessLiveStream。

    名称 类型 必选 描述
    Definition Integer 智能字幕模板 ID 。
    示例值:10
    UserExtPara String 用户扩展字段,一般场景不用填。
    示例值:{"ParaTest":"test"}

    LiveStreamAiAnalysisResultInfo

    直播流分析结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    ResultSet Array of LiveStreamAiAnalysisResultItem 直播分析子任务结果,支持:
  • 直播拆条
  • 直播高光集锦
  • 直播摘要

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

    LiveStreamAiAnalysisResultItem

    直播流 AI 分析结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Type String 结果的类型,取值范围:
  • SegmentRecognition:拆条。
  • Highlight :集锦。
  • Description:摘要。

  • 示例值:SegmentRecognition
    SegmentResultSet Array of SegmentRecognitionItem 拆条结果,当 Type 为
    SegmentRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    HighlightResultSet Array of MediaAiAnalysisHighlightItem 集锦结果,当Type 为 Highlight 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    DescriptionResult LiveAiAnalysisDescriptionItem 摘要结果,当Type 为 Description 时有效。

    LiveStreamAiQualityControlResultInfo

    直播流媒体质检结果

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamAiRecognitionResultInfo

    直播流 AI 识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamAiRecognitionResultItem

    直播流 AI 识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Type String 结果的类型,取值范围:
  • FaceRecognition:人脸识别,
  • AsrWordsRecognition:语音关键词识别,
  • OcrWordsRecognition:文本关键词识别,
  • AsrFullTextRecognition:语音全文识别,
  • OcrFullTextRecognition:文本全文识别。
  • TransTextRecognition:语音翻译。
  • ObjectRecognition:目标检测。
  • 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
    ObjectRecognitionResultSet Array of LiveStreamObjectRecognitionResult 目标检测结果,当Type为 ObjectRecognition 时有效。
    示例值:NULL
    TagRecognitionResultSet Array of LiveStreamTagRecognitionResult 打点结果,当Type 为 TagRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL

    LiveStreamAiReviewImagePoliticalResult

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

    被如下接口引用:ParseLiveStreamProcessNotification。

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

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

  • 示例值:politician
    Name String 敏感人物、违规图标名字。
    示例值:人物1
    AreaCoordSet Array of Integer 敏感人物、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    示例值:[101, 85, 111, 95]
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:http://252525.xx.myqcloud.com/1a168d62xxx0/bcf0c036xxxxxxxc/30xxx.jpg
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:20xx-10-01T18:00:00+08:00

    LiveStreamAiReviewImagePornResult

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

    被如下接口引用:ParseLiveStreamProcessNotification。

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

  • 示例值:block
    Label String 视频鉴黄结果标签,取值范围:
  • porn:色情。
  • sexy:性感。
  • vulgar:低俗。
  • intimacy:亲密行为。

  • 示例值:porn
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:http://ai-review.com/review-result.jpg
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:2025-03-25T06:16:39Z

    LiveStreamAiReviewImageTerrorismResult

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

    被如下接口引用:ParseLiveStreamProcessNotification。

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

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

  • 示例值:guns
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:http://252525.xx.myqcloud.com/a168d6/xxxxxx.jpg
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:20xx-10-01T18:00:00+08:00

    LiveStreamAiReviewResultInfo

    直播流 AI 审核结果

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamAiReviewResultItem

    直播流 AI 审核结果

    被如下接口引用:ParseLiveStreamProcessNotification。

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

  • 示例值:ImagePorn
    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 时间,单位:秒。
    示例值:0.266
    EndPtsTime Float 嫌疑片段结束的 PTS 时间,单位:秒。
    示例值:4.146
    Confidence Float 嫌疑片段涉黄分数。
    示例值:98
    Suggestion String 嫌疑片段鉴黄结果建议,取值范围:
  • pass
  • review
  • block

  • 示例值:block
    Label String 视频鉴黄结果标签,取值范围:
  • sexual_moan:呻吟。

  • 示例值:sexual_moan

    LiveStreamAiSmartSubtitleResultInfo

    直播智能字幕结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    SmartSubtitleResult Array of LiveSmartSubtitleResult 直播智能字幕任务结果列表。

    LiveStreamAsrFullTextRecognitionResult

    直播识别 Asr 全文识别

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamAsrWordsRecognitionResult

    直播 AI Asr 单词识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamFaceRecognitionResult

    直播 AI 人脸识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

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

  • 示例值:Default
    StartPtsTime Float 识别片段起始的 PTS 时间,单位:秒。
    示例值:10.05
    EndPtsTime Float 识别片段终止的 PTS 时间,单位:秒。
    示例值:12.05
    Confidence Float 识别片段置信度。取值:0~100。
    示例值:80
    AreaCoordSet Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。
    示例值:[1500,80,1800,120]

    LiveStreamObjectRecognitionResult

    直播 AI 物体识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Name String 识别的物体名称。
    示例值:足球
    StartPtsOffset Float 识别片段起始的 PTS 时间,单位:秒。
    示例值:61.08
    EndPtsOffset Float 识别片段终止的 PTS 时间,单位:秒。
    示例值:65.54
    Confidence Float 识别片段置信度。取值:0~100。
    示例值:90
    AreaCoordSet Array of Integer 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。
    示例值:[1590,84,1867,129]
    Url String 截图链接。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://252525.xx.myqcloud.com/a168d6/xxxxxx.jpg

    LiveStreamOcrFullTextRecognitionResult

    直播识别 Ocr 全文识别

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamOcrWordsRecognitionResult

    直播 AI Ocr 单词识别结果

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    LiveStreamProcessErrorInfo

    直播流处理错误信息

    被如下接口引用:ParseLiveStreamProcessNotification。

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

  • 示例值:0
    Message String 错误信息。
    示例值:open url failed

    LiveStreamProcessTask

    直播处理任务信息

    被如下接口引用:DescribeTaskDetail。

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

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

    LiveStreamRecordResultInfo

    直播流录制结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    RecordOver Integer 录制是否结束。
    0:录制未结束,返回单个文件结果
    1:录制结束,返回所有录制文件结果
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    FileResults Array of LiveRecordFile 文件列表
    注意:此字段可能返回 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 通知类型:
    TDMQ-CMQ:消息队列
    "URL": 指定URL时HTTP回调推送到 NotifyUrl 指定的地址,回调协议http+json,包体内容同解析直播事件通知接口 的输出参数

    注:不填或为空时不发送回调,如需回调需填写对应类型值。
    示例值:URL
    NotifyUrl String HTTP回调地址,NotifyType为URL时必填。
    示例值:http://www.qq.com/callback
    CmqModel String 有 Queue 和 Topic 两种模型。
    示例值:Queue
    CmqRegion String TDMQ-CMQ 的园区,如 sh,bj 等。
    示例值:sh
    QueueName String 当模型为 Queue 时有效,表示接收事件通知的 TDMQ-CMQ 的队列名。
    示例值:mpstest-queue
    TopicName String 当模型为 Topic 时有效,表示接收事件通知的 TDMQ-CMQ 的主题名。
    示例值:mpstest-topic
    NotifyKey String 用于生成回调签名的 Key。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0se***9idaY

    LiveStreamTransTextRecognitionResult

    直播实时翻译结果

    被如下接口引用:ParseLiveStreamProcessNotification。

    名称 类型 描述
    Text String 识别文本。
    示例值:Hello
    StartPtsTime Float 翻译片段起始的 PTS 时间,单位:秒。
    示例值:8.764
    EndPtsTime Float 翻译片段终止的 PTS 时间,单位:秒。
    示例值:15.977
    Confidence Float 翻译片段置信度。取值:0~100。
    示例值:99
    Trans String 翻译文本。
    示例值:你好
    StartTime String 翻译开始UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2025-03-21T10:11:52Z
    EndTime String 翻译结束UTC时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2025-03-21T10:12:52Z
    SteadyState Boolean 稳态标记。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    UserId String websocket与trtc实时翻译的UserId
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:bot

    LowLightEnhanceConfig

    低光照增强配置

    被如下接口引用:CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage。

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

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

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

    MP4ConfigureInfo

    MP4配置参数

    被如下接口引用:CreateLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate。

    名称 类型 必选 描述
    Interval Integer 录制周期,单位:秒,取值范围 10 分钟到720分钟。默认值:60分钟(3600秒)。
    示例值:3600

    ManifestInfo

    线性组装频道配置。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel。

    名称 类型 必选 描述
    Windows Integer 单位秒。
    示例值:60
    AdMarkupType String 打到output广告标签的格式,可选Date Range和Enhanced SCTE-35。
    示例值:Enhanced SCTE-35

    MediaAiAnalysisClassificationItem

    智能分类结果

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

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

    MediaAiAnalysisCoverItem

    智能封面信息

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

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

    MediaAiAnalysisDescriptionItem

    智能描述信息

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

    名称 类型 描述
    Description String 智能描述。
    示例值:本段主要讲述了xxxxx内容
    Confidence Float 智能描述的可信度,取值范围是 0 到 100。
    示例值:90.0
    Title String 智能描述标题
    示例值:标题1
    Keywords Array of String 智能描述关键词
    示例值:["word1","word2"]
    Paragraphs Array of AiParagraphInfo 分段结果。
    注意:此字段可能返回 null,表示取不到有效值。
    MindMapUrl String 摘要思维导图地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:https://xxxx.cos.myqcloud.com/mindoutput/mindmap_4114033726.png
    MindMapPath String 摘要思维导图路径。
    示例值:/mindoutput/mindmap_4114033726.png
    SubtitlePath String 视频字幕文件路径。
    示例值:/subtitleoutput/subtitle_149957943.vtt
    OutputStorage TaskOutputStorage 摘要文件存储位置。

    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。
    示例值:60

    MediaAiAnalysisFrameTagSegmentItem

    按帧标签片段列表

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

    名称 类型 描述
    StartTimeOffset Float 按帧标签起始的偏移时间。
    示例值:10.052
    EndTimeOffset Float 按帧标签结束的偏移时间。
    示例值:15.052
    TagSet Array of MediaAiAnalysisFrameTagItem 时间片段内的标签列表。
    示例值:[{"Tag": "寺庙","CategorySet":["场景", "人文建筑"],"Confidence": 26}]

    MediaAiAnalysisHighlightItem

    智能精彩片段信息

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

    名称 类型 描述
    HighlightPath String 智能精彩集锦地址。
    示例值:/AItst/hht-2025031xxx-021354578E_17243423310test-0.mp4
    CovImgPath String 智能精彩集锦封面地址。
    示例值:/AItest/hht-2025031xxx-021245578E_17243423310test-0.jpg
    Confidence Float 智能精彩集锦的可信度,取值范围是 0 到 100。
    示例值:92.56
    Duration Float 智能精彩集锦持续时间。
    示例值:43.76
    SegmentSet Array of HighlightSegmentItem 智能精彩集锦子片段列表。
    HighlightUrl String 智能精彩集锦地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://test-12246.cos.ap-nanjing.myqcloud.com/AItest/hht-2025031xxx-02135468E_17243423310test-0.mp4
    CovImgUrl String 智能精彩集锦封面地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://test-12246.cos.ap-nanjing.myqcloud.com/AItest/hht-2025031xxx-02134468E_17243423310test-0.jpg

    MediaAiAnalysisTagItem

    智能标签结果信息

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

    名称 类型 描述
    Tag String 标签名称。
    示例值:影视综艺,影视片段
    Confidence Float 标签的可信度,取值范围是 0 到 100。
    示例值:77.00
    SpecialInfo String 根据不同类型决定
    示例值:额外输出信息

    MediaAnimatedGraphicsItem

    视频转动图结果信息

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

    名称 类型 描述
    Storage TaskOutputStorage 转动图文件的存储位置。
    Path String 转动图的文件路径。
    示例值:/xxx.gif
    Definition Integer 转动图模板 ID,参见转动图参数模板
    示例值:20000
    Container String 动图格式,如 gif。
    示例值:gif
    Height Integer 动图的高度,单位:px。
    示例值:1080
    Width Integer 动图的宽度,单位:px。
    示例值:1920
    Bitrate Integer 动图码率,单位:bps。
    示例值:0
    Size Integer 动图大小,单位:字节。
    示例值:1048576
    Md5 String 动图的md5值。
    示例值:xxxx1b3082d8b18de1xxxx
    StartTimeOffset Float 动图在视频中的起始时间偏移,单位:秒。
    示例值:1.5
    EndTimeOffset Float 动图在视频中的结束时间偏移,单位:秒。
    示例值:5.5

    MediaAudioStreamItem

    点播文件音频流信息

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

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

    MediaContentReviewAsrTextSegmentItem

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

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

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    示例值:10.05
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    示例值:15.00
    Confidence Float 嫌疑片段置信度。
    示例值:90.00
    Suggestion String 嫌疑片段审核结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 示例值:pass
    KeywordSet Array of String 嫌疑关键词列表。
    示例值:["张三"]

    MediaContentReviewOcrTextSegmentItem

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

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

    名称 类型 描述
    StartTimeOffset Float 嫌疑片段起始的偏移时间,单位:秒。
    示例值:10.05
    EndTimeOffset Float 嫌疑片段结束的偏移时间,单位:秒。
    示例值:15.00
    Confidence Float 嫌疑片段置信度。
    示例值:90
    Suggestion String 嫌疑片段审核结果建议,取值范围:
  • pass。
  • review。
  • block。

  • 示例值:review
    KeywordSet Array of String 嫌疑关键词列表。
    示例值:['张三']
    AreaCoordSet Array of Integer 嫌疑文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    示例值:[500,150,700,300]
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:http://xxx.jpg
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:2025-03-23T07:14:47+08:00

    MediaContentReviewPoliticalSegmentItem

    内容审核涉敏嫌疑片段

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

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

  • 示例值:block
    Name String 涉敏人物、违规图标名字。
    示例值:测试人物1
    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:敏感军事人物。

  • 示例值:sensitive_entertainment
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:http://252325.test2.myqcloud.com/1a168dtest/test01_01.jpg
    AreaCoordSet Array of Integer 涉敏人物、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
    示例值:[801, 952, 808, 996]
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:2023-xx-xxT10:11:32.392Z

    MediaContentReviewSegmentItem

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

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

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

  • 示例值:block
    Url String 嫌疑图片 URL (图片不会永久存储,到达
    PicUrlExpireTime 时间点后图片将被删除)。
    示例值:http://252452.test.myqcloud.com/1a168abcd12345560/419f9123123_01.jpg
    PicUrlExpireTime String 嫌疑图片 URL 失效时间,使用 ISO 日期格式
    示例值:2023-03-28T10:12:16.948Z

    MediaImageSpriteItem

    雪碧图信息

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

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

    MediaInputInfo

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

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, CreateWorkflow, DescribeBatchTaskDetail, DescribeImageTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, DetectVideoSubtitleArea, EditMedia, ExtractBlindWatermark, ParseNotification, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, ResetWorkflow, WithdrawsWatermark。

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

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

    MediaMetaData

    点播媒体文件元信息

    被如下接口引用:DescribeBatchTaskDetail, 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 三种。
    示例值:SUCCESS
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:InvalidInput
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:SUCCESS
    Input ImageSpriteTaskInput 对视频截雪碧图任务的输入。
    Output MediaImageSpriteItem 对视频截雪碧图任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式
    示例值:2019-07-16T06:21:28Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式
    示例值: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:自适应码流

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

    MediaProcessTaskSnapshotByTimeOffsetResult

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

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

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

    MediaProcessTaskTranscodeResult

    转码任务结果类型

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

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

    MediaSampleSnapshotItem

    采样截图信息

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

    名称 类型 描述
    Definition Integer 采样截图规格 ID,参见采样截图参数模板
    示例值:10
    SampleType String 采样方式,取值范围:
  • Percent:根据百分比间隔采样。
  • Time:根据时间间隔采样。

  • 示例值:Percent
    Interval Integer 采样间隔
  • 当 SampleType 为 Percent 时,该值表示多少百分比一张图。
  • 当 SampleType 为 Time 时,该值表示多少时间间隔一张图,单位秒, 第一张图均为视频首帧。

  • 示例值:10
    Storage TaskOutputStorage 截图后文件的存储位置。
    示例值:{ "Type": "COS", "CosOutputStorage": { "Bucket": "mpstest-12xxxxxx7", "Region": "ap-nanjing"} }
    ImagePathSet Array of String 生成的截图 path 列表。
    示例值:["/output/test_sampleByOffset_10_0.jpg"]
    WaterMarkDefinition Array of Integer 截图如果被打上了水印,被打水印的模板 ID 列表。
    示例值:100001

    MediaSnapshotByTimeOffsetItem

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

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

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

    MediaSnapshotByTimePicInfoItem

    指定时间点截图信息

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

    名称 类型 描述
    TimeOffset Float 该张截图对应视频文件中的时间偏移,单位为秒。
    示例值:3.5
    Path String 该张截图的路径。
    示例值:/output/689a7xxxxxa/test_snapshotByOffset_23123x_0.jpg
    WaterMarkDefinition Array of Integer 截图如果被打上了水印,被打水印的模板 ID 列表。
    示例值:[1011]

    MediaTranscodeItem

    转码信息

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

    名称 类型 描述
    OutputStorage TaskOutputStorage 转码后文件的目标存储。
    示例值:null
    Path String 转码后的视频文件路径。
    示例值:/output/test.mp4
    Definition Integer 转码规格 ID,参见转码参数模板
    示例值:10
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和, 单位:bps。
    示例值:1000
    Height Integer 视频流高度的最大值,单位:px。
    示例值:1080
    Width Integer 视频流宽度的最大值,单位:px。
    示例值:1920
    Size Integer 媒体文件总大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。
    示例值:20000
    Duration Float 视频时长,单位:秒。
    示例值:15
    Container String 容器类型,例如 m4a,mp4 等。
    示例值:mp4
    Md5 String 视频的 md5 值。
    示例值:"xxxx"
    AudioStreamSet Array of MediaAudioStreamItem 音频流信息。
    VideoStreamSet Array of MediaVideoStreamItem 视频流信息。
    CallBackExtInfo String 视频转码使用增强项说明,增强项解释
  • hdr:HDR配置
  • wd_fps:插帧帧率配置
  • video_super_resolution: 超分配置
  • repair:综合增强配置
  • denoise:视频降噪配置
  • color_enhance:色彩增强配置
  • scratch:去划痕配置
  • artifact:去伪影(毛刺)配置
  • sharp:细节增强配置
  • low_light:低光照增强配置
  • face_enhance:人脸增强配置

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:"{"enhance_item":["hdr","color_enhance"]}"

    MediaVideoStreamItem

    点播文件视频流信息

    被如下接口引用:DescribeBatchTaskDetail, 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
    FpsNumerator Integer 帧率分子部分
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:30
    FpsDenominator Integer 帧率分母部分
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    Metadata

    Metadata。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, ModifyStreamPackageLinearAssemblyProgram。

    名称 类型 必选 描述
    Key String Key。
    示例值:test-key
    Value String Value。
    示例值:test-val

    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的配置信息。
    RTPSettings CreateInputRTPSettings RTP的配置信息。
    Protocol String 输入的协议,可选[SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST]。 -
    示例值:SRT
    FailOver String 输入的主备开关,可选[OPEN|CLOSE]。
    示例值:CLOSE
    RTMPPullSettings CreateInputRTMPPullSettings RTMP_PULL的配置信息。
    RTSPPullSettings CreateInputRTSPPullSettings RTSP_PULL的配置信息。
    HLSPullSettings CreateInputHLSPullSettings HLS_PULL的配置信息。
    ResilientStream ResilientStreamConf 延播平滑吐流配置信息。
    SecurityGroupIds Array of String 绑定的输入安全组 ID。 仅支持关联一组安全组。
    示例值:["019631fd7ab41ea506497cedffg"]
    Zones Array of String 可用区,非必填,最多支持输入两个可用区,对于需改接口,只要第二个可用区会参与到资源分配。如果input开启容灾或者涉及RTSP_PULL协议切换时有效(会重新分配地址)。
    示例值:["ap-shanghai-1"]
    RISTSettings CreateInputRISTSettings RIST的配置信息。
    InputRegion String 输入节点的地区
    示例值:ap-shanghai
    FailOverOption FailOverOption 冷热备相关

    ModifyOutputInfo

    修改Output配置。

    被如下接口引用:ModifyStreamLinkOutputInfo。

    名称 类型 必选 描述
    OutputId String 需要修改的Output的Id。
    示例值:019202e96d9f09dc0f325e7f7a2a
    OutputName String 输出的名称。
    示例值:OutputName
    Description String 输出的描述。
    示例值:Description
    Protocol String 输出的转推协议,支持SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST。
    示例值:SRT
    OutputKind String 输出模块类型,包括Pinpoint(单点输出,最多支持四路并发输出);MultiMesh(多路输出,支持大于四路的并发输出,目前可以达到200路)。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出。
    示例值:Pinpoint
    SRTSettings CreateOutputSRTSettings 转推SRT的配置。
    RTPSettings CreateOutputInfoRTPSettings 转推RTP的配置。
    RTMPSettings CreateOutputRTMPSettings 转推RTMP的配置。
    AllowIpList Array of String IP白名单列表,格式为CIDR,如0.0.0.0/0。
    当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。
    示例值:["0.0.0.0/0"]
    MaxConcurrent Integer 最大拉流并发数,最大4,默认4。
    示例值:1
    SecurityGroupIds Array of String 绑定的安全组 ID。 仅支持关联一组安全组。
    示例值:["035hk1fd7ab41ea5064bb9"]
    Zones Array of String 可用区
    示例值:["ap-shanghai-1"]
    RISTSettings CreateOutputRistSettings 转推RIST的配置。
    OutputType String 输出类型:Internet/TencentCSS/StreamLive
    示例值:TencentCSS
    StreamSelector StreamSelector 对于含有多个音/视频轨的流,可以指定需要使用的轨道

    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

    NameServer

    自定义服务器信息。

    被如下接口引用:CreateStreamPackageSourceLocation, ModifyStreamPackageSourceLocation。

    名称 类型 必选 描述
    Name String 名称。
    示例值:server_name
    Url String 地址。
    示例值:https://testserver.com/"

    NumberFormat

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

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

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

    OcrFullTextConfigureInfo

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

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

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

  • 示例值:ON

    OcrFullTextConfigureInfoForUpdate

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

    被如下接口引用:ModifyAIRecognitionTemplate。

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

  • 示例值:ON

    OcrWordsConfigureInfo

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

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

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

  • 示例值:ON
    LabelSet Array of String 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["腾讯云"]

    OcrWordsConfigureInfoForUpdate

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

    被如下接口引用:ModifyAIRecognitionTemplate。

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

  • 示例值:ON
    LabelSet Array of String 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["腾讯云"]

    OutputAddress

    输出的出口的地址。

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

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

    OutputInfo

    线性组装output信息。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel。

    名称 类型 必选 描述
    Type String HLS DASH。
    示例值:HLS
    GroupName String output group名称,可以和source的group名称对应关联起来。
    示例值:group_name
    ManifestName String channel program调度后输出的文件名。
    示例值:master
    ManifestConf ManifestInfo Type为HLS时manifest配置使用的字段。
    PlaybackURL String 播放地址。
    示例值:http://251009588.ap-shanghai.streampackage.srclivepull.myqcloud.com/channel_assembly/698ADB7C1D3EA6831FFF/master.m3u8
    DashManifestConf DashManifestInfo Type为DASH时manifest配置使用的字段。

    OutputRISTSourceAddressResp

    RIST输出的监听地址。

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

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

    OutputReq

    线性组装output信息。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel。

    名称 类型 必选 描述
    Type String 输出类型,区分HLS DASH。
    示例值:HLS
    GroupName String output group名称,可以和source的group名称对应关联起来。
    示例值:group_name
    ManifestName String channel program调度后输出的文件名。
    示例值:master
    ManifestConf ManifestInfo Type为HLS时manifest配置使用的字段。
    DashManifestConf DashManifestInfo Type为DASH时manifest配置使用的字段。

    OutputSRTSourceAddressResp

    SRT输出的监听地址。

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

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

    OverrideEraseParameter

    智能擦除自定义参数

    被如下接口引用:ProcessMedia。

    名称 类型 必选 描述
    EraseType String

    擦除类型

    • subtitle 去字幕
    • watermark 去水印
    • privacy 隐私保护

    示例值:subtitle
    EraseSubtitleConfig UpdateSmartEraseSubtitleConfig

    字幕擦除配置;
    当EraseType值为:subtitle,此字段为必填参数

    EraseWatermarkConfig UpdateSmartEraseWatermarkConfig

    水印擦除配置;
    当EraseType值为:watermark,此字段为必填参数

    ErasePrivacyConfig UpdateSmartErasePrivacyConfig

    隐私保护配置;
    当EraseType值为:privacy,此字段为必填参数

    SubtitleEmbedId Integer

    擦除压制字幕模板id。


    示例值:1001

    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 视频流配置参数。
    AudioTemplate AudioTemplateInfoForUpdate 音频流配置参数。
    TEHDConfig TEHDConfigForUpdate 极速高清转码参数。
    注意:此字段可能返回 null,表示取不到有效值。
    SubtitleTemplate SubtitleTemplate 字幕流配置参数。
    AddonAudioStream Array of MediaInputInfo 外挂音轨参数。
    StdExtInfo String 转码扩展字段。
    示例值:{"audio_info": {"codec": "vivid"}}
    AddOnSubtitles Array of AddOnSubtitle 要插入的字幕文件。

    PidSelector

    对于含有多个音/视频轨的流,可以指定需要使用的轨道

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

    名称 类型 必选 描述
    AudioPID Array of Integer 对于含有多音轨的流, 可以通过输入PID来指定需要使用的音轨,PID可以输入1到8191之间的正整数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[123,124]
    VideoPID Array of Integer 对于含有多个视频轨的流,可以通过输入PID来指定需要使用的视频轨,PID可以输入1到8191之间的正整数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[123,124]

    PlaybackInfo

    program播放配置。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms。

    名称 类型 必选 描述
    Duration Integer

    program持续时间,单位毫秒,直播有效。


    示例值:10
    TransitionType String

    program启动方式,直播只支持Absolute,点播还支持Relative。


    示例值:Absolute
    StartTime Integer

    unix时间戳,Absolute场景下program的开始执行时间。


    示例值:1770789719
    RelativePosition String

    和所选program的插入顺序关系,分After和Before。


    示例值:After
    RelativeProgramId String

    所选的插入参考program id。


    示例值:69CA3E5D4083AFE14663
    ClipRangeConf ClipRangeInfo

    垫片配置。

    RelativeProgramName String

    RelativeProgramName。


    示例值:test_program1

    PlaybackInfoReq

    program播放配置请求。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, ModifyStreamPackageLinearAssemblyProgram。

    名称 类型 必选 描述
    TransitionType String program启动方式,直播只支持Absolute,点播还支持Relative。PlaybackMode类型为Linear的VOD支持Absolute和Relative。PlaybackMode类型为Loop的VOD只支持Relative
    示例值:Absolute
    StartTime Integer unix时间戳,absolute场景下program的开始执行时间。最多大于当前90天(7776000)。
    示例值:1770789719
    Duration Integer program持续时间,单位毫秒,直播有效。支持600000-86400000。默认600000。
    示例值:10
    RelativePosition String 和所选program的插入顺序关系,分After和Before。
    示例值:After
    RelativeProgramId String 所选的插入参考program id。
    示例值:66503E8E0000930000F7
    ClipRangeConf ClipRangeInfo 垫片配置。

    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:关闭语音涉敏任务。

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

    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:关闭语音鉴黄任务。

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

    PornAsrReviewTemplateInfoForUpdate

    语音鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

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

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

    PornConfigureInfo

    鉴黄任务控制参数

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

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

    PornConfigureInfoForUpdate

    鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

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

    PornImgReviewTemplateInfo

    画面鉴黄任务控制参数

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

    名称 类型 必选 描述
    Switch String 画面鉴黄任务开关,可选值:
  • ON:开启画面鉴黄任务;
  • OFF:关闭画面鉴黄任务。

  • 示例值:ON
    LabelSet Array of String 画面鉴黄过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为:
  • porn:色情;
  • vulgar:低俗;
  • intimacy:亲密行为;
  • sexy:性感。

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

    PornImgReviewTemplateInfoForUpdate

    画面鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 画面鉴黄任务开关,可选值:
  • ON:开启画面鉴黄任务;
  • OFF:关闭画面鉴黄任务。

  • 示例值:ON
    LabelSet Array of String 画面鉴黄过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为:
  • porn:色情;
  • vulgar:低俗;
  • intimacy:亲密行为;
  • sexy:性感。

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

    PornOcrReviewTemplateInfo

    文本鉴黄任务控制参数

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

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

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

    PornOcrReviewTemplateInfoForUpdate

    文本鉴黄任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

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

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

    ProcessImageTemplate

    图片处理模板

    被如下接口引用:DescribeProcessImageTemplates。

    名称 类型 描述
    Definition Integer 图片处理模板唯一标识。
    示例值:10
    Name String 图片处理模板名称。
    示例值:图片处理模板1
    Comment String 图片处理模板描述信息。
    示例值:图片处理使用超分
    Type String 模板类型。
    示例值:Custom
    ProcessImageConfig ImageTaskInput 图片处理模板配置参数。
    CreateTime String 模板创建时间。
    示例值:2021-02-03T04:05:06Z
    UpdateTime String 模板最后修改时间。
    示例值: 2022-02-03T04:05:06Z

    ProgramAlertCounts

    线性组装Program聚合告警信息

    被如下接口引用:DescribeStreamPackageLinearAssemblyChannelAlerts。

    名称 类型 描述
    ProgramId String

    Program ID。


    示例值:69CA28574083B064D4BB
    ProgramName String

    Program名称。


    示例值:test_program
    Category String

    告警分类。


    示例值:Warning
    Count Integer

    出现次数


    示例值:1
    LastModifiedTime Integer

    更新时间。


    示例值:1774861917

    ProgramAlertInfos

    线性组装program告警信息详情。

    被如下接口引用:DescribeStreamPackageLinearAssemblyChannelAlerts。

    名称 类型 描述
    ChannelId String

    频道ID。


    示例值:69CA3EA14083B04FDE2D
    ChannelName String

    频道名称。


    示例值:test_channel
    ProgramId String

    ProgramName。


    示例值:69CA3E5D4083AFE14663
    ProgramName String

    ProgramName。


    示例值:64C33E5D4083AFE14662
    Code Integer

    告警事件码。


    示例值:5002
    Category String

    告警分类。


    示例值:Warning
    Message String

    告警消息。


    示例值:InvalidPara
    LastModifiedTime Integer

    更新时间。


    示例值:1774861917

    ProgramScheduleInfo

    该channel下面Program的调度信息。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels。

    名称 类型 必选 描述
    ProgramName String

    program名称。


    示例值:test_program
    ProgramId String

    program id。


    示例值:69CA28574083B064D4BB
    SourceType String

    source类型。


    示例值:VOD
    SourceId String

    source id。


    示例值:69CA280B4083B089741E
    SourceLocationId String

    source location的id。


    示例值:69CA27E04083B089741D
    StartTime Integer

    开始时间戳。


    示例值:1774861917
    Duration String

    持续时长。


    示例值:60

    ProhibitedAsrReviewTemplateInfo

    语音违禁任务控制参数

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

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

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

    ProhibitedAsrReviewTemplateInfoForUpdate

    语音违禁任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

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

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

    ProhibitedConfigureInfo

    违禁任务控制参数

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

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

    ProhibitedConfigureInfoForUpdate

    违禁任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

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

    ProhibitedOcrReviewTemplateInfo

    文本违禁任务控制参数

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

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

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

    ProhibitedOcrReviewTemplateInfoForUpdate

    文本违禁任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

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

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

    Project

    剧集项目信息

    被如下接口引用:QueryProject。

    名称 类型 必选 描述
    ProjectId String

    项目id


    示例值:458f16b1-7da9-4a56-a841-78567c5bee48
    ProjectName String

    项目名称


    示例值:斗破苍穹(第二季)
    Description String

    项目描述


    示例值:玄幻题材有声剧
    TermBase Array of TermBase

    项目术语库

    Speakers Array of Speakers

    角色列表

    CreatedAt Integer

    创建时间(Unix 时间戳)


    示例值:1775011251
    UpdatedAt Integer

    更新时间(Unix 时间戳)


    示例值:1775014479

    PureSubtitleTransResult

    纯字幕翻译结果

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

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

    PureSubtitleTransResultOutput

    翻译详细输出结果

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

    名称 类型 描述
    OutputStorage TaskOutputStorage 字幕文件存储位置。
    注意:此字段可能返回 null,表示取不到有效值。
    SubtitleResults Array of SubtitleTransResultItem 多语言翻译的结果集合

    QualityControlData

    媒体质检结果输出。

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

    名称 类型 描述
    NoAudio Boolean

    为true时表示视频无音频轨。


    示例值:true
    NoVideo Boolean

    为true时表示视频无视频轨。


    示例值:true
    QualityEvaluationScore Integer

    视频无参考质量评分,百分制。


    示例值:95
    QualityEvaluationMeanOpinionScore Float

    视频无参考质量评分,MOS分数。


    示例值:4.75
    AestheticEvaluationScore Integer

    视频美学评分,范围:[0,100]。


    示例值:80
    QualityControlResultSet Array of QualityControlResult

    内容质检检出异常项。

    ContainerDiagnoseResultSet Array of ContainerDiagnoseResultItem

    格式诊断检出异常项。

    QualityControlItem

    质检结果项

    被如下接口引用:ParseLiveStreamProcessNotification。

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

    QualityControlItemConfig

    质检项配置

    被如下接口引用:CreateQualityControlTemplate, DescribeQualityControlTemplates, ModifyQualityControlTemplate。

    名称 类型 必选 描述
    Type String 质检项名称。质检项取值如下:
  • LowEvaluation:视频无参考评分(MOS)
  • AudioEvaluation:音频无参考评分(MOS)
  • Mosaic:马赛克检测
  • CrashScreen:花屏检测
  • Blur:模糊检测
  • Jitter:抖动检测
  • Noise:噪点检测
  • QRCode:二维码检测
  • BarCode:条形码检测
  • AppletCode:小程序码检测
  • BlackWhiteEdge:黑白边检测
  • SolidColorScreen:纯色屏检测
  • LowLighting:低光照
  • HighLighting:过曝
  • NoVoice:静音检测
  • LowVoice:低音检测
  • HighVoice:爆音检测
  • AudioNoise:音频噪声检测
  • VideoResolutionChanged:视频分辨率变化
  • AudioSampleRateChanged:音频采样率变化
  • AudioChannelsChanged:音频通道数变化
  • ParameterSetsChanged:流参数集信息发生变化
  • DarOrSarInvalid:视频的宽高比异常
  • TimestampFallback:DTS时间戳回退
  • DtsJitter:DTS抖动过大
  • PtsJitter:PTS抖动过大
  • AACDurationDeviation:AAC帧时间戳间隔不合理
  • AudioDroppingFrames:音频丢帧
  • VideoDroppingFrames:视频丢帧
  • AVTimestampInterleave:音视频交织不合理
  • PtsLessThanDts:媒体流的 pts 小于 dts
  • ReceiveFpsJitter:网络接收帧率抖动过大
  • ReceiveFpsTooSmall:网络接收视频帧率过小
  • FpsJitter:通过PTS计算得到的流帧率抖动过大
  • StreamOpenFailed:流打开失败
  • StreamEnd:流结束
  • StreamParseFailed:流解析失败
  • VideoFirstFrameNotIdr:首帧不是IDR帧
  • StreamNALUError:NALU起始码错误
  • TsStreamNoAud:mpegts的H26x流缺失 AUD NALU
  • AudioStreamLack:无音频流
  • VideoStreamLack:无视频流
  • LackAudioRecover:缺失音频流恢复
  • LackVideoRecover:缺失视频流恢复
  • VideoBitrateOutofRange:视频流码率(kbps)超出范围
  • AudioBitrateOutofRange:音频流码率(kbps)超出范围
  • VideoDecodeFailed:视频解码错误
  • AudioDecodeFailed:音频解码错误
  • AudioOutOfPhase:双通道音频相位相反
  • VideoDuplicatedFrame:视频流中存在重复帧
  • AudioDuplicatedFrame:音频流中存在重复帧
  • VideoRotation:视频画面旋转
  • TsMultiPrograms:MPEG2-TS流有多个program
  • Mp4InvalidCodecFourcc:MP4中codec fourcc不符合Apple HLS要求
  • HLSBadM3u8Format:无效的m3u8文件
  • HLSInvalidMasterM3u8:无效的main m3u8文件
  • HLSInvalidMediaM3u8:无效的media m3u8文件
  • HLSMasterM3u8Recommended:main m3u8缺少标准推荐的参数
  • HLSMediaM3u8Recommended:media m3u8缺少标准推荐的参数
  • HLSMediaM3u8DiscontinuityExist:media m3u8存在EXT-X-DISCONTINUITY
  • HLSMediaSegmentsStreamNumChange:切片的流数目发生变化
  • HLSMediaSegmentsPTSJitterDeviation:切片间PTS跳变且没有EXT-X-DISCONTINUITY
  • HLSMediaSegmentsDTSJitterDeviation:切片间DTS跳变且没有EXT-X-DISCONTINUITY
  • TimecodeTrackExist:MP4存在tmcd轨道

  • 示例值:Mosaic
    Switch String 能力配置开关,可选值:
  • ON:开启;
  • OFF:关闭。

  • 默认值:ON。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ON
    Sampling String 采样方式,取值范围:
    - Time:根据时间间隔采样。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Time
    IntervalTime Integer 采样间隔时间,单位:ms。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1000
    Duration Integer 异常持续时间,单位:ms。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1000
    Threshold String 检测项对应的阈值,不同检测项对应阈值不同。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:80

    QualityControlResult

    质检异常项。

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

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

    QualityControlStrategy

    媒体质检检测策略。

    被如下接口引用:CreateQualityControlTemplate, DescribeQualityControlTemplates, ModifyQualityControlTemplate。

    名称 类型 必选 描述
    StrategyType String 策略类型。取值:
    - TimeSpotCheck
    示例值:TimeSpotCheck
    TimeSpotCheck TimeSpotCheck 根据时间的抽检策略。

    QualityControlTemplate

    媒体质检模板详情

    被如下接口引用:DescribeQualityControlTemplates。

    名称 类型 描述
    Definition Integer 媒体质检模板唯一标识。
    示例值:10
    Name String 媒体质检模板名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    Comment String 模板描述信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:my test media quality control template
    Type String 模板类型,取值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:Custom
    QualityControlItemSet Array of QualityControlItemConfig 媒体质检配置参数。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-02-03T04:05:06Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2022-02-03T04:05:06Z
    Strategy QualityControlStrategy 媒体质检的抽检策略。
    示例值: { "StrategyType": "TimeSpotCheck", "TimeSpotCheck": { "CheckDuration": 50, "CheckInterval": 10, "SkipDuration": 10, "CirclesNumber": 10 } }

    RTMPAddressDestination

    RTMP转推的目标地址信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, 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目标地址信息。

    被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, 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

    RawSmartEraseParameter

    智能擦除自定义参数

    被如下接口引用:ProcessMedia。

    名称 类型 必选 描述
    EraseType String

    擦除类型

    • subtitle 去字幕
    • watermark 去水印
    • privacy 隐私保护

    示例值:subtitle
    EraseSubtitleConfig SmartEraseSubtitleConfig

    字幕擦除配置;
    当EraseType值为:subtitle,此字段为必填参数


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

    水印擦除配置;
    当EraseType值为:watermark,此字段为必填参数


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

    隐私保护配置;
    当EraseType值为:privacy,此字段为必填参数


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

    擦除字幕压制模板id。


    示例值:1001
    UseOriginalPos Integer

    压制配置,默认开启1, 把字幕压制回原字幕位置。


    示例值:1
    UseOriginalSize Integer

    压制配置,默认开启1, 开启后使用原字幕字号。


    示例值:1

    RawSmartSubtitleParameter

    自定义智能字幕参数

    被如下接口引用:BatchProcessMedia, DescribeBatchTaskDetail, ParseNotification, ProcessMedia。

    名称 类型 必选 描述
    SubtitleType Integer

    智能字幕字幕语言类型
    0: 源语言
    1: 翻译语言
    2: 源语言+翻译语言
    当TranslateSwitch为OFF时仅支持取0
    当TranslateSwitch为ON时仅支持取1或2


    示例值:0
    VideoSrcLanguage String

    智能字幕视频源语言
    OCR识别仅支持以下语言:
    zh_en:中英
    multi:其他
    ASR识别和纯字幕翻译当前支持以下语言:
    auto:自动识别
    zh:简体中文
    en:英语
    ja:日语
    ko:韩语
    zh-PY:中英粤
    zh_medical:中文医疗
    vi:越南语
    ms:马来语
    id:印度尼西亚语
    fil:菲律宾语
    th:泰语
    pt:葡萄牙语
    tr:土耳其语
    ar:阿拉伯语
    es:西班牙语
    hi:印地语
    fr:法语
    de:德语
    it:意大利语
    zh_dialect:中文方言
    zh_en:中英
    yue:粤语
    ru:俄语
    prime_zh:中英方言
    af-ZA:南非荷兰语(南非)
    sq-AL:阿尔巴尼亚语(阿尔巴尼亚)
    am-ET:阿姆哈拉语(埃塞俄比亚)
    ar-DZ:阿拉伯语(阿尔及利亚)
    ar-BH:阿拉伯语(巴林)
    ar-EG:阿拉伯语(埃及)
    ar-IQ:阿拉伯语(伊拉克)
    ar-IL:阿拉伯语(以色列)
    ar-JO:阿拉伯语(约旦)
    ar-KW:阿拉伯语(科威特)
    ar-LB:阿拉伯语(黎巴嫩)
    ar-MR:阿拉伯语(毛里塔尼亚)
    ar-MA:阿拉伯语(摩洛哥)
    ar-OM:阿拉伯语(阿曼)
    ar-QA:阿拉伯语(卡塔尔)
    ar-SA:阿拉伯语(沙特阿拉伯)
    ar-PS:阿拉伯语(巴勒斯坦国)
    ar-SY:阿拉伯语(叙利亚)
    ar-TN:阿拉伯语(突尼斯)
    ar-AE:阿拉伯语(阿拉伯联合酋长国)
    ar-YE:阿拉伯语(也门)
    hy-AM:亚美尼亚语(亚美尼亚)
    az-AZ:阿塞拜疆语(阿塞拜疆)
    eu-ES:巴斯克语(西班牙)
    bn-BD:孟加拉语(孟加拉)
    bn-IN:孟加拉语(印度)
    bs-BA:波斯尼亚语(波斯尼亚和黑塞哥维那)
    bg-BG:保加利亚语(保加利亚)
    my-MM:缅甸语(缅甸)
    ca-ES:加泰罗尼亚语(西班牙)
    hr-HR:克罗地亚语(克罗地亚)
    cs-CZ:捷克语(捷克共和国)
    da-DK:丹麦语(丹麦)
    nl-BE:荷兰语(比利时)
    nl-NL:荷兰语(荷兰)
    en-AU:英语(澳大利亚)
    en-CA:英语(加拿大)
    en-GH:英语(加纳)
    en-HK:英语(中国香港)
    en-IN:英语(印度)
    en-IE:英语(爱尔兰)
    en-KE:英语(肯尼亚)
    en-NZ:英语(新西兰)
    en-NG:英语(尼日利亚)
    en-PK:英语(巴基斯坦)
    en-PH:英语(菲律宾)
    en-SG:英语(新加坡)
    en-ZA:英语(南非)
    en-TZ:英语(坦桑尼亚)
    en-GB:英语(英国)
    en-US:英语(美国)
    et-EE:爱沙尼亚语(爱沙尼亚)
    fil-PH:菲律宾语(菲律宾)
    fi-FI:芬兰语(芬兰)
    fr-BE:法语(比利时)
    fr-CA:法语(加拿大)
    fr-FR:法语(法国)
    fr-CH:法语(瑞士)
    gl-ES:加利西亚语(西班牙)
    ka-GE:格鲁吉亚语(格鲁吉亚)
    el-GR:希腊语(希腊)
    gu-IN:古吉拉特语(印度)
    iw-IL:希伯来语(以色列)
    hi-IN:印地语(印度)
    hu-HU:匈牙利语(匈牙利)
    is-IS:冰岛语(冰岛)
    id-ID:印度尼西亚语(印度尼西亚)
    it-IT:意大利语(意大利)
    it-CH:意大利语(瑞士)
    ja-JP:日语(日本)
    jv-ID:爪哇语(印度尼西亚)
    kn-IN:卡纳达语(印度)
    kk-KZ:哈萨克语(哈萨克斯坦)
    km-KH:高棉语(柬埔寨)
    rw-RW:卢旺达语(卢旺达)
    ko-KR:韩语(韩国)
    lo-LA:老挝语(老挝)
    lv-LV:拉脱维亚语(拉脱维亚)
    lt-LT:立陶宛语(立陶宛)
    mk-MK:马其顿语(北马其顿)
    ms-MY:马来语(马来西亚)
    ml-IN:马拉雅拉姆语(印度)
    mr-IN:马拉地语(印度)
    mn-MN:蒙古语(蒙古)
    ne-NP:尼泊尔语(尼泊尔)
    no-NO:博克马尔挪威语(挪威)
    fa-IR:波斯语(伊朗)
    pl-PL:波兰语(波兰)
    pt-BR:葡萄牙语(巴西)
    pt-PT:葡萄牙语(葡萄牙)
    ro-RO:罗马尼亚语(罗马尼亚)
    ru-RU:俄语(俄罗斯)
    sr-RS:塞尔维亚语(塞尔维亚)
    si-LK:僧伽罗语(斯里兰卡)
    sk-SK:斯洛伐克语(斯洛伐克)
    sl-SI:斯洛文尼亚语(斯洛文尼亚)
    st-ZA:南索托语(南非)
    es-AR:西班牙语(阿根廷)
    es-BO:西班牙语(玻利维亚)
    es-CL:西班牙语(智利)
    es-CO:西班牙语(哥伦比亚)
    es-CR:西班牙语(哥斯达黎加)
    es-DO:西班牙语(多米尼加共和国)
    es-EC:西班牙语(厄瓜多尔)
    es-SV:西班牙语(萨尔瓦多)
    es-GT:西班牙语(危地马拉)
    es-HN:西班牙语(洪都拉斯)
    es-MX:西班牙语(墨西哥)
    es-NI:西班牙语(尼加拉瓜)
    es-PA:西班牙语(巴拿马)
    es-PY:西班牙语(巴拉圭)
    es-PE:西班牙语(秘鲁)
    es-PR:西班牙语(波多黎各)
    es-ES:西班牙语(西班牙)
    es-US:西班牙语(美国)
    es-UY:西班牙语(乌拉圭)
    es-VE:西班牙语(委内瑞拉)
    su-ID:巽他语(印度尼西亚)
    sw-KE:斯瓦希里语(肯尼亚)
    sw-TZ:斯瓦希里语(坦桑尼亚)
    sv-SE:瑞典语(瑞典)
    ta-IN:泰米尔语(印度)
    ta-MY:泰米尔语(马来西亚)
    ta-SG:泰米尔语(新加坡)
    ta-LK:泰米尔语(斯里兰卡)
    te-IN:泰卢固语(印度)
    th-TH:泰语(泰国)
    ts-ZA:聪加语(南非)
    tr-TR:土耳其语(土耳其)
    uk-UA:乌克兰语(乌克兰)
    ur-IN:乌尔都语(印度)
    ur-PK:乌尔都语(巴基斯坦)
    uz-UZ:乌兹别克语(乌兹别克斯坦)
    ve-ZA:文达语(南非)
    vi-VN:越南语(越南)
    xh-ZA:科萨语(南非)
    zu-ZA:祖鲁语(南非)


    示例值:zh
    SubtitleFormat String

    智能字幕文件格式:

    • ASR识别翻译处理类型下:
      • vtt: WebVTT 格式字幕
      • srt: SRT 格式字幕
      • 不填或填空:不生成字幕文件
    • 纯字幕翻译处理类型下:
      • original:与源文件一致
      • vtt: WebVTT 格式字幕
      • srt: SRT 格式字幕
    • OCR识别翻译处理类型下:
      • vtt: WebVTT 格式字幕
      • srt: SRT 格式字幕

    注意

    • ASR识别方式下,翻译大于等于2种语言时不允许传空或不传;
    • 纯字幕翻译和OCR识别翻译方式下,不允许传空或不传
    • OCR类型的任务,在开启压制时,允许不传或传空

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

    字幕翻译开关
    ON: 开启翻译
    OFF: 关闭翻译

    注意:纯字幕翻译方式下,不传默认是打开的,不允许传空或OFF


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

    字幕翻译目标语言
    当TranslateSwitch为ON的时候生效,翻译语言列表:
    ab:阿布哈兹语
    ace:亚齐语
    ach:阿乔利语
    af:南非荷兰语
    ak:契维语(阿坎语)
    am:Amharic
    ar:阿拉伯语
    as:阿萨姆语
    ay:艾马拉语
    az:阿塞拜疆语
    ba:巴什基尔语
    ban:巴厘语
    bbc:巴塔克托巴语
    bem:Bemba
    bew:Betawi
    bg:保加利亚语
    bho:博杰普尔语
    bik:Bikol
    bm:班巴拉语
    bn:孟加拉语
    br:布列塔尼语
    bs:波斯尼亚语
    btx:巴塔克卡罗语
    bts:巴塔克西马隆贡语
    bua:布里亚特语
    ca:加泰罗尼亚语
    ceb:宿务语
    cgg:Kiga
    chm:草原马里语
    ckb:库尔德语(索拉尼语)
    cnh:哈卡钦语
    co:科西嘉语
    crh:克里米亚鞑靼语
    crs:塞舌尔克里奥尔语
    cs:捷克语
    cv:楚瓦什语
    cy:威尔士语
    da:丹麦语
    de:德语
    din:Dinka
    doi:多格来语
    dov:敦贝语
    dv:第维埃语
    dz:宗卡语
    ee:Ewe
    el:希腊语
    en:英语
    eo:世界语
    es:西班牙语
    et:爱沙尼亚语
    eu:巴斯克语
    fa:波斯语
    ff:富拉语
    fi:芬兰语
    fil:菲律宾语(塔加拉语)
    fj:斐济语
    fr:法语
    fr-CA:法语(加拿大)
    fr-FR:法语(法国)
    fy:弗里斯兰语
    ga:爱尔兰语
    gaa:加 (Ga) 语
    gd:苏格兰盖尔语
    gl:加利西亚语
    gn:瓜拉尼语
    gom:贡根语
    gu:古吉拉特语
    gv:马恩岛语
    ha:Hausa
    haw:夏威夷语
    he:希伯来语
    hi:印地语
    hil:希利盖农语
    hmn:苗语
    hr:克罗地亚语
    hrx:洪斯吕克语
    ht:海地克里奥尔语
    hu:匈牙利语
    hy:亚美尼亚语
    id:印度尼西亚语
    ig:Igbo
    ilo:伊洛果语
    is:冰岛语
    it:意大利语
    iw:希伯来语
    ja:日语
    jv:爪哇语
    ka:格鲁吉亚语
    kk:哈萨克语
    km:高棉语
    kn:卡纳达语
    ko:韩语
    kri:Krio
    ku:库尔德语(库尔曼吉语)
    ktu:吉土巴语
    ky:吉尔吉斯语
    la:拉丁语
    lb:卢森堡语
    lg:干达语(卢干达语)
    li:林堡语
    lij:利古里亚语
    lmo:伦巴第语
    ln:林加拉语
    lo:老挝语
    lt:立陶宛语
    ltg:拉特加莱语
    luo:Luo
    lus:米佐语
    lv:拉脱维亚语
    mai:迈蒂利语
    mak:马卡萨
    mg:马尔加什语
    mi:毛利语
    min:米南语
    mk:马其顿语
    ml:马拉雅拉姆语
    mn:蒙古语
    mr:马拉地语
    ms:马来语
    mt:马耳他语
    my:缅甸语
    ne:尼泊尔语
    new:尼瓦尔语
    nl:荷兰语
    no:挪威语
    nr:恩德贝莱语(南部)
    nso:北索托语(塞佩蒂语)
    nus:努尔语
    ny:齐切瓦语(尼扬贾语)
    oc:奥克斯坦语
    om:Oromo
    or:奥里亚语
    pa:旁遮普语
    pag:邦阿西楠语
    pam:邦板牙语
    pap:Papiamento
    pl:波兰语
    ps:Pashto
    pt:葡萄牙语
    pt-BR:葡萄牙语(巴西)
    pt-PT:葡萄牙语(葡萄牙)
    qu:克丘亚语
    ro:罗马尼亚语
    rom:罗姆语
    rn:Rundi
    ru:俄语
    rw:卢旺达语
    sa:梵语
    scn:西西里语
    sd:信德语
    sg:Sango
    shn:掸语
    si:僧伽罗语
    sk:斯洛伐克语
    sl:斯洛文尼亚语
    sm:萨摩亚语
    sn:修纳语
    so:索马里语
    sq:阿尔巴尼亚语
    sr:塞尔维亚语
    ss:斯瓦特语
    st:塞索托语
    su:巽他语
    sv:瑞典语
    sw:斯瓦希里语
    szl:西里西亚语
    ta:泰米尔语
    te:泰卢固语
    tet:德顿语
    tg:塔吉克语
    th:泰语
    ti:提格里尼亚语
    tk:土库曼语
    tn:茨瓦纳语
    tr:土耳其语
    ts:聪加语
    tt:鞑靼语
    ug:维吾尔语
    uk:乌克兰语
    ur:乌尔都语
    uz:乌兹别克语
    vi:越南语
    xh:科萨语
    yi:意第绪语
    yo:约鲁巴语
    yua:尤卡坦玛雅语
    yue:粤语
    zh:简体中文
    zh-TW:中文(繁体)
    zu:祖鲁语

    注意:多语言方式,则使用 / 分割,如:en/ja,表示英语和日语。


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

    ASR热词库参数


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

    自定义参数


    示例值:"{}"
    ProcessType Integer

    字幕处理类型:

    • 0:ASR识别字幕
    • 1:纯字幕翻译
    • 2:OCR识别字幕

    注意:不传的情况下默认类型为 ASR识别字幕


    示例值:0
    SelectingSubtitleAreasConfig SelectingSubtitleAreasConfig

    字幕OCR提取框选区域配置


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

    压制模板id,只有ProcessType为0或2(任务类型为ASR或OCR)时才允许填写


    示例值:1011
    SpeakerMode Integer

    说话人识别模式,可选值:
    0:表示不开启说话人识别;
    1:表示开启说话人识别;
    默认值:0


    示例值:0
    SpeakerLabel Integer

    说话人识别输出到字幕文件,可选值:
    0:表示不输出到字幕文件;
    1:表示输出到vtt字幕文件
    注意:使用此参数SpeakerMode的值不能为0;
    默认值:0


    示例值:0

    RawTranscodeParameter

    自定义转码的规格参数。

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

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

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

  • 默认值:0。
    示例值:0
    VideoTemplate VideoTemplateInfo 视频流配置参数,当 RemoveVideo 为 0,该字段必填。
    AudioTemplate AudioTemplateInfo 音频流配置参数,当 RemoveAudio 为 0,该字段必填。
    TEHDConfig TEHDConfig 极速高清转码参数。
    StdExtInfo String 扩展参数,序列化的 json 字符串。
    示例值:{"video_info":{"color_prim":"bt709"}}
    EnhanceConfig EnhanceConfig 音视频增强配置
    注意:此字段可能返回 null,表示取不到有效值。
    SubtitleTemplate SubtitleTemplate 字幕参数
    注意:此字段可能返回 null,表示取不到有效值。

    RawWatermarkParameter

    自定义水印规格参数。

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

    名称 类型 必选 描述
    Type String 水印类型,可选值:
  • image:图片水印。

  • 示例值:image
    CoordinateOrigin String 原点位置,可选值:
  • TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角。
  • TopRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
  • BottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
  • BottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。

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

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

  • 默认值:0px。
    示例值:80px
    ImageTemplate RawImageWatermarkInput 图片水印模板,当 Type 为 image,该字段必填。当 Type 为 text,该字段无效。
    示例值:{ "ImageContent": { "Type": "URL", "UrlInputInfo": { "Url": "https://xxxxx.cos.ap-nanjing.myqcloud.com/test.jpeg" } } }

    RecognizeAudioSentence

    识别音频单句结果

    被如下接口引用:RecognizeAudio。

    名称 类型 描述
    Start Float 在音频中的起始时间,单位秒
    示例值:1.00
    End Float 在音频中的截止时间,单位秒
    示例值:2.00
    Text String 音频识别结果
    示例值:腾讯云
    WordsInfo Array of WordResult 字词时间戳结果

    RegionInfo

    地区信息。

    被如下接口引用:DescribeStreamLinkRegions。

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

    RemoveBlindWatermarkConfig

    移除盲水印配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

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

    ResilientStreamConf

    延播平滑吐流配置。

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

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

    RuleConditionItem

    规则条件配置。

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

    名称 类型 必选 描述
    Key String 质检项条件对应的Key。
    示例值:Resolution-1
    Value String 条件对应的Value。
    示例值:720

    Rules

    任务判断条件

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

    名称 类型 必选 描述
    Id String 判断条件id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:rule1-or-result-true
    Conditions Array of RuleConditionItem 判断条件配置
    注意:此字段可能返回 null,表示取不到有效值。
    Linker String 条件列表的链接符号,取值如下:

    - &&:逻辑与
    - ||:逻辑或
    示例值:"&&"
    RearDriveIndexs Array of Integer 满足判断条件执行节点索引;
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[3,4]

    S3InputInfo

    AWS S3存储输入

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, DescribeImageTaskDetail, DescribeMediaMetaData, DetectVideoSubtitleArea, ExtractBlindWatermark, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。

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

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

    S3OutputStorage

    AWS S3 输出位置

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

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

    SRTAddressDestination

    转推的目标地址信息。

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

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

    SRTFECFullOptions

    SRT FEC 高级配置

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

    名称 类型 必选 描述
    Enable Boolean 是否开启 FEC
    示例值:true
    Cols Integer FEC 数据包 Layout 列数量. 取值范围>0
    示例值:3
    Rows Integer FEC 数据包 Layout 行数量. 取值范围 >=2 或者 <=-2
    示例值:1
    ARQ String FEC 开启的情况下,ARQ的策略。取值 "always", "onreq", "never"
    示例值:always
    Layout String FEC 数据包 Layout 组织形式,取值 "even", "staircase"
    示例值:staircase

    SRTFECSimpleOptions

    SRT FEC 设置

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

    名称 类型 必选 描述
    Enable Boolean 是否开启 FEC
    示例值:false

    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

    SSAIChannelInfo

    广告插入频道配置信息。

    被如下接口引用:CreateStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannels。

    名称 类型 必选 描述
    ID String

    频道ID,全局唯一标识。


    示例值:698AAD421D3EA5656115
    Name String

    频道名称。


    示例值:TestConf
    ContentSource String

    广告源信息。


    示例值:https://www.tencent.com/abc
    PlaybackPrefix String

    播放地址。兼容旧版本参数,推荐使用HlsPlaybackPrefix或DashPlaybackPrefix


    示例值:http://251009588.ap-shanghai.streampackage.srclivepull.myqcloud.com/v1/ssai/master/019c45b4c912150043f634b5a3c17/
    HlsPlaybackPrefix String

    hls播放地址


    示例值:http://25100*588.ap-mumbai.streampackage.s**livepull.myqcloud.*************aster/019d6811b9**150043f61bc6dfe8f9/
    DashPlaybackPrefix String

    dash播放地址


    示例值:http://25100***8.ap-mu*****streampack*ge.sr****epull.myqcloud.com/****sai/dash/019d6811b988150043**1bc6dfe8f9/
    SSAIInfo SSAIConf

    广告插入SSAI配置信息。

    Region String

    地域信息。


    示例值:ap-shanghai
    SessionInitPrefix String

    用于clickthrough地址


    示例值:http://251009588.ap-shanghai.streampackage.srclivepull.myqcloud.com/v1/ssai/session/019c45b4c912150043f634b5a3c17/

    SSAIConf

    SSAI广告插入配置。

    被如下接口引用:CreateStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannels, ModifyStreamPackageSSAIChannel。

    名称 类型 必选 描述
    AdsUrl String

    广告决策服务器URL(ADS)。注意:填了AdsUrl会自动代替覆盖AdsUrls[0]


    示例值:https://g.adspeed.net/ad.php?do=vast&zid=130114&oid=29173&wd=-1&ht=-1&vastver=3&cb=1745402245
    AdsUrls Array of String

    广告决策服务器URL数组(ADS)


    示例值:["https://g.adspeed.net/ad.php?do=vast&zid=130114&oid=29173&wd=-1&ht=-1&vastver=3&cb=1745402245"]
    ConfigAliases Array of ConfigAliasesInfo

    参数配置。


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

    是否开启广告标记透传。


    示例值:true
    SCTE35AdType Integer

    如何处理广告中的标记,可选值[1-2]:
    1:所有SCTE-35类型标记全部处理-all(默认)
    2:SCTE-35enhanced,解析部分类型。


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

    默认广告url。


    示例值:https://lxqtokyo-1306038592.cos.ap-tokyo.myqcloud.com/cos/10s_ad.mp4
    Threshold Integer

    未填充的最大时长,单位:秒。


    示例值:0
    DashMPDLocation Boolean

    是否开启mpd location, true对应enable, false对应disable。


    示例值:true
    AdTriggers Array of Integer

    被视作广告的标记类型,可选值[1-8]:

    1. Splice insert
      2.Provider advertisement
    2. Distributor advertisement
    3. Provider placement opportunity
    4. Distributor placement opportunity
    5. Break
    6. Provider overlay placement opportunity
    7. Distributor overlay placement opportunity。

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[2]
    DeliveryRestrictions Integer

    被视作广告的分发限制类型,可选值[1-4]:
    1:None
    2:Restricted(默认) 3:Unrestricted
    4.Both


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

    源流CDN前缀,需要以http://或者https://开头。


    示例值:https://www.tencent.com/abc
    AdCDNPrefix String

    广告CDN前缀,需要以http://或者https://开头。


    示例值:https://www.tencent.com/abc
    PreRollAdsUrl String

    预加载广告决策服务地址。注意:填了PreRollAdsUrl会自动代替覆盖PreRollAdsUrls[0]


    示例值:https://g.adspeed.net/ad.php?do=vast&zid=130114&oid=29173&wd=-1&ht=-1&vastver=3&cb=1745402245
    PreRollAdsUrls Array of String

    预加载广告决策服务地址数组


    示例值:["https://g.adspeed.net/ad.php?do=vast&zid=130114&oid=29173&wd=-1&ht=-1&vastver=3&cb=1745402245"]
    PreRollMaxAllowedDuration Integer

    预加载广告最大允许时长,0-3600。


    示例值:120
    MultiRequest Boolean

    是否开启多次请求ADS,开启后将优先请求ADS,请求失败后再请求兜底广告


    示例值:true
    DashOriginManifestType String

    dash周期类型:SinglePeriod 或 MultiPeriod,默认 MultiPeriod


    示例值:MultiPeriod
    SlateOnEmptyVast Boolean

    广告为空时是否插入Slate,默认开启(true)


    示例值:true
    SCTEMarkerDuration Integer

    SCTE marker duration,默认180,范围0-3600


    示例值:180
    SecurityGroupId String

    安全组Id


    示例值:69E09A2340836DFDC04F

    SSAIUsageInfo

    SSAI用量信息

    被如下接口引用:DescribeStreamPackageSSAIUsage。

    名称 类型 描述
    AdRequestSuccess Integer 广告请求成功次数
    示例值:0
    AdRequestFail Integer 广告请求失败次数
    示例值:0
    Impression Integer 曝光次数
    示例值:0
    MidFillRate Float 中贴个性化广告填充率
    示例值:0
    AdMarkerTime Float 中贴广告标记时间
    示例值:0
    ReplacedTime Float 中贴个性化替换时间
    示例值:0
    PreReplaceRate Float 前贴广告替换率
    示例值:0
    PreReqNum Integer 前贴广告请求数
    示例值:0
    PreReplacedNum Integer 前贴广告替换数
    示例值:0
    UsageDetails Array of UsageDetail 各广告配置用量详情
    注意:此字段可能返回 null,表示取不到有效值。

    SampleSnapshotTaskInput

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

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

    名称 类型 必选 描述
    Definition Integer

    采样截图模板 ID。


    示例值:10
    WatermarkSet Array of WatermarkInput

    水印列表,支持多张图片或文字水印,最大可支持 10 张。

    OutputStorage TaskOutputStorage

    采样截图后文件的目标存储,不填则继承上层的 OutputStorage 值。


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

    采样截图后图片文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明
    相对路径示例:

  • 文件名_{变量名}.{format}
  • 文件名.{format}
  • 绝对路径示例:
  • /自定义路径/文件名_{变量名}.{format}
  • 如果不填,则默认为相对路径:{inputName}_sampleSnapshot_{definition}_{number}.{format}
    示例值:/{inputName}_snapshotByTimeOffsetTest_{definition}_{number}.{format}
    ObjectNumberFormat NumberFormat

    采样截图后输出路径中的{number}变量的规则。


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

    扩展参数。


    示例值:{"sample":""}

    SampleSnapshotTemplate

    采样截图模板详情

    被如下接口引用:DescribeSampleSnapshotTemplates。

    名称 类型 描述
    Definition Integer 采样截图模板唯一标识。
    示例值:10
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:Custom
    Name String 采样截图模板名称。
    示例值:采样截图模板test
    Comment String 模板描述信息。
    示例值:采样截图模板test
    Width Integer 截图宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    示例值:400
    Height Integer 截图高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

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

  • 默认值:open。
    示例值:open
    Format String 图片格式。
    示例值:jpg
    SampleType String 采样截图类型。
    示例值:Time
    SampleInterval Integer 采样间隔。
    示例值:10
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2024-08-13T04:32:21Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2024-08-13T04:32:21Z
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊。

  • 默认值:black 。
    示例值:black

    ScheduleAnalysisTaskResult

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

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

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

    ScheduleExecRuleTaskResult

    媒体质检任务结果类型

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:SUCCESS
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值: input
    Message String 错误信息。
    示例值:SUCCESS
    Input ExecRulesTask 条件判断任务的输入。
    Output ExecRuleTaskData 条件判断任务的输出。
    注意:此字段可能返回 null,表示取不到有效值。

    ScheduleQualityControlTaskResult

    媒体质检任务结果类型

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

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

    ScheduleRecognitionTaskResult

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

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

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

    ScheduleReviewTaskResult

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

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:SUCCESS
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:
    ErrCode Integer 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
    示例值:0
    Message String 错误信息。
    示例值:SUCCESS
    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

    ScheduleSmartSubtitleTaskResult

    编排智能字幕任务结果类型

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

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

    ScheduleTask

    编排任务信息

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

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

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

    SchedulesInfo

    编排详情。

    被如下接口引用:DescribeSchedules。

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

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

    ScratchRepairConfig

    去划痕配置

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

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

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

    SearchTaskResult

    视频检索的检索结果

    被如下接口引用:DescribeVideoSearchTaskDetail。

    名称 类型 描述
    Score Float 视频在本次检索中的得分,得分越高和检索值越相似,取值范围[0,1]
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0.60
    VideoId String 检索获得的视频ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:caf2c4be****abc

    SearchValueInput

    视频检索的检索输入

    被如下接口引用:CreateVideoSearchTask。

    名称 类型 必选 描述
    SearchValueType String 检索输入的类型,目前支持:
    Text:文本检索
    示例值:Text
    TextInput String 当SearchValueType为Text时有效且必填,用于检索视频的文本
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:测试文本

    SecurityGroupInfo

    安全组信息。

    被如下接口引用:DescribeStreamLinkSecurityGroups。

    名称 类型 描述
    Id String 安全组 ID。
    示例值:id
    Name String 安全组名称。
    示例值:name
    Whitelist Array of String 白名单列表。
    示例值:0.0.0.0/0
    OccupiedInputs Array of String 绑定的输入流列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["034561fd7ab41ea506497cdecbbc"]
    Region String 安全组地址。
    示例值:ap-shanghai
    OccupiedOutputs Array of String 绑定的输出流列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["094561fd7ab41ea506497cdfffc"]

    SegmentDeliverInfo

    SourceLocation垫片配置。

    被如下接口引用:CreateStreamPackageSourceLocation, DescribeStreamPackageSourceLocation, DescribeStreamPackageSourceLocations, ModifyStreamPackageSourceLocation。

    名称 类型 必选 描述
    DefaultSegmentUrl String 默认内容源地址。
    示例值:https://tencent.com
    NameServers Array of NameServer 自定义服务器地址。

    SegmentRecognitionItem

    智能拆条片段。

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

    名称 类型 描述
    Confidence Float 置信度。
    示例值:85.32
    StartTimeOffset Float 片段起始时间偏移。
    示例值:0
    EndTimeOffset Float 片段结束时间偏移。
    示例值:59.52
    SegmentUrl String 拆条片段URL。
    示例值:http://www.example.com/mps/test.mp4
    CovImgUrl String 拆条片段封面。
    示例值:http://www.example.com/mps/test.jpg
    Title String 分段标题。
    示例值:上海风云
    Summary String 分段概要。
    示例值:本段描述从鸦片战争到民国时期,上海经历了巨大的变迁
    Keywords Array of String 分段关键词。
    示例值:["明星","歌后"]
    BeginTime String 直播切片对应直播起始时间点,采用 ISO 日期格式。
    示例值:2024-10-21T17:18:34+08:00
    EndTime String 直播切片对应直播结束时间点,采用 ISO 日期格式。
    示例值:2024-10-21T17:26:19+08:00
    AudioUrl String 直播拆条用,音频url。
    示例值:http://www.example.com/mps/audio1.mp3
    AudioBeginTime Float 直播拆条用,音频对应起始时间戳;
    示例值:3.438
    AudioEndTime Float 直播拆条用,音频对应结束时间戳。
    示例值:7.438
    PersonPositionUrl String 直播拆条用,人物位置参考信息用于横转竖。
    示例值:http://test-12345**9.test.ap-beijing.myqcloud.com/streamtmp/40_xx12345.json
    PersonId String 指定人物ID。
    示例值:party_xxxxxx

    SegmentSpecificInfo

    切片特殊配置信息。

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

    名称 类型 必选 描述
    Switch String 启动分片时长开关,可选值:
    on:打开
    off:关闭
    默认off
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:off
    FragmentTime Integer 启动时分片时长,单位:秒
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    FragmentEndNum Integer 生效分片数,表示前FragmentEndNum个分片以FragmentTime时长切片,取值>=1
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    SelectingSubtitleAreasConfig

    字幕OCR提取框选区域配置

    被如下接口引用:BatchProcessMedia, CreateSmartSubtitleTemplate, DescribeSmartSubtitleTemplates, ModifySmartSubtitleTemplate, ProcessMedia。

    名称 类型 必选 描述
    AutoAreas Array of EraseArea 自动选择自定义区域。
    对选定区域,利用AI模型自动检测其中存在的选择目标并提取。
    SampleWidth Integer 示例视频或图片的宽,单位像素值
    示例值:200
    SampleHeight Integer 示例视频或图片的高,单位像素值
    示例值:1000

    SharpEnhanceConfig

    细节增强配置

    被如下接口引用:CreateProcessImageTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ProcessImage。

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

  • 默认值:ON。
    示例值: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

    SlateInfo

    线性组装频道垫片配置。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel。

    名称 类型 必选 描述
    SourceLocationId String source location的ID。
    示例值:698557DC1D3EA60266EB
    VodSourceName String 对应的vod垫片内容源名称。
    示例值:test_source_2

    SmartErasePrivacyConfig

    智能擦除模板隐私保护配置

    被如下接口引用:CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia。

    名称 类型 必选 描述
    PrivacyModel String 隐私保护擦除方式。
    - blur 模糊
    - mosaic 马赛克
    示例值:blur
    PrivacyTargets Array of String 隐私保护目标,(在API Explorer上使用时无需传入数组,添加相应项并填入对应值即可)。
    - face 人脸
    - plate 车牌
    示例值:["face","plate"]

    SmartEraseSubtitleConfig

    智能擦除模板去字幕配置

    被如下接口引用:CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia。

    名称 类型 必选 描述
    SubtitleEraseMethod String

    字幕擦除方式。
    自动擦除:通过AI模型自动识别视频中的字幕文本内容,进行无痕化擦除,生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题,可以通过指定区域擦除处理。
    当使用自动擦除时,若您不指定AutoAreas,将对默认区域(画面中下部)进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。
    指定区域擦除:若您的字幕位置较固定,建议您直接指定擦除区域,最大程度减少漏擦的情况。
    当您选择指定区域擦除时,请在CustomAreas中至少传入一个指定区域。

    • auto 自动擦除
    • custom 指定区域擦除

    示例值:auto
    SubtitleModel String

    字幕擦除模型。
    标准版(推荐):若您的字幕样式标准,通常建议选择该版本,细节无痕化效果更好。
    区域版:若您的字幕存在花体、阴影、动效等特殊样式,建议选择区域版,擦除面积更大,但细节效果不如标准版。

    • standard 标准模型
    • area 区域模型

    示例值:standard
    OcrSwitch String

    是否开启OCR字幕提取,默认取OFF。
    当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取,开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域,对字幕区域中的文字进行提取和擦除。

    • ON 开启
    • OFF 关闭

    示例值:ON
    SubtitleLang String

    字幕语言,用于指导OCR识别,默认取zh_en;仅当OcrSwitch取"ON"时生效。

    • zh_en 中英文
    • multi 其他
      其他具体支持识别如下语言:
      中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆语 、印度-泰米尔语、印度-泰卢固语、斯洛文尼亚语、波兰语、加泰罗尼亚语、波斯尼亚语、捷克语、爱沙尼亚语、克罗地亚语、旁遮普语、马拉地语、阿塞拜疆语、印尼语、卢森堡语 、立陶宛语、拉脱维亚语、马耳他语、斯洛伐克语、土耳其语、哈萨克语、希腊语、爱尔兰语、白俄罗斯语、高棉语、他加禄语、普什图语、波斯语、塔吉克斯坦语

    示例值:zh_en
    SubtitleFormat String

    字幕文件格式,默认取vtt;仅当OcrSwitch取"ON"时生效。

    • srt srt格式
    • vtt WebVTT格式
    • 当填写SubtitleEmbedId时可以取值空字符串,表示不输出字幕文件

    示例值:vtt
    TransSwitch String

    是否开启字幕翻译,默认取OFF;仅当OcrSwitch取"ON"时生效。

    • ON 开启
    • OFF 关闭

    示例值:ON
    TransDstLang String

    字幕翻译目标语言,默认取en;仅当TransSwitch取"ON"时生效。
    当前支持以下语言:
    zh:简体中文
    en:英语
    ja:日语
    ko:韩语
    fr:法语
    es:西班牙语
    it:意大利语
    de:德语
    tr:土耳其语
    ru:俄语
    pt:葡萄牙语
    vi:越南语
    id:印度尼西亚语
    ms:马来语
    th:泰语
    ar:阿拉伯语
    hi:印地语


    示例值:en
    AutoAreas Array of EraseArea

    自动擦除自定义区域。
    对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。
    注意:当擦除方式选择custom时,此参数将不会生效;修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。

    CustomAreas Array of EraseTimeArea

    指定擦除自定义区域。
    对选定区域,在选定时间段内不进行检测识别直接进行擦除。
    注意:修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。

    SubtitleEmbedId Integer

    字幕压制模板id,只有开启OCR翻译时可以填写


    示例值:1011
    UseOriginalPos Integer

    压制配置,默认开启1, 把字幕压制回原字幕位置。只有开启OCR翻译时可以填写,取0时表示不开启压回原位


    示例值:1
    UseOriginalSize Integer

    压制配置,默认开启1, 开启后使用原字幕字号。只有开启OCR翻译时可以填写,取0时表示不使用原字号


    示例值:1

    SmartEraseTaskInput

    智能擦除任务

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

    名称 类型 必选 描述
    Definition Integer 智能擦除模板id。
    示例值:101
    RawParameter RawSmartEraseParameter 智能擦除自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定智能擦除参数。
    注意:此字段可能返回 null,表示取不到有效值。
    OverrideParameter OverrideEraseParameter 智能擦除自定义参数,当 Definition 不填 0 时有效。 当填写了该结构中的部分擦除参数时,将使用填写的参数覆盖智能擦除模板中的参数。 该参数用于高度定制场景,建议您仅使用 Definition 指定智能擦除参数。
    OutputStorage TaskOutputStorage 文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明
    相对路径示例:
  • 文件名_{变量名}.{format}
  • 文件名.{format}

  • 绝对路径示例:
  • /自定义路径/文件名_{变量名}.{format}


  • 注意:目前不支持BatchProcessMedia接口。
    示例值:{inputName}_smarterase.{format}

    SmartEraseTaskResult

    智能擦除任务结果

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

    名称 类型 描述
    Status String 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
    示例值:SUCCESS
    ErrCodeExt String 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。
    示例值:InvalidInput
    Message String 错误信息。
    示例值:SUCCESS
    Input SmartEraseTaskInput 智能擦除输入。
    注意:此字段可能返回 null,表示取不到有效值。
    Output AiAnalysisTaskDelLogoOutput 智能擦除任务输出。
    注意:此字段可能返回 null,表示取不到有效值。
    Progress Integer 任务进度。
    示例值:100
    BeginProcessTime String 任务开始执行的时间,采用 ISO 日期格式。
    示例值:2024-03-21T10:13:06Z
    FinishTime String 任务执行完毕的时间,采用 ISO 日期格式。
    示例值:2024-03-21T10:14:06Z

    SmartEraseTemplateItem

    智能擦除模板详情

    被如下接口引用:DescribeSmartEraseTemplates。

    名称 类型 描述
    Definition Integer 智能擦除模板唯一标识
    示例值:30
    Name String 智能擦除模板名称
    示例值:模板1
    Comment String 智能擦除模板描述信息
    示例值:用于A的模板
    Type String 模板类型,取值范围:
    * Preset:系统预置模板;
    * Custom:用户自定义模板。
    示例值:Preset
    EraseType String 擦除类型
    - subtitle 去字幕
    - watermark 去水印
    - privacy 隐私保护
    示例值:subtitle
    EraseSubtitleConfig SmartEraseSubtitleConfig 字幕擦除配置
    注意:此字段可能返回 null,表示取不到有效值。
    EraseWatermarkConfig SmartEraseWatermarkConfig 水印擦除配置
    注意:此字段可能返回 null,表示取不到有效值。
    ErasePrivacyConfig SmartErasePrivacyConfig 隐私保护配置
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2023-10-05T14:30:00Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2024-10-05T14:32:00Z
    AliasName String 智能擦除预设模板别名
    示例值:PresetTemplate1

    SmartEraseWatermarkConfig

    智能擦除模板去水印配置

    被如下接口引用:CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia。

    名称 类型 必选 描述
    WatermarkEraseMethod String 水印擦除方式。
    自动擦除:通过A模型自动识别视频中的水印,擦除后生成新的视频。适用于动态水印。
    当使用自动擦除时,若您不指定AutoAreas,将对视频全屏进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。
    指定区域擦除:针对位置较固定的静态水印,建议您直接指定擦除区域。
    当您选择指定区域擦除时,请至少传入一个指定区域。

    - auto 自动擦除
    - custom 指定区域擦除
    示例值:auto
    WatermarkModel String 水印擦除模型。
    基础版:效果一般,性价比高,适合动画或背景较干净的视频。
    高级版:效果更好,适合短剧等现实风格视频。
    - basic 基础版
    - advanced 高级版
    示例值:advanced
    AutoAreas Array of EraseArea 自动擦除自定义区域。
    对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。
    注意,当擦除方式为custom时,此参数将不会生效。修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。
    CustomAreas Array of EraseTimeArea 指定擦除自定义区域。
    对选定区域,在选定时间段内不进行检测识别直接进行擦除。
    注意:修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。

    SmartSubtitleTaskAsrFullTextResult

    语音全文识别结果。

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

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

    SmartSubtitleTaskAsrFullTextResultOutput

    语音全文识别结果。

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

    名称 类型 描述
    SegmentSet Array of SmartSubtitleTaskAsrFullTextSegmentItem

    语音全文识别片段列表。


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

    字幕文件路径


    示例值:/subtitles/1027/31***8.vtt
    SubtitlePath String

    字幕文件地址。


    示例值:http://smart-subtitle-test-12******.cos.ap-shanghai.myqcloud.com/31*******8.vtt
    SubtitleInfo SubtitleResult

    识别字幕结果信息。

    OutputStorage TaskOutputStorage

    字幕文件存储位置。

    SmartSubtitleTaskAsrFullTextSegmentItem

    语音全文识别片段。

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

    名称 类型 描述
    Confidence Float

    识别片段置信度。取值:0~100。


    示例值:100.0
    StartTimeOffset Float

    识别片段起始的偏移时间,单位:秒。


    示例值:3.204
    EndTimeOffset Float

    识别片段终止的偏移时间,单位:秒。


    示例值:7.204
    Text String

    识别文本。


    示例值:腾讯云媒体处理
    Wordlist Array of WordResult

    字词时间戳信息。


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

    说话人ID(如启用说话人识别)


    示例值:speaker_0

    SmartSubtitleTaskBatchOutput

    智能字幕输出信息

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

    名称 类型 描述
    Progress Integer

    任务进度。


    示例值:100
    Status String

    任务状态,有 PROCESSING,SUCCESS,WAITING 和 FAIL 四种。


    示例值:SUCCESS
    ErrCodeExt String

    错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。


    示例值:InvalidInput
    Message String

    错误信息。


    示例值:task fail
    TransTextTask SmartSubtitleTaskTransTextResultOutput

    翻译任务输出信息。


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

    语音全文识别任务输出信息。


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

    SmartSubtitleTaskFullTextResult

    智能字幕全文识别结果。

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

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

    SmartSubtitleTaskResultInput

    智能字幕翻译的输入。

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

    名称 类型 描述
    Definition Integer

    智能字幕模板 ID。


    示例值:10
    RawParameter RawSmartSubtitleParameter

    智能字幕自定义参数,当 Definition 填 0 时有效。
    该参数用于高度定制场景,建议您优先使用 Definition 指定智能字幕参数。


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

    扩展参数。


    示例值:{"subtitle":""}

    SmartSubtitleTaskTextResultOutput

    智能字幕识别结果。

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

    名称 类型 描述
    RecognizeSubtitleResult Array of SubtitleResult

    识别字幕结果


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

    翻译字幕结果


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

    字幕文件存储位置


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

    SmartSubtitleTaskTransTextResult

    翻译结果。

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

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

    SmartSubtitleTaskTransTextResultOutput

    翻译结果。

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

    名称 类型 描述
    SegmentSet Array of SmartSubtitleTaskTransTextSegmentItem

    翻译片段列表。


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

    字幕文件地址。


    示例值:http://lily-12*****.cos.ap-shanghai.myqcloud.com/310*****.vtt
    OutputStorage TaskOutputStorage

    智能字幕结果存储信息。

    Path String

    字幕文件路径。


    示例值:/subtitles/1027/310*.vtt
    SubtitleResults Array of SubtitleTransResultItem

    多语言翻译时返回翻译结果。

    SmartSubtitleTaskTransTextSegmentItem

    翻译片段。

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

    名称 类型 描述
    Confidence Float

    识别片段置信度。取值:0~100。


    示例值:100
    StartTimeOffset Float

    识别片段起始的偏移时间,单位:秒。


    示例值:17.45
    EndTimeOffset Float

    识别片段终止的偏移时间,单位:秒。


    示例值:29.99
    Text String

    识别文本。


    示例值:你好
    Trans String

    翻译文本。


    示例值:Hello
    Wordlist Array of WordResult

    字词时间戳信息。


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

    说话人ID(如启用说话人识别)


    示例值:speaker_0

    SmartSubtitleTemplateItem

    智能字幕模板详情

    被如下接口引用:DescribeSmartSubtitleTemplates。

    名称 类型 描述
    Definition Integer

    智能字幕模板唯一标识


    示例值:30
    Name String

    智能字幕模板名称


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:模板1
    Comment String

    智能字幕模板描述信息


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:用于A的模板
    Type String

    模板类型,取值范围:

    • Preset:系统预置模板;
    • Custom:用户自定义模板。

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

    ASR热词库参数


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

    模板关联热词库名称


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

    智能字幕视频源语言列表:

    zh:简体中文
    yue:中文粵语
    zh-PY:中英粤
    zh_medical:中文医疗
    zh_dialect:中文方言
    prime_zh:中英方言
    zh_en:中英
    en:英语
    ja:日语
    ko:韩语
    fr:法语
    es:西班牙语
    it:意大利语
    de:德语
    tr:土耳其语
    ru:俄语
    pt:葡萄牙语(巴西)
    pt-PT:葡萄牙语(葡萄牙)
    vi:越南语
    id:印度尼西亚语
    ms:马来语
    th:泰语
    ar:阿拉伯语
    hi:印地语
    fil:菲律宾语
    auto:自动识别(仅在纯字幕翻译中支持)


    示例值:zh
    SubtitleFormat String

    智能字幕文件格式

    • vtt: WebVTT 格式
    • srt: SRT格式
    • original:与源字幕文件一致(用于纯字幕翻译模板)
    • 不填或填空:不生成字幕文件

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

    智能字幕字幕语言类型
    0: 源语言
    1: 翻译语言
    2: 源语言+翻译语言
    当TranslateSwitch为OFF时仅支持取0
    当TranslateSwitch为ON时仅支持取1或2


    示例值:0
    TranslateSwitch String

    字幕翻译开关
    ON: 开启翻译
    OFF: 关闭翻译


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

    字幕翻译目标语言
    当TranslateSwitch为ON的时候生效
    zh:简体中文
    zh-TW:繁体中文
    en:英语
    ja:日语
    ko:韩语
    fr:法语
    es:西班牙语
    it:意大利语
    de:德语
    tr:土耳其语
    ru:俄语
    pt:葡萄牙语(巴西)
    pt-PT:葡萄牙语(葡萄牙)
    vi:越南语
    id:印度尼西亚语
    ms:马来语
    th:泰语
    ar:阿拉伯语
    hi:印地语
    fil:菲律宾语

    注意:多语言方式,则使用 / 分割,如:en/ja,表示英语和日语。


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

    模板创建时间,使用 ISO 日期格式


    示例值:2023-10-05T14:30:00Z
    UpdateTime String

    模板最后修改时间,使用 ISO 日期格式


    示例值:2024-10-05T14:32:00Z
    AliasName String

    智能字幕预设模板别名


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

    字幕处理类型:

    • 0:ASR识别字幕
    • 1:纯字幕翻译
    • 2: OCR识别字幕

    示例值:0
    SelectingSubtitleAreasConfig SelectingSubtitleAreasConfig

    字幕OCR提取框选区域配置信息


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

    字幕压制模板id


    示例值:1011
    SpeakerMode Integer

    说话人识别模式,可选值:
    0:表示不开启说话人识别;
    1:表示开启说话人识别;
    默认值:0


    示例值:0
    SpeakerLabel Integer

    说话人识别输出到字幕文件,可选值:
    0:表示不输出到字幕文件;
    1:表示输出到vtt字幕文件
    注意:使用此参数SpeakerMode的值不能为0;
    默认值:0


    示例值:0

    SmartSubtitlesResult

    智能字幕结果。

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

    名称 类型 描述
    Type String 任务的类型,取值范围:
    - AsrFullTextRecognition:语音全文识别
    - TransTextRecognition:语音翻译
    - PureSubtitleTrans: 纯字幕翻译
    - OcrFullTextRecognition:文字提取字幕
    示例值:AsrFullTextRecognition
    AsrFullTextTask SmartSubtitleTaskAsrFullTextResult 语音全文识别结果,当 Type 为
    AsrFullTextRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    TransTextTask SmartSubtitleTaskTransTextResult 翻译结果,当 Type 为

    TransTextRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    PureSubtitleTransTask PureSubtitleTransResult 当翻译类型为:PureSubtitleTrans 是返回纯字幕文件翻译结果。
    注意:此字段可能返回 null,表示取不到有效值。
    OcrFullTextTask SmartSubtitleTaskFullTextResult 文字提取字幕结果,当 Type 为
    OcrFullTextRecognition 时有效。
    注意:此字段可能返回 null,表示取不到有效值。

    SmartSubtitlesTaskInput

    智能字幕输入结构体

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

    名称 类型 必选 描述
    Definition Integer 智能字幕模板 ID 。
    示例值:110167
    UserExtPara String 用户扩展字段,一般场景不用填。
    示例值:用户扩展字段
    RawParameter RawSmartSubtitleParameter 智能字幕自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定智能字幕参数。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputStorage TaskOutputStorage 媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。
    注意:当InputInfo.Type为URL时,该参数是必填项。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{ "Type": "COS", "CosOutputStorage": { "Bucket": "xxxx-yyy", "Region": "region" } }
    OutputObjectPath String 生成字幕文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明

    相对路径示例:
    - 文件名_{变量名}.{format}
    - 文件名.{format}

    绝对路径示例:
    - /自定义路径/文件名_{变量名}.{format}

    如果不填,则默认为相对路径: {inputName}_smartsubtitle_{definition}.{format}
    示例值:/storage/{inputName}_smartsubtitle_{definition}.{format}

    SnapshotByTimeOffsetTaskInput

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

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

    名称 类型 必选 描述
    Definition Integer

    指定时间点截图模板 ID。


    示例值:11028
    ExtTimeOffsetSet Array of String

    截图时间点列表,时间点支持 s、% 两种格式:

  • 当字符串以 s 结尾,表示时间点单位为秒,如 3.5s 表示时间点为第3.5秒;
  • 当字符串以 % 结尾,表示时间点为视频时长的百分比大小,如10%表示时间点为视频前第10%的时间。

  • 示例值:["3.5s", "50%"]
    TimeOffsetSet Array of Float

    截图时间点列表,单位为。此参数已不再建议使用,建议您使用 ExtTimeOffsetSet 参数。


    示例值:[7.5, 10]
    WatermarkSet Array of WatermarkInput

    水印列表,支持多张图片或文字水印,最大可支持 10 张。

    OutputStorage TaskOutputStorage

    时间点截图后文件的目标存储,不填则继承上层的 OutputStorage 值。


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

    时间点截图后图片文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明
    相对路径示例:

  • 文件名_{变量名}.{format}
  • 文件名.{format}
  • 绝对路径示例:
  • /自定义路径/文件名_{变量名}.{format}
  • 如果不填,则默认为相对路径:{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}
    示例值:/mps/output/{inputName}_test_{definition}.{format}
    ObjectNumberFormat NumberFormat

    时间点截图后输出路径中的{number}变量的规则。


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

    扩展参数。


    示例值:{"snapshot":""}

    SnapshotByTimeOffsetTemplate

    时间点截图模板详情

    被如下接口引用:DescribeSnapshotByTimeOffsetTemplates。

    名称 类型 描述
    Definition Integer 时间点截图模板唯一标识。
    示例值:239287
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值: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。
    示例值:400
    Height Integer 截图高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

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

  • 默认值:open。
    示例值:open
    Format String 图片格式。
    示例值:jpg
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2024-05-07T12:14:58Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2024-05-07T12:15:39Z
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • black:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • black:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊。

  • 默认值:black 。
    示例值:black

    SourceAlert

    线性组装Location告警信息

    被如下接口引用:DescribeStreamPackageSourceAlerts。

    名称 类型 描述
    SourceId String Source ID。
    示例值:66503E8E0000930000F1
    SourceName String Source名称。
    示例值:source_name
    Code Integer 告警事件码。
    示例值:20012
    Category String 告警分类。
    示例值:PLAYBACK_WARNING
    Message String 告警消息。
    示例值:https://test.com/demo.m3u8 request response http 404.
    LastModifiedTime Integer 更新时间。
    示例值:1590508900

    SourceInfo

    源信息。

    被如下接口引用:CreateStreamPackageSource, DescribeStreamPackageSource, DescribeStreamPackageSources。

    名称 类型 必选 描述
    Name String 名称。
    示例值:test_source
    Type String source类型,区分直播Live和点播Vod。
    示例值:VOD
    PackageConf Array of SourcePackageConf 源配置。
    Id String ID。
    示例值:6985B2641D3EA53D16FD
    CreateTime Integer 创建时间戳。
    示例值:1770369636
    UpdateTime Integer 更新时间戳。
    示例值:1770369636
    Region String Region。
    示例值:ap-shanghai
    SourceTags Array of SourceTag 源标签

    SourceLocationInfo

    SourceLocation配置信息。

    被如下接口引用:CreateStreamPackageSourceLocation, DescribeStreamPackageSourceLocation, DescribeStreamPackageSourceLocations。

    名称 类型 必选 描述
    Id String

    ID,唯一标识。


    示例值:69CA3E5D4083AFE14663
    Name String

    SourceLocation名称。


    示例值:test_channel
    Region String

    地域。


    示例值:ap-mumbai
    BaseUrl String

    BaseUrl信息。


    示例值:http://www.baidu.com
    SegmentDeliverEnable Boolean

    是否开启补片。


    示例值:true
    SegmentDeliverConf SegmentDeliverInfo

    补片配置。

    AttachedLiveSources Array of String

    绑定的直播source id列表。


    示例值:["69CA3EA14083B04FDE2D"]
    AttachedVodSources Array of String

    绑定的点播source id列表。


    示例值:["69CA25CB4083B064D4BA"]
    CreateTime Integer

    source location创建时间,Unix时间戳。


    示例值:1774861917
    UpdateTime Integer

    source location最近一次修改时间,Unix时间戳。


    示例值:1774861985
    SegmentDeliverUsePackageEnable Boolean

    是否开启package分发分片,默认开启。


    示例值:true

    SourcePackageConf

    源文件信息。

    被如下接口引用:CreateStreamPackageSource, DescribeStreamPackageSource, DescribeStreamPackageSources, ModifyStreamPackageSource。

    名称 类型 必选 描述
    GroupName String group名称,当channel为Linear模式并且选择了vod source的时候,该group 名称和channel output的输出组名称对应。
    示例值:group_test
    Type String 类型,区分HLS和DASH,可选值:HLS、DASH。
    示例值:HLS
    Path String 访问路径。
    示例值:/vod/main.m3u8

    SourceTag

    type SourceTag struct {
    Key string json:"Key"
    Value string json:"Value"
    }

    被如下接口引用:CreateStreamPackageSource, DescribeStreamPackageSource, DescribeStreamPackageSources, ModifyStreamPackageSource。

    名称 类型 必选 描述
    Key String sourcetag的key,支持1-50位的大写字母、数字、下划线、中划线
    示例值:SPORT
    Value String sourcetag的value,支持1-200位的字母、数字下划线、中划线、英文句号、百分号(%)
    示例值:sport

    Speakers

    角色列表

    被如下接口引用:CreateProject, QueryProject, UpdateProject。

    名称 类型 必选 描述
    SpeakerId String

    角色唯一标识


    示例值:xiao_yan
    VoiceId String

    绑定的音色 ID


    示例值:voice_001
    Gender String

    性别:male / female,默认 male


    示例值:male
    AgeGroup String

    年龄段:child / teenager / youth / middle_aged/ senior,默认 youth


    示例值:youth
    Description String

    角色描述


    示例值:女主薰儿
    NameTerms Array of TermBase

    角色人名术语表

    SpecificationDataItem

    指定规格任务统计数据。

    被如下接口引用:DescribeUsageData。

    名称 类型 描述
    Specification String 任务规格。
    Data Array of TaskStatDataItem 统计数据。

    SpekeDrm

    FairPlay,WideVine,PlayReady 等Drm加密方式。

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

    名称 类型 必选 描述
    ResourceId String 资源标记,该字段内容为用户自定义;
    支持1-128个字符的数字、字母、下划线(_)、中划线(-)。
    该字段对应Speke请求中的cid字段。
    注:不同DRM厂商对该字段的限制有所区别(如:华曦达不支持该字段带_),具体规则请与DRM厂商进行确认。
    示例值:123xx
    KeyServerUrl String DRM厂商访问地址,该字段内容从DRM厂商获取。

    注: 不同DRM厂商对子流的数量限制不一样,如 PallyCon 限制不能超过5条子流,DRMtoday厂商最多仅支持9条子流加密
    示例值:https://fe.drmtoday.com/frontend/cpix/v1/xxxxx?ticket=xxxxx
    Vector String 加密初始化向量(十六进制32字节字符串),该字段内容为用户自定义。
    示例值:452ac1553f19b846e2f2c4cffd8f4a9b
    EncryptionMethod String 加密方式,可选值:
    cbcs:PlayReady,Widevine,FairPlay,WideVine+FairPlay,Widevine+Playready,Playready+Fairplay,Widevine+Playready+Fairplay支持;
    cenc:PlayReady,Widevine,Widevine+Playready支持;

    若不填
    FairPlay 默认cbcs;
    PlayReady,Widevine 默认cenc;
    WideVine+FairPlay,Playready+Fairplay,Widevine+Playready+Fairplay默认cbcs;
    Widevine+Playready默认cenc;
    示例值:cbcs
    EncryptionPreset String 子流加密规则,默认 preset0
    preset0:全部子流使用同一个key加密;
    preset1:每个子流使用不同的key加密;

    示例值:preset0

    SpliceInsertInfo

    SpliceInsertInfo。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, ModifyStreamPackageLinearAssemblyProgram。

    名称 类型 必选 描述
    EventID String EventID。
    示例值:1
    AvailNum String AvailNum。
    示例值:0
    AvailExpected String AvailExpected。
    示例值:0
    ProgramID String ProgramID。
    示例值:3

    StreamLinkRegionInfo

    媒体传输的地区信息。

    被如下接口引用:DescribeStreamLinkRegions。

    名称 类型 描述
    Regions Array of RegionInfo 媒体直传输的地区信息列表。

    StreamSelector

    选择指定的音轨或者视频输出

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

    名称 类型 必选 描述
    SelectorType String 选择类型: PID | TRACK
    示例值:PID
    PidSelector PidSelector 根据 PID 配置选择器
    TrackSelector TrackSelector 根据 Track 配置选择器

    StreamUrlDetail

    描述 URL 的完整信息

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

    名称 类型 描述
    Label String 会描述运营商信息等
    示例值:BGP
    Url String URL
    示例值:rtmp://example.com/live/live_channel
    Type String Playback: 拉流播放地址; RelayDestination:转推目的地址;SourceCaptureUrl:回源拉流地址;IngestEndpoint:推流地址
    示例值:Playback

    SubtitleArea

    自动探测硬字幕区域中,表示字幕区域坐标的数据结构。同时包含置信度。

    被如下接口引用:DetectVideoSubtitleArea。

    名称 类型 描述
    Area EraseArea

    检测到的字幕区域

    Confidence Float

    检测区域的置信度

    取值范围:[0, 100]


    示例值:92.46

    SubtitleBoardConfig

    字幕压制模块背景配置

    被如下接口引用:CreateSubtitleEmbedTemplate, ModifySubtitleEmbedTemplate。

    名称 类型 必选 描述
    SubtitleBoardConfigSwitch Integer 字幕压制模块背景配置开关,0关闭,1开启,默认0
    示例值:0
    BoardX Integer 字幕背景底板的x轴坐标位置;支持像素和百分比格式:

    - 像素:Npx,N范围:[-4096,4096]。
    - 百分百:N%,N范围:[-100,100];例如10%表示字幕背景底板x坐标=10%*源视频宽度。

    默认值:0px。
    注意:坐标轴原点位于源视频的中轴线底部,字幕底板的基准点在其中轴线底部,参考下图:
    image

    示例值:0
    BoardXUnit Integer BoardX单位, 0 像素,1百分比,默认为0,像素
    示例值:0
    BoardY Integer 字幕背景底板的y轴坐标位置;支持像素和百分比格式:

    - 像素:Npx,N范围:[0,4096]。
    - 百分百:N%,N范围:[0,100];例如10%表示字幕背景底板y坐标=10%*源视频高度。

    不传表示不开启字幕背景底板。
    注意:坐标轴原点位于源视频的中轴线底部,字幕背景底板的基准点在其中轴线底部,参考下图:
    image

    示例值:0
    BoardYUnit Integer BoardY单位, 0 像素,1百分比,默认为0,像素
    示例值:0
    BoardWidth Integer 底板的宽度,正整数。
    - 代表像素时,取值范围:[0,4096]。
    - 代表百分数时,[0, 100]。
    开启底板且不填此值时,默认源视频宽像素的90%。

    示例值:90
    BoardWidthUnit Integer 底板的宽度单位,0 像素,1百分比,默认为0,像素

    示例值:0
    BoardHeight Integer 底板的高度,正整数。
    - 代表像素时,取值范围:[0,4096]。
    - 代表百分数时,[0, 100]。
    开启底板且不填此值时,默认为源视频高像素的15%。

    示例值:15
    BoardHeightUnit Integer 底板的高度单位,0 像素,1百分比,默认为0,像素

    示例值:0
    BoardColor String 底板颜色。格式:0xRRGGBB,
    默认值:0x000000(黑色)。
    示例值:0x000000
    BoardAlpha Float 字幕背景板透明度,取值范围:[0, 1]
  • 0:完全透明
  • 1:完全不透明

  • 默认值:0.8。
    示例值:0

    SubtitleEmbedConfig

    字幕压制模块配置

    被如下接口引用:CreateSubtitleEmbedTemplate, DescribeSubtitleEmbedTemplates, ModifySubtitleEmbedTemplate。

    名称 类型 必选 描述
    FontType String

    字体类型,支持:

  • hei.ttf:黑体
  • song.ttf:宋体
  • kai.ttf(推荐)或 simkai.ttf:楷体
  • msyh.ttf:微软雅黑
  • msyhbd.ttf:微软雅黑加粗
  • hkjgt.ttf:华康金刚体
  • dhttx.ttf:典黑体特细
  • xqgdzt.ttf:喜鹊古字典体
  • qpcyt.ttf:巧拼超圆体
  • arial.ttf:仅支持英文
  • dinalternate.ttf:DIN Alternate Bold
  • helveticalt.ttf:Helvetica
  • helveticains.ttf:Helvetica Inserat
  • trajanpro.ttf:TrajanPro-Bold
  • korean.ttf:韩语
  • japanese.ttf:日语
  • thai.ttf:泰语
  • roboto.ttf:Roboto
  • notosans.ttf:NotoSans
  • notosansthai.ttf:泰语NotoSansThai
  • sarabun.ttf:泰语Sarabun
  • kanit.ttf:泰语Kanit
  • charmonman.ttf:泰语Charmonman
  • notonaskharabic.ttf:阿拉伯语NotoNaskhArabic
  • notosansdevanagari.ttf:印度语NotoSansDevanagari
  • notosanstc.ttf:粤语思源黑体NotoSansTC
  • notosanskr.ttf:韩语NotoSansKR
  • gothica1.ttf:韩语GothicA1
  • nanummyeongjo.ttf:韩语NanumMyeongjo
  • notosansjp.ttf:日语NotoSansJP
  • notoserifjp.ttf:日语NotoSerifJP
  • shipporimincho.ttf:日语ShipporiMincho
  • 默认:hei.ttf 黑体。
    注意:
  • 楷体推荐使用kai.ttf
  • 填了FontPath时FontPath优先

  • 示例值:kai.ttf
    FontPath String

    自定义字体文件url地址,和CosInputInfo二选一


    示例值:/url
    CosInputInfo CosInputInfo

    自定义字体文件cos地址

    FontSize Integer

    字体大小,不指定则以字幕文件中为准。支持像素和百分比格式:

    • 像素:Npx,N范围:(0,4096]。
    • 百分百:N%,N范围:(0,100];例如10%表示字幕字体大小=10%*源视频高度。

    不填且字幕文件无设置时,默认源视频高度的5%。


    示例值:50
    FontSizeUnit Integer

    FontSize单位, 0 像素,1百分比,默认为0,像素


    示例值:0
    FontColor String

    字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。


    示例值:0xFFFFFF
    FontAlpha Float

    文字透明度,取值范围:(0, 1]

  • 0:完全透明
  • 1:完全不透明
  • 默认值:1。
    示例值:0.0
    PosX Integer

    字幕x轴坐标位置,指定此参数会忽略字幕文件自带坐标;支持像素和百分比格式:

    • 像素:Npx,N范围:[-4096,4096]。
    • 百分百:N%,N范围:[-100,100];例如10%表示字幕x坐标=10%*源视频宽度。

    默认值:0px。
    注意:坐标轴原点在源视频中轴线底部,字幕基准点在字幕中轴线底部,参考下图:
    image


    示例值:0
    PosXUnit Integer

    PosX单位, 0 像素,1百分比,默认为0,像素


    示例值:0
    PosY Integer

    字幕y轴坐标位置,指定此参数会忽略字幕文件自带坐标;支持像素和百分比格式:

    • 像素:Npx,N范围:[0,4096]。
    • 百分百:N%,N范围:[0,100];例如10%表示字幕y坐标=10%源视频高度。

    默认值:源视频高度4%。
    注意:坐标轴原点在源视频中轴线底部,字幕基准点在字幕中轴线底部,参考下图:
    image


    示例值:4
    PosYUnit Integer

    PosY单位, 0 像素,1百分比,默认为0,像素


    示例值:0
    SubtitleBoardConfig SubtitleBoardConfig

    背景配置

    SubtitleLayoutConfig SubtitleLayoutConfig

    排列配置

    SubtitleOutlineConfig SubtitleOutlineConfig

    文字描边配置

    SubtitleShadowConfig SubtitleShadowConfig

    文字阴影配置

    SampleWidth Integer

    源视频尺寸的宽,单位像素值


    示例值:1920
    SampleHeight Integer

    源视频尺寸的高,单位像素值


    示例值:1080

    SubtitleEmbedTemplateItem

    字幕压制模板详情

    被如下接口引用:DescribeSubtitleEmbedTemplates。

    名称 类型 描述
    Definition Integer 字幕压制模板唯一标识
    示例值:1011
    Name String 字幕压制模板名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:字幕压制模板
    Comment String 字幕压制模板描述信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:模板1
    Type String 模板类型,取值范围:
    * Preset:系统预置模板;
    * Custom:用户自定义模板。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Custom
    DeleteTag Integer 删除标记,0 未删除 1 删除
    示例值:0
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2023-10-05T14:30:00Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2023-10-05T14:32:00Z
    SubtitleEmbedConfig SubtitleEmbedConfig 字幕压制模块配置
    AliasName String 字幕压制模板英文名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:AutoFont-NoBackground-SmallSize'

    SubtitleLayoutConfig

    字幕压制模块字幕排列配置

    被如下接口引用:CreateSubtitleEmbedTemplate, ModifySubtitleEmbedTemplate。

    名称 类型 必选 描述
    SubtitleLayoutConfigSwitch Integer 字幕排列配置开关,0关闭,1开启,默认0
    示例值:0
    LineSpacing Integer 行间距。正整数。
    - 代表像素值时, [0, 1000]。
    - 代表百分数时,[0, 100]。不填默认0。

    示例值:0
    LineSpacingUnit Integer LineSpacing单位,0 像素,1百分比,默认为0,像素

    示例值:0
    Alignment String 对齐方式,取值:top: 顶部对齐,字幕顶部按位置固定,底部随行数变化。bottom: 底部对齐,字幕底部按位置固定,顶部随行数变化。不填默认底部对齐。

    示例值:bottom

    SubtitleOutlineConfig

    字幕压制模块文字描边配置

    被如下接口引用:CreateSubtitleEmbedTemplate, ModifySubtitleEmbedTemplate。

    名称 类型 必选 描述
    SubtitleOutlineConfigSwitch Integer

    文字描边配置开关,0关闭,1开启,默认0


    示例值:0
    OutlineWidth Float

    描边宽度,默认单位像素,底层默认值为源视频高度的0.3%


    示例值:0.3
    OutlineWidthUnit Integer

    描边宽度单位,0 像素,1百分比,默认为0,像素


    示例值:0
    OutlineColor String

    描边颜色。6位16进制RGB。不填默认黑色。


    示例值:0x000000
    OutlineAlpha Float

    描边透明度。(0,1] 正浮点数。不填默认1,完全不透明


    示例值:0.0

    SubtitlePosition

    字幕位置信息

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

    名称 类型 描述
    CenterY Integer 居中位置时Y的坐标值
    示例值:970

    SubtitleResult

    智能字幕结果

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

    名称 类型 必选 描述
    Language String

    字幕文件语言


    示例值:zh
    Status String

    处理是否成功


    示例值:Success
    Path String

    字幕文件路径。


    示例值:/xx/310*.vtt
    SubtitleEmbedPath String

    字幕压制视频路径。


    示例值:/xx/310*.mp4

    SubtitleShadowConfig

    字幕压制模块文字阴影配置

    被如下接口引用:CreateSubtitleEmbedTemplate, ModifySubtitleEmbedTemplate。

    名称 类型 必选 描述
    SubtitleShadowConfigSwitch Integer 文字阴影配置开关,0关闭,1开启,默认0
    示例值:0
    ShadowWidth Float 阴影宽度,默认单位像素,底层默认值为0,无阴影

    示例值:0.0
    ShadowWidthUnit Integer 阴影宽度单位, 0 像素,1百分比,默认为0,像素

    示例值:0
    ShadowColor String 阴影颜色。6位16进制RGB。不填默认黑色(有设置阴影的情况下)

    示例值:0x000000
    ShadowAlpha Float 阴影透明度。(0,1] 正浮点数。不填默认1,完全不透明(有设置阴影的情况下)

    示例值:0.0

    SubtitleTemplate

    字幕流配置参数。

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

    名称 类型 必选 描述
    Path String 要压制到视频中的字幕文件地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:https://test-13xxxx46.cos.ap-nanjing.myqcloud.com/xxxxx/subtitle/1.srt
    StreamIndex Integer 指定要压制到视频中的字幕轨道,Streamindex的取值从0开始,0表示使用源视频中的第一条字幕轨。如果指定了Path,则优先使用Path。Path 和 StreamIndex 至少指定一个。

    - 注意:StreamIndex必须与源文件中的字幕轨索引一致。例如,源文件中的字幕轨为stream#0:3,则StreamIndex应为3,否则可能导致任务处理失败。


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SubtitleFileInput MediaInputInfo 要压制到视频中的字幕文件的输入信息,目前仅支持存储在COS的字幕文件
    注意:此字段可能返回 null,表示取不到有效值。
    FontFileInput MediaInputInfo 压制字幕字体文件的输入信息,目前仅支持url和cos。都填时url优先于cos。填了FontFileInput时FontFileInput优先于FontType
    FontType String 字体类型,支持:
  • hei.ttf:黑体
  • song.ttf:宋体
  • kai.ttf(推荐)或 simkai.ttf:楷体
  • msyh.ttf:微软雅黑
  • msyhbd.ttf:微软雅黑加粗
  • hkjgt.ttf:华康金刚体
  • dhttx.ttf:典黑体特细
  • xqgdzt.ttf:喜鹊古字典体
  • qpcyt.ttf:巧拼超圆体
  • arial.ttf:仅支持英文
  • dinalternate.ttf:DIN Alternate Bold
  • helveticalt.ttf:Helvetica
  • helveticains.ttf:Helvetica Inserat
  • trajanpro.ttf:TrajanPro-Bold
  • korean.ttf:韩语
  • japanese.ttf:日语
  • thai.ttf:泰语
  • roboto.ttf:Roboto
  • notosans.ttf:NotoSans
  • notosansthai.ttf:泰语NotoSansThai
  • sarabun.ttf:泰语Sarabun
  • kanit.ttf:泰语Kanit
  • charmonman.ttf:泰语Charmonman
  • notonaskharabic.ttf:阿拉伯语NotoNaskhArabic
  • notosansdevanagari.ttf:印度语NotoSansDevanagari
  • notosanstc.ttf:粤语思源黑体NotoSansTC
  • notosanskr.ttf:韩语NotoSansKR
  • gothica1.ttf:韩语GothicA1
  • nanummyeongjo.ttf:韩语NanumMyeongjo
  • notosansjp.ttf:日语NotoSansJP
  • notoserifjp.ttf:日语NotoSerifJP
  • shipporimincho.ttf:日语ShipporiMincho

  • 默认:hei.ttf 黑体。

    注意:
  • 楷体推荐使用kai.ttf
  • 填了FontFileInput时FontFileInput优先


  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:kai.ttf
    FontSize String 字体大小,不指定则以字幕文件中为准。支持像素和百分比格式:

    - 像素:Npx,N范围:(0,4096]。
    - 百分百:N%,N范围:(0,100];例如10%表示字幕字体大小=10%*源视频高度。

    不填且字幕文件无设置时,默认源视频高度的5%。

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:50px
    FontColor String 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0xFFFFFF
    FontAlpha Float 文字透明度,取值范围:(0, 1]
  • 0:完全透明
  • 1:完全不透明

  • 默认值:1。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    YPos String 字幕y轴坐标位置,指定此参数会忽略字幕文件自带坐标;支持像素和百分比格式:

    - 像素:Npx,N范围:[0,4096]。
    - 百分百:N%,N范围:[0,100];例如10%表示字幕y坐标=10%源视频高度。

    默认值:源视频高度
    4%。
    注意:坐标轴原点在源视频中轴线底部,字幕基准点在字幕中轴线底部,参考下图:
    image

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:4%
    BoardY String 字幕背景底板的y轴坐标位置;支持像素和百分比格式:

    - 像素:Npx,N范围:[0,4096]。
    - 百分百:N%,N范围:[0,100];例如10%表示字幕背景底板y坐标=10%*源视频高度。

    不传表示不开启字幕背景底板。
    注意:坐标轴原点位于源视频的中轴线底部,字幕背景底板的基准点在其中轴线底部,参考下图:
    image

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1%
    BoardWidth Integer 底板的宽度,正整数。
    - 代表像素时,取值范围:[0,4096]。
    - 代表百分数时,[0, 100]。
    开启底板且不填此值时,默认源视频宽像素的90%。

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1920
    BoardHeight Integer 底板的高度,正整数。
    - 代表像素时,取值范围:[0,4096]。
    - 代表百分数时,[0, 100]。
    开启底板且不填此值时,默认为源视频高像素的15%。

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100
    BoardColor String 底板颜色。格式:0xRRGGBB,
    默认值:0x000000(黑色)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0x000000
    BoardAlpha Float 字幕背景板透明度,取值范围:[0, 1]
  • 0:完全透明
  • 1:完全不透明

  • 默认值:0.8。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0.8
    OutlineWidth Float 描边宽度。浮点数。
    - 代表像素值时, [0, 1000]。
    - 代表百分数时,[0, 100]。
    不填默认源视频高度的0.3%。

    示例值:1.0
    OutlineColor String 描边颜色。6位16进制RGB。不填默认黑色。

    示例值:0x000000
    OutlineAlpha Float 描边透明度。(0,1] 正浮点数。不填默认1,完全不透明

    示例值:0.8
    ShadowWidth Float 阴影宽度。浮点数。
    - 代表像素值时, [0, 1000]。
    - 代表百分数时,[0, 100]。
    不填默认无阴影。

    示例值:1.0
    ShadowColor String 阴影颜色。6位16进制RGB。不填默认黑色(有设置阴影的情况下)

    示例值:0x000000
    ShadowAlpha Float 阴影透明度。(0,1] 正浮点数。不填默认1,完全不透明(有设置阴影的情况下)

    示例值:0.9
    LineSpacing Integer 行间距。正整数。
    - 代表像素值时, [0, 1000]。
    - 代表百分数时,[0, 100]。不填默认0。

    示例值:5
    Alignment String 对齐方式,取值:top: 顶部对齐,字幕顶部按位置固定,底部随行数变化。bottom: 底部对齐,字幕底部按位置固定,顶部随行数变化。不填默认底部对齐。

    示例值:bottom
    BoardWidthUnit Integer 默认0。为1时BoardWidth代表百分之几,以视频宽为基准

    示例值:1
    BoardHeightUnit Integer 默认0。为1时BoardHeight代表百分之几,以视频高为基准

    示例值:1
    OutlineWidthUnit Integer 默认0。为1时OutlineWidth代表百分之几,以视频高为基准

    示例值:1
    ShadowWidthUnit Integer 默认0。为1时ShadowWidth代表百分之几,以视频高为基准

    示例值:1
    LineSpacingUnit Integer 默认0。为1时LineSpacing代表百分之几,以视频高为基准

    示例值:1

    SubtitleTransResultItem

    字幕翻译输出结果

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

    名称 类型 描述
    Status String

    翻译标识:

    • Success
    • Error

    示例值:Success
    TransSrc String

    源语言(如"en")


    示例值:en
    TransDst String

    目标语言(如"zh")


    示例值:zh
    Path String

    字幕文件地址


    示例值:/subtitles/1027/xxx.vtt
    SubtitleEmbedPath String

    翻译字幕压制视频路径。


    示例值:/subtitles/1027/xxx.mp4

    SuperResolutionConfig

    超分配置

    被如下接口引用:CreateProcessImageTemplate, CreateTranscodeTemplate, DescribeImageTaskDetail, ModifyProcessImageTemplate, ModifyTranscodeTemplate, ProcessImage。

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

  • 默认值:ON。
    示例值:ON
    Type String 类型,可选值:
  • lq:针对低清晰度有较多噪声视频的超分;
  • hq:针对高清晰度视频超分。

  • 默认值:lq。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:lq
    Size Integer 超分倍数,可选值:
  • 2:目前只支持 2 倍超分。

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

    SvgWatermarkInput

    SVG水印模板输入参数

    被如下接口引用:CreateWatermarkTemplate, DescribeWatermarkTemplates。

    名称 类型 必选 描述
    Width String 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式:
  • 当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;当填 0px 且
    Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度;
  • 当字符串以 W% 结尾,表示水印 Width 为视频宽度的百分比大小,如 10W% 表示 Width 为视频宽度的 10%;
  • 当字符串以 H% 结尾,表示水印 Width 为视频高度的百分比大小,如 10H% 表示 Width 为视频高度的 10%;
  • 当字符串以 S% 结尾,表示水印 Width 为视频短边的百分比大小,如 10S% 表示 Width 为视频短边的 10%;
  • 当字符串以 L% 结尾,表示水印 Width 为视频长边的百分比大小,如 10L% 表示 Width 为视频长边的 10%;
  • 当字符串以 % 结尾时,含义同 W%。

  • 默认值为 10W%。
    示例值:10%
    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。
    示例值: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%。
    示例值:10%
    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。

  • 示例值:0px

    SyncDubbingOutputOption

    同步配音输出参数设置

    被如下接口引用:SyncDubbing。

    名称 类型 必选 描述
    Type String

    合成结果输出类型

    枚举值:

    • data: 音频base64编码
    • url: 音频url,有效期24小时

    示例值:url

    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:关闭智能标签任务。

  • 示例值:ON

    TagConfigureInfoForUpdate

    智能标签任务控制参数

    被如下接口引用:ModifyAIAnalysisTemplate。

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

  • 示例值:ON

    TaskNotifyConfig

    任务的事件通知配置。

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateVideoDatabaseEntryTask, CreateVideoSearchTask, CreateWorkflow, DescribeBatchTaskDetail, DescribeSchedules, DescribeTaskDetail, DescribeWorkflows, EditMedia, ExtractBlindWatermark, ModifySchedule, ProcessMedia, ResetWorkflow, WithdrawsWatermark。

    名称 类型 必选 描述
    NotifyType String

    通知类型,可选值:

  • CMQ:已下线,建议切换到TDMQ-CMQ
  • TDMQ-CMQ:消息队列
  • URL:指定URL时HTTP回调推送到 NotifyUrl 指定的地址,回调协议http+json,包体内容同解析事件通知接口的输出参数
  • SCF:不推荐使用,需要在控制台额外配置SCF
  • AWS-SQS:AWS 队列,只适用于 AWS 任务,且要求同区域
  • 注:不填或为空时默认 TDMQ-CMQ,如需采用其他类型需填写对应类型值;如果使用TDMQ-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 的主题名。


    示例值:mps_notify
    QueueName String

    当模型为 Queue 时有效,表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。


    示例值:mps_que
    AwsSQS AwsSQS

    AWS SQS 回调,NotifyType为 AWS-SQS 时必填。


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

    用于生成回调签名的key。


    示例值:0se***9idaY

    TaskOutputStorage

    媒体处理输出对象信息。

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateWorkflow, DescribeBatchTaskDetail, DescribeImageTaskDetail, DescribeSchedules, DescribeTaskDetail, DescribeWorkflows, EditMedia, ModifySchedule, ParseNotification, ProcessImage, ProcessLiveStream, ProcessMedia, ResetWorkflow。

    名称 类型 必选 描述
    Type String 媒体处理输出对象存储位置的类型,支持:
  • COS:COS存储
  • AWS-S3:AWS 存储,只适用于AWS任务,且要求同区域
  • VOD:点播专业版

  • 示例值:NULL
    CosOutputStorage CosOutputStorage 当 Type 为 COS 时有效,则该项为必填,表示媒体处理 COS 输出位置。
    注意:此字段可能返回 null,表示取不到有效值。
    S3OutputStorage S3OutputStorage 当 Type 为 AWS-S3 时有效,则该项为必填,表示媒体处理 AWS S3 输出位置。
    注意:此字段可能返回 null,表示取不到有效值。
    VODOutputStorage VODOutputStorage 当 Type 为 VOD 时有效,则该项为必填,表示媒体处理 点播专业版 输出位置。
    注意:此字段可能返回 null,表示取不到有效值。

    TaskSimpleInfo

    任务概要信息

    被如下接口引用:DescribeTasks。

    名称 类型 描述
    TaskId String 任务 ID。
    示例值:24022-WorkflowTask-99f82fb306909
    TaskType String 任务类型,包含:
  • WorkflowTask:工作流处理任务;
  • EditMediaTask:视频编辑任务;
  • LiveProcessTask:直播处理任务。

  • 示例值:WorkflowTask
    CreateTime String 任务创建时间,使用 ISO 日期格式
    示例值:2024-05-17T08:56:12Z
    BeginProcessTime String 任务开始执行时间,使用 ISO 日期格式。若任务尚未开始,该字段为:0000-00-00T00:00:00Z。
    示例值:2024-05-17T08:56:26Z
    FinishTime String 任务结束时间,使用 ISO 日期格式。若任务尚未完成,该字段为:0000-00-00T00:00:00Z。
    示例值:2024-05-17T08:56:56Z
    SubTaskTypes Array of String 子任务类型。
    示例值:["Transcode", "AiRecognition"]

    TaskStatData

    任务统计数据。

    被如下接口引用:DescribeUsageData。

    名称 类型 描述
    TaskType String 任务类型。
  • Transcode: 转码
  • Enhance: 增强
  • AIAnalysis: 智能分析
  • AIRecognition: 智能识别
  • AIReview: 内容审核
  • Snapshot: 截图
  • AnimatedGraphics: 转动图
  • ImageProcess: 图片处理

  • 示例值:Transcode
    Summary Array of TaskStatDataItem 任务数统计数据概览。
  • Transcode:用量单位为秒
  • Enhance:用量单位为秒
  • AIAnalysis:用量单位为秒
  • AIRecognition:用量单位为秒
  • AIReview:用量单位为秒
  • Snapshot:用量单位为张
  • AnimatedGraphics: 用量单位为秒
  • ImageProcess: 用量单位为张
  • Details Array of SpecificationDataItem 不同规格任务统计数据详情。

    1、转码规格:
  • Audio:纯音频
  • Remuxing:转封装
  • 其他转码规格:{TYPE}.{CODEC}.{SPECIFICATION}
  •   其中 TYPE 取值
        Standard:普通转码
        TESHD-10:视频极速高清
        TESHD-20:音频极速高清
        TESHD-30:音视频极速高清
        TESHD-30-SDK:音视频极速高清SDK按时长计费
        TESHD-30-SDKCores:音视频极速高清SDK按核心数计费
        Edit:视频编辑
      其中 CODEC 取值
        H264:H.264 编码
        H265:H.265 编码
        AV1:AV1 编码
        MV-HEVC:MV-HEVC 编码
      其中 SPECIFICATION 取值
        SD:标清
        HD:高清
        FHD:全高清
        2K:2K
        4K:4K
    例如 TESHD-10.H265.HD 表示 H.265 编码方式高清极速高清转码

    2、增强规格:视频增强格式:{TYPE}.{CODEC}.{SPECIFICATION}.{FPS},其中 CODEC 和 SPECIFICATION 同转码,FPS在原子类型时才存在;音频增强格式:{TYPE}。
    增强TYPE 取值:
  • Enhance:通用增强类型,可能是任意一种原子增强类型
  • 原子增强类型
  •   视频原子增强类型取值:
        Sdr2hdr:SDR2HDR
        SuperResolution:超分
        InsertFrame:插帧
        ComprehensiveEnhancement:综合增强
        NoiseReduction:视频降噪
        ColorEnhancement:色彩增强
        RemoveScratches:去划痕
        Deburr:去毛刺
        DetailEnhancement:细节增强
        LightEnhancement:低光照增强
        FaceEnhancement:人脸增强
      音频原子增强类型取值:
        AudioNoiseReduction
        VolumeBalance
        AudioBeautify
        AudioSeparation

    3、截图规格:
  • ImageSprite:雪碧图
  • SampleSnapshot:采样截图
  • SnapshotByTime:时间点截图

  • 4、图片处理规格:{TYPE}.{CODEC}.{SPECIFICATION}
  • ImageCompression:图片编码
  • ImageSuperResolution:图片超分
  • EnhanceImageColor:图片色彩增强

  • 5、智能分析规格:
  • AIAnalysis:分析大类
  • VideoTag:视频标签
  • VideoClassification:视频分类
  • SmartCover:智能封面
  • FrameLabel:帧标签
  • VideoSplit:视频拆条
  • Highlights:精彩集锦
  • OpeningAndEnding:片头片尾

  • 6、智能识别规格:
  • AIRecognition:识别大类
  • FaceRecognition:人脸识别
  • TextRecognition:文字识别
  • ObjectRecognition:物体识别
  • VoiceRecognition:语音识别
  • VoiceTranslation:语音翻译

  • 7、内容审核、转动图无细分规格。

    TaskStatDataItem

    任务统计数据,包括任务数和用量。

    被如下接口引用:DescribeUsageData。

    名称 类型 描述
    Time String 数据所在时间区间的开始时间,使用 ISO 日期格式。如:当时间粒度为天,2018-12-01T00:00:00+08:00,表示2018年12月1日(含)到2018年12月2日(不含)区间。
    示例值:2025-10-02T00:00:00+08:00
    Count Integer 任务数。
    示例值:2
    Usage Integer 任务用量。
    示例值:472

    TermBase

    术语表

    被如下接口引用:CreateProject, QueryProject, UpdateProject。

    名称 类型 必选 描述
    Src String

    术语原语言


    示例值:Xun Er
    Dst String

    术语目标语言


    示例值:薰儿
    SrcLanguage String

    术语源语言,支持:"ab": "阿布哈兹语", "ace": "亚齐语", "ach": "阿乔利语", "af": "南非荷兰语", "ak": "契维语(阿坎语)", "am": "Amharic", "ar": "阿拉伯语", "as": "阿萨姆语", "ay": "艾马拉语", "az": "阿塞拜疆语", "ba": "巴什基尔语", "ban": "巴厘语", "bbc": "巴塔克托巴语", "bem": "Bemba", "bew": "Betawi", "bg": "保加利亚语", "bho": "博杰普尔语", "bik": "Bikol", "bm": "班巴拉语", "bn": "孟加拉语", "br": "布列塔尼语", "bs": "波斯尼亚语", "btx": "巴塔克卡罗语", "bts": "巴塔克西马隆贡语", "bua": "布里亚特语", "ca": "加泰罗尼亚语", "ceb": "宿务语", "cgg": "Kiga", "chm": "草原马里语", "ckb": "库尔德语(索拉尼语)", "cnh": "哈卡钦语", "co": "科西嘉语", "crh": "克里米亚鞑靼语", "crs": "塞舌尔克里奥尔语", "cs": "捷克语", "cv": "楚瓦什语", "cy": "威尔士语", "da": "丹麦语", "de": "德语", "din": "Dinka", "doi": "多格来语", "dov": "敦贝语", "dv": "第维埃语", "dz": "宗卡语", "ee": "Ewe", "el": "希腊语", "en": "英语", "eo": "世界语", "es": "西班牙语", "et": "爱沙尼亚语", "eu": "巴斯克语", "fa": "波斯语", "ff": "富拉语", "fi": "芬兰语", "fil": "菲律宾语(塔加拉语)", "fj": "斐济语", "fr": "法语", "fr-CA": "法语(加拿大)", "fr-FR": "法语(法国)", "fy": "弗里斯兰语", "ga": "爱尔兰语", "gaa": "加 (Ga) 语", "gd": "苏格兰盖尔语", "gl": "加利西亚语", "gn": "瓜拉尼语", "gom": "贡根语", "gu": "古吉拉特语", "gv": "马恩岛语", "ha": "Hausa", "haw": "夏威夷语", "he": "希伯来语", "hi": "印地语", "hil": "希利盖农语", "hmn": "苗语", "hr": "克罗地亚语", "hrx": "洪斯吕克语", "ht": "海地克里奥尔语", "hu": "匈牙利语", "hy": "亚美尼亚语", "id": "印度尼西亚语", "ig": "Igbo", "ilo": "伊洛果语", "is": "冰岛语", "it": "意大利语", "iw": "希伯来语", "ja": "日语", "jv": "爪哇语", "jw": "爪哇语", "ka": "格鲁吉亚语", "kk": "哈萨克语", "km": "高棉语", "kn": "卡纳达语", "ko": "韩语", "kri": "Krio", "ku": "库尔德语(库尔曼吉语)", "ktu": "吉土巴语", "ky": "吉尔吉斯语", "la": "拉丁语", "lb": "卢森堡语", "lg": "干达语(卢干达语)", "li": "林堡语", "lij": "利古里亚语", "lmo": "伦巴第语", "ln": "林加拉语", "lo": "老挝语", "lt": "立陶宛语", "ltg": "拉特加莱语", "luo": "Luo", "lus": "米佐语", "lv": "拉脱维亚语", "mai": "迈蒂利语", "mak": "马卡萨", "mg": "马尔加什语", "mi": "毛利语", "min": "米南语", "mk": "马其顿语", "ml": "马拉雅拉姆语", "mn": "蒙古语", "mr": "马拉地语", "ms": "马来语", "mt": "马耳他语", "my": "缅甸语", "ne": "尼泊尔语", "new": "尼泊尔语(尼瓦尔语)", "nl": "荷兰语", "no": "挪威语", "nr": "恩德贝莱语(南部)", "nso": "北索托语(塞佩蒂语)", "nus": "努尔语", "ny": "齐切瓦语(尼扬贾语)", "oc": "奥克斯坦语", "om": "Oromo", "or": "奥里亚语(奥里亚)", "pa": "旁遮普语", "pag": "邦阿西楠语", "pam": "邦板牙语", "pap": "Papiamento", "pl": "波兰语", "ps": "Pashto", "pt": "葡萄牙语", "pt-BR": "葡萄牙语(巴西)", "pt-PT": "葡萄牙语(葡萄牙)", "qu": "克丘亚语", "ro": "罗马尼亚语", "rom": "罗姆语", "rn": "Rundi", "ru": "俄语", "rw": "卢旺达语", "sa": "梵语", "scn": "西西里语", "sd": "信德语", "sg": "Sango", "shn": "掸语", "si": "僧伽罗语", "sk": "斯洛伐克语", "sl": "斯洛文尼亚语", "sm": "萨摩亚语", "sn": "修纳语", "so": "索马里语", "sq": "阿尔巴尼亚语", "sr": "塞尔维亚语", "ss": "斯瓦特语", "st": "塞索托语", "su": "巽他语", "sv": "瑞典语", "sw": "斯瓦希里语", "szl": "西里西亚语", "ta": "泰米尔语", "te": "泰卢固语", "tet": "德顿语", "tg": "塔吉克语", "th": "泰语", "ti": "提格里尼亚语", "tk": "土库曼语", "tl": "菲律宾语(塔加拉语)", "tn": "茨瓦纳语", "tr": "土耳其语", "ts": "聪加语", "tt": "鞑靼语", "ug": "维吾尔语", "uk": "乌克兰语", "ur": "乌尔都语", "uz": "乌兹别克语", "vi": "越南语", "xh": "科萨语", "yi": "意第绪语", "yo": "约鲁巴语", "yua": "尤卡坦玛雅语", "yue": "粤语", "zh": "简体中文", "zh-TW": "中文(繁体)", "zu": "祖鲁语"


    示例值:en
    DstLanguage String

    术语目标语言,支持:"ab": "阿布哈兹语", "ace": "亚齐语", "ach": "阿乔利语", "af": "南非荷兰语", "ak": "契维语(阿坎语)", "am": "Amharic", "ar": "阿拉伯语", "as": "阿萨姆语", "ay": "艾马拉语", "az": "阿塞拜疆语", "ba": "巴什基尔语", "ban": "巴厘语", "bbc": "巴塔克托巴语", "bem": "Bemba", "bew": "Betawi", "bg": "保加利亚语", "bho": "博杰普尔语", "bik": "Bikol", "bm": "班巴拉语", "bn": "孟加拉语", "br": "布列塔尼语", "bs": "波斯尼亚语", "btx": "巴塔克卡罗语", "bts": "巴塔克西马隆贡语", "bua": "布里亚特语", "ca": "加泰罗尼亚语", "ceb": "宿务语", "cgg": "Kiga", "chm": "草原马里语", "ckb": "库尔德语(索拉尼语)", "cnh": "哈卡钦语", "co": "科西嘉语", "crh": "克里米亚鞑靼语", "crs": "塞舌尔克里奥尔语", "cs": "捷克语", "cv": "楚瓦什语", "cy": "威尔士语", "da": "丹麦语", "de": "德语", "din": "Dinka", "doi": "多格来语", "dov": "敦贝语", "dv": "第维埃语", "dz": "宗卡语", "ee": "Ewe", "el": "希腊语", "en": "英语", "eo": "世界语", "es": "西班牙语", "et": "爱沙尼亚语", "eu": "巴斯克语", "fa": "波斯语", "ff": "富拉语", "fi": "芬兰语", "fil": "菲律宾语(塔加拉语)", "fj": "斐济语", "fr": "法语", "fr-CA": "法语(加拿大)", "fr-FR": "法语(法国)", "fy": "弗里斯兰语", "ga": "爱尔兰语", "gaa": "加 (Ga) 语", "gd": "苏格兰盖尔语", "gl": "加利西亚语", "gn": "瓜拉尼语", "gom": "贡根语", "gu": "古吉拉特语", "gv": "马恩岛语", "ha": "Hausa", "haw": "夏威夷语", "he": "希伯来语", "hi": "印地语", "hil": "希利盖农语", "hmn": "苗语", "hr": "克罗地亚语", "hrx": "洪斯吕克语", "ht": "海地克里奥尔语", "hu": "匈牙利语", "hy": "亚美尼亚语", "id": "印度尼西亚语", "ig": "Igbo", "ilo": "伊洛果语", "is": "冰岛语", "it": "意大利语", "iw": "希伯来语", "ja": "日语", "jv": "爪哇语", "jw": "爪哇语", "ka": "格鲁吉亚语", "kk": "哈萨克语", "km": "高棉语", "kn": "卡纳达语", "ko": "韩语", "kri": "Krio", "ku": "库尔德语(库尔曼吉语)", "ktu": "吉土巴语", "ky": "吉尔吉斯语", "la": "拉丁语", "lb": "卢森堡语", "lg": "干达语(卢干达语)", "li": "林堡语", "lij": "利古里亚语", "lmo": "伦巴第语", "ln": "林加拉语", "lo": "老挝语", "lt": "立陶宛语", "ltg": "拉特加莱语", "luo": "Luo", "lus": "米佐语", "lv": "拉脱维亚语", "mai": "迈蒂利语", "mak": "马卡萨", "mg": "马尔加什语", "mi": "毛利语", "min": "米南语", "mk": "马其顿语", "ml": "马拉雅拉姆语", "mn": "蒙古语", "mr": "马拉地语", "ms": "马来语", "mt": "马耳他语", "my": "缅甸语", "ne": "尼泊尔语", "new": "尼泊尔语(尼瓦尔语)", "nl": "荷兰语", "no": "挪威语", "nr": "恩德贝莱语(南部)", "nso": "北索托语(塞佩蒂语)", "nus": "努尔语", "ny": "齐切瓦语(尼扬贾语)", "oc": "奥克斯坦语", "om": "Oromo", "or": "奥里亚语(奥里亚)", "pa": "旁遮普语", "pag": "邦阿西楠语", "pam": "邦板牙语", "pap": "Papiamento", "pl": "波兰语", "ps": "Pashto", "pt": "葡萄牙语", "pt-BR": "葡萄牙语(巴西)", "pt-PT": "葡萄牙语(葡萄牙)", "qu": "克丘亚语", "ro": "罗马尼亚语", "rom": "罗姆语", "rn": "Rundi", "ru": "俄语", "rw": "卢旺达语", "sa": "梵语", "scn": "西西里语", "sd": "信德语", "sg": "Sango", "shn": "掸语", "si": "僧伽罗语", "sk": "斯洛伐克语", "sl": "斯洛文尼亚语", "sm": "萨摩亚语", "sn": "修纳语", "so": "索马里语", "sq": "阿尔巴尼亚语", "sr": "塞尔维亚语", "ss": "斯瓦特语", "st": "塞索托语", "su": "巽他语", "sv": "瑞典语", "sw": "斯瓦希里语", "szl": "西里西亚语", "ta": "泰米尔语", "te": "泰卢固语", "tet": "德顿语", "tg": "塔吉克语", "th": "泰语", "ti": "提格里尼亚语", "tk": "土库曼语", "tl": "菲律宾语(塔加拉语)", "tn": "茨瓦纳语", "tr": "土耳其语", "ts": "聪加语", "tt": "鞑靼语", "ug": "维吾尔语", "uk": "乌克兰语", "ur": "乌尔都语", "uz": "乌兹别克语", "vi": "越南语", "xh": "科萨语", "yi": "意第绪语", "yo": "约鲁巴语", "yua": "尤卡坦玛雅语", "yue": "粤语", "zh": "简体中文", "zh-TW": "中文(繁体)", "zu": "祖鲁语"


    示例值:zh

    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:涉敏人物;

  • 示例值: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:涉敏人物;

  • 示例值: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:仅支持英文。

  • 示例值:arial.ttf
    FontSize String 字体大小,格式:Npx,N 为数值。N的取值范围:[0,1] 和 [8, 4096]
    示例值:10px
    FontColor String 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。
    示例值:0xFFFFFF
    FontAlpha Float 文字透明度,取值范围:(0, 1]
  • 0:完全透明
  • 1:完全不透明

  • 默认值:1。
    示例值:0.5
    TextContent String 文字内容,长度不超过100个字符。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:mps水印测试

    TextWatermarkTemplateInputForUpdate

    文字水印模板

    被如下接口引用:ModifyWatermarkTemplate。

    名称 类型 必选 描述
    FontType String 字体类型,目前可以支持两种:
  • simkai.ttf:可以支持中文和英文;
  • arial.ttf:仅支持英文。

  • 示例值:simkai.ttf
    FontSize String 字体大小,格式:Npx,N 为数值。N的取值范围:[0,1] 和 [8, 4096]
    示例值:10px
    FontColor String 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。
    示例值:0xFFFFFF
    FontAlpha Float 文字透明度,取值范围:(0, 1]
  • 0:完全透明
  • 1:完全不透明

  • 示例值:1
    TextContent String 文字内容,长度不超过100个字符。
    示例值:mps水印测试

    TimeShiftInfo

    线性组装频道时移配置信息。

    被如下接口引用:CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel。

    名称 类型 必选 描述
    TimeWindows Integer 回看窗口,单位秒。
    示例值:0

    TimeSignalInfo

    TimeSignalInfo。

    被如下接口引用:CreateStreamPackageLinearAssemblyProgram, ModifyStreamPackageLinearAssemblyProgram。

    名称 类型 必选 描述
    EventID String EventID。
    示例值:1
    UPIDType String UPIDType。
    示例值:0
    UPID String UPID。
    示例值:0
    TypeID String TypeID。
    示例值:3
    Num String Num。
    示例值:3
    Expected String Expected。
    示例值:33
    SubsegmentNum String SubsegmentNum。
    示例值:33
    SubsegmentsExpected String SubsegmentsExpected。
    示例值:12

    TimeSpotCheck

    媒体质检的检测策略。

    被如下接口引用:CreateQualityControlTemplate, ModifyQualityControlTemplate。

    名称 类型 必选 描述
    CheckDuration Integer 每次循环检测的时长。取值范围(单位s):

    - 最小值:10
    - 最大值:86400

    示例值:30
    CheckInterval Integer 抽检间隔,表示在一次检测结束后,等待多长时间后,再次检测。取值范围(单位 s):
    - 最小值:10
    - 最大值:3600
    示例值:30
    SkipDuration Integer 片头跳过时长。取值范围(单位 s):
    - 最小值:1
    - 最大值:1800
    示例值:60
    CirclesNumber Integer 循环次数。取值范围:
    - 最小值:0
    - 最大值:1000

    取值为 0 或为空时,表示循环至视频结束。
    示例值:10

    TrackInfo

    音轨信息

    被如下接口引用:CreateTranscodeTemplate。

    名称 类型 必选 描述
    TrackNum String 音轨和声道数字,说明:
    当:SelectType值为track,此值为整数类型,例如:1;
    当:SelectType值为track_channel,此值为小数类型,例如:1.0;
    默认值:1.0
    注意:整数部分代表音轨序号,以小数部分代表声道。音轨序号即为音轨的stream index,支持输入0和正整数。小数部分最多支持2位小数,并且仅支持0-63,但是如果Codec为aac/eac3/ac3时,小数部分仅支持0-15。例如:对于stream index为1的音轨,1.0代表这个音轨的第1个声道,1.1代表这个音轨的第2个声道。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    ChannelVolume Array of Float 声道音量大小,说明:
    当:AudioChannel的值为1时,此数组长度为1,例如:[6];
    当:AudioChannel的值为2时,此数组长度为2,例如:[0,6];
    当:AudioChannel的值为6时,此数组长度大于2小于16,例如:[-60,0,0,6]。
    此值数组值取值范围:[-60, 6],其中-60代表静音、0代表保持原音量,6表示原音量增加一倍,默认值为-60。
    注意:支持3位小数。

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[-60, 0, 6]

    TrackSelector

    音视频轨道选择

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

    名称 类型 必选 描述
    VideoIndex Array of Integer 视频轨道序号,从1开始.
    示例值:[1,2]
    AudioIndex Array of Integer 音频轨道序号,从1开始.
    示例值:[1,2]

    TranscodeTaskInput

    转码任务输入参数类型

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

    名称 类型 必选 描述
    Definition Integer 视频转码模板 ID。
    示例值:20
    RawParameter RawTranscodeParameter 视频转码自定义参数,当 Definition 填 0 时有效。
    该参数用于高度定制场景,建议您优先使用 Definition 指定转码参数。
    OverrideParameter OverrideTranscodeParameter 视频转码自定义参数,当 Definition 不填 0 时有效。
    当填写了该结构中的部分转码参数时,将使用填写的参数覆盖转码模板中的参数。
    该参数用于高度定制场景,建议您仅使用 Definition 指定转码参数。
    注意:此字段可能返回 null,表示取不到有效值。
    WatermarkSet Array of WatermarkInput 水印列表,支持多张图片或文字水印,最大可支持 10 张。
    BlindWatermark BlindWatermarkInput 数字水印参数。
    注意:此字段可能返回 null,表示取不到有效值。
    MosaicSet Array of MosaicInput 马赛克列表,最大可支持 10 张。
    StartTimeOffset Float 转码后的视频的起始时间偏移,单位:秒。
  • 不填或填0,表示转码后的视频从原始视频的起始位置开始;
  • 当数值大于0时(假设为 n),表示转码后的视频从原始视频的第 n 秒位置开始;
  • 当数值小于0时(假设为 -n),表示转码后的视频从原始视频结束 n 秒前的位置开始。

  • 示例值:1.0
    EndTimeOffset Float 转码后视频的终止时间偏移,单位:秒。
  • 不填或填0,表示转码后的视频持续到原始视频的末尾终止;
  • 当数值大于0时(假设为 n),表示转码后的视频持续到原始视频第 n 秒时终止;
  • 当数值小于0时(假设为 -n),表示转码后的视频持续到原始视频结束 n 秒前终止。

  • 示例值:15.0
    OutputStorage TaskOutputStorage 转码后文件的目标存储,不填则继承上层的 OutputStorage 值。
    注意:此字段可能返回 null,表示取不到有效值。
    OutputObjectPath String 转码后主文件的输出路径,可以为相对路径或者绝对路径。
    若需定义输出路径,路径需以.{format}结尾。变量名请参考 文件名变量说明
    相对路径示例:
  • 文件名_{变量名}.{format}
  • 文件名.{format}

  • 绝对路径示例:
  • /自定义路径/文件名_{变量名}.{format}

  • 如果不填,则默认为相对路径:{inputName}_transcode_{definition}.{format}

    示例值:{inputName}_transcode_{definition}.{format}
    SegmentObjectName String 转码后分片文件的输出路径(转码 HLS 时 ts 的路径),只能为相对路径。如果不填,则默认为:{inputName}_transcode_{definition}_{number}.{format}
    示例值:{inputName}_transcode_{definition}_{number}.{format}
    ObjectNumberFormat NumberFormat 转码后输出路径中的{number}变量的规则。
    注意:此字段可能返回 null,表示取不到有效值。
    HeadTailParameter HeadTailParameter 片头片尾参数。
    注意:此字段可能返回 null,表示取不到有效值。

    TranscodeTemplate

    转码模板详情

    被如下接口引用:DescribeTranscodeTemplates。

    名称 类型 描述
    Definition String 转码模板唯一标识。
    示例值:0
    Container String 封装格式,取值:mp4、flv、hls、mp3、flac、ogg。
    示例值:mp4
    Name String 转码模板名称。
    示例值:transcode1
    Comment String 模板描述信息。
    示例值:转码模板1
    Type String 模板类型,取值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值: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:纯音频格式,只能包含音频流的封装格式板。

  • 示例值:Video
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2023-10-17T14:59:45.123Z
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2023-11-17T14:59:45.123Z
    EnhanceConfig EnhanceConfig 音视频增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    AliasName String 转码模板别名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:mps_transcode1

    TranslateConfigureInfo

    语音翻译任务控制参数

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

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

  • 示例值:ON
    SourceLanguage String 视频源语言。
    示例值:zh
    DestinationLanguage String 翻译目标语言。
    示例值:en
    SubtitleFormat String 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值:
  • vtt:生成 WebVTT 字幕文件。

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

    TranslateConfigureInfoForUpdate

    语音翻译任务控制参数

    被如下接口引用:ModifyAIRecognitionTemplate。

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

  • 示例值:ON
    SourceLanguage String 视频源语言。
    示例值:zh
    DestinationLanguage String 翻译目标语言。
    示例值:en
    SubtitleFormat String 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值:
  • vtt:生成 WebVTT 字幕文件。

  • 示例值:vtt

    UnattachSecurityGroupInOutInfo

    安全组解绑输入/输出请求信息。

    被如下接口引用:DisassociateSecurityGroup。

    名称 类型 必选 描述
    FlowId String 该安全组关联的FlowId。
    示例值:01963d5435de1eaa814800077080
    InOutId String 要解绑的输入/输出ID。
    示例值:019527caa7b209dc0f3253a63420
    InOutType String 输入/输出类型,可选值:
    Input:输入
    Output:输出。
    示例值:input
    FlowRegion String Flow所在的Region,和input共用。
    示例值:ap-shanghai

    UpdateSmartErasePrivacyConfig

    智能擦除模板隐私保护配置

    被如下接口引用:ProcessMedia。

    名称 类型 必选 描述
    PrivacyModel String 隐私保护擦除方式。
    - blur 模糊
    - mosaic 马赛克
    示例值:blur
    PrivacyTargets Array of String 隐私保护目标,(在API Explorer上使用时无需传入数组,添加相应项并填入对应值即可)。
    - face 人脸
    - plate 车牌
    示例值:["face"]

    UpdateSmartEraseSubtitleConfig

    智能擦除模板去字幕配置

    被如下接口引用:ProcessMedia。

    名称 类型 必选 描述
    SubtitleEraseMethod String 字幕擦除方式。
    自动擦除:通过AI模型自动识别视频中的字幕文本内容,进行无痕化擦除,生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题,可以通过指定区域擦除处理。
    当使用自动擦除时,若您不指定AutoAreas,将对默认区域(画面中下部)进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。
    指定区域擦除:若您的字幕位置较固定,建议您直接指定擦除区域,最大程度减少漏擦的情况。
    当您选择指定区域擦除时,请在CustomAreas中至少传入一个指定区域。
    - auto 自动擦除
    - custom 指定区域擦除

    示例值:auto
    SubtitleModel String 字幕擦除模型。
    标准版(推荐):若您的字幕样式标准,通常建议选择该版本,细节无痕化效果更好。
    区域版:若您的字幕存在花体、阴影、动效等特殊样式,建议选择区域版,擦除面积更大,但细节效果不如标准版。
    - standard 标准模型
    - area 区域模型
    示例值:standard
    OcrSwitch String 是否开启OCR字幕提取,默认取OFF。
    当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取,开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域,对字幕区域中的文字进行提取和擦除。
    - ON 开启
    - OFF 关闭
    示例值:ON
    SubtitleLang String 字幕语言,用于指导OCR识别,默认取zh_en;仅当OcrSwitch取"ON"时生效。
    - zh_en 中英文
    - multi 其他
    其他具体支持识别如下语言:
    中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆语 、印度-泰米尔语、印度-泰卢固语、斯洛文尼亚语、波兰语、加泰罗尼亚语、波斯尼亚语、捷克语、爱沙尼亚语、克罗地亚语、旁遮普语、马拉地语、阿塞拜疆语、印尼语、卢森堡语 、立陶宛语、拉脱维亚语、马耳他语、斯洛伐克语、土耳其语、哈萨克语、希腊语、爱尔兰语、白俄罗斯语、高棉语、他加禄语、普什图语、波斯语、塔吉克斯坦语


    示例值:zh_en
    SubtitleFormat String 字幕文件格式,默认取vtt;仅当OcrSwitch取"ON"时生效。
    - srt srt格式
    - vtt WebVTT格式
    示例值:vtt
    TransSwitch String 是否开启字幕翻译,默认取OFF;仅当OcrSwitch取"ON"时生效。
    - ON 开启
    - OFF 关闭
    示例值:ON
    TransDstLang String 字幕翻译目标语言,默认取en;仅当TransSwitch取"ON"时生效。
    当前支持以下语言:
    zh:简体中文
    en:英语
    ja:日语
    ko:韩语
    fr:法语
    es:西班牙语
    it:意大利语
    de:德语
    tr:土耳其语
    ru:俄语
    pt:葡萄牙语
    vi:越南语
    id:印度尼西亚语
    ms:马来语
    th:泰语
    ar:阿拉伯语
    hi:印地语
    示例值:en
    AutoAreas Array of EraseArea 自动擦除自定义区域。
    对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。
    注意:当擦除方式选择custom时,此参数将不会生效;修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。
    CustomAreas Array of EraseTimeArea 指定擦除自定义区域。
    对选定区域,在选定时间段内不进行检测识别直接进行擦除。
    注意:修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。

    UpdateSmartEraseWatermarkConfig

    智能擦除模板去水印配置

    被如下接口引用:ProcessMedia。

    名称 类型 必选 描述
    WatermarkEraseMethod String 水印擦除方式。
    自动擦除:通过A模型自动识别视频中的水印,擦除后生成新的视频。适用于动态水印。
    当使用自动擦除时,若您不指定AutoAreas,将对视频全屏进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。
    指定区域擦除:针对位置较固定的静态水印,建议您直接指定擦除区域。
    当您选择指定区域擦除时,请至少传入一个指定区域。

    - auto 自动擦除
    - custom 指定区域擦除
    示例值:auto
    WatermarkModel String 水印擦除模型。
    基础版:效果一般,性价比高,适合动画或背景较干净的视频。
    高级版:效果更好,适合短剧等现实风格视频。
    - basic 基础版
    - advanced 高级版
    示例值:basic
    AutoAreas Array of EraseArea 自动擦除自定义区域。
    对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。
    注意,当擦除方式为custom时,此参数将不会生效。清除区域请传入[],不传时将保持模板区域信息不变。
    CustomAreas Array of EraseTimeArea 指定擦除自定义区域。
    对选定区域,在选定时间段内不进行检测识别直接进行擦除。
    注意:清除区域请传入[],不传时将保持模板区域信息不变。

    UrlInputInfo

    媒体处理 URL 对象信息。

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, DescribeImageTaskDetail, DescribeMediaMetaData, DetectVideoSubtitleArea, ExtractBlindWatermark, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。

    名称 类型 必选 描述
    Url String 视频的 URL。
    示例值:NULL

    UsageDetail

    广告配置及广告类型维度下的SSAI用量详情

    被如下接口引用:DescribeStreamPackageSSAIUsage。

    名称 类型 描述
    UniqId String

    广告配置uniq_id


    示例值:13565212
    ChannelId String

    广告配置id


    示例值:69CA3EA14083B04FDE2D
    ChannelName String

    广告配置名称


    示例值:test_channel
    AdType String

    广告类型


    示例值:AVOD
    AdRequestSuccess Integer

    广告请求成功数


    示例值:10
    AdRequestFail Integer

    广告请求失败数


    示例值:0
    Impression Integer

    广告曝光数


    示例值:10
    Start Integer

    广告开始播放数


    示例值:10
    FirstQuarter Integer

    广告播放到1/4处数


    示例值:1
    Midpoint Integer

    广告播放到1/2处数


    示例值:3
    ThirdQuarter Integer

    广告播放到3/4处数


    示例值:4
    Complete Integer

    广告播放完成数


    示例值:2
    AdMarkerTime Float

    中贴广告标记时间


    示例值:10.5
    ReplacedTime Float

    中贴个性化替换时间


    示例值:10.5
    MidFillRate Float

    中贴个性化广告填充率


    示例值:0.5
    PreReqNum Integer

    前贴广告请求数


    示例值:1
    PreReplacedNum Integer

    前贴广告替换数


    示例值:1
    PreReplaceRate Float

    前贴广告替换率


    示例值:0.5
    ADMarkerFound Integer

    在清单中发现了广告标记次数


    示例值:1
    MakeAdsRequest Integer

    向ADS请求广告次数


    示例值:1
    VASTResponse Integer

    从ADS收到VAST返回次数


    示例值:1
    FilledAvail Integer

    成功填充了广告次数


    示例值:1
    WarningNoAd Integer

    执行广告替换时遇到问题次数


    示例值:1
    ErrorAdsTimeout Integer

    ADS返回超时次数


    示例值:1
    EmptyVASTResponse Integer

    ADS 返回了一个空的 VAST 响应次数


    示例值:1
    EmptyVMAPResponse Integer

    ADS 返回了一个空的VMAP 响应次数


    示例值:1
    Date String

    日期


    示例值:2026-03-20
    StartTime String

    开始时间


    示例值:2026-02-10T11:00:00+08:00
    EndTime String

    结束时间


    示例值:2026-02-10T11:20:00+08:00

    UserDefineAsrTextReviewTemplateInfo

    用户自定义语音审核任务控制参数

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

    名称 类型 必选 描述
    Switch String 用户自定语音审核任务开关,可选值:
  • ON:开启自定义语音审核任务;
  • OFF:关闭自定义语音审核任务。

  • 示例值:ON
    LabelSet Array of String 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["自定义语音过滤标签1"]
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    示例值:100
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
    示例值:85

    UserDefineAsrTextReviewTemplateInfoForUpdate

    用户自定义语音审核任务控制参数

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 用户自定语音审核任务开关,可选值:
  • ON:开启自定义语音审核任务;
  • OFF:关闭自定义语音审核任务。

  • 示例值:ON
    LabelSet Array of String 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["自定义语音过滤标签1"]
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    示例值:100
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
    示例值:85

    UserDefineConfigureInfo

    用户自定义审核任务控制参数

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

    名称 类型 必选 描述
    FaceReviewInfo UserDefineFaceReviewTemplateInfo 用户自定义人物审核控制参数。
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfo 用户自定义语音审核控制参数。
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfo 用户自定义文本审核控制参数。

    UserDefineConfigureInfoForUpdate

    用户自定义审核任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    FaceReviewInfo UserDefineFaceReviewTemplateInfoForUpdate 用户自定义人物审核控制参数。
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfoForUpdate 用户自定义语音审核控制参数。
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfoForUpdate 用户自定义文本审核控制参数。

    UserDefineFaceReviewTemplateInfo

    用户自定义人物审核任务控制参数

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

    名称 类型 必选 描述
    Switch String 用户自定义人物审核任务开关,可选值:
  • ON:开启自定义人物审核任务;
  • OFF:关闭自定义人物审核任务。

  • 示例值:ON
    LabelSet Array of String 用户自定义人物过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["自定义人物过滤标签1"]
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 97 分。取值范围:0~100。
    示例值:100
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 95 分。取值范围:0~100。
    示例值:85

    UserDefineFaceReviewTemplateInfoForUpdate

    用户自定义人物审核任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 用户自定义人物审核任务开关,可选值:
  • ON:开启自定义人物审核任务;
  • OFF:关闭自定义人物审核任务。

  • 示例值:ON
    LabelSet Array of String 用户自定义人物过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["自定义人物过滤标签1"]
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    示例值:100
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
    示例值:85

    UserDefineOcrTextReviewTemplateInfo

    用户自定义文本审核任务控制参数

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

    名称 类型 必选 描述
    Switch String 用户自定文本审核任务开关,可选值:
  • ON:开启自定义文本审核任务;
  • OFF:关闭自定义文本审核任务。

  • 示例值:ON
    LabelSet Array of String 用户自定义文本过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["自定义文本过滤标签1"]
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
    示例值:100
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
    示例值:85

    UserDefineOcrTextReviewTemplateInfoForUpdate

    用户自定义文本审核任务控制参数。

    被如下接口引用:ModifyContentReviewTemplate。

    名称 类型 必选 描述
    Switch String 用户自定文本审核任务开关,可选值:
  • ON:开启自定义文本审核任务;
  • OFF:关闭自定义文本审核任务。

  • 示例值:ON
    LabelSet Array of String 用户自定义文本过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。
    标签个数最多 10 个,每个标签长度最多 16 个字符。
    示例值:["entertainment", "sport"]
    BlockConfidence Integer 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
    示例值:90
    ReviewConfidence Integer 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
    示例值:80

    VODInputInfo

    媒体处理 VOD (点播专业版)对象信息。

    被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, DescribeImageTaskDetail, DescribeMediaMetaData, DetectVideoSubtitleArea, ExtractBlindWatermark, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。

    名称 类型 必选 描述
    Bucket String 媒体处理对象文件所在的 Bucket ID
    示例值:a00ehq6ocdmo0exn
    Region String 媒体处理对象文件所在的 Bucket 所属园区
    示例值:ap-chongqing
    Object String 媒体处理对象文件的输入路径
    示例值:/movie/201907/WildAnimal.mov
    SubAppId Integer 点播专业版应用Id
    示例值:220762

    VODOutputStorage

    媒体处理 VOD(点播专业版) 输出对象信息。

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

    名称 类型 必选 描述
    Bucket String 媒体处理生成的文件输出的目标 Bucket ID
    示例值:a00ehq6ocdmo0exn
    Region String 媒体处理生成的文件输出的目标 Bucket 的园区
    示例值:ap-chongqing
    SubAppId Integer 点播专业版应用Id
    示例值:220762

    VideoComprehensionResultItem

    视频分镜理解结果

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

    名称 类型 描述
    StartTime Float 分镜片段起始时间(单位:秒)

    示例值:48.733334
    EndTime Float 分镜片段结束时间(单位:秒)
    示例值:54.166668
    Title String 分镜片段标题
    示例值:有人都以为她出事了,没想到她才是最终赢家
    Description String 分镜片段信息描述
    示例值:朋友焦急地冲过来查看情况,以为她遇到了危险。没想到她只是淡定一笑,原来一切尽在她的掌握之中。
    Keywords Array of String 分镜片段关键词
    示例值:["剧情","反转","爽文","霸气"]

    VideoDBEntryTaskResult

    视频检索入库任务的结果

    被如下接口引用:DescribeVideoDatabaseEntryTaskDetail。

    名称 类型 描述
    VideoId String 入库的视频ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:70f571-****-298377

    VideoDenoiseConfig

    视频降噪配置

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

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

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

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

    VideoEnhanceConfig

    视频增强配置

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

    名称 类型 必选 描述
    FrameRate FrameRateConfig 插帧帧率配置(旧)。新用户建议使用FrameRateWithDen配置插帧帧率,支持分数,且效果更好。注意,FrameRate 与FrameRateWithDen 只能二选一,同时配置可能导致任务失败。源帧率大于等于目标帧率时能力不会生效。

    注意:此字段可能返回 null,表示取不到有效值。
    SuperResolution SuperResolutionConfig 超分配置。源分辨率高于目标分辨率时不对视频做处理。注意与大模型增强不可同时开启。

    注意:此字段可能返回 null,表示取不到有效值。
    Hdr HdrConfig HDR配置。
    注意:此字段可能返回 null,表示取不到有效值。
    Denoise VideoDenoiseConfig 视频降噪配置。注意与大模型增强不可同时开启。

    注意:此字段可能返回 null,表示取不到有效值。
    ImageQualityEnhance ImageQualityEnhanceConfig 综合增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项
    注意:此字段可能返回 null,表示取不到有效值。
    ColorEnhance ColorEnhanceConfig 色彩增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    LowLightEnhance LowLightEnhanceConfig 低光照增强配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ScratchRepair ScratchRepairConfig 去划痕配置。
    注意:此字段可能返回 null,表示取不到有效值。
    ArtifactRepair ArtifactRepairConfig 去伪影(毛刺)配置。注意大模型、综合增强、去毛刺三项里最多配置一项
    注意:此字段可能返回 null,表示取不到有效值。
    EnhanceSceneType String 增强场景配置,可选值:
  • common(通用),通用增强参数,适用于各种视频类型的基础优化参数,提升整体画质。
  • AIGC,整体分辨率提升,利用AI技术提升视频整体分辨率,增强画面清晰度。
  • short_play(短剧),增强面部与字幕细节,突出人物面部表情细节和字幕清晰度,提升观剧体验。
  • short_video(短视频),优化复杂多样的画质问题,针对短视频的复杂场景,优化画质,解决多种视觉问题。
  • game(游戏视频),修复运动模糊,提升细节,重点提升游戏细节清晰度,恢复运动模糊区域,使游戏画面内容更清晰,更丰富。
  • HD_movie_series(超高清影视剧),获得超高清流畅效果,针对广电/OTT超高清视频的诉求,生成4K 60fps HDR的超高清标准视频。支持广电场景格式标准要求。
  • LQ_material(低清素材/老片修复),整体分辨率提升,针对老旧视频由于拍摄年代较久存在的分辨率不足、模糊失真、划痕损伤和色温等问题进行专门优化。
  • lecture(秀场/电商/大会/讲座),美化提升面部效果,针对秀场/电商/大会/讲座等存在人物进行讲解的场景,进行人脸区域、噪声消除、毛刺处理的专门优化。
  • 填空字符串代表不使用增强场景

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:common
    DiffusionEnhance DiffusionEnhanceConfig 大模型增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项。且不可与超分、降噪同时开启。

    注意:此字段可能返回 null,表示取不到有效值。
    FrameRateWithDen FrameRateWithDenConfig 新插帧帧率配置,支持分数。注意与FrameRate二选一。源帧率大于等于目标帧率时能力不会生效。

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

    VideoTemplateInfo

    视频流配置参数

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

    名称 类型 必选 描述
    Codec String 视频流的编码格式,可选值:
  • h264:H.264 编码
  • h265:H.265 编码
  • h266:H.266 编码
  • av1:AOMedia Video 1 编码
  • vp8:VP8 编码
  • vp9:VP9 编码
  • mpeg2:MPEG2 编码
  • dnxhd:DNxHD 编码
  • mv-hevc:MV-HEVC 编码


  • 注意:av1 编码容器目前只支持 mp4 ,webm,mkv。
    注意:H.266 编码容器目前只支持 mp4 ,hls,ts,mov。
    注意:VP8、VP9编码容器目前只支持webm,mkv。
    注意:MPEG2、dnxhd 编码容器目前只支持mxf。
    注意:MV-HEVC编码容器目前只支持mp4,hls,mov。其中hls格式只支持mp4分片格式。且要求输入源为全景视频(带多视角)。
    示例值:h264
    Fps Integer 视频帧率,取值范围:
    当FpsDenominator的值为空时,范围:[0, 120],单位:Hz;
    当FpsDenominator的值不为空时,Fps/FpsDenominator的范围:[0,120]
    当取值为 0,表示帧率和原始视频保持一致。
    示例值:0
    Bitrate Integer 视频流的码率,取值范围:0 和 [128, 100000],单位: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。
    注意:Codec为MV-HEVC时可以支持到7680
    示例值:0
    Height Integer 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    注意:Codec为MV-HEVC时可以支持到7680
    示例值:0
    Gop Integer 关键帧 I 帧之间的间隔,允许按帧或秒自定义GOP长度,取值范围:0 和 [1, 100000],
    当填 0 或不填时,系统将自动设置 gop 长度。
    示例值:0
    GopUnit String Gop数值单位,可选值:
    frame:表示帧
    second:表示秒
    默认值:frame
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:frame
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊填充。
  • smarttailor:智能剪裁:智能选取视频画面,来保证画面比例裁剪。

  • 默认值:black 。
    示例值:black
    Vcrf Integer 视频的恒定码率控制因子,取值范围为[0, 51],不填表示“自动”。如果没有特殊需求,建议不指定该参数。
    当Mode参数设置为VBR时,如果同时配置了Vcrf值,MPS将在VBR模式下处理视频,同时考虑Vcrf和Bitrate参数的设置,以平衡视频质量、码率、转码效率和文件大小。
    当Mode参数设置为CRF,Bitrate设置将失效,编码将根据Vcrf值进行。
    当Mode参数选择ABR或CBR时,无需配置Vcrf值。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    HlsTime Integer 分片平均时长,范围:(0-10],单位:秒
    不填表示自动,将根据视频的GOP等特征自动选择合适的分片时长。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    SegmentType Integer hls 分片类型,可选值 :
  • 0:HLS+TS 切片
  • 2:HLS+TS byte range
  • 7:HLS+MP4 切片
  • 5:HLS+MP4 byte range

  • 默认值:0
    注意:该字段用于普通/极速高清转码设置,对自适应码流不生效,如需给自适应码流配置分片类型,可以使用外层字段
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    FpsDenominator Integer 帧率分母部分
    注意:值必须大于0
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Stereo3dType String 3D视频拼接方式,仅mv-hevc,3D视频生效,可选值:
  • side_by_side:原视频内容左右排列布局
  • top_bottom:原视频内容上下排列布局

  • 计费将按照切分后的分辨率尺寸上报用量及计费;
    默认值:side_by_side
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:side_by_side
    VideoProfile String Profile,适用于不同场景。
    baseline: 只支持I/P帧,并只支持无交错的场景,适用于视频通话、手机视频等场景。
    main: 主流Profile,提供I帧、P帧、B帧,并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。
    high: 最高编码等级,在Main Profile上添加了8X8的预测,并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。
    default:随原视频自动填充。

    仅编码标准选择h264时出现该配置, 支持 baseline/main/high,默认为:default
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:default
    VideoLevel String 编码器级别,默认为自动("")
    若编码标准选择H264: 支持以下选项:"",1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1
    若编码标准选择H265: 支持以下选项:"",1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Bframes Integer 参考帧之间的B帧数,默认选自动,支持 0 - 16
    注意:不填表示使用自动
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Mode String 码率控制模式:可选值:
    VBR(Variable Bit Rate):动态比特率,根据视频画面的复杂度动态调整输出的码率,使得画面质量更高,适用于存储场景和对画面质量要求较高的应用。
    ABR(Average Bit Rate):平均比特率,尽量保持输出视频的平均码率稳定,但允许短期内的码率波动,适用于需要在保持一定画质的情况下尽量减少整体码率的场景。
    CBR(Constant Bit Rate):恒定比特率,指视频编码时输出的码率保持恒定不变,不考虑画面复杂度的变化,适用于对网络带宽要求较为严格的场景,如直播等。
    VCRF(Constant Rate Factor):恒定质量因子,通过设定一个质量因子来控制视频质量,实现视频的恒定质量编码,码率会根据内容的复杂度自动调整,适用于希望保持一定画质的场景。
    默认选择 VBR
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:VBR
    Sar String 显示高宽比,可选值:[1:1,2:1,default]
    默认值:default
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:default
    NoScenecut Integer 自适应I帧决策,开启后,媒体处理将自动识别视频中不同场景之间的过渡点(通常是视觉上显著不同的帧,比如从一个镜头切换到另一个镜头),在这些点自适应插入关键帧(I帧),从而提高视频的随机访问性和编码效率。可选值:
    0:关闭自适应I帧决策
    1:使用自适应I帧决策
    默认值:0
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    BitDepth Integer 比特位:支持8/10,默认为8
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:8
    RawPts Integer 保持原始时间戳:可选值:
    0:表示关闭
    1:表示打开
    默认是关闭
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Compress Integer 按比例压缩码率,开启后,将根据比例来调整输出视频的码率。填写压缩率后,系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100
    不填此值表示不开启,默认不开启
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SegmentSpecificInfo SegmentSpecificInfo 启动时分片时长
    注意:此字段可能返回 null,表示取不到有效值。
    ScenarioBased Integer 模板是否开启场景化
    0:不开启
    1:开启
    默认值:0
    注意:只有此字段值为1时,SceneType和CompressType字段的值才会生效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SceneType String 视频场景化,可选值:
    normal:通用转码场景:通用转码压缩场景。
    pgc:PGC高清影视:压缩时会注重影视剧的观看体验,根据影视剧特性进行ROI编码,同时保留高质量的视频内容和音频。
    materials_video:高清素材:素材资源类场景,对画质要求极高,较多透明画面内容,在压缩的同时接近视觉无损。
    ugc:UGC内容:适用于广泛的UGC/短视频场景,针对短视频的特性优化编码码率, 画质提升,提升业务QOS/QOE指标。
    e-commerce_video:秀场/电商类:压缩时会强调细节清晰度和ROI区域提升,尤其注重保持人脸区域的画质。
    educational_video:教育类:压缩时会强调文字和图像的清晰度和可读性,以便学生更好地理解内容,确保讲解内容清晰传达。
    默认值:normal
    注意:要使用此值ScenarioBased的值必须为1,否则此值不生效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:normal
    CompressType String 转码策略,可选值:
    ultra_compress:极致压缩:相比标准压缩,该策略能在保证一定画质的基础上最大限度压缩码率,极大节约带宽和存储成本。
    standard_compress:综合最优:平衡压缩率与画质,在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。
    high_compress:码率优先:优先保证降低文件体积大小,可能有一定画质损失。该策略仅收取音视频极速高清转码费用。
    low_compress:画质优先:优先保证画质,压缩出来的文件体积可能相对较大。该策略仅收取音视频极速高清转码费用。
    默认值:standard_compress
    注:若需要在电视上观看视频,不建议使用ultra_compress策略。ultra_compress策略计费标准为极速高清转码 + 音视频增强-去毛刺。
    注意:要使用此值ScenarioBased的值必须为1,否则此值不生效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:standard_compress

    VideoTemplateInfoForUpdate

    视频流配置参数

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

    名称 类型 必选 描述
    Codec String 视频流的编码格式,可选值:
  • h264:H.264 编码
  • h265:H.265 编码
  • h266:H.266 编码
  • av1:AOMedia Video 1 编码
  • vp8:VP8 编码
  • vp9:VP9 编码
  • mpeg2:MPEG2 编码
  • dnxhd:DNxHD 编码
  • mv-hevc:MV-HEVC 编码


  • 注意:av1 编码容器目前只支持 mp4 ,webm,mkv。
    注意:H.266 编码容器目前只支持 mp4 ,hls,ts,mov。
    注意:VP8、VP9编码容器目前只支持webm,mkv。
    注意:MPEG2、dnxhd 编码容器目前只支持mxf。
    注意:MV-HEVC编码容器目前只支持mp4,hls,mov。其中hls格式只支持mp4分片格式。且要求输入源为全景视频(带多视角)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:h264
    Fps Integer 视频帧率,取值范围:
    当FpsDenominator的值为空时,范围:[0, 120],单位:Hz;
    当FpsDenominator的值不为空时,Fps/FpsDenominator的范围:[0,120]
    当取值为 0,表示帧率和原始视频保持一致。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Bitrate Integer 视频流的码率,取值范围:0 和 [128, 100000],单位: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,则分辨率按用户指定。

  • 注意:Codec为MV-HEVC时可以支持到7680
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Height Integer 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
    注意:Codec为MV-HEVC时可以支持到7680
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Gop Integer 关键帧 I 帧之间的间隔,允许按帧或秒自定义GOP长度,取值范围:0 和 [1, 100000]。
    当填 0 时,系统将自动设置 gop 长度。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    GopUnit String Gop数值单位,可选值:
    frame:表示帧
    second:表示秒
    默认值:frame
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:frame
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
  • white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。
  • gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊填充。
  • smarttailor:智能剪裁:智能选取视频画面,来保证画面比例裁剪。

  • 默认值:black 。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:black
    Vcrf Integer 视频的恒定码率控制因子,取值范围为[0, 51],不填表示“自动”。如果没有特殊需求,建议不指定该参数。
    当Mode参数设置为VBR时,如果同时配置了Vcrf值,MPS将在VBR模式下处理视频,同时考虑Vcrf和Bitrate参数的设置,以平衡视频质量、码率、转码效率和文件大小。
    当Mode参数设置为CRF,Bitrate设置将失效,编码将根据Vcrf值进行。
    当Mode参数选择ABR或CBR时,无需配置Vcrf值。
    注意:需要修改为自动时,填100

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ContentAdaptStream Integer 内容自适应编码。可选值:
  • 0:不开启
  • 1:开启

  • 默认值: 0. 当开启该参数时,将会自适应生成多个不同分辨率,不同码率的码流, 其中VideoTemplate的宽和高为多个码流中的最大分辨率,VideoTemplate中的码率为多个码流中的最高码率, VideoTemplate中的vcrf为多个码流中的最高质量。 当不设置分辨率、码率和vcrf时, ContentAdaptStream 参数生成的最高分辨率为视频源的分辨率,视频质量为接近vmaf95分。 若要开启该参数或了解计费细节, 请联系您的腾讯云商务。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    HlsTime Integer 分片平均时长,取值范围:(0-10],单位:秒
    默认值:10
    注意:只在封装格式HLS时使用
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    SegmentType Integer hls 分片类型,可选值:
  • 0:HLS+TS 切片
  • 2:HLS+TS byte range
  • 7:HLS+MP4 切片
  • 5:HLS+MP4 byte range

  • 默认值:0
    注意:该字段用于普通/极速高清转码设置,对自适应码流不生效,如需给自适应码流配置分片类型,可以使用外层字段
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    FpsDenominator Integer 帧率分母部分
    注意:值必须大于0
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Stereo3dType String 3D视频拼接方式,仅mv-hevc,3D视频生效,可选值:
  • side_by_side:原视频内容左右排列布局
  • top_bottom:原视频内容上下排列布局

  • 计费将按照切分后的分辨率尺寸上报用量及计费;
    默认值:side_by_side
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:side_by_side
    VideoProfile String Profile,适用于不同场景。
    baseline: 只支持I/P帧,并只支持无交错的场景,适用于视频通话、手机视频等场景。
    main: 主流Profile,提供I帧、P帧、B帧,并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。
    high: 最高编码等级,在Main Profile上添加了8X8的预测,并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。
    default:随原视频自动填充

    仅编码标准选择h264时出现该配置,默认为:default
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:default
    VideoLevel String 编码器级别,默认为自动("")
    若编码标准选择H264: 支持以下选项:"",1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1
    若编码标准选择H265: 支持以下选项:"",1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Bframes Integer 最大连续B帧数,默认选自动,支持 0 - 16和-1
    注意:
    -1表示修改为自动值
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Mode String 码率控制模式:可选值:
    VBR(Variable Bit Rate):动态比特率,根据视频画面的复杂度动态调整输出的码率,使得画面质量更高,适用于存储场景和对画面质量要求较高的应用。
    ABR(Average Bit Rate):平均比特率,尽量保持输出视频的平均码率稳定,但允许短期内的码率波动,适用于需要在保持一定画质的情况下尽量减少整体码率的场景。
    CBR(Constant Bit Rate):恒定比特率,指视频编码时输出的码率保持恒定不变,不考虑画面复杂度的变化,适用于对网络带宽要求较为严格的场景,如直播等。
    VCRF(Constant Rate Factor):恒定质量因子,通过设定一个质量因子来控制视频质量,实现视频的恒定质量编码,码率会根据内容的复杂度自动调整,适用于希望保持一定画质的场景。
    默认选择 VBR
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:VBR
    Sar String 显示高宽比,可选值:[1:1,2:1,default]
    默认值:default
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:default
    NoScenecut Integer 自适应I帧决策,开启后,媒体处理将自动识别视频中不同场景之间的过渡点(通常是视觉上显著不同的帧,比如从一个镜头切换到另一个镜头),在这些点自适应插入关键帧(I帧),从而提高视频的随机访问性和编码效率。可选值:
    0:关闭自适应I帧决策
    1:使用自适应I帧决策
    默认值:0
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    BitDepth Integer 比特位:支持8/10,默认为8
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:8
    RawPts Integer 保持原始时间戳:可选值:
    0:表示关闭
    1:表示打开
    默认是关闭
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Compress Integer 按比例压缩码率,开启后,将根据比例来调整输出视频的码率。填写压缩率后,系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100,可选值:[0-100]和-1
    注意:-1表示修改为自动
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SegmentSpecificInfo SegmentSpecificInfo 启动时分片时长
    注意:此字段可能返回 null,表示取不到有效值。
    ScenarioBased Integer 模板是否开启场景化
    0:不开启
    1:开启
    默认值:0
    注意:只有此字段值为1时,SceneType和CompressType字段的值才会生效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SceneType String 视频场景化,可选值:
    normal:通用转码场景:通用转码压缩场景 pgc:PGC高清影视:压缩时会注重影视剧的观看体验,根据影视剧特性进行ROI编码,同时保留高质量的视频内容和音频。
    materials_video:高清素材:素材资源类场景,对画质要求极高,较多透明画面内容,在压缩的同时接近视觉无损。
    ugc:UGC内容:适用于广泛的UGC/短视频场景,针对短视频的特性优化编码码率, 画质提升,提升业务QOS/QOE指标。
    e-commerce_video:秀场/电商类:压缩时会强调细节清晰度和ROI区域提升,尤其注重保持人脸区域的画质。
    educational_video:教育类:压缩时会强调文字和图像的清晰度和可读性,以便学生更好地理解内容,确保讲解内容清晰传达。
    默认值:normal
    注意:要使用此值ScenarioBased的值必须为1,否则此值不生效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:normal
    CompressType String 转码策略,可选值:
    ultra_compress:极致压缩:相比标准压缩,该策略能在保证一定画质的基础上最大限度压缩码率,极大节约带宽和存储成本。
    standard_compress:综合最优:平衡压缩率与画质,在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。
    high_compress:码率优先:优先保证降低文件体积大小,可能有一定画质损失。该策略仅收取音视频极速高清转码费用。
    low_compress:画质优先:优先保证画质,压缩出来的文件体积可能相对较大。该策略仅收取音视频极速高清转码费用。
    默认值:standard_compress
    注:若需要在电视上观看视频,不建议使用ultra_compress策略。ultra_compress策略计费标准为极速高清转码 + 音视频增强-去毛刺。
    注意:要使用此值ScenarioBased的值必须为1,否则此值不生效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:standard_compress

    VoiceInfo

    音色信息

    被如下接口引用:DescribeVoices, UpdateVoice。

    名称 类型 必选 描述
    VoiceId String

    音色ID


    示例值:s1_NTEwPE5DPwpdXDH2X2CM/YFaeHm73AGz8NmUwRJti8zvCO0BmWRc+Rz4
    Name String

    音色名


    示例值:甜美女声
    Description String

    音色描述信息


    示例值:一位温柔甜美的青年女性声音,标准普通话。
    Category String

    音色类别

    枚举值:

    • system: 系统音色

    示例值:system
    Gender String

    性别

    枚举值:

    • male: 男
    • famale: 女

    示例值:male
    Age String

    年龄

    枚举值:

    • child: 儿童
    • teenager: 少年
    • youth: 青年
    • middle_aged: 中年
    • senior: 老年
    • unknown: 未知

    示例值:youth
    Languages Array of String

    支持语种列表

    如:en


    示例值:["zh"]
    AudioUrl String

    试听音频URL


    示例值:https://ie-mps-1258344699.cos.ap-nanjing.myqcloud.com/common/lauriehuang/dubbing/voice/samples/s1_3NM2Z1I1O.wav
    Labels Array of String

    标签列表

    如:温柔


    示例值:["温柔"]
    Scenes Array of String

    推荐场景

    如:教育


    示例值:["教学"]

    VoiceProfile

    音色属性

    被如下接口引用:DesignVoiceAsync, SyncDubbing。

    名称 类型 必选 描述
    Name String

    音色名


    示例值:clone-test
    Description String

    音色描述


    示例值:这是一个克隆音色
    Gender String

    性别

    枚举值:

    • male: 男性
    • female: 女性
    • unknown: 未知

    示例值:female
    Age String

    年龄

    枚举值:

    • child: 儿童
    • teenager: 少年
    • youth: 青年
    • middle_aged: 中年
    • senior: 老年
    • unknown: 未知

    示例值:middle_aged
    Languages Array of String

    语言,当前支持:
    zh 中文 (Chinese)
    en 英语 (English)
    ja 日语 (Japanese)
    de 德语 (German)
    fr 法语 (French)
    ko 韩语 (Korean)
    ru 俄语 (Russian)
    uk 乌克兰语 (Ukrainian)
    pt 葡萄牙语 (Portuguese)
    it 意大利语 (Italian)
    es 西班牙语 (Spanish)
    id 印度尼西亚语 (Indonesian)
    nl 荷兰语 (Dutch)
    tr 土耳其语 (Turkish)
    fil 菲律宾语 (Filipino)
    ms 马来语 (Malay)
    el 希腊语 (Greek)
    fi 芬兰语 (Finnish)
    hr 克罗地亚语 (Croatian)
    sk 斯洛伐克语 (Slovak)
    pl 波兰语 (Polish)
    sv 瑞典语 (Swedish)
    hi 印地语 (Hindi)
    bg 保加利亚语 (Bulgarian)
    ro 罗马尼亚语 (Romanian)
    ar 阿拉伯语 (Arabic)
    cs 捷克语 (Czech)
    da 丹麦语 (Danish)
    ta 泰米尔语 (Tamil)
    hun 匈牙利语(Hungarian)
    vi 越南语(Vietnamese)
    no 挪威语(Norwegian)
    yue 粤语(Cantonese)
    th 泰语(Thai)
    he 希伯来语(Hebrew)
    ca 加泰罗尼亚语(Catalan)
    nn 尼诺斯克语(Nynorsk)
    af 阿非利卡语(Afrikaans)
    fa 波斯语(Persian)
    sl 斯洛文尼亚语(Slovenian)


    示例值:["zh"]
    Labels Array of String

    标签


    示例值:["磁性"]
    Scenes Array of String

    使用场景


    示例值:["解说"]

    VoiceUpdateFields

    音色更新字段

    被如下接口引用:UpdateVoice。

    名称 类型 必选 描述
    Name String

    音色名


    示例值:update-voice
    Description String

    音色描述


    示例值:温柔动听的年轻女声
    Gender String

    性别

    枚举值:

    • male: 男
    • female: 女
    • unknown: 未知

    示例值:male
    Age String

    年龄

    枚举值:

    • child: 儿童
    • teenager: 少年
    • youth: 青年
    • middle_aged: 中年
    • senior: 老年
    • unknown: 未知

    示例值:youth
    Languages Array of String

    语言


    示例值:["zh"]
    Labels Array of String

    标签


    示例值:["温柔"]
    Scenes Array of String

    场景


    示例值:["通用"]
    AudioUrl String

    试听音频


    示例值:https://laurie-tmp-1300828900.cos.ap-nanjing.myqcloud.com/sync_dubbing/27111c32-93e3-476e-8ab5-e7fb5838f994.wav

    VolumeBalanceConfig

    音量均衡配置

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

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

  • 默认值:ON。
    示例值:ON
    Type String 类型,可选值:
  • loudNorm:响度标准化
  • gainControl:减小突变

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

    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 水印模板唯一标识。
    示例值:222400
    Type String 水印类型,取值:
  • image:图片水印;
  • text:文字水印。

  • 示例值:image
    Name String 水印模板名称。
    示例值:水印模板
    Comment String 模板描述信息。
    示例值:水印模板
    XPos String 水印图片原点距离视频图像原点的水平位置。
  • 当字符串以 % 结尾,表示水印 Left 为视频宽度指定百分比的位置,如 10% 表示 Left 为视频宽度的 10%;
  • 当字符串以 px 结尾,表示水印 Left 为视频宽度指定像素的位置,如 100px 表示 Left 为 100 像素。

  • 示例值:5%
    YPos String 水印图片原点距离视频图像原点的垂直位置。
  • 当字符串以 % 结尾,表示水印 Top 为视频高度指定百分比的位置,如 10% 表示 Top 为视频高度的 10%;
  • 当字符串以 px 结尾,表示水印 Top 为视频高度指定像素的位置,如 100px 表示 Top 为 100 像素。

  • 示例值:5%
    ImageTemplate ImageWatermarkTemplate 图片水印模板,仅当 Type 为 image,该字段有效。
    注意:此字段可能返回 null,表示取不到有效值。
    TextTemplate TextWatermarkTemplateInput 文字水印模板,仅当 Type 为 text,该字段有效。
    注意:此字段可能返回 null,表示取不到有效值。
    SvgTemplate SvgWatermarkInput SVG 水印模板,当 Type 为 svg,该字段有效。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    示例值:2024-04-30T16:40:14+08:00
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    示例值:2024-04-30T16:40:14+08:00
    CoordinateOrigin String 原点位置,可选值:
  • TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;
  • TopRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
  • BottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
  • BottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。

  • 示例值:TopLeft

    WordResult

    字词信息。

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

    名称 类型 描述
    Word String 字词文本。
    示例值:腾讯云
    Start Float 字词起始时间戳,单位秒。
    示例值:3.204
    End Float 字词结束时间戳,单位秒。
    示例值:5.404
    Trans String 翻译文本
    示例值:Tencent Cloud

    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。
    示例值:2xxxx-asdews
    Status String 任务流状态,取值:
  • PROCESSING:处理中;
  • FINISH:已完成。

  • 示例值:PROCESSING
    ErrCode Integer 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。
    示例值:0
    Message String 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。
    示例值:SUCCESS
    InputInfo MediaInputInfo 媒体处理的目标文件信息。
    注意:此字段可能返回 null,表示取不到有效值。
    MetaData MediaMetaData 原始视频的元信息。
    注意:此字段可能返回 null,表示取不到有效值。
    MediaProcessResultSet Array of MediaProcessTaskResult 媒体处理任务的执行状态与结果。
    AiContentReviewResultSet Array of AiContentReviewResult 视频内容审核任务的执行状态与结果。
    AiAnalysisResultSet Array of AiAnalysisResult 视频内容分析任务的执行状态与结果。
    AiRecognitionResultSet Array of AiRecognitionResult 视频内容识别任务的执行状态与结果。
    AiQualityControlTaskResult ScheduleQualityControlTaskResult 媒体质检任务的执行状态与结果。
    注意:此字段可能返回 null,表示取不到有效值。
    SmartSubtitlesTaskResult Array of SmartSubtitlesResult 智能字幕任务的执行结果
    注意:此字段可能返回 null,表示取不到有效值。
    SmartEraseTaskResult SmartEraseTaskResult 智能擦除任务的执行结果
    注意:此字段可能返回 null,表示取不到有效值。

    WorkflowTrigger

    输入规则,当上传视频命中该规则时,即触发工作流。

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

    名称 类型 必选 描述
    Type String 触发器的类型,可选值:
  • CosFileUpload:COS触发
  • AwsS3FileUpload:AWS触发,目前只支持转码任务。只有编排支持,工作流不支持。



  • 示例值:CosFileUpload
    CosFileUploadTrigger CosFileUploadTrigger 当 Type 为 CosFileUpload 时必填且有效,为 COS 触发规则。
    注意:此字段可能返回 null,表示取不到有效值。
    AwsS3FileUploadTrigger AwsS3FileUploadTrigger 当 Type 为 AwsS3FileUpload 时必填且有效,为 AWS S3 触发规则。

    注意:目前AWS的S3、对应触发队列SQS、回调队列SQS的秘钥需要一致。
    注意:此字段可能返回 null,表示取不到有效值。