数据结构

最近更新时间:2019-09-05 17:51:20

AiAnalysisTaskInput

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

被如下接口引用:DescribeWorkflows、ProcessLiveMedia。

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

AiContentReviewTaskInput

智能内容审核任务类型

被如下接口引用:DescribeWorkflows。

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

AiRecognitionTaskInput

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

被如下接口引用:DescribeWorkflows、ProcessLiveMedia。

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

AnimatedGraphicTaskInput

转动图任务类型。

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

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

AnimatedGraphicsTemplate

转动图模板详情。

被如下接口引用:DescribeAnimatedGraphicsTemplates。

名称 类型 描述
Definition Integer 转动图模板唯一标识。
Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • Name String 转动图模板名称。
    Comment String 转动图模板描述。
    Width Integer 动图宽度(或长边)的最大值。
    Height Integer 动图高度(或短边)的最大值。
    Format String 动图格式。
    Fps Integer 帧率。
    Quality Float 图片质量。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式

    AudioTemplateInfo

    音频流配置参数

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

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

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

  • 当外层参数 Container 为 m4a 时,可选值为:
  • libfdk_aac;
  • libmp3lame;
  • ac3。

  • 当外层参数 Container 为 mp4 或 flv 时,可选值为:
  • libfdk_aac:更适合 mp4;
  • libmp3lame:更适合 flv;
  • mp2。

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

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

  • 默认值:2。

    AudioTemplateInfoForUpdate

    音频流配置参数

    被如下接口引用:ModifyTranscodeTemplate。

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

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

  • 当外层参数 Container 为 m4a 时,可选值为:
  • libfdk_aac;
  • libmp3lame;
  • ac3。

  • 当外层参数 Container 为 mp4 或 flv 时,可选值为:
  • libfdk_aac:更适合 mp4;
  • libmp3lame:更适合 flv;
  • mp2。

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

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

    绑定到 COS 的输入规则。

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

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

    CosInputInfo

    视频处理 COS 对象信息。

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

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

    CosOutputStorage

    视频处理 COS 输出对象信息。

    被如下接口引用:CreateWorkflow、DescribeTaskDetail、DescribeWorkflows、ProcessLiveMedia、ProcessMedia、ResetWorkflow。

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

    ImageSpriteTaskInput

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

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

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

    ImageSpriteTemplate

    雪碧图模板详情

    被如下接口引用:DescribeImageSpriteTemplates。

    名称 类型 描述
    Definition Integer 雪碧图模板唯一标识。
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • Name String 雪碧图模板名称。
    Width Integer 雪碧图中小图的宽度。
    Height Integer 雪碧图中小图的高度。
    SampleType String 采样类型。
    SampleInterval Integer 采样间隔。
    RowCount Integer 雪碧图中小图的行数。
    ColumnCount Integer 雪碧图中小图的列数。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式

    ImageWatermarkInput

    图片水印模板输入参数

    被如下接口引用:CreateWatermarkTemplate。

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

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

  • 默认值:0px,表示 Height 按照原始水印图片的宽高比缩放。

    ImageWatermarkInputForUpdate

    图片水印模板输入参数

    被如下接口引用:ModifyWatermarkTemplate。

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

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

    ImageWatermarkTemplate

    图片水印模板

    被如下接口引用:DescribeWatermarkTemplates。

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

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

    MediaAnimatedGraphicsItem

    视频转动图结果信息

    被如下接口引用:DescribeTaskDetail。

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

    MediaAudioStreamItem

    点播文件音频流信息

    被如下接口引用:DescribeTaskDetail。

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

    MediaImageSpriteItem

    雪碧图信息

    被如下接口引用:DescribeTaskDetail。

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

    MediaInputInfo

    视频处理输入对象信息。

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

    名称 类型 必选 描述
    Type String 视频处理对象的类型,现在仅支持 COS。
    CosInputInfo CosInputInfo 当 Type 为 COS 时有效,则该项为必填,表示视频处理 COS 对象信息。

    MediaMetaData

    点播媒体文件元信息

    被如下接口引用:DescribeTaskDetail。

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

    MediaProcessTaskAnimatedGraphicResult

    转动图任务结果类型

    被如下接口引用:DescribeTaskDetail。

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

    MediaProcessTaskImageSpriteResult

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

    被如下接口引用:DescribeTaskDetail。

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

    MediaProcessTaskInput

    视频处理任务类型

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

    名称 类型 必选 描述
    TranscodeTaskSet Array of TranscodeTaskInput 视频转码任务列表。
    AnimatedGraphicTaskSet Array of AnimatedGraphicTaskInput 视频转动图任务列表。
    SnapshotByTimeOffsetTaskSet Array of SnapshotByTimeOffsetTaskInput 对视频按时间点截图任务列表。
    SampleSnapshotTaskSet Array of SampleSnapshotTaskInput 对视频采样截图任务列表。
    ImageSpriteTaskSet Array of ImageSpriteTaskInput 对视频截雪碧图任务列表。

    MediaProcessTaskResult

    任务查询结果类型

    被如下接口引用:DescribeTaskDetail。

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

    MediaProcessTaskSampleSnapshotResult

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

    被如下接口引用:DescribeTaskDetail。

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

    MediaProcessTaskSnapshotByTimeOffsetResult

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

    被如下接口引用:DescribeTaskDetail。

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

    MediaProcessTaskTranscodeResult

    转码任务结果类型

    被如下接口引用:DescribeTaskDetail。

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

    MediaSampleSnapshotItem

    采样截图信息

    被如下接口引用:DescribeTaskDetail。

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

    MediaSnapshotByTimeOffsetItem

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

    被如下接口引用:DescribeTaskDetail。

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

    MediaSnapshotByTimePicInfoItem

    指定时间点截图信息

    被如下接口引用:DescribeTaskDetail。

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

    MediaTranscodeItem

    转码信息

    被如下接口引用:DescribeTaskDetail。

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

    MediaVideoStreamItem

    点播文件视频流信息

    被如下接口引用:DescribeTaskDetail。

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

    NumberFormat

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

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

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

    SampleSnapshotTaskInput

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

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

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

    SampleSnapshotTemplate

    采样截图模板详情

    被如下接口引用:DescribeSampleSnapshotTemplates。

    名称 类型 描述
    Definition Integer 采样截图模板唯一标识。
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • Name String 采样截图模板名称。
    Comment String 模板描述信息。
    Width Integer 图片宽度。
    Height Integer 图片高度。
    Format String 图片格式。
    SampleType String 采样截图类型。
    SampleInterval Integer 采样间隔。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式

    SnapshotByTimeOffsetTaskInput

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

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

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

    SnapshotByTimeOffsetTemplate

    时间点截图模板详情

    被如下接口引用:DescribeSnapshotByTimeOffsetTemplates。

    名称 类型 描述
    Definition Integer 时间点截图模板唯一标识。
    Type String 模板类型,取值范围:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • Name String 时间点截图模板名称。
    Comment String 模板描述信息。
    Width Integer 图片宽度。
    Height Integer 图片高度。
    Format String 图片格式。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式

    SvgWatermarkInput

    SVG水印模板输入参数

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

    名称 类型 必选 描述
    Width String 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式:
  • 当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;当填 0px 且
    Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度;
  • 当字符串以 W% 结尾,表示水印 Width 为视频宽度的百分比大小,如 10W% 表示 Width 为视频宽度的 10%;
  • 当字符串以 H% 结尾,表示水印 Width 为视频高度的百分比大小,如 10H% 表示 Width 为视频高度的 10%;
  • 当字符串以 S% 结尾,表示水印 Width 为视频短边的百分比大小,如 10S% 表示 Width 为视频短边的 10%;
  • 当字符串以 L% 结尾,表示水印 Width 为视频长边的百分比大小,如 10L% 表示 Width 为视频长边的 10%;
  • 当字符串以 % 结尾时,含义同 W%。

  • 默认值为 10W%。
    Height String 水印的高度,支持 px,W%,H%,S%,L% 六种格式:
  • 当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素;当填 0px 且
    Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度;
  • 当字符串以 W% 结尾,表示水印 Height 为视频宽度的百分比大小,如 10W% 表示 Height 为视频宽度的 10%;
  • 当字符串以 H% 结尾,表示水印 Height 为视频高度的百分比大小,如 10H% 表示 Height 为视频高度的 10%;
  • 当字符串以 S% 结尾,表示水印 Height 为视频短边的百分比大小,如 10S% 表示 Height 为视频短边的 10%;
  • 当字符串以 L% 结尾,表示水印 Height 为视频长边的百分比大小,如 10L% 表示 Height 为视频长边的 10%;
  • 当字符串以 % 结尾时,含义同 H%。

  • 默认值为 0px。

    SvgWatermarkInputForUpdate

    SVG水印模板输入参数

    被如下接口引用:ModifyWatermarkTemplate。

    名称 类型 必选 描述
    Width String 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式:
  • 当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;当填 0px 且
    Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度;
  • 当字符串以 W% 结尾,表示水印 Width 为视频宽度的百分比大小,如 10W% 表示 Width 为视频宽度的 10%;
  • 当字符串以 H% 结尾,表示水印 Width 为视频高度的百分比大小,如 10H% 表示 Width 为视频高度的 10%;
  • 当字符串以 S% 结尾,表示水印 Width 为视频短边的百分比大小,如 10S% 表示 Width 为视频短边的 10%;
  • 当字符串以 L% 结尾,表示水印 Width 为视频长边的百分比大小,如 10L% 表示 Width 为视频长边的 10%;
  • 当字符串以 % 结尾时,含义同 W%。

  • 默认值为 10W%。
    Height String 水印的高度,支持 px,%,W%,H%,S%,L% 六种格式:
  • 当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素;当填 0px 且
    Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度;
  • 当字符串以 W% 结尾,表示水印 Height 为视频宽度的百分比大小,如 10W% 表示 Height 为视频宽度的 10%;
  • 当字符串以 H% 结尾,表示水印 Height 为视频高度的百分比大小,如 10H% 表示 Height 为视频高度的 10%;
  • 当字符串以 S% 结尾,表示水印 Height 为视频短边的百分比大小,如 10S% 表示 Height 为视频短边的 10%;
  • 当字符串以 L% 结尾,表示水印 Height 为视频长边的百分比大小,如 10L% 表示 Height 为视频长边的 10%;
  • 当字符串以 % 结尾时,含义同 H%。
    默认值为 0px。
  • TEHDConfig

    极速高清参数配置。

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

    名称 类型 必选 描述
    Type String 极速高清类型,可选值:
  • TEHD-100:极速高清-100。

  • 不填代表不启用极速高清。
    MaxVideoBitrate Integer 视频码率上限,当 Type 指定了极速高清类型时有效。
    不填或填0表示不设视频码率上限。

    TEHDConfigForUpdate

    极速高清参数配置。

    被如下接口引用:ModifyTranscodeTemplate。

    名称 类型 必选 描述
    Type String 极速高清类型,可选值:
  • TEHD-100:极速高清-100。

  • 不填代表不修改。
    MaxVideoBitrate Integer 视频码率上限,不填代表不修改。

    TaskNotifyConfig

    任务的事件通知配置。

    被如下接口引用:CreateWorkflow、DescribeTaskDetail、DescribeWorkflows、ProcessLiveMedia、ProcessMedia、ResetWorkflow。

    名称 类型 必选 描述
    CmqModel String CMQ 的模型,有 Queue 和 Topic 两种,目前仅支持 Queue。
    CmqRegion String CMQ 的园区,如 sh,bj 等。
    QueueName String 当模型为 Queue 时有效,表示接收事件通知的 CMQ 的队列名。
    TopicName String 当模型为 Topic 时有效,表示接收事件通知的 CMQ 的主题名。
    NotifyMode String 工作流通知的模式,可取值有 Finish 和 Change,不填代表 Finish。

    TaskOutputStorage

    视频处理输出对象信息。

    被如下接口引用:CreateWorkflow、DescribeTaskDetail、DescribeWorkflows、ProcessLiveMedia、ProcessMedia、ResetWorkflow。

    名称 类型 必选 描述
    Type String 视频处理输出对象存储位置的类型,现在仅支持 COS。
    CosOutputStorage CosOutputStorage 当 Type 为 COS 时有效,则该项为必填,表示视频处理 COS 输出位置。
    注意:此字段可能返回 null,表示取不到有效值。

    TaskSimpleInfo

    任务概要信息

    被如下接口引用:DescribeTasks。

    名称 类型 描述
    TaskId String 任务 ID。
    TaskType String 任务类型,目前仅支持 WorkflowTask。
    CreateTime String 任务创建时间,使用 ISO 日期格式
    BeginProcessTime String 任务开始执行时间,使用 ISO 日期格式。若任务尚未开始,该字段为:0000-00-00T00:00:00Z。
    FinishTime String 任务结束时间,使用 ISO 日期格式。若任务尚未完成,该字段为:0000-00-00T00:00:00Z。

    TextWatermarkTemplateInput

    文字水印模板

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

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

  • 默认值:1。

    TextWatermarkTemplateInputForUpdate

    文字水印模板

    被如下接口引用:ModifyWatermarkTemplate。

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

    转码任务输入参数类型

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

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

    TranscodeTemplate

    转码模板详情

    被如下接口引用:DescribeTranscodeTemplates。

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

    VideoTemplateInfo

    视频流配置参数

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

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

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

  • 默认值:open。
    Width Integer 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    Height Integer 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。

  • 默认值:black 。

    VideoTemplateInfoForUpdate

    视频流配置参数

    被如下接口引用:ModifyTranscodeTemplate。

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

  • 目前 H.265 编码必须指定分辨率,并且需要在 640*480 以内。
    Fps Integer 视频帧率,取值范围:[0, 60],单位:Hz。
    当取值为 0,表示帧率和原始视频保持一致。
    Bitrate Integer 视频流的码率,取值范围:0 和 [128, 35000],单位:kbps。
    当取值为 0,表示视频码率和原始视频保持一致。
    ResolutionAdaptive String 分辨率自适应,可选值:
  • open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
  • close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。
  • Width Integer 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。
  • Height Integer 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。

  • 默认值:black 。

    WatermarkInput

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

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

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

    WatermarkTemplate

    水印模板详情

    被如下接口引用:DescribeWatermarkTemplates。

    名称 类型 描述
    Definition Integer 水印模板唯一标识。
    Type String 水印类型,取值:
  • image:图片水印;
  • text:文字水印。
  • Name String 水印模板名称。
    Comment String 模板描述信息。
    XPos String 水印图片原点距离视频图像原点的水平位置。
  • 当字符串以 % 结尾,表示水印 Left 为视频宽度指定百分比的位置,如 10% 表示 Left 为视频宽度的 10%;
  • 当字符串以 px 结尾,表示水印 Left 为视频宽度指定像素的位置,如 100px 表示 Left 为 100 像素。
  • YPos String 水印图片原点距离视频图像原点的垂直位置。
  • 当字符串以 % 结尾,表示水印 Top 为视频高度指定百分比的位置,如 10% 表示 Top 为视频高度的 10%;
  • 当字符串以 px 结尾,表示水印 Top 为视频高度指定像素的位置,如 100px 表示 Top 为 100 像素。
  • ImageTemplate ImageWatermarkTemplate 图片水印模板,仅当 Type 为 image,该字段有效。
    注意:此字段可能返回 null,表示取不到有效值。
    TextTemplate TextWatermarkTemplateInput 文字水印模板,仅当 Type 为 text,该字段有效。
    注意:此字段可能返回 null,表示取不到有效值。
    SvgTemplate SvgWatermarkInput SVG 水印模板,当 Type 为 svg,该字段有效。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 模板创建时间,使用 ISO 日期格式
    UpdateTime String 模板最后修改时间,使用 ISO 日期格式
    CoordinateOrigin String 原点位置,可选值:
  • topLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;
  • topRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
  • bottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
  • bottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下。;
  • WorkflowInfo

    工作流信息详情。

    被如下接口引用:DescribeWorkflows。

    名称 类型 描述
    WorkflowId Integer 工作流 ID。
    WorkflowName String 工作流名称。
    Status String 工作流状态,取值范围:
  • Enabled:已启用,
  • Disabled:已禁用。
  • Trigger WorkflowTrigger 工作流绑定的输入规则,当上传视频命中该规则到该对象时即触发工作流。
    OutputStorage TaskOutputStorage 视频处理的文件输出存储位置。
    注意:此字段可能返回 null,表示取不到有效值。
    MediaProcessTask MediaProcessTaskInput 视频处理类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    AiContentReviewTask AiContentReviewTaskInput 视频内容审核类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    AiAnalysisTask AiAnalysisTaskInput 视频内容分析类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    AiRecognitionTask AiRecognitionTaskInput 视频内容识别类型任务参数。
    注意:此字段可能返回 null,表示取不到有效值。
    TaskNotifyConfig TaskNotifyConfig 任务的事件通知信息,不填代表不获取事件通知。
    注意:此字段可能返回 null,表示取不到有效值。
    TaskPriority Integer 任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
    OutputDir String 视频处理生成的文件输出的目标目录,如/movie/201907/
    CreateTime String 工作流创建时间,使用 ISO 日期格式
    UpdateTime String 工作流最后修改时间,使用 ISO 日期格式

    WorkflowTask

    视频处理任务信息

    被如下接口引用:DescribeTaskDetail。

    名称 类型 描述
    TaskId String 视频处理任务 ID。
    Status String 任务流状态,取值:
  • PROCESSING:处理中;
  • FINISH:已完成。
  • ErrCode Integer 错误码
  • 0:成功;
  • 其他值:失败。
  • Message String 错误信息。
    InputInfo MediaInputInfo 视频处理的目标文件信息。
    注意:此字段可能返回 null,表示取不到有效值。
    MetaData MediaMetaData 原始视频的元信息。
    注意:此字段可能返回 null,表示取不到有效值。
    MediaProcessResultSet Array of MediaProcessTaskResult 视频处理任务的执行状态与结果。

    WorkflowTrigger

    输入规则,当上传视频命中该规则时,即触发工作流。

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

    名称 类型 必选 描述
    Type String 触发器的类型,目前仅支持 CosFileUpload。
    CosFileUploadTrigger CosFileUploadTrigger 当 Type 为 CosFileUpload 时必填且有效,为 COS 触发规则。
    注意:此字段可能返回 null,表示取不到有效值。