Extracts audio

Function

This API is an asynchronous API. After an audio extraction task is created and delivered, asset_id and the extracted audio_asset_id are returned. However, the audio extraction task is not complete immediately. You can check whether the audio extraction task is complete in the audio extraction completion event on the event notification page.

URI

POST /v1.0/{project_id}/asset/extract_audio

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the 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. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
asset_id	Yes	String	Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.
parameter	No	Parameter object	Parameters of the audio to be extracted

**Table 4** Parameter
Parameter	Mandatory	Type	Description
format	No	String	Packaging format Possible values are: MP3 AAC

Response Parameters

Status code: 202

**Table 5** Response body parameters
Parameter	Type	Description
asset_id	String	Media ID of the source video
audio_asset_id	String	Media ID of the extracted audio

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Example Requests

Extracts an audio file.

POST https://{endpoint}/v1.0/{project_id}/asset/extract_audio

Content-Type: application/json
{
  "asset_id": "3e1cd21131a94525be55acf65888bf46",
  "parameter": {
    "format": "MP3"
  }
}

Example Responses

Status code: 202

The information is returned when the request succeeds.

{
  "asset_id" : "f488337c31c8e4622f1590735b134c65",
  "audio_asset_id" : "5412"
}

Status code: 400

The information is returned when the request fails.

{
  "error_code" : "VOD.10062",
  "error_msg" : "Media asset or resource does not exist, please check."
}

Status Codes

Status Code	Description
202	The information is returned when the request succeeds.
400	The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Media file processing

Previous topic: Cancels a media asset transcoding task

Next topic: Cancels an audio extraction task

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot