Help Center> Media Processing Center> API Reference> APIs for Video Metadata Extraction> Creating a Video Parsing Task
View PDF

Creating a Video Parsing Task

Function

This API is used to create a task to parse the metadata of a video file.

URI

POST /v1/{project_id}/extract-metadata

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

The token is obtained by calling the IAM API used to obtain a user token. The token is the value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Project_Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

input

No

ObsObjInfo object

Input file information

output

No

ObsObjInfo object

Output file information

user_data

No

String

Custom user data

sync

No

Integer

Whether to enable synchronous processing.

  • 0: Synchronous processing is not enabled. Video metadata is not synchronized. It is queued for processing.

  • 1: Synchronous processing is enabled. Video metadata is synchronized.

Default value: 0.
Table 4 ObsObjInfo

Parameter

Mandatory

Type

Description

bucket

Yes

String

OBS bucket name

location

Yes

String

Region where an OBS bucket is located. It must be the same as the region where MPC is deployed.

object

Yes

String

File path.

  • If this parameter is used for an input, a specific path must be specified.

  • If this parameter is used for an output, only the directory for storing the outputs needs to be specified.

file_name

No

String

Name of an output file. This parameter is valid only for packaging tasks.

  • If this parameter is specified, the output object name is object/file_name.

  • If this parameter is not specified, the output object name is object/xxx, where xxx is allocated by MPC.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task_id

String

Task ID

status

String

Task status.

create_time

String

Time when a task is created

output

ObsObjInfo object

Output file information

output_file_name

String

Name of an output file.

description

String

Task description. If a task is abnormal, this field indicates error details.

metadata

MetaData object

Metadata of a video file
Table 6 ObsObjInfo

Parameter

Type

Description

bucket

String

OBS bucket name

location

String

Region where an OBS bucket is located. It must be the same as the region where MPC is deployed.

object

String

File path.

  • If this parameter is used for an input, a specific path must be specified.

  • If this parameter is used for an output, only the directory for storing the outputs needs to be specified.

file_name

String

Name of an output file. This parameter is valid only for packaging tasks.

  • If this parameter is specified, the output object name is object/file_name.

  • If this parameter is not specified, the output object name is object/xxx, where xxx is allocated by MPC.
Table 7 MetaData

Parameter

Type

Description

size

Long

File size

duration_ms

Double

Video duration (unit: second), with decimal places.

duration

Long

Video duration

Unit: s

format

String

File container format

bitrate

Long

Total bitrate. Unit: bit/s.

video

Array of VideoInfo objects

Video metadata

audio

Array of AudioInfo objects

Audio metadata
Table 8 VideoInfo

Parameter

Type

Description

width

Integer

Video width

height

Integer

Video height

bitrate

Integer

Video bitrate, in kbit/s

bitrate_bps

Long

Video bitrate, in bit/s

frame_rate

Integer

Frame rate.

The value is 0 or ranges from 5 to 60. The value 0 indicates adaptive frame rate.

Unit: FPS

NOTE:

If the configured frame rate is not within the value range, the value is automatically changed to 0. If the configured frame rate is higher than the frame rate of the input file, the value is automatically changed to the frame rate of the input file.

codec

String

Video codec
Table 9 AudioInfo

Parameter

Type

Description

codec

String

Audio codec

sample

Integer

Audio sampling rate

channels

Integer

Number of audio channels

bitrate

Integer

Audio bitrate, in kbit/s

bitrate_bps

Long

Audio bitrate, in bit/s

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

POST https://{endpoint}/v1/{project_id}/extract-metadata
  {
  "input": {
             "bucket": "obs-gxh",
             "location": "region1",
             "object": "1/okFLV.flv"
  },
  "output": {
             "bucket": "obs-gxh",
             "location": "region1",
             "object": "1/output"
  },
  "sync": 0
  }

Example Responses

Status code: 400

Failed to create a video parsing task.

{
  "error_code" : "MPC.10202",
  "error_msg" : "Invalid request parameter."
}

Status Codes

Status Code

Description

200

Video parsing task created successfully.

400

Failed to create a video parsing task.

Error Codes

See Error Codes.