定时录制接口

最近更新时间:2020-05-27 21:08:29

定时录制接口(CreateRecordTask)

接口描述

此接口支持为某指定时间内的直播内容启动定时录制的任务;注意若此段时间内存在断流情况,则将断流前后的视频文件拼接为一个录制文件,若没有直播内容则返回为空;

只允许发起一个月内的定时任务;

线上最多只能存在30个待启动和已启动的定时录制任务;

此接口需开通才能应用,请联系技术支持。

请求参数

参数名 类型 是否必须 描述
Action String Y 操作接口名,取值:CreateRecordTask
Version String Y 版本号,取值:2017-01-01
UniqueName string Y 域名标识
App string Y 应用名
Pubdomain string Y 推流域名
Stream string Y 流名
Mp4VodEnable int N 是否录制MP4文件, 0:不录制, 1:录制;默认值为0
Ks3FileNameM3U8 string N 设置M3U8文件文件名,支持变量匹配;包含{UniqueName}、{AppName}、{Pubdomain}、{StreamName}、{UnixTimestamp}、 {Y} 、{m} 、{d}、、{H}、{S}、{M}、默认文件名为{StreamName}-{UnixTimestamp}-activity
Ks3FullPathMP4 string N 设置MP4文件存储全路径(路径+文件名),支持变量匹配;包含{UniqueName}、{AppName}、{Pubdomain}、{StreamName}、{UnixTimestamp}、 {Y} 、{m} 、{d}、{H}、{S}、{M}、默认文件路径为record/{UniqueName}/{AppName}/{Pubdomain}/{StreamName}/mp4/{StreamName}-{UnixTimestamp}-activity
StartUnixTime int Y 开始录制时间,开始时间必须在当前时间的5min后,UTC时间戳,从1970年开始的毫秒数
EndUnixTime int Y 结束录制时间,UTC时间戳,从1970年开始的毫秒数;结束录制时间需在开始录制时间之后至少1min;

注:

1.定时录制文件存储bucket为HLS录像绑定的Bucket,请确保HLS录像的开启;

2.默认生成m3u8录制文件,存储路径为/record/app/stream/hls/;

3.变量匹配支持:字母a-zA-Z,数字,“_”,“-”“{”,“}”,首个字符支持a-zA-Z,数字或者“{”,“{”代表通配符;

{Y} :year 2017

{m} : month (01..12)

{d} : day of month (e.g, 01)

{H} :hour (00..23)

{S} : second (00..60)

{M} :minute (00..59);

4.命名内时间戳取用户配置的定时录制结束时间;

返回参数

参数名 类型 是否必须 描述
RecID int Y 响应成功为录像任务ID 失败为0
UniqueName string N 域名标识
App string N 应用名
Pubdomain string N 推流域名
Stream string N 流名
Retcode int Y 响应码 0成功 其他失败
RetMsg string Y 错误信息

请求示例

POST /?Action=CreateRecordTask&Version=2017-01-01 HTTP/1.1 
Content-Type: application/json
X-Amz-Date: YOURDATE
Authorization: AWS4-HMAC-SHA256 Credential=YOURAK/YYYYMMDD/cn-beijing-6/kls/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=SIG
Host: kls.api.ksyun.com
 {
     "UniqueName":"xxxx",
     "App":"live",
     "Pubdomain":"xxx.xxx.xxx.com",
     "Stream":"xxx",
     "Mp4VodEnable":1,
     "Ks3FileNameM3U8":"a_m3u8_{UnixTimestamp}_{StreamName}",
     "Ks3FullPathMP4":"record-1/{UniqueName}/{AppName}/{Pubdomain}/{StreamName}/mp4/{StreamName}-{UnixTimestamp}-{Y}-{m}-{d}-{H}-{M}-{S}-activity",
     "StartUnixTime":1490855280,
     "EndUnixTime":1490855380
}

返回示例

{  
   "Data": {
        "App": "xxx",
        "Pubdomain": "xxx.xxx.com",
        "RecID": 696,  
        "RetCode": 0,   
        "RetMsg": "success", 
        "Stream": "xxx", 
        "UniqueName": "xxx" 
   }
}

金山云,开启您的云计算之旅

免费注册