API 文档

创建录制任务

最近更新时间:2020-03-06 10:51:39

1.接口描述

  • 接口
    Live_Tape_Start:创建录制任务。
  • 地址
    API 调用地址为:http://fcgi.video.qcloud.com/common_access
  • 说明
    • 录制文件存放于点播平台。用户如需使用录制功能,需首先自行开通点播服务,录制文件存放后相关费用(含存储以及下行播放流量)按照点播平台计费方式收取,具体请参考 计费概述 文档。
    • 创建录制任务。该接口支持两种录制模式,定时录制任务和实时视频录制模式,定时任务录制由于需要传入任务开始时间导致可能会错过精彩视频的录制,实时视频录制功能则可满足出现精彩视频的瞬间同步录制。调用接口超时设置应大于3秒,小于3秒重试以及频繁调用都有可能产生重复录制任务
    • 为避免恶意或非主观的频繁 API 请求,对定时录制模式最大创建任务数做了限制,当天可以创建的最大任务数不超过4000(不含已删除的任务)当前时刻并发运行的任务数不超过400有超出此限制的需要 提工单 申请

2.输入参数

参数名 参数含义 类型 备注 是否必需
appid 客户 ID int 直播 appid,用于区分不同客户的身份。
interface 接口名称 string Live_Tape_Start。
t 有效时间 int UNIX 时间戳。
sign 安全签名 string MD5(key+t)。
Param.s.channel_id 频道 ID string 频道托管 的相关参数。
Param.s.start_time 任务开始时间 string 中国标准时间,需要 URLEncode。如:2017-01-01 10:10:01,编码为:2017-01-01+10%3a10%3a01
Param.s.end_time 任务结束时间 string 中国标准时间,需要 URLEencode。如:2017-01-01 10:30:02,编码为:2017-01-01+10%3a30%3a02
Param.n.task_sub_type 是否开启实时视频录制 int
  • 1:开启;0:关闭,推荐使用实时视频录制。
  • 实时视频录制创建成功依赖主播活跃推流,调用接口成功则同步开始录制,并忽略任务开始时间参数。
  • 实时视频录制任务时长支持最大为30分钟,如果传入任务结束时间与当前时间差大于30分钟,则按30分钟计算。
  • 录制时长建议控制在5分钟以内。
  • 如果关闭实时录制,则需要传入任务开始时间参数,且结束时间与开始时间差不大于1天。
  • Param.s.file_format 录制文件格式 string 默认 flv;可取值 flv、hls、mp4、aac。
    Param.s.record_type 录制文件类型 string
  • 默认 video。
  • 当 record_type 取值 video 时,file_format 可以取值 “flv”,"hls","mp4"。
  • 当 record_type 取值 audio 时,file_format 可以取值 “aac”,“flv”,“hls”,“mp4”。
  • Param.s.path 路径 string 多路径用户使用。
    Param.s.domain 域名 string 多域名用户使用。
    Param.s.mix_stream 是否开启输出流类型为1的混流录制 int 1:开启,0:关闭,该功能只针对于直播码模式,且 混流输出流类型 为1生效。

    3.输出结果

    参数名 参数含义 类型 备注
    ret 返回码 int 0:成功;其他值:失败
    message 错误信息 string 错误信息
    output 消息内容 array 详情见下

    其中output的主要内容为:

    字段名 含义 类型 备注
    task_id 任务 ID int 64位无符整形

    4.调用示例

    目标:查询直播码为 8888_test123 的直播流在整个直播过程中所录制的文件列表。

    组成部分 示例内容
    接口 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-01-01+10%3a10%3a01
    Param.s.end_time 2017-01-01+10%3a30%3a02
    t 1471850187
    sign b17971b51ba0fe5916ddcd96692e9fb3
    // copy时请去掉美化排版用的不可见换行符,否则可能出现 “appid is invalid” 等url拼装错误
    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
    注:Param.s.start_time和Param.s.end_time需要encode编码。2017-05-20+10%3a00%3a00是2017-05-20 10:00:00的encode编码;2017-05-20+10%3a30%3a00是2017-05-20 10:30:00的encode编码。
    目录