开启关闭推流

最近更新时间:2019-08-09 16:38:30

1.接口描述

  • 接口
    Live_Channel_SetStatus
    对一条直播流执行禁用、断流和允许推流操作。禁用 表示不能再继续使用该流 ID 推流;如果正在推流,则推流会被中断,中断后不可再次推流。断流 表示中断正在推的流,断流后可以再次推流。允许推流 表示启用该流 ID,允许用该流 ID 推流。
  • 地址
    API 调用地址为: http://fcgi.video.qcloud.com/common_access
  • 用途
    主要用于鉴黄时的禁播场景,例如,您如果在后台发现某个主播有涉黄或者反动内容,可以随时断流或者禁用这条流。
  • 说明
    一条直播流一旦被设置为【禁用】状态,推流链路将被腾讯云主动断开,并且后续的推流请求也会被拒绝,一条流最长禁用3个月,超过3个月,禁用失效。

2.输入参数

参数名 参数含义 类型 备注 是否必需
appid 客户 ID int 即直播 APPID,用于区分不同客户的身份 Y
interface 接口名称 string Live_Channel_SetStatus Y
t 有效时间 int UNIX 时间戳 Y
sign 安全签名 string MD5(key+t) Y
Param.s.channel_id 直播码 string Y
Param.n.status 开关状态 int 0表示禁用,1表示允许推流,2表示断流 Y
Param.s.path 路径 string 多路径用户使用 N
Param.s.domain 域名 string 多域名用户使用 N

注意:

有些早期提供的 API 中直播码参数被定义为 channel_id,新的 API 则称直播码为 stream_id,仅历史原因而已。

3.输出结果

参数名 参数含义 类型 备注
ret 返回码 int 0:成功;其他值:失败
message 错误信息 string 错误信息

4.调用示例

目标:考虑到直播码为 8888_test123 的直播流内容涉及违规内容,对其进行禁播操作。

组成部分 示例内容
接口URL http://fcgi.video.qcloud.com/common_access?
appid 1234
interface Live_Channel_SetStatus
Param.s.channel_id 8888_test123
Param.n.status 0
t 1471850187
sign b17971b51ba0fe5916ddcd96692e9fb3
// copy时请去掉美化排版用的不可见换行符,否则可能出现 “appid is invalid” 等url拼装错误
 URL = http://fcgi.video.qcloud.com/common_access?
            appid=1234&interface=Live_Channel_SetStatus
            &Param.s.channel_id=8888_test123
            &Param.n.status=0
            &t=1471850187&sign=b17971b51ba0fe5916ddcd96692e9fb3