SubmitMediaInfoJob - 提交媒体信息作业

更新时间:
复制为 MD 格式

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

接口说明

  • 请确认文件已成功上传至 OSS 后再提交媒体信息作业,否则会导致执行失败。您可通过配置 OSS 回调消息确认文件上传状态。

  • 媒体信息作业分为同步和异步模式。

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

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mts:SubmitMediaInfoJob

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Input

string

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

说明
  • 在媒体处理 API 中,Object 必须经过URL Encoding(基于 UTF-8 编码)后使用。

  • OSS 的地域需要与当前 MPS 所在地域保持一致。

{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Fexample.flv"}

UserData

string

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

testid-001

PipelineId

string

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

  • 可选值:可以通过 MPS 控制台>全局设置>管道查询和创建。

  • 如果需要异步通知,请为管道绑定 MNS 消息,具体请参见接收消息通知

88c6ca184c0e432bbf5b665e2a15****

Async

boolean

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

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

  • false:不发起异步作业。

true

Config

string

返回参数

名称

类型

描述

示例值

object

返回参数。

MediaInfoJob

object

媒体信息作业详细信息。

CreationTime

string

作业添加时间。

2014-01-10T12:00:00Z

State

string

作业状态。

  • Success:成功。

  • Fail:失败。

  • Analyzing:分析中。

Analyzing

JobId

string

元信息分析作业 ID。

23ca1d184c0e4341e5b665e2a12****

UserData

string

用户自定义数据。

testid-001

Code

string

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

InvalidParameter.JsonObjectFormatInvalid

Message

string

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

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

PipelineId

string

管道 ID。

88c6ca184c0e432bbf5b665e2a15****

Async

boolean

是否异步。

true

Input

object

作业输入信息。

Object

string

输入文件的 OSS Object。

example.flv

Location

string

输入文件 OSS 的服务区域。

example-location

Bucket

string

输入文件的 OSS Bucket。

example-bucket

MNSMessageResult

object

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

MessageId

string

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

16f01ad6175e4230ac42bb5182cd****

ErrorMessage

string

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

InvalidParameter.JsonObjectFormatInvalid

ErrorCode

string

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

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

Properties

object

媒体文件属性。

Width

string

视频宽度,单位为 px。

1920

Height

string

视频高度,单位为 px。

1080

Duration

string

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

17.226000

Fps

string

帧率。

25

Bitrate

string

码率。单位为 Kbps。

1630.045

FileFormat

string

文件格式。

QuickTime/MOV

Streams

object

流信息。

VideoStreamList

object

VideoStream

array<object>

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

array<object>

返回参数。

Sar

string

编码信号分辨率比。

1:1

Height

string

视频高度,单位为 px。

1080

CodecTagString

string

编码格式标记文本。

avc1

NetworkCost

object

网络带宽消耗。

PreloadTime

string

预加载时间。

8

AvgBitrate

string

平均码率,单位为 Kbps。

300.34

CostBandwidth

string

最大消耗带宽。

10

Width

string

视频宽度,单位为 px。

1920

Index

string

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

1

Timebase

string

时基。

1/24000

AvgFPS

string

平均帧率。

23.976025

PixFmt

string

像素格式。

yuv420p

Lang

string

语言。

eng

CodecLongName

string

编码格式长述名。

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

NumFrames

string

总帧数。

100

Rotate

string

视频旋转角度。

90

Bitrate

string

码率,单位 Kbps。

1496.46

HasBFrames

string

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

0

Profile

string

编码预置。

High

StartTime

string

起始时间。

0.042000

Dar

string

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

16:9

CodecName

string

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

  • h264

  • h265

  • gif

  • webp

h264

Duration

string

时长,单位为秒(s)。

17.225542

Fps

string

帧率。

25

CodecTag

string

编码格式标记。

0x31637661

CodecTimeBase

string

编码时基。

1001/48000

Level

string

编码等级。

41

ColorRange

string

色彩范围。

700

ColorTransfer

string

色彩通道。

R255 G83 B170

ColorPrimaries

string

色原。

700

DurationInaccurate

string

DolbyVision

object

Profile

string

Level

string

AudioStreamList

object

AudioStream

array<object>

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

object

返回参数。

Timebase

string

时基。

1/44100

Index

string

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

1

SampleFmt

string

采样格式。

fltp

ChannelLayout

string

声道输出样式。

stereo

Lang

string

语言。

eng

Samplerate

string

采样率,单位 Hz。

44100

CodecLongName

string

编码格式长述名。

AAC (Advanced Audio Coding)

Channels

string

声道数。

2

NumFrames

string

总帧数。

123

Bitrate

string

码率,单位为 Kbps。

128.806

CodecTagString

string

编码格式标记文本。

mp4a

StartTime

string

起始时间。

0.000000

CodecName

string

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

  • acc

  • mp3

  • mp4

  • ogg

  • flac

aac

Duration

string

时长,单位为秒(s)。

17.159546

CodecTag

string

编码格式标记。

0x6134706d

CodecTimeBase

string

编码时基。

1/44100

DurationInaccurate

string

SubtitleStreamList

object

SubtitleStream

array<object>

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

object

返回参数。

Timebase

string

时基。

1/1000

Index

string

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

3

StartTime

string

起始时间。

0.000000

CodecName

string

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

  • srt

  • ass

ass

Lang

string

语言。

eng

CodecLongName

string

编码格式长述名。

ASS (Advanced SSA) subtitle

Duration

string

时长,单位为秒(s)。

1370.116000

CodecTag

string

编码格式标记。

0x0000

CodecTimeBase

string

编码时基。

0/1

CodecTagString

string

编码格式标记文本。

[0][0][0][0]

Format

object

格式信息。

StartTime

string

起始时间。

0.000000

NumPrograms

string

节目流总数。

0

Size

string

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

3509895

NumStreams

string

媒体流总数。

2

FormatLongName

string

容器、封装格式长述名。

QuickTime/MOV

Duration

string

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

17.226000

Bitrate

string

总码率,单位为 Kbps。

1630.045

FormatName

string

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

mov

Tags

object

FileSize

string

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

3509895

MD5

string

RequestId

string

请求 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",
              "DurationInaccurate": "",
              "DolbyVision": {
                "Profile": "",
                "Level": ""
              }
            }
          ]
        },
        "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",
              "DurationInaccurate": ""
            }
          ]
        },
        "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",
        "Tags": {
          "test": "test",
          "test2": 1
        }
      },
      "FileSize": "3509895",
      "MD5": ""
    }
  },
  "RequestId": "62D9BE16-B7D5-550C-A482-7A0F60E09877"
}

错误码

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

变更历史

更多信息,参考变更详情