tencent cloud

All product documents
APIs
DocumentationAPIsVideo on DemandOther APIsAttachMediaSubtitles
AttachMediaSubtitles
Last updated: 2024-03-27 16:09:27
AttachMediaSubtitles
Last updated: 2024-03-27 16:09:27

1. API Description

Domain name for API request: vod.tencentcloudapi.com.

This API is used to associate/disassociate subtitles with/from a media file of a specific adaptive bitrate streaming template ID.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: AttachMediaSubtitles.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
FileId Yes String Unique ID of the media file
Operation Yes String Operation. Valid values:
  • Attach: associates subtitles.
  • Detach: disassociates subtitles.
    		•
    AdaptiveDynamicStreamingDefinition Yes Integer Adaptive bitrate streaming template ID
    SubtitleIds.N Yes Array of String Unique IDs of the subtitles
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Associating subtitles

    Input Example

    https://vod.tencentcloudapi.com/?Action=AttachMediaSubtitles
&FileId=123
&AdaptiveDynamicStreamingDefinition=10000
&Operation=Attach
&SubtitleIds.0=subtitle1
&SubtitleIds.1=subtitle2
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "requestId"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon