消息通知类型

最近更新时间:2022-09-20 05:17:40

实时通信

事件类型

event_typeevent_name事件含义payload 包含的字段
101channel create创建频道。
  • channelName
  • ts
  • channelSId
  • 102channel destroy销毁频道。
  • channelName
  • ts
  • channelSId
  • 103broadcaster join channel直播场景下,主播加入频道。
  • channelName
  • uid
  • platform
  • ts
  • channelSId
  • uSId
  • 104broadcaster leave channel直播场景下,主播离开频道。
  • channelName
  • uid
  • platform
  • reason
  • ts
  • channelSId
  • uSId
  • 105audience join channel直播场景下,观众加入频道。
  • channelName
  • uid
  • platform
  • ts
  • channelSId
  • uSId
  • 106audience leave channel直播场景下,观众离开频道。
  • channelName
  • uid
  • platform
  • reason
  • ts
  • channelSId
  • uSId
  • 107user join channel with communication mode通信场景下,用户加入频道。
  • channelName
  • uid
  • platform
  • ts
  • channelSId
  • uSId
  • 108user leave channel with communication mode通信场景下,用户离开频道。
  • channelName
  • uid
  • platform
  • reason
  • ts
  • channelSId
  • uSId
  • 111client role change to broadcaster直播场景下,加入频道后,用户将角色切换为主播。
  • channelName
  • uid
  • ts
  • channelSId
  • uSId
  • 112client role change to audience直播场景下,加入频道后,用户将角色切换为观众。
  • channelName
  • uid
  • ts
  • channelSId
  • uSId
  • payload 字段

    字段名类型含义
    channelNameString频道名。
    tsNumber事件发生的 Unix 时间戳,单位为秒。
    uidNumber用户使用的 UID。
    platformNumber用户使用的设备类型:
  • 1:Android
  • 2:iOS
  • 5:Windows
  • 6:Linux
  • 7:Web
  • 8:macOS
  • 0:其他平台
  • reasonNumber用户离开频道的原因:
  • 1:正常离开频道。
  • 2:连接超时,判断标准为 GT-RTN 超过 10 秒未收到用户的任何数据包。
  • 3:权限原因。比如如被运营人员通过踢人 RESTful API 踢出频道。
  • 4:服务端原因。比如服务端做负载调整,和用户短暂断开连接,一般 SDK 会自动重连。
  • 5:连接切换原因。比如用户换新设备登录频道,迫使旧设备离开频道。
  • 0:其他原因。
  • channelSIdString频道Session ID,用于解决频道创建重复使用channelName的情况,使用该字段可记录频道的生命周期 。
    uSIdString用户Session ID,用于解决一个用户重复进入频道的情况,使用该字段可记录用户每次进出频道的生命周期。

    服务端推流到 CDN

    事件类型

    event_typeevent_name事件含义payload 包含的字段
    1Publish Stream开始推流。
  • event
  • stream
  • code
  • time
  • reason
  • channel
  • videoCodec
  • videoProfile
  • width
  • height
  • audioCodec
  • audioProfile
  • audioChannels
  • audioSampleRate
  • 2Unpublish Stream取消推流。
  • event
  • stream
  • code
  • time
  • reason
  • channel
  • 3Publish Status推流状态改变。
  • event
  • stream
  • code
  • time
  • reason
  • channel
  • 4Update Transcoding推流的转码布局设置已更新。
  • event
  • stream
  • code
  • time
  • reason
  • channel
  • videoCodec
  • videoProfile
  • width
  • height
  • audioCodec
  • audioProfile
  • audioChannels
  • audioSampleRate
  • 5Publish RequestanyRTC 推流服务器收到开始推流的请求。
  • event
  • stream
  • time
  • channel
  • uid
  • 6Publish First Frame视频首帧已推到 CDN。
  • event
  • stream
  • time
  • channel
  • uid
  • elapse
  • retry
  • payload 字段

    字段名类型含义
    eventString推流事件:
  • PublishStream:开始推流。
  • UnpublishStream:取消推流。
  • PublishStatus:推流状态改变。
  • UpdateTranscoding:推流的转码布局设置已更新。
  • PublishRequest: 推流服务器收到开始推流的请求。
  • PublishFirstFrame:视频首帧已推到 CDN。
  • streamString推流地址,支持 RTMP 协议。 Note:不支持中文字符等特殊字符,且该字符长度不能超过 1024 字节。
    codeNumber错误码:
  • 200:推流成功。
  • 450:非法参数。比如设置转码布局设置时,传入的参数与 anyRTC 要求的格式不同。
  • 451:非法推流地址。请检查使用的流地址。
  • 452:没有发起推流操作。比如推流过程中,更新转码布局后,没有再次调用推流接口。
  • 453:不支持的操作。比如非转码推流时更新转码布局参数。
  • 454:重复推流,已经存在该流地址。
  • 455:超出最大允许推流的流数量(10个)。
  • 456:没有权限的操作。比如删除别人的流。
  • 30:RTMP handshake 失败。
  • 31:RTMP connect 失败。
  • 32:RTMP publish 失败。
  • 33:TCP 连接断开。
  • timeNumber事件发生的 Unix 时间戳,单位为毫秒。
    reasonString具体原因。
    channelString频道名。
    videoCodecString输出视频的编码格式:
  • H.264
  • H.265
  • videoProfileString输出视频的编码规格:
  • High:High 级别的视频编码规格,一般用于广播及视频碟片存储,高清电视。
  • Main:Main 级别的视频编码规格,一般用于主流消费类电子产品,如 mp4、便携的视频播放器、PSP 和 iPad 等。
  • Baseline:Baseline 级别的视频编码规格,一般用于低阶或需要额外容错的应用,比如视频通话、手机视频等。
  • uidString用户的 UID。
    widthNumber输出视频的宽度(px)。
    heightNumber输出视频的高度(px)。
    audioCodecString输出音频的编码标准:AAC
    audioProfileString输出音频的编码规格:
  • LC:LC-AAC,低复杂度高级音频编码。
  • HE:HE-AAC,高效率高级音频编码。
  • audioChannelsNumber输出音频的声道数。
    audioSampleRateNumber输出音频的采样率(Hz)。
    elapseNumber首帧推流所耗时间(ms),即从 anyRTC 推流服务器收到推流请求(PublishRequest)到输出视频首帧(PublishFirstFrame)的时间。
    retryBoolean是否为重新推流:true:重新推流。false:首次推流。Note:此处的重新推流指 anyRTC 服务器尝试重新推流,不是用户调用推流接口重复推流。用户重复推流时会收到错误码 454