短视频开始录制接口

最近更新时间:2020-05-27 21:09:15

短视频开始录制接口(StartStreamRecord)

描述

调用此接口将直播中的精彩片段实时生成短视频;

任务限制:每条流同一时间段只能开始一个短视频录制,同一时间段内只能最多存在30条路流进行短视频录制;

时长限制:2h,开始短视频录制和结束短视频录制时间差最长2h,若时间差大于2h,则从开始操作2h后,自动结束录制;

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

请求参数

参数名 类型 是否必须 描述
Action String Y 操作接口名,取值:StartStreamRecord
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}-micro
Ks3FullPathMP4 string N MP4文件存储全路径规则,支持变量匹配;包含{UniqueName}、{AppName}、{Pubdomain}、{StreamName}、{UnixTimestamp}、{Y} 、{m}、{d} 、{H}、{S}、{M};默认文件路径为record/{UniqueName}/{AppName}/{ Pubdomain}/{StreamName}/mp4/{StreamName}-{UnixTimestamp}-micro

注:

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.命名内时间戳是小视频结束录制触发时间;

返回参数

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

请求示例

POST /?Action=StartStreamRecord&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":"xxx",
    "App":"xxx",
    "Pubdomain":"xxx.xxx.com",
    "Stream":"xxx",
    "Mp4VodEnable":1,
    "Ks3FileNameM3U8":"{UniqueName}-{AppName}-{Pubdomain}-{StreamName}-{UnixTimestamp}-{Y}-{m}-{d}-{H}-{M}-{S}-{S}",
    "Ks3FullPathMP4":"record/{UniqueName}/{AppName}/{Pubdomain}/{StreamName}/mp4/{StreamName}-{UnixTimestamp}-{Y}-{m}-{d}-{H}-{M}-{S}-activity"

}

返回示例

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

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

免费注册