文档反馈
文档反馈

互动直播事件

事件类型

event_type 事件含义
100 开始推流
101 推流服务异常
102 推流成功
103 推流失败
104 推流结束
105 推流的转码布局设置已更新
106 互动直播其他异常

100 开始推流

互动直播服务器收到推流任务,开始推流时,触发此消息抄送。

字段说明

字段 类型 示例 说明
eventType Number 100 事件类型。
streamUrl String rtmp://***.live.126.net/live/5729b8161c28478cabaa01b58fbf28ba 推流地址,支持 RTMP 协议。
注意:推流地址不支持中文等特殊字符,且该字符长度不能超过 1024 字节。
reason String - 状态详情,详细说明请参考互动直播事件状态码
code Number 500 状态码,详细说明请参考互动直播事件状态码
channelName String 64955488 房间名称。
channelId Number 43356618819536 房间 ID。
taskId String stream_1 推流任务 ID。
timestamp Number 1606963065982 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "streamUrl":"rtmp://*******.live.126.net/live/e4bacd4b635c4d0d89b52a7d57bd1043?wsSecret=********&wsTime=*******",
        "reason":"",
        "code":500,
        "channelName":"64955488",
        "channelId":"43356618819536",
        "taskId":"stream_1",
        "timestamp":1606963065982
    },
    "eventType":100
}   

101 推流服务异常

推流服务异常时,会触发此消息回调。

字段说明

字段 类型 示例 说明
eventType Number 101 事件类型。
uid Number 1234 用户的 UID 或 User Account。
  • 如果使用 int 型 uid 加入房间,则服务器在此处自动将 uid 转为 string 型参数并返回该参数。
  • 如果使用 string 型 userAccount 加入房间,则服务器返回该参数。
channelId Number 234 房间 ID。
timestamp Number 1606974909978 该事件发生的 Unix 时间戳,单位为毫秒(ms)。
reason Number 1 状态原因,详细说明请参考互动直播事件状态码
channelName String abc 房间名。
produceType String video 录制失败的流类型,包括:
  • audio:音频流。
  • video:音视频流。
  • screenshare:屏幕共享。

JSON 示例

{
  "eventType": 101,
  "data": {
    "uid":1234,
    "channelId":234,
    "timestamp":1606974909978,
    "reason":1,
    "channelName":"abc",
    "produceType":"video"
 }
}

102 推流成功

推流成功时会触发此消息抄送。

字段说明

字段 类型 示例 说明
eventType Number 102 事件类型。
streamUrl String rtmp://***.live.126.net/live/e4bacd4b635c4d0d89b52a7d57bd1043?wsSecret=***&wsTime=*** 推流地址,支持 RTMP 协议。
注意:推流地址不支持中文等特殊字符,且该字符长度不能超过 1024 字节。
reason String stream push succeeded 状态原因,详细说明请参考互动直播事件状态码
code Number 505 状态码,详细说明请参考互动直播事件状态码
channelName String 64955488 房间名。
channelId Number 43356618819536 房间 ID。
taskId String stream_1 推流任务 ID。
timestamp Number 1606963169066 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "streamUrl":"rtmp://*******.live.126.net/live/e4bacd4b635c4d0d89b52a7d57bd1043?wsSecret=*******&wsTime=*******",
        "reason":"stream push succeeded",
        "code":505,
        "channelName":"64955488",
        "channelId":"43356618819536",
        "taskId":"stream_1",
        "timestamp":1606963169066
    },
    "eventType":102
}

103 推流失败

源站建连失败、中途禁流等原因导致推流失败时,会触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 103 事件类型。
streamUrl String rtmp://***.live.126.net/live/decdf0d5c69c4a2 推流地址,支持 RTMP 协议。
注意:推流地址不支持中文等特殊字符,且该字符长度不能超过 1024 字节。
reason String stream push failed 状态原因,详细说明请参考互动直播事件状态码
code Number 506 状态码,详细说明请参考互动直播事件状态码
channelName String 555666 房间名。
channelId Number 43357283911632 房间 ID。
taskId String task_0 推流任务 ID。
timestamp Number 1606983886438 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "streamUrl":"rtmp://********.live.126.net/live/decdf0d5c69c4a2",
        "reason":"stream push failed",
        "code":506,
        "channelName":"555666",
        "channelId":"43357283911632",
        "taskId":"task_0",
        "timestamp":1606983886438
    },
    "eventType":103
}

104 推流结束

用户调用删除任务接口、所有用户退出房间或房间超时关闭任务时,会触发此消息抄送。

字段说明

字段 类型 示例 说明
eventType Number 104 事件类型。
streamUrl String rtmp://***.live.126.net/live/e4bacd4b635c4d0d89b52a7d57bd1043?wsSecret=***&wsTime=*** 推流地址,支持 RTMP 协议。
注意:推流地址不支持中文等特殊字符,且该字符长度不能超过 1024 字节。
reason String - 状态原因,详细说明请参考互动直播事件状态码
code Number 500 状态码,详细说明请参考互动直播事件状态码
channelName String 64955488 房间名。
channelId String 43356618819536 房间 ID。
taskId String stream_1 推流任务 ID。
timestamp Number 1606964961569 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "streamUrl":"rtmp://*******.live.126.net/live/e4bacd4b635c4d0d89b52a7d57bd1043?wsSecret=********&wsTime=*******",
        "reason":"",
        "code":500,
        "channelName":"64955488",
        "channelId":"43356618819536",
        "taskId":"stream_1",
        "timestamp":1606964961569
    },
    "eventType":104
}

105 推流的转码布局设置已更新

用户调用接口更新推流布局参数时,会触发此消息抄送。

字段说明

字段 类型 示例 说明
eventType Number 105 事件类型。
streamUrl String rtmp://***.live.126.net/live/481ff312e5f14b669d68c03fd72fb523?wsSecret=**&wsTime=*** 推流地址,支持 RTMP 协议。
注意:推流地址不支持中文等特殊字符,且该字符长度不能超过 1024 字节。
reason String - 状态原因,详细说明请参考互动直播事件状态码
code Number 500 状态码,详细说明请参考互动直播事件状态码
channelName String 666888 房间名。
channelId Number 43356933425104 房间 ID。
taskId String task_0 推流任务 ID。
timestamp Number 1606972870034 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "streamUrl":"rtmp://*******.live.126.net/live/481ff312e5f14b669d68c03fd72fb523?wsSecret=*******&wsTime=*******",
        "reason":"",
        "code":500,
        "channelName":"666888",
        "channelId":"43356933425104",
        "taskId":"task_0",
        "timestamp":1606972870034
    },
    "eventType":105
}

106 互动直播其他异常

互动直播服务器校验布局参数,发现布局任务中异常时会报错,此时触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 106 事件类型。
streamUrl String rtmp://***.live.126.net/live/decdf0d5c69c4a229b6f0d180b61f952?wsSecret=**&wsTime=*** 推流地址,支持 RTMP 协议。
注意:推流地址不支持中文等特殊字符,且该字符长度不能超过 1024 字节。
reason String invalid room task parameter: images value 状态原因,详细说明请参考互动直播事件状态码
code Number 513 状态码,详细说明请参考互动直播事件状态码
channelName String 555666 房间名。
channelId Number 43357283911632 房间 ID。
taskId String task_0 推流任务 ID。
timestamp Number 1606983359004 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "streamUrl":"rtmp://*******.live.126.net/live/decdf0d5c69c4a229b6f0d180b61f952?wsSecret=*******&wsTime=*******",
        "reason":"invalid room task parameter: images value",
        "code":513,
        "channelName":"555666",
        "channelId":"43357283911632",
        "taskId":"task_0",
        "timestamp":1606983359004
    },
    "eventType":106
}

互动直播事件状态码

互动直播相关事件中,code 字段表示状态码,reason 字段表示该状态的产生原因。code、对应的 reason 及其说明如下:

状态码(code) 状态原因(reason) 说明
500 - 初始值。
505 stream push succeeded 推流成功。
506 stream push failed 推流失败。
511 stop pushing stream 推流结束。
510 no record permission 应用无互动录制权限。
512 pic download failed 背景图片下载失败。
512 pic diskIo failed 图片读取失败。
512 read pic failed 图片读取失败。
512 pic format error 图片格式错误。
512 decode pic failed 图片解码失败。
513 "invalid room task parameter: " + 字段 推流任务参数错误。
×

反馈成功

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