Create Recording Task

Last updated: 2019-07-30 15:36:08

PDF

1. API Description

  • API
  • Live_Tape_Start*: This API is used to create a recording task.
  • URL
    URL for calling API: http://fcgi.video.qcloud.com/common_access
  • Note
    Recorded files are stored on the VOD platform. If you want to use the recording feature, you need to activate the VOD service. When recording files are stored, the charges (including charges for storage and downstream playback traffic) are calculated with VOD billing method.
    Create a recording task. This API supports two recording modes: Scheduled Recording and Real-time Recording. In Scheduled Recording, importing the start time of a task is needed, which may cause the missing of wonderful moments in a video. In Real-time Recording, recording is synchronous with playback of a video, making it possible to capture all of the marvelous moments in a video. Note: API calling timeout should be greater than 3 seconds, because retries within 3 seconds and frequent calls may lead to duplicate recording tasks.

2. Input Parameters

Parameter Name Description Type Note Required
APPID Customer ID int LVB APPID used for identifying customers Y
interface API name string Enter Live_Tape_Start Y
t Validity period int UNIX timestamp (decimal) Y
sign Security signature string MD5(key+t) Y
Param.s.channel_id Channel ID string Y
Param.s.start_time Start time of the task string China Standard Time, which needs urlencode, such as: 2017-01-01%2010:10:01 Y
Param.s.end_time End time of the task string China Standard Time, which needs urlencode, such as: 2017-01-01%2010:10:01 Y
Param.n.task_sub_type Whether to enable real-time recording int 1 - Enable; 0 - Disable. 1 is recommended.
a. Creating real-time recording tasks requires that VJs push streams actively. The video recording starts at the moment when this API is successfully called. In this case, the parameter of task start time is ignored.
b. The real-time recording task supports a maximum length of 30 minutes. If the time difference between the passed task end time and the current time is longer than 30 minutes, only a length of 30 minutes is recorded. The recommended recording length is within 5 minutes.
c. If real-time recording is disabled, the parameter of task start time is required, and the time difference between the end time and the start time should not be longer than 1 day.
Y
Param.s.file_format Format of recorded files string Available values include flv (default), hls, mp4, and aac N
Param.s.record_type Type of recorded files string Default is video
When record_type is "video", file_format can be "flv", "hls", or "mp4"
When record_type is "audio", file_format can be "aac", "flv", "hls", or "mp4"
N

3. Output Parameters

Parameter Name Description Type Note
ret Error code int 0: Successful; other values: Failed.
message Error message string Error message
output Message content array For more information, please see the description below.

"output" is composed as follows:

Field Name Description Type Note
task_id Task ID int 64-bit unsigned integer

4. Example

Purpose: To query the list of files recorded during the LVB for the LVB stream with an LVB Code of 8888_test123.

Component Example
API URL http://fcgi.video.qcloud.com/common_access?
appid 1234
interface Live_Tape_Start
Param.s.channel_id 8888_test123
Param.s.start_time Start time of the task
Param.s.end_time End time of the task
t 1471850187
sign b17971b51ba0fe5916ddcd96692e9fb3
//When copying them, remove the invisible line breaks used for improving layout. Otherwise, URL construction errors may occur, such as "appid is invalid".
URL = http://fcgi.video.qcloud.com/common_access?
            appid=1234&interface=Live_Tape_Start
            &Param.s.channel_id=8888_test123
            &Param.s.start_time=2017-05-20+10%3a00%3a00
            &Param.s.end_time=2017-05-20+10%3a30%3a00
            &Param.n.task_sub_type=1
            &t=1471850187&sign=b17971b51ba0fe5916ddcd96692e9fb3
Note: Param.s.start_time and Param.s.end_time need to be encoded. After being encoded, 2017-05-20 10:00:00 is converted to 2017-05-20+10%3a00%3a00, and 2017-05-20 10:30:00 to 2017-05-20+10%3a30%3a00.