合并直播录制

接口描述

1、合并直播录制文件,保存至频道号内视频库,接口合并过程为异步处理过程
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/record/merge

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

2、合并MP4文件不能超过15个,合并视频总时长不能超过24小时

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

channelId

true

String

频道号

fileIds

true

String

要合并的录制视频文件ID,多个id用英文逗号, 分隔【fileId可通过查询频道录制视频信息获取】

fileName

false

String

合并后的视频的文件名

callbackUrl

false

String

合并成功或失败回调的url,可以带上自定义参数【详见回调说明

autoConvert

false

String

是否自动转存到点播,默认为N Y:自动转存到对应点播分类下(点播保存路径:直播回放-频道号-场次) N:不自动转存

mergeMp4

false

String

合并后文件类型,默认为N Y:合并为MP4文件 N:合并为m3u8文件

示例

http://api.polyv.net/live/v3/channel/record/merge

表单参数:

mergeMp4=N&fileName=%E6%B5%8B%E8%AF%95%E5%BC%82%E6%AD%A5%E5%90%88%E5%B9%B633333&fileIds=46a586558b9e716c2cc2802a52b9e907%2C9a41298b5f032f3d5a8119b104c5dfcc&appId=frlr1zazn3&sign=1C08E1AB4882DEFB00CC2A5582472A03&autoConvert=N&callbackUrl=http%3A%2F%2Fabc.com&channelId=2191541&timestamp=1621841986670

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

String

请求成功时返回提交成功信息 "processing.":合并任务正在处理中 "submit success.":合并任务提交成功

回调说明

合并结果实时信息回调,可以及时通知用户合并任务的结果。

原理

通过HTTP接口(设置的callbackUrl)向用户服务器发送GET请求,将合并结果推送给用户服务器。

举例说明

举例如下:http://abc.com/test.do?status=success&timestamp=1603506240000&fileId=xxxx&fileIds=xxx,xxx&sign=xxdxxxxx&fileUrl=urlxxxx&fileName=xxxx

参数名类型说明

status

String

接口处理结果,成功为success,失败为error

timestamp

Long

当前13位毫秒级时间戳

fileId

String

合并后的文件ID,成功时返回

fileIds

String

合并前的文件ID

fileUrl

String

合并后的视频文件地址,成功时返回

fileName

String

合并后的文件名称,成功时返回

sign

String

校验的加密字符串,生成的规则md5(AppSecret+timestamp),AppSecret是直播系统用的密钥

Java请求示例

快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 异步合并直播录制文件
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testRecordFileMergeAsync() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/record/merge";
    String channelId = "2191541";
    String fileIds = "249fd64bdf9329aa1e1c1228fb0732cd,66fda01de2e11bf1d91e801ea7cbc431";
    String fileName = "合并后文件名MP4";
    String callbackUrl = "http://abc.com";
    String autoConvert = "N";
    String mergeMp4 = "Y";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("fileIds", fileIds);
    requestMap.put("fileName", fileName);
    requestMap.put("callbackUrl", callbackUrl);
    requestMap.put("autoConvert", autoConvert);
    requestMap.put("mergeMp4", mergeMp4);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试异步合并直播录制文件,返回值:{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"submit success."
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Last updated