SubmitSyncMediaInfoJob - 提交同步媒体信息任务

调用SubmitSyncMediaInfoJob以同步模式提交媒体文件进行媒体信息分析。

接口说明

您可以调用本接口以同步模式对输入的文件进行媒体分析,适用于实时性要求较高且并发量较小的场景。 如果遇到片源获取 MediaInfo 需要耗时比较久的情况,可能会因请求超时获取不到信息或者信息不准确,推荐通过SubmitMediaInfoJob - 提交异步媒体信息任务接口获取媒体信息。

调试

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

授权信息

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

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

请求参数

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

任务名字。

job-name
Inputobject

任务输入。

Typestring

媒体对象类型。

  • OSS:OSS 文件,
  • Media:媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议。
说明 URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
UserDatastring

用户数据。

user-data
ScheduleConfigobject

调度参数。可不填。

PipelineIdstring

管道 ID。

e37ebee5d98b4781897f6086e89f9c56
Priorityinteger

任务优先级。数字越大优先级越高,取值范围:1~10

5

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

31E30781-9495-5E2D-A84D-759B0A01E262
MediaInfoJobobject

MediaInfoJobDTO

Namestring

任务名字。

job-name
TriggerSourcestring

任务来源。 API: API, WorkFlow: 工作流, Console: 控制台

API
JobIdstring

任务 ID。

ab4802364a2e49208c99efab82dfa8e8
Inputobject

任务输入。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;

  • type 为 Media 时,为媒资 ID。

oss://bucket/path/to/video.mp4
Asyncboolean

是否异步处理。

true
UserDatastring

用户数据。

user-data
ScheduleConfigobject

调度信息。

PipelineIdstring

管道 ID。

e37ebee5d98b4781897f6086e89f9c56
Priorityinteger

任务优先级。数字越大优先级越高,取值范围:1~10

5
Statusstring

任务状态

  • Init:已提交

  • Success:成功

  • Fail:失败

Init
SubmitResultJsonobject

任务提交信息。

{}
MediaInfoPropertyobject

媒体信息详情。

FileBasicInfoobject

基础文件信息。

MediaIdstring

媒资 ID

999e68259c924f52a6be603cbb3f91cc
FileNamestring

文件名。

file.m3u8
FileStatusstring

文件状态。

Normal
FileTypestring

文件类型。

source_file
FileSizestring

文件大小。单位:Byte。

31737
FileUrlstring

文件 URL。

http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8
Regionstring

文件所在区域。

cn-shanghai
FormatNamestring

视频格式名称。

hls,applehttp
Durationstring

视频时长(单位:秒)。

403.039999
Bitratestring

视频码率。

888.563
Widthstring

宽。

848
Heightstring

高。

478
AudioStreamInfoListarray<object>

音频流信息。

AudioStreamInfoListobject

音频流信息。

Indexstring

流序号。

1
CodecNamestring

编码格式。

aac
CodecLongNamestring

编码格式名。

AAC (Advanced Audio Coding)
CodecTimeBasestring

编码器时间基。

1/44100
CodecTagStringstring

编码器标签名。

[15][0][0][0]
CodecTagstring

编码器标签。

0x000f
SampleFmtstring

采样格式。

fltp
SampleRatestring

采样率(单位:Hz)。

44100
Channelsstring

声道数。

2
ChannelLayoutstring

声道布局。

stereo
Timebasestring

时间基。

1/90000
StartTimestring

开始时间。

1.473556
Durationstring

时长。

403.039989
Bitratestring

码率。

0.f
Langstring

语言。

us
VideoStreamInfoListarray<object>

视频流信息。

VideoStreamInfoListobject

视频流信息。

Indexstring

流序号。

0
Codec_namestring

编码格式。

h264
Codec_long_namestring

编码格式名。

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

编码器预设。

High
Codec_time_basestring

编码时基。

1/50
Codec_tag_stringstring

编码格式标记文本。

[27][0][0][0]
Codec_tagstring

编码格式标记。

0x001b
Widthstring

宽。

848
Heightstring

高。

478
Has_b_framesstring

是否有 B 帧。 取值:

  • 0:没有 B 帧,
  • 1:有一个 B 帧,
  • 2:有多个连续 B 帧。
2
Sarstring

采集点数宽高比。

478:477
Darstring

图像显示宽高比。

16:9
PixFmtstring

颜色存储格式。

yuv420p
Levelstring

编码等级。

31
Fpsstring

帧率。

25.0
Avg_fpsstring

平均帧率。

25.0
Time_basestring

时基。

1/90000
Start_timestring

起始时间。

1.473556
Durationstring

时长。

403.039989
Bit_ratestring

码率。

888.563
NumFramesstring

总帧数。

10040
Langstring

语言。

zh
Rotatestring

视频画面旋转角度。

0
SubmitTimestring

任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。

2022-01-12T08:49:41Z
FinishTimestring

任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。

2022-01-12T08:49:41Z
RequestIdstring

请求 ID。

4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168

示例

正常返回示例

JSON格式

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "MediaInfoJob": {
    "Name": "job-name",
    "TriggerSource": "API",
    "JobId": "ab4802364a2e49208c99efab82dfa8e8",
    "Input": {
      "Type": "OSS",
      "Media": "oss://bucket/path/to/video.mp4"
    },
    "Async": true,
    "UserData": "user-data",
    "ScheduleConfig": {
      "PipelineId": "e37ebee5d98b4781897f6086e89f9c56",
      "Priority": 5
    },
    "Status": "Init",
    "SubmitResultJson": {},
    "MediaInfoProperty": {
      "FileBasicInfo": {
        "MediaId": "999e68259c924f52a6be603cbb3f91cc",
        "FileName": "file.m3u8",
        "FileStatus": "Normal",
        "FileType": "source_file",
        "FileSize": "31737",
        "FileUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8",
        "Region": "cn-shanghai",
        "FormatName": "hls,applehttp",
        "Duration": "403.039999",
        "Bitrate": "888.563",
        "Width": "848",
        "Height": "478"
      },
      "AudioStreamInfoList": [
        {
          "Index": "1",
          "CodecName": "aac",
          "CodecLongName": "AAC (Advanced Audio Coding)",
          "CodecTimeBase": "1/44100",
          "CodecTagString": "[15][0][0][0]",
          "CodecTag": "0x000f",
          "SampleFmt": "fltp",
          "SampleRate": "44100",
          "Channels": "2",
          "ChannelLayout": "stereo",
          "Timebase": "1/90000",
          "StartTime": "1.473556",
          "Duration": "403.039989",
          "Bitrate": "0.f",
          "Lang": "us"
        }
      ],
      "VideoStreamInfoList": [
        {
          "Index": "0",
          "Codec_name": "h264",
          "Codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
          "Profile": "High",
          "Codec_time_base": "1/50",
          "Codec_tag_string": "[27][0][0][0]",
          "Codec_tag": "0x001b",
          "Width": "848",
          "Height": "478",
          "Has_b_frames": "2",
          "Sar": "478:477",
          "Dar": "16:9",
          "PixFmt": "yuv420p",
          "Level": "31",
          "Fps": "25.0",
          "Avg_fps": "25.0",
          "Time_base": "1/90000",
          "Start_time": "1.473556",
          "Duration": "403.039989",
          "Bit_rate": "888.563",
          "NumFrames": "10040",
          "Lang": "zh",
          "Rotate": "0"
        }
      ]
    },
    "SubmitTime": "2022-01-12T08:49:41Z",
    "FinishTime": "2022-01-12T08:49:41Z",
    "RequestId": "4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-27API 内部配置变更,不影响调用查看变更详情
2022-08-10API 内部配置变更,不影响调用查看变更详情
2022-07-11新增 OpenAPI查看变更详情