全部产品
Search
文档中心

媒体处理:SubmitJobs - 提交转码作业

更新时间:Dec 26, 2024

提交转码作业。当控制台创建的转码任务和工作流均无法满足您的使用场景时,可以按需调用SubmitJobs接口进行转码。根据您的业务逻辑配置所需的转码参数即可。

接口说明

  • 转码作业为异步执行,不保证时效性。在提交转码作业后,任务会添加到管道中排队,被调度执行。所以在接口返回时,不保证转码已经完成。执行完成后需要调用查询转码作业接口轮询执行结果,或通过为管道绑定 MNS 消息接收执行结果,详细操作请参见接收消息通知

  • 输入单个文件大小最大支持 100 GB,超过可能导致执行失败。

  • 使用预置智能模板对输入文件进行转码时,必须要先调用提交预置模板分析作业接口( SubmitAnalysisJob ),分析作业成功完成后可以通过调用查询模板分析作业接口( QueryAnalysisJobList )获取该输入文件的可用预置模板列表。在提交转码作业时,将 TemplateId 参数设置为可用的预置模板 ID 即可。若提交的转码作业中指定的模板不在可用的预置模板列表中,会导致转码作业失败。

  • 使用预置静态模板对输入文件进行转码时,不需要提交模板分析作业。

  • 如需在 MPS 服务中使用多个账号,可以为阿里云账号创建 RAM 用户,详细说明请参见创建 RAM 用户并授权。如果提交转码作业和查询转码作业使用的是不同的阿里云账号,则会导致查询不到数据。

  • 更多转码常见问题,请参见媒体处理常见问题

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mts:SubmitJobs
*全部资源
*

请求参数

名称类型必填描述示例值
Inputstring

作业输入。详细说明,请参见 Input 详情

说明
  • 在媒体处理 API 中,Object 必须经过 URL Encoding(基于 UTF-8 编码)后使用。
    • OSS 的地域需要与当前 MPS 所在地域保持一致。
    {"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"example.flv","Referer": "用户自行在OSS控制台设置的OSS防盗链参数"}
    Outputsstring

    作业输出配置。详细说明,请参见 Output 详情

    • Outputs 由 Output 列表构成,JSON 数组,大小上限为 30。
    [{"OutputObject":"exampleOutput.mp4","TemplateId":"6181666213ab41b9bc21da8ff5ff****","WaterMarks":[{"InputFile":{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"image_01.png"},"WaterMarkTemplateId":"9b772ce2740d4d55876d8b542d47****"}],"UserData":"testid-001"}]
    OutputBucketstring

    输出文件所在的 OSS Bucket。

    • 遵守 OSS Bucket 定义,更多信息请参见基本概念
    exampleBucket
    OutputLocationstring

    输出文件所在的 OSS Bucket 的地域(OSS Region)。

    • OSS Bucket 必须与媒体处理服务在同一个地域。
    • 遵守 OSS Bucket 定义,更多信息请参见基本概念
    oss-cn-hangzhou
    PipelineIdstring

    管道 ID。更多信息,请参见基本概念

    • 可以通过 MPS 控制台 > 全局设置 > 管道及回调查询。

    • 如果需要异步通知,请为管道绑定 MNS 消息。详细操作,请参见接收消息通知

    dd3dae411e704030b921e52698e5****

    返回参数

    名称类型描述示例值
    object

    返回参数。

    JobResultListarray<object>

    提交转码作业结果列表。

    JobResultobject

    返回参数。

    Jobobject

    作业详细信息。如果提交失败则不会生成作业 ID。

    CreationTimestring

    作业添加时间。

    2014-01-10T12:00:00Z
    Percentlong

    转码进度。

    100
    FinishTimestring

    作业完成时间。

    2014-01-10T12:20:00Z
    Statestring

    作业状态。

    • Submitted:作业已提交。
    • TranscodeFail:转码失败。
    Submitted
    JobIdstring

    任务 ID。

    31fa3c9ca8134f9cec2b4b0b0f78****
    Codestring

    转码失败时的错误码。转码成功时不返回。

    InternalError
    Messagestring

    转码失败时的消息。转码成功时不返回。

    The operation has failed due to some unknown error, exception or failure.
    Outputobject

    作业输出。

    Videoobject

    视频配置。

    说明 指定则替换 TemplateId 所指定模板的 AliyunVideoCodec 设置。
    Bufsizestring

    缓冲区大小。

    • 单位:Kb。
    • 默认值:6000
    1000
    Degrainstring

    独立去噪算法强度。

    5
    BitrateBndobject

    视频平均码率范围。

    Maxstring

    总码率上限。单位:Kbps。

    20
    Minstring

    总码率下限。单位:Kbps。

    10
    PixFmtstring

    视频颜色格式。

    • 默认值:yuv420p 或原始颜色格式。

    • 可取值:yuv420pyuvj420p 等标准颜色格式。

      说明 非标准颜色格式(比如:yuvj420p(pc, bt470bg/bt470bg/smpte170m)需要配置兼容,否则会导致转码失败。
    yuvj420p
    Padstring

    视频贴黑边。

    • 参数格式:width:height:left:top。

    • 单位:px。

    1280:800:0:140
    Codecstring

    编解码格式。

    • 支持H.264H.265GIFWEBP
    • 默认值:H.264
    H.264
    Heightstring

    高。

    • 单位:px。
    • 默认值:视频原始高度。
    1280
    Qscalestring

    视频质量控制值。

    15
    Cropstring

    视频画面裁切。支持 2 种方式:

    • 自动检测黑边并裁切:设置为 border
    • 自定义裁切:参数格式为 width:height:left:top。
    1280:800:0:140
    Bitratestring

    视频输出文件的码率。单位:Kbps。

    10
    Maxratestring

    视频码率峰值。单位:Kbps。

    10
    MaxFpsstring

    最大帧率。

    15
    Profilestring

    编码级别,目前仅 H264 支持此参数。默认值:high,可取值:

    说明 如果您有多个清晰度,建议最低清晰度配置成 baseline,以保证最低端设备可播放。其他清晰度配置为 main 或 high。
    • baseline:针对移动设备。

    • main:针对标准分辨率设备。

    • high:针对高分辨率设备。

    baseline
    Crfstring

    码率-质量控制因子。

    • 如果设置了 Crf,则 Bitrate 的设置失效。

    • 默认值:编码格式为 H264,默认值为 23。编码格式为 H265,默认值为 26

    22
    Gopstring

    关键帧间最大时间间隔或最大帧数。单位:秒(s)。

    • 默认值:10s。

    • 最大帧数时无单位。

    1
    Widthstring

    宽。

    • 单位:px。
    • 默认值:视频原始宽度
    1080
    Fpsstring

    帧率。

    • 单位:fps。

    • 可取值范围:0~60,当输入文件帧率超过 60 时取 60。

    • 默认值:取输入文件帧率。

    60
    Presetstring

    视频算法器预置。默认值:medium。可取值:

    • veryfast:超快。

    • fast:快。

    • medium:中等。

    • slow:慢。

    • slower:超慢。

    veryfast
    ScanModestring

    扫描模式。取值如下:

    • 不设置:按输入文件的原始模式。
    • auto:自动去隔行。
    • progressive:顺序扫描(逐行扫描)。
    • interlaced:交叉扫描(隔行扫描)。
    • 默认值:空,即不设置。

    最佳实践:交叉扫描虽然比顺序扫描更节省数据量,但画质不佳,所以现在主流视频制作都采用顺序扫描。

    • 如果您设置了顺序扫描交叉扫描,但与原视频模式不符,会导致转码失败。
    • 建议您设置原视频模式自动去隔行,以提高兼容性。
    interlaced
    ResoPrioritystring

    资源优先级。

    1
    TransConfigobject

    转码通用配置。

    说明 如果请求参数中设置了该值,则覆盖指定转码模板中的对应参数。
    IsCheckAudioBitratestring

    是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于 IsCheckAudioBitrateFail。

    • true 表示检查。
    • false 表示不检查。
    • 默认值:
      • 参数为空,并且 codec 和输入源不一样:false。
      • 参数为空,并且 codec 和输入源一样:true。
    false
    TransModestring

    转码模式。可取值:

    • onepass: 基于 One-Pass 算法,准确性较好。

    • twopass:基于 Two-Pass 算法,准确性较差。

    • CBR:Constant bit rate,固定码率。

    onepass
    IsCheckResostring

    是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则视为输出分辨率等于输入分辨率。

    • true 表示检查。

    • false 表示不检查。

    • 默认值:false

    false
    IsCheckVideoBitrateFailstring

    是否检查码率。当输出视频码率大于媒体源视频码率时,则不进行转码,直接返回转码失败。此值优先级大于 IsCheckVideoBitrate

    • true 表示检查。

    • false 表示不检查。

    • 默认值:false

    true
    AdjDarMethodstring

    分辨率改写方式。默认值:none。可取值:

    • rescale:重新做 scale。

    • crop:裁剪。

    • pad:填充。

    • none:不改写。

    crop
    IsCheckVideoBitratestring

    是否检查视频码率。如果视频输出码率大于视频输入码率,则视为视频输出码率等于视频输入码率。

    • true 表示检查。

    • false 表示不检查。

    • 默认值:false

    false
    IsCheckResoFailstring

    是否检查分辨率。此值优先级大于 IsCheckReso。如果输出分辨率大于输入分辨率(判断条件是宽或高),不进行转码,直接返回转码失败。

    • true:检查。

    • false:不检查。

    • 默认值:false

    false
    IsCheckAudioBitrateFailstring

    是否检查音频码率。此值优先级大于 IsCheckAudioBitrate。当输出音频码率大于媒体源音频码率时,不进行转码,直接返回转码失败。

    • false:检查。
    • true:不检查。
    true
    Encryptionobject

    数据加密,只支持 m3u8 格式的输出。

    Typestring

    加密类型。取值:hls-aes-128

    hls-aes-128
    Keystring

    加密视频的密钥。

    encryptionkey128
    KeyTypestring

    密钥 Key 不能明文传输给 MPS,需要加密,方式为 Base64 或 KMS。如密钥为"encryptionkey128”, 则 Base64(“encryptionkey128”), 或 KMS(Base64(“encryptionkey128”)。

    Base64
    Idstring

    加密 ID。

    31fa3c9ca8134f9cec2b4b0b0f78****
    KeyUristring

    密钥的访问 URL,使用 BASE64 进行编码。

    https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/
    SkipCntstring

    前面不加密的片数(视频能快速播放起来)。

    3
    WaterMarkListarray<object>

    水印列表。

    说明 如果水印输出截断或失败,请先检查您添加的文本水印中是否包含特殊字符,如有,则需要对特殊字符进行转义后再传入,或提交工单联系阿里云客服进行兼容处理。
    WaterMarkobject

    水印详细信息。

    Typestring

    水印类型。如果请求参数中设置了此参数,则此值覆盖水印模板对应参数。更多信息,请参见参数详情。可取值:

    • Image:图片水印。
    • Text:文字水印。
    Image
    ReferPosstring

    水印的位置。如果请求参数中设置了此值,则覆盖水印模板对应参数。可取值:

    • TopRight:右上。
    • TopLeft:左上。
    • BottomRight:右下。
    • BottomLeft:左下。
    TopRight
    Dxstring

    水印图片相对输出视频的水平偏移量。如果请求参数中设置了此值,则覆盖水印模板对应参数。默认值为 0。值有两种形式:

    • 整数型:代表偏移像素值。

      • 范围:[8,4096]

      • 单位:px。

    • 小数型:代表水平偏移量与输出分辨率宽的比率。

      • 范围:(0,1)。

      • 支持四位小数,例如:0.9999,超出部分系统自动丢弃。

    1
    Widthstring

    水印图片宽。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片宽。值有两种形式:

    • 整数型:代表水印图片宽的像素值。

      • 范围:[8,4096]

      • 单位:px。

    • 小数型:代表相对输出视频分辨率宽的比率。

      • 范围:(0,1)

      • 支持 4 位小数,例如:0.9999,超出部分系统自动丢弃。

    1080
    Heightstring

    水印图片高。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片高。值有两种形式:

    • 整数型:代表水印图片高的像素值。

      • 范围:[8,4096]

      • 单位:px。

    • 小数型:代表相对输出视频分辨率高的比率。

      • 范围:(0,1)

      • 支持 4 位小数,例如:0.9999,超出部分系统自动丢弃。

    1280
    InputFileobject

    水印输入文件。目前支持 png 图片、mov 文件作为输入文件。

    Objectstring

    输入文件的 OSS Object。

    example-logo-****.png
    Locationstring

    输入文件的 OSS Location。

    oss-cn-hangzhou
    Bucketstring

    输入文件的 OSS Bucket。

    example-bucket
    WaterMarkTemplateIdstring

    水印模板 ID。

    88c6ca184c0e47098a5b665e2a12****
    Dystring

    水印图片相对输出视频的垂直偏移量。如果在请求参数中设置了此值,则覆盖水印模板对应水印图片相对输出视频的垂直偏移量。值有两种形式:

    • 整数型:代表水印图片相对输出视频的垂直偏移量像素。

      • 范围:[8,4096]

      • 单位:px。

    • 小数型:代表水印图片相对输出视频的垂直偏移量比率。

      • 范围:(0,1)

      • 支持 4 位小数,例如:0.9999,超出部分系统自动丢弃。

    1
    WaterMarkConfigUrlstring

    水印配置文件 URL。

    http://example.com/configure
    DeWatermarkstring

    模糊处理,JSON 对象。更多信息请参见参数详情中的模糊处理详情

    {"0": [{"l": 10,"t": 10,"w": 10,"h": 10},{"l": 100,"t": 0.1,"w": 10,"h": 10}],"128000": [],"250000": [{"l": 0.2,"t": 0.1,"w": 0.01,"h": 0.05}]}
    M3U8NonStandardSupportobject

    M3U8 非标准支持,JSON 对象。更多信息请参见参数详情中的M3U8 非标准参数支持详情

    TSobject

    JSON 对象,TS 文件相关非标准支持。更多信息请参见参数详情中的TS 参数支持详情

    SizeSupportboolean

    是否支持在 M3U8 文件中输出 TS 文件的大小。可取值:

    • true:支持。

    • false:不支持。

    true
    Md5Supportboolean

    是否支持在 M3U8 文件中输出 TS 的 md5 值。可取值:

    • true:支持。

    • false:不支持。

    true
    Prioritystring

    任务在其对应管道内的优先级。

    • 最高优先级:10
    • 默认值:6
    5
    Audioobject

    音频配置。

    说明 如果请求参数中指定了音频配置则覆盖指定转码模板中的对应参数。
    Profilestring

    音频编码预置。

    说明 Codecaac 时可以取如下范围中的值:aac_lowaac_heaac_he_v2aac_ldaac_eld
    aac_low
    Codecstring

    音频编解码格式。

    • 支持 aacmp3vorbisflac
    • 默认值:aac
    aac
    Sampleratestring

    采样率。

    • 支持 2205032000441004800096000
    • 单位:Hz。
    • 默认值:44100
    说明 若视频容器格式为 flv,音频编解码格式选择为 mp3 时,采样率不支持 32000、48000、96000;音频编解码格式为 mp3 时,采样率不支持 96000。
    32000
    Qscalestring

    音频质量控制度。

    15
    Channelsstring

    声道数。

    • 当 Codec 设置为 mp3 时,声道数只支持 12

    • 当 Codec 设置为 aac 时,声道数只支持 124568

    • 默认值:2

    6
    Volumeobject

    音量控置。

    Methodstring

    音量调整方式。可取值:

    • auto:自动调整。

    • dynamic:动态调整。

    • linear:线性调整。

    auto
    Levelstring

    音量调整幅度

    • 单位:db。
    • 默认:-20db
    -20
    Bitratestring

    输出文件的音频码率。

    • 单位:Kbps。
    • 默认值:128
    128
    AudioStreamMapstring

    音频流序号。

    • 格式:格式:0:a:{序号},示例:0:a:0。

    • 序号的含义是音频流列表的下标,序号从 0 开始。

    • 若未设置,选择默认的音频流。

    0:a:0
    MergeListarray<object>

    视频拼接配置。

    Mergeobject

    视频拼接配置详细信息。

    Startstring

    起始时间点。

    • 格式:hh:mm:ss[.SSS]或者sssss[.SSS]

    • 示例:01:59:59.999 或者 32000.23。

    00000.50
    RoleArnstring

    代理授权使用的角色信息。

    acs:ram::<your uid>:role/<your role name>
    MergeURLstring

    拼接片段地址。

    • 示例:http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv
    • Object 需要经过 URLEncode,采用 UTF-8 编码。
    http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv
    Durationstring

    持续时间。

    • 格式:hh:mm:ss[.SSS]或者sssss[.SSS]
    • 示例:01:59:59.999 或者 32000.23。
    00000.20
    SuperResoobject

    分辨率随源。

    IsHalfSamplestring

    是否获取采样率相关参数。可取值:

    • true:是。

    • false:否。

    true
    UserDatastring

    用户自定义数据。

    example data
    OutSubtitleListarray<object>

    输出字幕列表。

    OutSubtitleobject

    输出字幕详情。

    Mapstring

    视频轨。格式:0:{流}:{流序号} ,即0:v:{video_index}。流取值为 v: video 音频流,序号的含义是音频流列表的下标,序号从 0 开始。

    0:v:0
    OutSubtitleFileobject

    输出文件详细信息。

    RoleArnstring

    代理授权使用的角色信息。

    acs:ram::<your uid>:role/<your role name>
    Objectstring

    输出文件的 OSS Object。

    example-output.flv
    Locationstring

    输出文件的 OSS Location。

    oss-cn-hangzhou
    Bucketstring

    输入文件的 OSS Bucket。

    example-bucket-****
    Successboolean

    是否成功。可取值:

    • true:成功。

    • false:失败。

    true
    Messagestring

    创建作业失败时错误消息。创建成功时此参数不返回。

    The specified parameter “%s” cannot be null.
    DigiWaterMarkobject

    数字水印。

    Typestring

    水印类型。如果设置过水印类型,则此值覆盖水印模板对应参数。可取值:

    • Image:默认值,图片水印。

    • Text:文字水印。

    Image
    Alphastring

    文字或图片的透明度。

    • 取值范围:(0,1]

    • 默认值:1.0

    1.0
    InputFileobject

    输入文件。

    Objectstring

    输入文件的 OSS Object。

    example-intput.flv
    Locationstring

    输入文件的 OSS Location。

    oss-cn-hangzhou
    Bucketstring

    输入文件的 OSS Bucket。

    example-bucket-****
    VideoStreamMapstring

    视频流序号。

    • 格式:格式:0:a:{序号},示例:0:a:0。

    • 序号的含义是音频流列表的下标,序号从 0 开始。

    • 若未设置,选择默认的视频流。

    0:a:0
    OutputFileobject

    输出文件。

    RoleArnstring

    代理授权使用的角色信息。

    acs:ram::<your uid>:role/<your role name>
    Objectstring

    输出文件的 OSS Object。

    example-output.flv
    Locationstring

    输出文件的 OSS Location。

    oss-cn-hangzhou
    Bucketstring

    输入文件的 OSS Bucket。

    example-bucket-****
    AmixListarray<object>

    混音列表。

    Amixobject

    返回参数。

    Mapstring

    在 AmixURL 中选取目标音轨,取值为:0:a:{audio_index}, 如 0:a:0。

    0:a:0
    Startstring

    起始时间。数字或时间格式例如:"1:25:36.240", "32000.23"。

    0
    AmixURLstring

    需要被混音的背景音轨媒体。

    • 可取值:OSS 地址或字符串"input"

    • input 场景:同一视频两路音轨合并。

    https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3
    Durationstring

    持续时长。数字或时间格式。

    20
    MixDurModestring

    媒体时长取值。可取值:firstlong

    • first:输出媒体的时长以输入媒体的时长为准。

    • long:输出媒体的时长以两个媒体中时长最长的为准。

    • 默认值:long

    long
    Rotatestring

    视频顺时针旋转角度。

    180
    Containerobject

    容器。

    Formatstring

    容器格式。

    • 默认值:mp4

    • 视频转码可取值 flv、mp4、HLS(m3u8+ts)、MPEG-DASH(MPD+fMP4)。

    • 音频转码可取值 mp3、mp4、ogg、flac、m4a。

    • 图片可取值 gif、WEBP。

    • 容器格式为 gif 时,VideoCodec 设置只能设置为 GIF。

    • 容器格式为 webp 时,VideoCodec 设置只能设置为 WEBP。

    • 容器格式为 flv 时,VideoCodec 不能设置为 H265。

    flv
    Clipobject

    剪辑片段。

    TimeSpanobject

    剪辑时间段。

    Seekstring

    开始时间。

    • 格式:hh:mm:ss[.SSS]sssss[.SSS]

    • 取值范围:[00:00:00.000,23:59:59.999][0.000,86399.999]

    01:59:59.999
    Durationstring

    延续时间。

    • 格式:hh:mm:ss[.SSS]sssss[.SSS]

    • 取值范围:[00:00:00.000,23:59:59.999][0.000,86399.999]

    01:00:59.999
    MergeConfigUrlstring

    MergeListMergeConfigUrl 两个参数只支持二选一。

    • MergeConfigUrl 指定的配置文件允许 50 个拼接片段上限。
    • MergeConfigUrl 是拼接配置文件 URL 地址。
    • 只支持存放在 OSS 上的配置文件,且需要保证有授权给 MPS 可访问权限,文件内部内容参见拼接参数详情。
    • mergeConfigfile 文件内部内容示例:{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}
    `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}
    OpeningListarray<object>

    开板列表,JSON 对象。

    Openingobject

    返回参数。

    openUrlstring

    开板视频的 OSS URL 地址。

    http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
    Startstring

    相对正片视频的开始时间。从 0 开始延迟多长时间后,显示开板视频。

    • 单位:秒。

    • 默认值:0

    1
    Widthstring

    宽。

    • 可取值:0~4096-1full

    • 默认值:-1

    • -1代表片源的值。

    • full 表示填满画面。

    1920
    Heightstring

    高。

    • 可取值:0~4096-1full

    • 默认值:-1

    • -1代表片源的值,

    • full 表示填满画面。

    1080
    MuxConfigobject

    转码封包配置。如果请求参数中设置了此参数,则覆盖指定转码模板中的对应参数。

    Webpobject

    Webp 对应的封包配置。

    Loopstring

    循环次数。

    0
    Gifobject

    Gif 对应的封包配置。

    FinalDelaystring

    终帧暂停时间,单位:厘秒。

    0
    DitherModestring

    调色板颜色抖动方式。可取值:sierrabayer

    bayer
    Loopstring

    循环次数。

    0
    IsCustomPalettestring

    自定义调色板功能。可取值:

    • true:自定义

    • false:非自定义。

    false
    Segmentobject

    切片配置,JSON 对象。

    Durationstring

    分片时长。整数,单位:秒。

    • 可取值范围:[1,10]

    • 默认值:10 秒。

    20
    TailSlateListarray<object>

    尾板列表,JSON 对象。

    TailSlateobject

    返回参数。

    Startstring

    开始时间。

    1
    BgColorstring

    如果尾板视频的宽、高小于正片时,设置空白处填充的背景色。默认为 White,更多取值请参见 bgcolor

    White
    IsMergeAudioboolean

    是否要拼接尾板视频的音频内容。可取值:

    • true:拼接。

    • false:不拼接。

    false
    Widthstring

    宽。

    • 可取值:0~4096-1full
    • -1代表片源的值,full 表示填满画面。
    • 默认为**-1**。
    1920
    Heightstring

    高。

    • 可取值:0~4096-1full
    • -1代表片源的值,full 表示填满画面。
    • 默认为**-1**。
    1080
    BlendDurationstring

    正片视频和尾板视频过渡的时长。过渡的效果是淡入淡出:正片显示最后一帧,同时播放尾板视频,正片最后一帧逐步变暗,尾板视频逐步变亮。单位秒,默认 0

    2
    TailUrlstring

    尾板视频的 OSS URL 地址。

    http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
    TemplateIdstring

    转码模板 ID。

    S00000000-000010
    SubtitleConfigobject

    字幕配置信息。

    ExtSubtitleListarray<object>

    外部字幕列表,JSON 数组,最多 4 个。

    ExtSubtitleobject

    外部字幕详细信息。

    CharEncstring

    外部字幕字符编码。

    • 范围:UTF-8GBKBIG5auto
    • 默认:auto
    说明 外部字幕字符编码设置为 auto 时,存在误检情况,建议您指定具体的字符编码。
    UTF-8
    FontNamestring

    外挂字幕转换成硬字幕对应的字体名称。默认值:SimSun。更多字体信息请参见字体列表

    "WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"
    Inputobject

    JSON 对象,外部输入字幕文件。目前支持 srtass 格式。

    Objectstring

    输入文件的 OSS Object。

    example-output.flv
    Locationstring

    输入文件所在的 OSS Location。

    oss-cn-hangzhou
    Bucketstring

    输入文件所在的 OSS Bucket。

    example-bucket-****
    SubtitleListarray<object>

    字幕列表。

    Subtitleobject

    返回参数。

    Mapstring

    音轨。格式:0:{流}:{流序号} ,即0:a:{audio_index}。流取值为 a: audio 音频流,序号的含义是音频流列表的下标,序号从 0 开始。

    0:a:0
    Propertiesobject

    媒体属性。

    Widthstring

    视频宽。

    1280
    Heightstring

    视频长。

    720
    Durationstring

    时长。

    55
    Fpsstring

    帧率,数字。

    25
    Bitratestring

    码率。

    1000
    FileFormatstring

    文件格式。

    QuickTime / MOV
    Streamsobject

    流信息。

    VideoStreamListarray<object>

    视频流列表。

    VideoStreamobject

    视频流详细信息。

    Indexstring

    视频流序号,标识视频流在整个媒体流中的位置。

    0
    Timebasestring

    时基。

    1/24000
    AvgFPSstring

    平均帧率。

    23.976025
    PixFmtstring

    像素格式。

    yuv420p
    Sarstring

    编码信号分辨率比。

    1:1
    Langstring

    语言。更多信息,请参见 FFmeg 语言定义ISO-639

    eng
    CodecLongNamestring

    编码格式长述名。

    H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
    Heightstring

    视频分辨率长。

    720
    NumFramesstring

    总帧数。

    25
    Bitratestring

    码率。

    1496.46
    CodecTagStringstring

    编码格式标记文本。

    avc1
    HasBFramesstring

    是否有 B 帧。

    2
    Profilestring

    编码预置。

    high
    StartTimestring

    起始时间。

    0.000000
    NetworkCostobject

    网络带宽消耗。

    PreloadTimestring

    预加载时间。

    8
    AvgBitratestring

    平均码率。

    100
    CostBandwidthstring

    最大消耗带宽。

    10
    Darstring

    编码显示分辨率比。

    16:9
    CodecNamestring

    编码格式简述名。

    h264
    Widthstring

    视频分辨率宽,数字。

    1280
    Durationstring

    时长。

    17.225542
    Fpsstring

    帧率。

    23.976025
    CodecTagstring

    编码格式标记。

    0x31637661
    CodecTimeBasestring

    编码时基。

    1001/48000
    Levelstring

    编码等级。

    51
    AudioStreamListarray<object>

    音频流列表。

    AudioStreamobject

    音频流详细信息。

    Timebasestring

    时基。

    1/44100
    Indexstring

    音频流序号。标识音频流在整个媒体流中的位置。

    1
    SampleFmtstring

    采样格式。

    fltp
    ChannelLayoutstring

    声道输出样式。

    stereo
    Langstring

    语言。更多信息,请参见 FFmeg 语言定义ISO-639

    eng
    Sampleratestring

    采样率。

    44100
    CodecLongNamestring

    编码格式长述名。

    AAC (Advanced Audio Coding)
    Channelsstring

    声道数。

    2
    NumFramesstring

    总帧数。

    25
    Bitratestring

    码率。

    128.806
    CodecTagStringstring

    编码格式标记文本。

    mp4a
    StartTimestring

    起始时间。

    0.000000
    CodecNamestring

    编码格式简述名。

    aac
    Durationstring

    时长。

    17.159546
    CodecTagstring

    编码格式标记。

    0x6134706d
    CodecTimeBasestring

    编码时基。

    1/44100
    SubtitleStreamListarray<object>

    字幕流列表。

    SubtitleStreamobject

    字幕流详细信息。

    Indexstring

    字幕流序号,标识字幕流在整个媒体流中的位置。

    1
    Langstring

    语言。更多信息,请参见 FFmeg 语言定义ISO-639

    eng
    Formatobject

    格式信息。

    StartTimestring

    起始时间。

    0.000000
    NumProgramsstring

    节目流总数。

    0
    Sizestring

    文件大小。

    3509895
    NumStreamsstring

    媒体流总数。

    2
    FormatLongNamestring

    容器、封装格式长述名。

    QuickTime / MOV
    Durationstring

    总时长。

    55
    Bitratestring

    总码率。

    1000
    FormatNamestring

    容器、封装格式简述名。可取值:mov、mp4、m4a、3gp、3g2、mj2。

    mov
    FileSizestring

    文件大小。

    3509895
    PipelineIdstring

    管道 ID。

    88c6ca184c0e47098a5b665e2a126797
    Inputobject

    作业输入。

    Objectstring

    作业输入的 OSS Object。

    example.flv
    Locationstring

    作业输入的 OSS Location。

    oss-cn-hangzhou
    Bucketstring

    作业输入的 OSS Bucket。

    example-bucket-****
    MNSMessageResultobject

    MNS 通知用户作业完成的消息结果。

    MessageIdstring

    失败时错误信息 ID。成功时此参数不返回。

    123
    ErrorMessagestring

    失败时错误信息。成功时此参数不返回。

    The resource operated "%s" cannot be found.
    ErrorCodestring

    失败时错误码。成功时此参数不返回。

    InvalidParameter.ResourceNotFound
    Successboolean

    是否成功。可取值:

    • true:成功。

    • false:失败。

    true
    Codestring

    创建作业失败时错误码。创建成功时此参数不返回。

    InvalidParameter.NullValue
    Messagestring

    创建作业失败时错误消息。创建成功时此参数不返回。

    The specified parameter "%s" cannot be null.
    RequestIdstring

    请求 ID。

    25818875-5F78-4A45S71F6-D73936451234

    示例

    正常返回示例

    JSON格式

    {
      "JobResultList": {
        "JobResult": [
          {
            "Job": {
              "CreationTime": "2014-01-10T12:00:00Z",
              "Percent": 100,
              "FinishTime": "2014-01-10T12:20:00Z",
              "State": "Submitted",
              "JobId": "31fa3c9ca8134f9cec2b4b0b0f78****",
              "Code": "InternalError",
              "Message": "The operation has failed due to some unknown error, exception or failure.",
              "Output": {
                "Video": {
                  "Bufsize": "1000",
                  "Degrain": "5",
                  "BitrateBnd": {
                    "Max": "20",
                    "Min": "10"
                  },
                  "PixFmt": "yuvj420p",
                  "Pad": "1280:800:0:140",
                  "Codec": "H.264",
                  "Height": "1280",
                  "Qscale": "15",
                  "Crop": "1280:800:0:140",
                  "Bitrate": "10",
                  "Maxrate": "10",
                  "MaxFps": "15",
                  "Profile": "baseline",
                  "Crf": "22",
                  "Gop": "1",
                  "Width": "1080",
                  "Fps": "60",
                  "Preset": "veryfast",
                  "ScanMode": "interlaced",
                  "ResoPriority": "1"
                },
                "TransConfig": {
                  "IsCheckAudioBitrate": "false",
                  "TransMode": "onepass",
                  "IsCheckReso": "false",
                  "IsCheckVideoBitrateFail": "true",
                  "AdjDarMethod": "crop",
                  "IsCheckVideoBitrate": "false",
                  "IsCheckResoFail": "false",
                  "IsCheckAudioBitrateFail": "true"
                },
                "Encryption": {
                  "Type": "hls-aes-128",
                  "Key": "encryptionkey128",
                  "KeyType": "Base64",
                  "Id": "31fa3c9ca8134f9cec2b4b0b0f78****",
                  "KeyUri": "https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/",
                  "SkipCnt": "3"
                },
                "WaterMarkList": {
                  "WaterMark": [
                    {
                      "Type": "Image",
                      "ReferPos": "TopRight",
                      "Dx": "1",
                      "Width": "1080",
                      "Height": "1280",
                      "InputFile": {
                        "Object": "example-logo-****.png",
                        "Location": "oss-cn-hangzhou",
                        "Bucket": "example-bucket"
                      },
                      "WaterMarkTemplateId": "88c6ca184c0e47098a5b665e2a12****",
                      "Dy": "1"
                    }
                  ]
                },
                "WaterMarkConfigUrl": "http://example.com/configure",
                "DeWatermark": "{\"0\": [{\"l\": 10,\"t\": 10,\"w\": 10,\"h\": 10},{\"l\": 100,\"t\": 0.1,\"w\": 10,\"h\": 10}],\"128000\": [],\"250000\": [{\"l\": 0.2,\"t\": 0.1,\"w\": 0.01,\"h\": 0.05}]}",
                "M3U8NonStandardSupport": {
                  "TS": {
                    "SizeSupport": true,
                    "Md5Support": true
                  }
                },
                "Priority": "5",
                "Audio": {
                  "Profile": "aac_low",
                  "Codec": "aac",
                  "Samplerate": "32000",
                  "Qscale": "15",
                  "Channels": "6",
                  "Volume": {
                    "Method": "auto",
                    "Level": "-20"
                  },
                  "Bitrate": "128"
                },
                "AudioStreamMap": "0:a:0",
                "MergeList": {
                  "Merge": [
                    {
                      "Start": "00000.50",
                      "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                      "MergeURL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv",
                      "Duration": "00000.20"
                    }
                  ]
                },
                "SuperReso": {
                  "IsHalfSample": "true"
                },
                "UserData": "example data",
                "OutSubtitleList": {
                  "OutSubtitle": [
                    {
                      "Map": "0:v:0",
                      "OutSubtitleFile": {
                        "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                        "Object": "example-output.flv",
                        "Location": "oss-cn-hangzhou",
                        "Bucket": "example-bucket-****"
                      },
                      "Success": true,
                      "Message": "The specified parameter “%s” cannot be null."
                    }
                  ]
                },
                "DigiWaterMark": {
                  "Type": "Image",
                  "Alpha": "1.0",
                  "InputFile": {
                    "Object": "example-intput.flv",
                    "Location": "oss-cn-hangzhou",
                    "Bucket": "example-bucket-****"
                  }
                },
                "VideoStreamMap": "0:a:0",
                "OutputFile": {
                  "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                  "Object": "example-output.flv",
                  "Location": "oss-cn-hangzhou",
                  "Bucket": "example-bucket-****"
                },
                "AmixList": {
                  "Amix": [
                    {
                      "Map": "0:a:0",
                      "Start": "0",
                      "AmixURL": "https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3",
                      "Duration": "20",
                      "MixDurMode": "long"
                    }
                  ]
                },
                "Rotate": "180",
                "Container": {
                  "Format": "flv"
                },
                "Clip": {
                  "TimeSpan": {
                    "Seek": "01:59:59.999",
                    "Duration": "01:00:59.999"
                  }
                },
                "MergeConfigUrl": "`{\"MergeList\":[{\"MergeURL\":\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\"}]}",
                "OpeningList": {
                  "Opening": [
                    {
                      "openUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv",
                      "Start": "1",
                      "Width": "1920",
                      "Height": "1080"
                    }
                  ]
                },
                "MuxConfig": {
                  "Webp": {
                    "Loop": "0"
                  },
                  "Gif": {
                    "FinalDelay": "0",
                    "DitherMode": "bayer",
                    "Loop": "0",
                    "IsCustomPalette": "false"
                  },
                  "Segment": {
                    "Duration": "20"
                  }
                },
                "TailSlateList": {
                  "TailSlate": [
                    {
                      "Start": "1",
                      "BgColor": "White",
                      "IsMergeAudio": false,
                      "Width": "1920",
                      "Height": "1080",
                      "BlendDuration": "2",
                      "TailUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv"
                    }
                  ]
                },
                "TemplateId": "S00000000-000010",
                "SubtitleConfig": {
                  "ExtSubtitleList": {
                    "ExtSubtitle": [
                      {
                        "CharEnc": "UTF-8",
                        "FontName": "\"WenQuanYi Zen Hei\", \"Yuanti SC Regular\", \"SimSun\"",
                        "Input": {
                          "Object": "example-output.flv",
                          "Location": "oss-cn-hangzhou",
                          "Bucket": "example-bucket-****"
                        }
                      }
                    ]
                  },
                  "SubtitleList": {
                    "Subtitle": [
                      {
                        "Map": "0:a:0"
                      }
                    ]
                  }
                },
                "Properties": {
                  "Width": "1280",
                  "Height": "720",
                  "Duration": "55",
                  "Fps": "25",
                  "Bitrate": "1000",
                  "FileFormat": "QuickTime / MOV",
                  "Streams": {
                    "VideoStreamList": {
                      "VideoStream": [
                        {
                          "Index": "0",
                          "Timebase": "1/24000",
                          "AvgFPS": "23.976025",
                          "PixFmt": "yuv420p",
                          "Sar": "1:1",
                          "Lang": "eng",
                          "CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
                          "Height": "720",
                          "NumFrames": "25",
                          "Bitrate": "1496.46",
                          "CodecTagString": "avc1",
                          "HasBFrames": "2",
                          "Profile": "high",
                          "StartTime": "0.000000",
                          "NetworkCost": {
                            "PreloadTime": "8",
                            "AvgBitrate": "100",
                            "CostBandwidth": "10"
                          },
                          "Dar": "16:9",
                          "CodecName": "h264",
                          "Width": "1280",
                          "Duration": "17.225542",
                          "Fps": "23.976025",
                          "CodecTag": "0x31637661",
                          "CodecTimeBase": "1001/48000",
                          "Level": "51"
                        }
                      ]
                    },
                    "AudioStreamList": {
                      "AudioStream": [
                        {
                          "Timebase": "1/44100",
                          "Index": "1",
                          "SampleFmt": "fltp",
                          "ChannelLayout": "stereo",
                          "Lang": "eng",
                          "Samplerate": "44100",
                          "CodecLongName": "AAC (Advanced Audio Coding)",
                          "Channels": "2",
                          "NumFrames": "25",
                          "Bitrate": "128.806",
                          "CodecTagString": "mp4a",
                          "StartTime": "0.000000",
                          "CodecName": "aac",
                          "Duration": "17.159546",
                          "CodecTag": "0x6134706d",
                          "CodecTimeBase": "1/44100"
                        }
                      ]
                    },
                    "SubtitleStreamList": {
                      "SubtitleStream": [
                        {
                          "Index": "1",
                          "Lang": "eng"
                        }
                      ]
                    }
                  },
                  "Format": {
                    "StartTime": "0.000000",
                    "NumPrograms": "0",
                    "Size": "3509895",
                    "NumStreams": "2",
                    "FormatLongName": "QuickTime / MOV",
                    "Duration": "55",
                    "Bitrate": "1000",
                    "FormatName": "mov"
                  },
                  "FileSize": "3509895"
                }
              },
              "PipelineId": "88c6ca184c0e47098a5b665e2a126797",
              "Input": {
                "Object": "example.flv",
                "Location": "oss-cn-hangzhou",
                "Bucket": "example-bucket-****"
              },
              "MNSMessageResult": {
                "MessageId": "123",
                "ErrorMessage": "The resource operated \"%s\" cannot be found.",
                "ErrorCode": "InvalidParameter.ResourceNotFound"
              }
            },
            "Success": true,
            "Code": "InvalidParameter.NullValue",
            "Message": "The specified parameter \"%s\" cannot be null."
          }
        ]
      },
      "RequestId": "25818875-5F78-4A45S71F6-D73936451234"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史