tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Streaming Services
    Documentation
    Download PDF

    CreateLiveRecordTemplate

    Last updated: 2022-06-15 16:21:10
    Download PDF

    1. API Description

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

    This API is used to create a recording template. You can create up to 50 templates. To use a template, you need to call the CreateLiveRecordRule API to bind the template ID returned by this API to a stream.

    More on recording: Live Recording

    A maximum of 200 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: CreateLiveRecordTemplate.
    Version Yes String Common Params. The value used for this API: 2018-08-01.
    Region No String Common Params. This parameter is not required for this API.
    TemplateName Yes String Template name. Only letters, digits, underscores, and hyphens can be contained.
    Description No String Message description
    FlvParam No RecordParam FLV recording parameter, which is set when FLV recording is enabled.
    HlsParam No RecordParam HLS recording parameter, which is set when HLS recording is enabled.
    Mp4Param No RecordParam Mp4 recording parameter, which is set when Mp4 recording is enabled.
    AacParam No RecordParam AAC recording parameter, which is set when AAC recording is enabled.
    IsDelayLive No Integer LVB type. Default value: 0.
    0: LVB.
    1: LCB.
    HlsSpecialParam No HlsSpecialParam HLS-specific recording parameter.
    Mp3Param No RecordParam Mp3 recording parameter, which is set when Mp3 recording is enabled.
    RemoveWatermark No Boolean Whether to remove the watermark. This parameter is invalid if IsDelayLive is 1.
    FlvSpecialParam No FlvSpecialParam A special parameter for FLV recording.

    3. Output Parameters

    Parameter Name Type Description
    TemplateId Integer Template ID.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sample request

    Input Example

    https://live.tencentcloudapi.com/?Action=CreateLiveRecordTemplate
&TemplateName=templat
&Description=test
&FlvParam.Enable=0
&FlvParam.RecordInterval=1800
&FlvParam.StorageTime=600
&HlsParam.Enable=1
&HlsParam.RecordInterval=1800
&HlsParam.StorageTime=600
&<Common request parameters>

    Output Example

    {
  "Response": {
    "TemplateId": 1000,
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

    Example2 Example

    Input Example

    POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLiveRecordTemplate
<Common request parameters>

{
    "RemoveWatermark": "false",
    "FlvParam": {
        "StorageTime": "2",
        "VodSubAppId": "251195406",
        "Enable": "1",
        "RecordInterval": "2222"
    },
    "IsDelayLive": "0",
    "Description": "String",
    "TemplateName": "String"
}

    Output Example

    {
  "Response": {
    "RequestId": "74ed2203-278d-4ec8-8c67-65626a94daef",
    "TemplateId": 362894
  }
}

    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.NotFound No records found.
    InternalError Internal error.
    InternalError.ArgsNotMatch For the transcoding template adding API.
    InternalError.ConfInUsed The template is in use.
    InternalError.ConfNotFound The template does not exist.
    InternalError.ConfOutLimit The number of templates exceeded the limit.
    InternalError.InvalidInput Parameter check failed.
    InternalError.NotFound The record does not exist.
    InternalError.RuleAlreadyExist The rule has already been configured.
    InternalError.RuleInUsing The rule is in use.
    InternalError.RuleNotFound The rule does not exist.
    InvalidParameter Invalid parameter.
    InvalidParameter.InvalidVodFileName Incorrect VodFileName.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Parameter missing.
    UnsupportedOperation.NotLVBCodeMode Not a LVB code/new console mode
    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 avaliable.

    Submit a Ticket
    7x24 Phone Support
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy