简介
本文档提供关于直播审核的 API 概览和 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.3.1。
API | 操作描述 |
用于提交一个直播审核任务 | |
用于查询指定的直播审核任务 | |
取消一个在进行中的直播审核任务 |
提交直播审核任务
功能说明
用于提交一个直播审核任务。
请求示例
// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/11459function postLiveAuditing() {const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须};const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';const key = 'video/auditing';const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {Type: 'live_video', // 固定值,必须Input: {Url: 'rtmp://example.com/live/123', // 需要审核的直播流播放地址// DataId: '',// UserInfo: {},},Conf: {BizType: 'xxx', // BizType 可通过控制台创建直播审核策略后获得,必填// Callback: 'https://callback.com', // 回调地址,非必须// CallbackType: 1, // 回调片段类型,非必须}}});cos.request({Method: 'POST', // 固定值,必须Url: url, // 请求的url,必须Key: key, // 固定值,必须ContentType: 'application/xml', // 固定值,必须Body: body // 请求体参数,必须},function(err, data){if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}postLiveAuditing();
参数说明
cos.request 方法参数说明:
参数名称 | 描述 | 类型 | 是否必选 |
Method | 请求方法,固定值 | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值 | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Container | 是 |
回调函数说明
function(err, data) { ... }
相关链接
查询直播审核任务结果
功能说明
用于查询直播审核任务执行情况和结果。
请求示例
// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/11459function getLiveAuditingResult() {const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须};const jobId = 'av0ca69557bd6111ed904c5254009411xx'; // jobId 可以通过提交直播审核任务返回const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';const key = `video/auditing/${jobId}`; // 固定值,必须const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Url: url, // 请求的url,必须Key: key, // 固定值,必须},function(err, data){if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}getLiveAuditingResult();
参数说明
cos.request 方法参数说明:
参数名称 | 描述 | 类型 | 是否必选 |
Method | 请求方法,固定值 | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:video/auditing/要查询的jobId | String | 是 |
参数名称 | 描述 | 类型 | 是否必选 |
jobId | 需要查询的任务 ID | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接
取消直播审核任务
功能说明
本接口用于取消一个在进行中的直播审核任务,成功取消后将返回已终止任务的 JobID。
请求示例
// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/11459function cancelLiveAuditing() {const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须};const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';const jobId = 'xxxx'; // jobId 可以通过提交直播审核任务返回const key = `video/cancel_auditing/${jobId}`; // 固定值,必须const url = `https://${host}/${key}`;cos.request({Method: 'POST', // 固定值,必须Url: url, // 请求的url,必须Key: key, // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}
参数说明
cos.request 方法参数说明:
参数名称 | 描述 | 类型 | 是否必选 |
Method | 请求方法,固定值 | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:video/cancel_auditing/要取消的jobId | String | 是 |
参数名称 | 描述 | 类型 | 是否必选 |
jobId | 需要取消的任务 ID | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接