CreateRecordTask

Last updated: 2020-09-04 09:44:44

1. API Description

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

This API is used to create a recording task that starts and ends at specified times and records by using the configuration corresponding to a specified recording template ID.

  • Prerequisites
  1. Recording files are stored on the VOD platform, so if you need to use the recording feature, you must first activate the VOD service.
  2. After the recording files are stored, applicable fees (including storage fees and downstream playback traffic fees) will be charged according to the VOD billing mode. For more information, please see the corresponding document.
  • Precautions
  1. An interruption will end the current recording and generate a recording file. The task will still be valid before the end time expires, and as long as the stream is pushed normally during the period, it will record normally, regardless of whether the push is interrupted or restarted multiple times.
  2. Creating recording tasks with overlapping time periods must be avoided. If there are multiple tasks with overlapping time periods for the same stream, the system will start three recording tasks at most to avoid repeated recording.
  3. The record of a created recording task will be retained for 3 months on the platform.
  4. The current recording task management APIs (CreateRecordTask/StopRecordTask/DeleteRecordTask) are not compatible with the legacy APIs (CreateLiveRecord/StopLiveRecord/DeleteLiveRecord), and they cannot be mixed.

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 parameter. The value used for this API: CreateRecordTask.
Version Yes String Common parameter. The value used for this API: 2018-08-01.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
StreamName Yes String Stream name.
DomainName Yes String Push domain name.
AppName Yes String Push path.
EndTime Yes Integer Recording task end time in UNIX timestamp, which must be after StartTime and within 24 hours from the current time.
StartTime No Integer Recording task start time in UNIX timestamp. If this parameter is left empty, it indicates to start recording immediately. It must be within 24 hours from the current time.
StreamType No Integer Push type. Default value: 0. Valid values:
0: LVB push.
1: mixed stream, i.e., A + B = C mixed stream.
TemplateId No Integer Recording template ID, which is the returned value of CreateLiveRecordTemplate. If this parameter is left empty or incorrect, the stream will be recorded in HLS format and retained permanently by default.
Extension No String Extended field, which is empty by default.

3. Output Parameters

Parameter Name Type Description
TaskId String Task ID, which uniquely identifies the recording task globally.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample

Input Example

https://live.tencentcloudapi.com/?Action=CreateRecordTask
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&StartTime=1589889600
&EndTime=1589904000
&TemplateId=0
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "TaskId": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError Internal error.
InternalError.GetConfigError Error getting the configuration.
InternalError.NetworkError Internal network error.
InvalidParameter Invalid parameter.
LimitExceeded.MaximumRunningTask The current number of concurrent tasks exceeds the limit.
ResourceUnavailable.InvalidVodStatus The VOD service has not been activated.
UnsupportedOperation Unsupported operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help