package bilibili.broadcast.v1

Get desktop application:
View/edit binary Protocol Buffers messages

broadcast操作，对应每个target_path

• rpc Auth (AuthReq, AuthResp)

  broadcast.proto:12

  用户鉴权

  message AuthReq

  broadcast.proto:37

  鉴权请求，通过authorization验证绑定用户mid

  • string guid = 1

    冷启动id，算法uuid，重新起启会变

  • string conn_id = 2

    连接id，算法uuid，重连会变

  • int64 last_msg_id = 3

    最后收到的消息id，用于过虑重连后获取未读的消息

  message AuthResp

  broadcast.proto:47

  鉴权返回

  (message has no fields)

• rpc Heartbeat (HeartbeatReq, HeartbeatResp)

  broadcast.proto:14

  心跳保活：成功心跳为4分45秒，重试心跳为30s，三次收不到进行重连（不超过5分45）

  message HeartbeatReq

  broadcast.proto:88

  心跳请求

  (message has no fields)

  message HeartbeatResp

  broadcast.proto:93

  心跳返回

  (message has no fields)

• rpc Subscribe (TargetPath, google.protobuf.Empty)

  broadcast.proto:16

  订阅target_path

• rpc Unsubscribe (TargetPath, google.protobuf.Empty)

  broadcast.proto:18

  取消订阅target_path

• rpc MessageAck (MessageAckReq, google.protobuf.Empty)

  broadcast.proto:20

  消息回执

  message MessageAckReq

  broadcast.proto:98

  消息回执

  • int64 ack_id = 1

    消息id

  • string ack_origin = 2

    ack来源，由业务指定用于埋点跟踪

  • string target_path = 3

    消息对应的target_path，方便业务区分和监控统计

• rpc Enter (stream RoomReq, stream RoomResp)

  room.proto:11

  message RoomReq

  room.proto:47

  • string id = 1

    {type}://{room_id}

  • oneof event

    • RoomJoinEvent join = 2

    • RoomLeaveEvent leave = 3

    • RoomOnlineEvent online = 4

    • RoomMessageEvent msg = 5

  message RoomResp

  room.proto:63

  • string id = 1

    {type}://{room_id}

  • oneof event

    • RoomJoinEvent join = 2

    • RoomLeaveEvent leave = 3

    • RoomOnlineEvent online = 4

    • RoomMessageEvent msg = 5

    • RoomErrorEvent err = 6

broadcast连接隧道

• rpc CreateTunnel (stream BroadcastFrame, stream BroadcastFrame)

  broadcast.proto:26

  创建双向stream连接隧道

  message BroadcastFrame

  broadcast.proto:53

  target_path: "/" Service-Name "/" {method name} 参考 gRPC Request Path

  • optional FrameOption options = 1

    请求消息信息

  • string target_path = 2

    业务target_path

  • optional google.protobuf.Any body = 3

    业务pb内容

Laser

• rpc WatchLogUploadEvent (google.protobuf.Empty, stream LaserLogUploadResp)

  laser.proto:10

  监听上报事件

  message LaserLogUploadResp

  laser.proto:14

  服务端下发日志上报事件

  • int64 taskid = 1

    任务id

  • string date = 2

    下发时间

ModManager

• rpc WatchResource (google.protobuf.Empty, stream ModResourceResp)

  mod.proto:10

  message ModResourceResp

  mod.proto:14

  • int32 atcion = 1

  • string app_key = 2

  • string pool_name = 3

  • string module_name = 4

  • int64 module_version = 5

  • int64 list_version = 6

Push

• rpc WatchMessage (google.protobuf.Empty, stream PushMessageResp)

  push.proto:9

  message PushMessageResp

  push.proto:33

  • int64 old_taskid = 1

    Deprecated: 推送任务id，使用string

  • PushMessageResp.Biz biz = 2

    业务 1:是视频 2:是直播 3:是活动

  • PushMessageResp.Type type = 3

    类型 1:是默认 2:是热门 3:是实时 4:是推荐

  • string title = 4

    主标题

  • string summary = 5

    副标题

  • string img = 6

    图片地址

  • string link = 7

    跳转地址

  • PushMessageResp.Position position = 8

    展示位置，1是顶部

  • int32 duration = 9

    展示时长（单位：秒），默认3秒

  • int64 expire = 10

    失效时间

  • string taskid = 11

    推送任务id

  • repeated PageBlackList page_blackList = 12

    应用内推送黑名单 UGC: ugc-video-detail PGC: pgc-video-detail 一起看: pgc-video-detail-theater 直播: live-room-detail Story: ugc-video-detail-vertical 播单黑名单 playlist-video-detail

  • repeated PageView page_view = 13

    预留pvid

  • optional TargetResource target_resource = 14

    跳转资源

  • int32 image_frame = 15

  • int32 image_marker = 16

  • int32 image_position = 17

  • int64 job = 18

Test

• rpc WatchTestEvent (google.protobuf.Empty, stream TestResp)

  test.proto:14

  监听上报事件

  message TestResp

  test.proto:37

  • int64 taskid = 1

    任务id

  • int64 timestamp = 2

    时间戳

  • string message = 3

    消息

  • optional google.protobuf.Any extra = 4

    扩展

• rpc Test (AddParams, google.protobuf.Empty)

  test.proto:20

  message AddParams

  test.proto:24

  • int32 a = 1

  • int32 b = 2

• UNKNOWN = 0

• UPDATE = 1

• DELETE = 2

• int32 r = 1

message_id: client: 本次连接唯一的消息id，可用于回执 server: 唯一消息id，可用于上报或者回执 sequence: client: 客户端应该每次请求时frame seq++，会返回对应的对称req/resp server: 服务端下行消息，只会返回默认值：0

Used in: BroadcastFrame

• int64 message_id = 1

  消息id

• int64 sequence = 2

  frame序号

• bool is_ack = 3

  是否进行消息回执(发出MessageAckReq) downstream 上只有服务端设置为true，客户端响应 upstream 上只有客户端设置为true，服务端响应 响应帧禁止设置is_ack，协议上禁止循环 通常只有业务帧才可能设置is_ack, 因为协议栈(例如心跳、鉴权)另有响应约定

• optional rpc.Status status = 4

  业务状态码

• string ack_origin = 5

  业务ack来源, 仅downstream时候由服务端填写.

• int64 timestamp = 6

Used in: TargetResource

• LINK_TYPE_UNKNOWN = 0

  未知

• LINK_TYPE_BANGUMI = 1

  番剧

• LINK_TYPE_VIDEO = 2

  视频

• LINK_TYPE_LIVE = 3

  直播

Used in: PushMessageResp

• string id = 1

Used in: PushMessageResp

• string id = 1

业务类型

Used in: PushMessageResp

• BIZ_UNKNOWN = 0

  未知

• BIZ_VIDEO = 1

  视频

• BIZ_LIVE = 2

  直播

• BIZ_ACTIVITY = 3

  活动

展示未知

Used in: PushMessageResp

• POS_UNKNOWN = 0

  未知

• POS_TOP = 1

  顶部

消息类型

Used in: PushMessageResp

• TYPE_UNKNOWN = 0

  未知

• TYPE_DEFAULT = 1

  默认

• TYPE_HOT = 2

  热门

• TYPE_REALTIME = 3

  实时

• TYPE_RECOMMEND = 4

  推荐

Used in: RoomResp

• optional rpc.Status status = 1

Used in: RoomReq, RoomResp

(message has no fields)

Used in: RoomReq, RoomResp

(message has no fields)

Used in: RoomReq, RoomResp

• string target_path = 1

• optional google.protobuf.Any body = 2

Used in: RoomReq, RoomResp

• int32 online = 1

• int32 all_online = 2

target_path

Used as request type in: Broadcast.Subscribe, Broadcast.Unsubscribe

• repeated string target_paths = 1

  需要订阅的target_paths

Used in: PushMessageResp

• LinkType Type = 1

  直播: roomid UGC: avid PGC: seasonid Story: avid 举个例子 Type: LINK_TYPE_BANGUMI (番剧) Resource: {"seasonid":"123"} Type: LINK_TYPE_VIDEO (视频) Resource: {"avid":"123"} Type: LINK_TYPE_LIVE (直播) Resource: {"roomid":"123"}

• map<string, string> Resource = 2