发起轮播转码接口(StartLoop)

最近更新时间:2021-03-15 18:09:42

查看PDF

接口描述

发起轮播任务,用于将指定的点播视频文件转换为源站的直播视频流;

适用于将客户在直播间内循环播放热门视频。

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

输入文件格式

mp4/flv/m3u8/mpegts

注:如果使用多文件轮播最好先用离线转码将所有视频参数统一,并转成mp4视频再发起轮播
支持的文件名字符:中文、英文大小写、-$^&=’~,[]{};!¥……(——);‘’“”,。《》?.
限制说明:目前只支持音视频类文件轮播,不支持纯视频、纯音频类混合轮播类。

请求方式:

POST

请求参数:

参数名 类型 是否必需 描述
UniqName string 客户的域名标识
App string 客户的频道名
Preset string 模板名称,支持配置:视频帧率、视频码率、音频码率、视频分辨率
StreamID string 轮播流名
SrcInfo json array 轮播源文件信息,数组,每项包括文件路径(金山云KS3内网URL)和顺序参数。发起轮播前请先确认轮播源文件是否存在。最多可以支持100个轮播任务。
PubDomain string 推流域名
TaskStartTime int 任务开始时间戳,指定轮播流启动播放时间,精确到秒,不填默认下发后立即开始轮播。只能填当前时间1分钟之后的时间。
TaskStopTime int 任务结束时间戳,指定轮播流结束播放时间,精确到秒,不填默认结束时间为开始时间之后一年。TaskStopTime-TaskStartTime必须>30s。
LoopTimes int 文件轮播次数,与TaskStopTime冲突时,以TaskStopTime为准,如果需要以轮播次数为准,TaskStopTime不填
SrcInfo 类型 是否必需 描述
Path string 源文件在ks3的完整路
Index int 文件播放顺序

备注:

  • SrcInfo必须是金山云KS3内网URL,组合内网域名与视频文件的objectkey。使用外网URL会造成轮播失败。推荐使用region在北京的bucket做为SrcInfo的来源。在KS3空间概况可以显示该bucket的内网域名。

  • 推荐bucket的权限设置为公开读,设置方式参见KS3存储空间维护-权限设置。如果bucket只能设置私密,则SrcInfo需要客户按KS3接口文档-请求签名的要求预先完成签名,再赋予SrcInfo。请注意,采用预先签名时,需要保证签名过期时间足够长,因为签名过期,会造成轮播失败。

  • 新建轮播任务时,只能指定最大20天的轮播时长,可以调用更新轮播时长接口,每次更新时长也是最长20天。更新轮播时长接口可以多次调用。

返回参数:

参数名 类型 是否必需 描述
ErrNum int 错误码
ErrMsg string 错误信息
List json array 轮播转码任务信息
TaskID string 轮播转码单个任务ID
Format int 转码任务使用的output_format

请求示例:


POST /?Action=StartLoop

&Version=2017-01-01

&X-Amz-Algorithm=AWS4-HMAC-SHA256

&X-Amz-Date=20170518T090434Z

&X-Amz-Credential=xxxxx

&X-Amz-SignedHeaders=xxxxx

&X-Amz-Signature=xxxxxx HTTP/1.1

Host: ket.cn-beijing-6.api.ksyun.com

Accept: application/json

{

    "PubDomain": "xxx.xxx.com",

    "UniqName": "xxxxx",

    "Preset": "testpreset",

    "SrcInfo": [

        {

            "Path": "http://xxx.xxx.com/ksyun.flv",

            "Index": 0

        }

    ],

    "StreamID": "myteststreamid",

    "App": "xxx",

 

}

返回示例:


HTTP/1.1 200 OK

Server: ksyun-open-platform

Date: Fri, 12 May 2017 08:01:06 GMT

Content-Type: application/json;charset=UTF-8

Transfer-Encoding: chunked

{

    "List": [

        {

            "TaskID": "5cf5b255d7cf7d8a16cdafe46ee38cca",

            "Format": 256

        },

        {

            "TaskID": "87a24f7fb1758f77b93756dce42082f0",

            "Format": 257

        }

    ],

    "ErrNum": 0,

    "ErrMsg": "success"

}

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

  • 内容不全,不深入
  • 内容更新不及时
  • 描述不清晰,比较混乱
  • 系统或功能太复杂,缺乏足够的引导
  • 内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈