文档

SubmitMediaInfoJob - 提交媒体信息作业

更新时间:

提交媒体信息作业。调用本接口之后媒体处理MPS会对输入文件进行媒体信息分析,返回输入文件的媒体信息。

接口说明

  • 请确认文件已成功上传至OSS后再提交媒体信息作业,否则会导致执行失败。您可通过配置OSS回调消息确认文件上传状态。
  • 媒体信息作业分为同步和异步模式。
  • 异步模式不保证时效性,在提交媒体信息作业后,任务会添加到管道中排队,被调度执行。所以在接口返回时,不保证作业已经生成。执行完成后需要调用查询媒体信息作业接口轮询执行结果,或通过为管道绑定MNS消息接收执行结果,详细说明请参见接收消息通知

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

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

说明
  • 在媒体处理API中,Object必须经过URL Encoding(基于UTF-8编码)后使用。
    • OSS的地域需要与当前MPS所在地域保持一致。
    {"Bucket":"example-bucket","Location":"example-location","Object":"example%2Fexample.flv"}
    UserDatastring

    用户自定义数据。可以使用中英文、数字、中划线(-)等,不能以特殊符号开头,最大长度1024个字节。

    testid-001
    PipelineIdstring

    管道ID。详细信息请参见基本概念

    • 可选值:可以通过MPS控制台>全局设置>管道查询和创建。
    • 如果需要异步通知,请为管道绑定MNS消息,具体请参见接收消息通知
    88c6ca184c0e432bbf5b665e2a15****
    Asyncboolean

    是否发起异步作业。取值:

    • true:发起异步作业(推荐)。
    • false:不发起异步作业。
    true

    返回参数

    名称类型描述示例值
    object

    返回参数。

    MediaInfoJobobject

    媒体信息作业详细信息。

    CreationTimestring

    作业添加时间。

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

    作业状态。

    • Success:成功。
    • Fail:失败。
    • Analyzing:分析中。
    Analyzing
    JobIdstring

    元信息分析作业ID。

    23ca1d184c0e4341e5b665e2a12****
    UserDatastring

    用户自定义数据。

    testid-001
    Codestring

    元信息分析失败时错误码。

    InvalidParameter.JsonObjectFormatInvalid
    Messagestring

    元信息分析失败时错误信息。

    The parameter ”*” does not conform to the JSON Object specification
    PipelineIdstring

    管道ID。

    88c6ca184c0e432bbf5b665e2a15****
    Asyncboolean

    是否异步。

    true
    Inputobject

    作业输入信息。

    Objectstring

    输入文件的OSS Object。

    example.flv
    Locationstring

    输入文件OSS的服务区域。

    example-location
    Bucketstring

    输入文件的OSS Bucket。

    example-bucket
    MNSMessageResultobject

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

    MessageIdstring

    成功时消息ID。如果执行失败则不返回此参数。

    16f01ad6175e4230ac42bb5182cd****
    ErrorMessagestring

    失败时错误信息。如果执行成功则不返回此参数。

    InvalidParameter.JsonObjectFormatInvalid
    ErrorCodestring

    失败时错误码。如果执行成功则不返回此参数。

    The parameter \"Input\" does not conform to the JSON Object specification
    Propertiesobject

    媒体文件属性。

    Widthstring

    视频宽度,单位为px。

    1920
    Heightstring

    视频高度,单位为px。

    1080
    Durationstring

    总时长,单位为秒(s)。

    17.226000
    Fpsstring

    帧率。

    25
    Bitratestring

    码率。单位为Kbps。

    1630.045
    FileFormatstring

    文件格式。

    QuickTime/MOV
    Streamsobject

    流信息。

    VideoStreamListobject []

    视频流列表。列表元素至多4个。

    Sarstring

    编码信号分辨率比。

    1:1
    Heightstring

    视频高度,单位为px。

    1080
    CodecTagStringstring

    编码格式标记文本。

    avc1
    NetworkCostobject

    网络带宽消耗。

    PreloadTimestring

    预加载时间。

    8
    AvgBitratestring

    平均码率,单位为Kbps。

    300.34
    CostBandwidthstring

    最大消耗带宽。

    10
    Widthstring

    视频宽度,单位为px。

    1920
    Indexstring

    视频流序号。标识视频流在整个媒体流中的位置。某些播放平台可以指定起播的视频流序号,某些默认从1号起播。

    1
    Timebasestring

    时基。

    1/24000
    AvgFPSstring

    平均帧率。

    23.976025
    PixFmtstring

    像素格式。

    yuv420p
    Langstring

    语言。

    eng
    CodecLongNamestring

    编码格式长述名。

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

    总帧数。

    100
    Rotatestring

    视频旋转角度。

    90
    Bitratestring

    码率,单位Kbps。

    1496.46
    HasBFramesstring

    是否有B帧。0表示无,1表示有。

    0
    Profilestring

    编码预置。

    High
    StartTimestring

    起始时间。

    0.042000
    Darstring

    编码显示分辨率比。Dar=视频宽度/视频高度,可以作为判断视频横竖屏的依据。

    16:9
    CodecNamestring

    编码格式简述名。可选值:

    • h264

    • h265

    • gif

    • webp

    h264
    Durationstring

    时长,单位为秒(s)。

    17.225542
    Fpsstring

    帧率。

    25
    CodecTagstring

    编码格式标记。

    0x31637661
    CodecTimeBasestring

    编码时基。

    1001/48000
    Levelstring

    编码等级。

    41
    ColorRangestring

    色彩范围。

    700
    ColorTransferstring

    色彩通道。

    R255 G83 B170
    ColorPrimariesstring

    色原。

    700
    AudioStreamListobject []

    音频流列表。列表元素至多4个。

    Timebasestring

    时基。

    1/44100
    Indexstring

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

    1
    SampleFmtstring

    采样格式。

    fltp
    ChannelLayoutstring

    声道输出样式。

    stereo
    Langstring

    语言。

    eng
    Sampleratestring

    采样率,单位Hz。

    44100
    CodecLongNamestring

    编码格式长述名。

    AAC (Advanced Audio Coding)
    Channelsstring

    声道数。

    2
    NumFramesstring

    总帧数。

    123
    Bitratestring

    码率,单位为Kbps。

    128.806
    CodecTagStringstring

    编码格式标记文本。

    mp4a
    StartTimestring

    起始时间。

    0.000000
    CodecNamestring

    编码格式简述名。默认值:acc。可取值:

    • acc

    • mp3

    • mp4

    • ogg

    • flac

    aac
    Durationstring

    时长,单位为秒(s)。

    17.159546
    CodecTagstring

    编码格式标记。

    0x6134706d
    CodecTimeBasestring

    编码时基。

    1/44100
    SubtitleStreamListobject []

    字幕流列表。列表元素至多4个。

    Timebasestring

    时基。

    1/1000
    Indexstring

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

    3
    StartTimestring

    起始时间。

    0.000000
    CodecNamestring

    编码格式简述名。可选值:

    • srt

    • ass

    ass
    Langstring

    语言。

    eng
    CodecLongNamestring

    编码格式长述名。

    ASS (Advanced SSA) subtitle
    Durationstring

    时长,单位为秒(s)。

    1370.116000
    CodecTagstring

    编码格式标记。

    0x0000
    CodecTimeBasestring

    编码时基。

    0/1
    CodecTagStringstring

    编码格式标记文本。

    [0][0][0][0]
    Formatobject

    格式信息。

    StartTimestring

    起始时间。

    0.000000
    NumProgramsstring

    节目流总数。

    0
    Sizestring

    文件大小,单位为字节(byte)。

    3509895
    NumStreamsstring

    媒体流总数。

    2
    FormatLongNamestring

    容器、封装格式长述名。

    QuickTime/MOV
    Durationstring

    总时长,单位为秒(s)。

    17.226000
    Bitratestring

    总码率,单位为Kbps。

    1630.045
    FormatNamestring

    容器、封装格式简述名。更多参数信息请参见参数详情

    mov
    FileSizestring

    文件大小,单位为字节(byte)。

    3509895
    RequestIdstring

    请求ID。

    62D9BE16-B7D5-550C-A482-7A0F60E09877

    示例

    正常返回示例

    JSON格式

    {
      "MediaInfoJob": {
        "CreationTime": "2014-01-10T12:00:00Z",
        "State": "Analyzing",
        "JobId": "23ca1d184c0e4341e5b665e2a12****",
        "UserData": "testid-001",
        "Code": "InvalidParameter.JsonObjectFormatInvalid",
        "Message": "The parameter ”*” does not conform to the JSON Object specification",
        "PipelineId": "88c6ca184c0e432bbf5b665e2a15****",
        "Async": true,
        "Input": {
          "Object": "example.flv",
          "Location": "example-location",
          "Bucket": "example-bucket"
        },
        "MNSMessageResult": {
          "MessageId": "16f01ad6175e4230ac42bb5182cd****",
          "ErrorMessage": "InvalidParameter.JsonObjectFormatInvalid",
          "ErrorCode": "The parameter \\\"Input\\\" does not conform to the JSON Object specification"
        },
        "Properties": {
          "Width": "1920",
          "Height": "1080",
          "Duration": "17.226000",
          "Fps": "25",
          "Bitrate": "1630.045",
          "FileFormat": "QuickTime/MOV",
          "Streams": {
            "VideoStreamList": {
              "VideoStream": [
                {
                  "Sar": "1:1",
                  "Height": "1080",
                  "CodecTagString": "avc1",
                  "NetworkCost": {
                    "PreloadTime": "8",
                    "AvgBitrate": "300.34",
                    "CostBandwidth": "10"
                  },
                  "Width": "1920",
                  "Index": "1",
                  "Timebase": "1/24000",
                  "AvgFPS": "23.976025",
                  "PixFmt": "yuv420p",
                  "Lang": "eng",
                  "CodecLongName": "H.264/AVC/MPEG-4 AVC/MPEG-4 part 10",
                  "NumFrames": "100",
                  "Rotate": "90",
                  "Bitrate": "1496.46",
                  "HasBFrames": "0",
                  "Profile": "High",
                  "StartTime": "0.042000",
                  "Dar": "16:9",
                  "CodecName": "h264",
                  "Duration": "17.225542",
                  "Fps": "25",
                  "CodecTag": "0x31637661",
                  "CodecTimeBase": "1001/48000",
                  "Level": "41",
                  "ColorRange": "700",
                  "ColorTransfer": "R255 G83 B170",
                  "ColorPrimaries": "700"
                }
              ]
            },
            "AudioStreamList": {
              "AudioStream": [
                {
                  "Timebase": "1/44100",
                  "Index": "1",
                  "SampleFmt": "fltp",
                  "ChannelLayout": "stereo",
                  "Lang": "eng",
                  "Samplerate": "44100",
                  "CodecLongName": "AAC (Advanced Audio Coding)",
                  "Channels": "2",
                  "NumFrames": "123",
                  "Bitrate": "128.806",
                  "CodecTagString": "mp4a",
                  "StartTime": "0.000000",
                  "CodecName": "aac",
                  "Duration": "17.159546",
                  "CodecTag": "0x6134706d",
                  "CodecTimeBase": "1/44100"
                }
              ]
            },
            "SubtitleStreamList": {
              "SubtitleStream": [
                {
                  "Timebase": "1/1000",
                  "Index": "3",
                  "StartTime": "0.000000",
                  "CodecName": "ass",
                  "Lang": "eng",
                  "CodecLongName": "ASS (Advanced SSA) subtitle",
                  "Duration": "1370.116000",
                  "CodecTag": "0x0000",
                  "CodecTimeBase": "0/1",
                  "CodecTagString": "[0][0][0][0]"
                }
              ]
            }
          },
          "Format": {
            "StartTime": "0.000000",
            "NumPrograms": "0",
            "Size": "3509895",
            "NumStreams": "2",
            "FormatLongName": "QuickTime/MOV",
            "Duration": "17.226000",
            "Bitrate": "1630.045",
            "FormatName": "mov"
          },
          "FileSize": "3509895"
        }
      },
      "RequestId": "62D9BE16-B7D5-550C-A482-7A0F60E09877"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2021-05-18新增 OpenAPI
    • 本页导读 (1)
    文档反馈