SubmitSyncMediaInfoJob-阿里云帮助中心

Submits a media file in synchronous mode for media information analysis.

Operation description

Analyze an input media file in synchronous mode. This operation is suitable for scenarios that require high real-time performance and low concurrency. If it takes an extended period of time to obtain the media information about the input media file, the request may time out or the obtained information may be inaccurate. We recommend that you call the SubmitMediaInfoJob operation to obtain media information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:SubmitSyncMediaInfoJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The job name.	job-name
Input	object	Yes	The input of the job.
Type	string	Yes	The type of the media object. OSS: an Object Storage Service (OSS) object. Media: a media asset.	OSS
Media	string	Yes	The media object. If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported. Note Before you use the OSS bucket in the URL, you must add the bucket on the Storage Management page of the Intelligent Media Services (IMS) console. If Type is set to Media, set this parameter to the ID of a media asset.	oss://bucket/path/to/video.mp4
UserData	string	No	The user data.	user-data
ScheduleConfig	object	No	The scheduling parameters. This parameter is optional.
PipelineId	string	No	The ID of the MPS queue to which the job was submitted.	e37ebee5d98b4781897f6086e89f9c56
Priority	integer	No	The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.	5

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	31E30781-9495-5E2D-A84D-759B0A01E262
MediaInfoJob	object	MediaInfoJobDTO
Name	string	The job name.	job-name
TriggerSource	string	The source of the job. Valid values: API, WorkFlow, and Console.	API
JobId	string	The job ID.	ab4802364a2e49208c99efab82dfa8e8
Input	object	The input of the job.
Type	string	The type of the media object. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	The media object. If Type is set to OSS, set this parameter to the URL of an OSS object. Both the OSS and HTTP protocols are supported. If Type is set to Media, set this parameter to the ID of a media asset.	oss://bucket/path/to/video.mp4
Async	boolean	Indicates whether asynchronous processing was performed.	true
UserData	string	The user data.	user-data
ScheduleConfig	object	The scheduling information.
PipelineId	string	The ID of the MPS queue to which the job was submitted.	e37ebee5d98b4781897f6086e89f9c56
Priority	integer	The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.	5
Status	string	The state of the job. Valid values: Init (the job is submitted), Success (the job is successful), and Fail (the job failed).	Init
SubmitResultJson	object	The job submission information.	{}
MediaInfoProperty	object	The details of the media information.
FileBasicInfo	object	The basic file information.
MediaId	string	The ID of the media asset.	999e68259c924f52a6be603cbb3f91cc
FileName	string	The file name.	file.m3u8
FileStatus	string	The state of the file. Valid values: Normal	Normal
FileType	string	The file type.	source_file
FileSize	string	The file size. Unit: bytes.	31737
FileUrl	string	The URL of the file.	http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8
Region	string	The region in which the file resides.	cn-shanghai
FormatName	string	The name of the video format.	hls,applehttp
Duration	string	The duration of the video. Unit: seconds.	403.039999
Bitrate	string	The video bitrate.	888.563
Width	string	The width of the output video.	848
Height	string	The height of the output video.	478
AudioStreamInfoList	array<object>	The information about the audio stream.
	object	The information about the audio stream.
Index	string	The sequence number of the stream.	1
CodecName	string	The encoding format.	aac
CodecLongName	string	The name of the encoding format.	AAC (Advanced Audio Coding)
CodecTimeBase	string	The time base of the encoder.	1/44100
CodecTagString	string	The name of the encoder tag.	[15][0][0][0]
CodecTag	string	The encoder tag.	0x000f
SampleFmt	string	The sample format.	fltp
SampleRate	string	The sampling rate. Unit: Hz.	44100
Channels	string	The number of sound channels.	2
ChannelLayout	string	The sound channel layout.	stereo
Timebase	string	The time base.	1/90000
StartTime	string	The start time of the stream.	1.473556
Duration	string	The duration of the file.	403.039989
Bitrate	string	The bitrate.	0.f
Lang	string	The language of the stream.	us
VideoStreamInfoList	array<object>	The information about the video stream.
	object	The information about the video stream.
Index	string	The sequence number of the stream.	0
Codec_name	string	The encoding format.	h264
Codec_long_name	string	The name of the encoding format.	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Profile	string	The encoder profile.	High
Codec_time_base	string	The time base of the encoder.	1/50
Codec_tag_string	string	The tag string of the encoding format.	[27][0][0][0]
Codec_tag	string	The tag of the encoding format.	0x001b
Width	string	The width of the output video.	848
Height	string	The height of the output video.	478
Has_b_frames	string	Indicates whether the video stream contains bidirectional frames (B-frames). Valid values: 0: The stream contains no B-frames. 1: The stream contains one B-frame. 2: The stream contains multiple consecutive B-frames.	2
Sar	string	The aspect ratio of the area from which the sampling points are collected.	478:477
Dar	string	The display aspect ratio.	16:9
PixFmt	string	The pixel format.	yuv420p
Level	string	The codec level.	31
Fps	string	The frame rate.	25.0
Avg_fps	string	The average frame rate.	25.0
Time_base	string	The time base.	1/90000
Start_time	string	The start time of the stream.	1.473556
Duration	string	The duration of the file.	403.039989
Bit_rate	string	The bitrate.	888.563
NumFrames	string	The total number of frames.	10040
Lang	string	The language of the stream.	zh
Rotate	string	The rotation angle of the video image.	0
SubmitTime	string	The time when the job was submitted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-01-12T08:49:41Z
FinishTime	string	The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-01-12T08:49:41Z
RequestId	string	The request ID.	4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.