package bilibili.pgc.gateway.player.v2

Get desktop application:
View/edit binary Protocol Buffers messages

视频url

• rpc PlayView (PlayViewReq, PlayViewReply)

  playurl.proto:10

  播放页信息

• rpc PlayViewComic (PlayViewReq, PlayViewReply)

  playurl.proto:12

Used in: ViewInfo

• map<string, string> qn_svga_animation_map = 1

Used in: PlayDubbingInfo, RoleAudioProto

• string audio_id = 1

• string title = 2

• string edition = 3

• uint64 person_id = 4

• string person_name = 5

• string person_avatar = 6

• repeated DashItem audio = 7

角标信息

Used in: ButtonInfo, PlayList

• string text = 1

  角标文案

• string bg_color = 2

  角标色值

• string bg_color_night = 3

  角标色值-夜间模式

• string text_color = 4

  文案色值

• optional GradientColor bg_gradient_color = 5

  ? 新版本客户端已弃用此项

• string img = 6

Dialog组件: 底部显示

Used in: Dialog

• optional TextInfo title = 1

  文案

• string icon = 2

  图标

按钮信息

Used in: CouponToast, Dialog, HighDefinitionTrialInfo, PayTip, PopWin, PromptBar, Toast

• string text = 1

  按钮文案

• string text_color = 2

  按钮字体色值

• string text_color_night = 3

  按钮字体色值-夜间模式

• string bg_color = 4

  按钮背景色

• string bg_color_night = 5

  按钮背景色-夜间模式

• string link = 6

  按钮链接

• string action_type = 7

  按钮动作类型

• optional BadgeInfo badge_info = 8

  角标信息

• optional Report report = 9

  埋点上报信息

• string left_strikethrough_text = 10

  左侧删除线样式文案

• optional TextInfo simple_text_info = 11

  缩略按钮文案信息

• string simple_bg_color = 12

  缩略按钮背景色值

• string simple_bg_color_night = 13

  缩略按钮字体色值-夜间模式

• optional GradientColor bg_gradient_color = 14

• map<string, string> order_report_params = 15

• optional TaskParam task_param = 16

• string pc_link = 17

投屏限制. code = 0 时为无限制, 否则表示不不允许投屏并提示message

Used in: PlayAbilityExtConf

• int32 code = 1

• string message = 2

跳过片头/片尾配置

Used in: PlayViewBusinessInfo

• int64 material_no = 1

• int32 start = 2

  DASH分段始

• int32 end = 3

  DASH分段终

• ClipType clip_type = 4

  Clip类型

• string toast_text = 5

  跳过片头/片尾时的提示语

• optional MultiView multi_view = 6

跳过片头/片尾配置: Clip类型

Used in: ClipInfo

• NT_UNKNOWN = 0

• CLIP_TYPE_OP = 1

  跳过OP

• CLIP_TYPE_ED = 2

  跳过ED

• CLIP_TYPE_HE = 3

• CLIP_TYPE_MULTI_VIEW = 4

• CLIP_TYPE_AD = 5

编码类型

Used in: PlayViewReq

• NOCODE = 0

  默认

• CODE264 = 1

  H.264

• CODE265 = 2

  H.265

Used in: PlayViewBusinessInfo

• int64 continue_play_ep_id = 1

优惠券

Used in: PopWin

• string coupon_token = 1

  优惠券token

• int64 type = 2

  优惠券类型 1:折扣券 2:满减券 3:兑换券

• string value = 3

  优惠券面值

• string use_desc = 4

  优惠券使用描述

• string title = 5

  优惠券标题

• string desc = 6

  优惠券描述

• string pay_button_text = 7

  优惠券支付按钮文案

• string pay_button_text_line_through = 8

  优惠券支付按钮删除线文案

• string real_amount = 9

  实付金额

• optional google.protobuf.Timestamp expire_time = 10

  使用过期时间

• int64 otype = 11

• string amount = 12

优惠券信息

Used in: ViewInfo

• optional CouponToast toast = 1

  提示框信息

• optional PopWin pop_win = 2

  弹窗信息

优惠券提示框文案信息

Used in: CouponToast

• string positive_preview = 1

  提示框文案-播正片6分钟预览

• string section = 2

  提示框文案-播非正片分节ep

优惠券提示框信息

Used in: CouponInfo

• optional CouponTextInfo text_info = 1

  提示框文案信息

• optional ButtonInfo button = 2

  提示框按钮

dash条目

Used in: AudioMaterialProto, DolbyItem, VideoInfo

• uint32 id = 1

  清晰度

• string base_url = 2

  主线流

• repeated string backup_url = 3

  备用流

• uint32 bandwidth = 4

  带宽

• uint32 codecid = 5

  编码id

• string md5 = 6

  md5

• uint64 size = 7

  视频大小

• string frame_rate = 8

  帧率

• string widevine_pssh = 9

  DRM widevine 密钥

dash视频流

Used in: Stream

• string base_url = 1

  主线流

• repeated string backup_url = 2

  备用流

• uint32 bandwidth = 3

  带宽

• uint32 codecid = 4

  编码id

• string md5 = 5

  md5

• uint64 size = 6

  大小

• uint32 audio_id = 7

  伴音质量id

• bool no_rexcode = 8

  是否非全二压

• string frame_rate = 9

  帧率

• int32 width = 10

  宽

• int32 height = 11

  高

• string widevine_pssh = 12

  DRM 密钥

Used in: PlayViewReq

• bool need_watch_progress = 1

鉴权浮层

Used in: EndPage, ViewInfo

• int64 code = 1

  鉴权限制码

• string msg = 2

  鉴权限制信息

• string type = 3

  浮层类型

• string style_type = 4

  浮层样式类型

• optional DialogConfig config = 5

  浮层配置

• optional TextInfo title = 6

  标题

• optional TextInfo subtitle = 7

  副标题

• optional ImageInfo image = 8

  图片信息

• repeated ButtonInfo button = 9

  按钮列表

• optional ButtonInfo bottom_desc = 10

  底部描述

• optional Report report = 11

  埋点上报信息

• int32 count_down_sec = 12

  倒计时 秒

• optional TextInfo right_bottom_desc = 13

  右下描述

• repeated BottomDisplay bottom_display = 14

• repeated PlayList play_list = 15

鉴权浮层配置

Used in: Dialog

• bool is_show_cover = 1

  是否显示高斯模糊背景图

• bool is_orientation_enable = 2

  是否响应转屏

• bool is_nested_scroll_enable = 3

  是否响应上滑吸顶

• bool is_force_halfscreen_enable = 4

  是否强制竖屏

• bool is_background_translucent_enable = 5

  是否启用背景半透明

当前分辨率信息

Used in: PlayViewBusinessInfo

• int32 width = 1

  宽

• int32 height = 2

  长

• int32 rotate = 3

  旋转角度

杜比音频信息

Used in: VideoInfo

• DolbyItem.Type type = 1

  杜比类型

• optional DashItem audio = 2

  音频流

杜比类型

Used in: DolbyItem

• NONE = 0

  NONE

• COMMON = 1

  普通杜比音效

• ATMOS = 2

  全景杜比音效

DRM技术类型

Used in: PlayViewBusinessInfo

• NON = 0

• FAIR_PLAY = 1

• WIDE_VINE = 2

• BILI_DRM = 3

播放结束后的尾页Dialog

Used in: ViewInfo

• optional Dialog dialog = 1

• bool hide = 2

Used in: EpPublicityVideo

• int64 material_no = 1

• int64 aid = 2

• int64 cid = 3

Used in: EpPublicityVideo

• int64 aid = 1

• int64 cid = 2

• EpPublicityVideo.Type type = 1

• oneof data

  • EpPreVideo ep_pre_video = 2

  • EpInlineVideo ep_inline_video = 3

Used in: EpPublicityVideo

• DATA_NOT_SET = 0

• EP_PRE_VIDEO = 2

• EP_INLINE = 3

• PRE = 0

• INLINE = 1

剧集广告信息

Used in: PlayViewBusinessInfo

• int64 aid = 1

• string title = 2

• string link = 3

• int32 follow_video_bnt_flag = 4

• string next_video_title = 5

• string next_video_link = 6

• int64 cid = 7

• int32 season_id = 8

• int32 follow = 9

EP信息

Used in: PlayViewBusinessInfo

• int32 ep_id = 1

• int64 cid = 2

• int64 aid = 3

• int64 ep_status = 4

• optional SeasonInfo season_info = 5

• string cover = 6

• string title = 7

• optional Interaction interaction = 8

• string long_title = 9

事件

Used in: app.playerunite.pgcanymodel.PGCAnyModel, PlayViewReply

• optional Shake shake = 1

  震动

放映室提示语

Used in: PlayAbilityExtConf

• string desc = 1

• int32 type = 2

• int32 issued_cnt = 3

• bool is_always_show = 4

• int32 screen_number = 5

• int32 full_screen_number = 6

渐变色信息

Used in: BadgeInfo, ButtonInfo, PromptBar

• string start_color = 1

• string end_color = 2

高画质试看信息

Used in: ViewInfo

• bool trial_able = 1

• int32 remaining_times = 2

• int32 start = 3

• int32 time_length = 4

• optional Toast start_toast = 5

• optional Toast end_toast = 6

• optional Report report = 7

• optional ButtonInfo quality_open_tip_btn = 8

• optional ButtonInfo no_longer_trial_btn = 9

历史记录节点

Used in: Interaction

• int64 node_id = 1

  节点ID

• string title = 2

  节点标题

• int64 cid = 3

  对应CID

图片信息

Used in: Dialog

• string url = 1

  图片链接

Used in: PlayViewReq

• UNKNOWN = 0

• RELATED_EP = 1

• HE = 2

• SKIP = 3

Used in: PlayViewBusinessInfo

• TYPE_UNKNOWN = 0

• TYPE_WHOLE = 1

• TYPE_HE_CLIP = 2

• TYPE_PREVIEW = 3

交互信息

Used in: EpisodeInfo

• optional HistoryNode history_node = 1

  历史节点

• int64 graph_version = 2

  版本

• string msg = 3

  交互消息

• bool is_interaction = 4

  是否为交互

限制操作类型

• LAT_UNKNOWN = 0

• SHOW_LIMIT_DIALOG = 1

• SKIP_CURRENT_EP = 2

Used in: ClipInfo

• string button_material = 1

• int64 ep_id = 2

• int64 cid = 3

• int64 avid = 4

大会员广告: 支付提示信息

Used in: ViewInfo

• string title = 1

  标题

• string url = 2

  跳转链接

• string icon = 3

  图标

• int32 type = 4

  浮层类型

• int32 show_type = 5

  显示类型

• string img = 6

  图片信息

• string bg_day_color = 7

  白天背景颜色

• string bg_night_color = 8

  夜间背景颜色

• string bg_line_color = 9

  白天线条颜色

• string bg_night_line_color = 10

  夜间线条颜色

• string text_color = 11

  文字颜色

• string text_night_color = 12

  夜间文字颜色

• int64 view_start_time = 13

  视图展示起始时间

• repeated ButtonInfo button = 14

  按钮列表

• int32 url_open_type = 15

  跳转链接打开方式

• optional Report report = 16

  埋点上报信息

• int32 angle_style = 17

  角度样式

• int32 report_type = 18

  埋点上报类型

• map<string, string> order_report_params = 19

  订单埋点上报参数

• string giant_screen_img = 20

  巨屏图片信息

禁用功能配置

Used in: PlayViewReply

• bool background_play_disable = 1

  后台播放

• bool flip_disable = 2

  镜像反转

• bool cast_disable = 3

  投屏

• bool feedback_disable = 4

  反馈

• bool subtitle_disable = 5

  字幕

• bool playback_rate_disable = 6

  播放速度

• bool time_up_disable = 7

  定时停止

• bool playback_mode_disable = 8

  播放方式

• bool scale_mode_disable = 9

  画面尺寸

• bool like_disable = 10

  赞

• bool dislike_disable = 11

  踩

• bool coin_disable = 12

  投币

• bool elec_disable = 13

  充电

• bool share_disable = 14

  分享

• bool screen_shot_disable = 15

  截图

• bool lock_screen_disable = 16

  锁定

• bool recommend_disable = 17

  相关推荐

• bool playback_speed_disable = 18

  播放速度

• bool definition_disable = 19

  清晰度

• bool selections_disable = 20

  选集

• bool next_disable = 21

  下一集

• bool edit_dm_disable = 22

  编辑弹幕

• bool small_window_disable = 23

  小窗

• bool shake_disable = 24

  震动

• bool outer_dm_disable = 25

  外层面板弹幕设置

• bool inner_dm_disable = 26

  三点内弹幕设置

• bool freya_enter_disable = 27

  一起看入口

• bool dolby_disable = 28

  杜比音效

• bool freya_full_disable = 29

  全屏一起看入口

• bool skip_oped_switch_disable = 30

  跳过片头片尾

• bool record_screen_disable = 31

  录屏

• bool color_optimize_disable = 32

  色觉优化

• bool dubbing_disable = 33

  配音

云控扩展配置信息

Used in: app.playerunite.pgcanymodel.PGCAnyModel, PlayViewReply

• bool allow_close_subtitle = 1

• optional FreyaConfig freya_config = 2

• optional CastTips cast_tips = 3

播放配音信息

Used in: PlayExtInfo

• optional AudioMaterialProto background_audio = 1

  背景音频

• repeated RoleAudioProto role_audio_list = 2

  角色音频列表

• string guide_text = 3

  引导文本

错误码

• NoErr = 0

• WithMultiDeviceLoginErr = 1

  管控类型的错误码

播放扩展信息

Used in: app.playerunite.pgcanymodel.PGCAnyModel, PlayViewReply

• optional PlayDubbingInfo play_dubbing_info = 1

  播放配音信息

Used in: Dialog

• int32 season_id = 1

• string title = 2

• string cover = 3

• string link = 4

• optional BadgeInfo badge_info = 5

其他业务信息

Used in: app.playerunite.pgcanymodel.PGCAnyModel, PlayViewReply

• bool is_preview = 1

  当前视频是否是预览

• bool bp = 2

  用户是否承包过

• string marlin_token = 3

  drm使用

• string playback_speed_color = 4

  倍速动效色值

• optional ContinuePlayInfo continue_play_info = 5

• repeated ClipInfo clip_info = 6

  跳过片头/片尾配置

• InlineType inline_type = 7

• int32 ep_whole_duration = 8

• optional Dimension dimension = 9

  当前分辨率信息

• map<int32, QualityExtInfo> quality_ext_map = 10

• map<string, int32> exp_map = 11

• DrmTechType drm_tech_type = 12

  DRM技术类型

• int32 limit_action_type = 13

• bool is_drm = 14

• optional RecordInfo record_info = 15

• int32 vip_status = 16

• bool is_live_pre = 17

• optional EpisodeInfo episode_info = 18

• optional EpisodeAdvertisementInfo episode_advertisement_info = 19

• optional UserStatus user_status = 20

播放页信息-响应

Used as response type in: PlayURL.PlayView, PlayURL.PlayViewComic

• optional VideoInfo video_info = 1

  视频流信息

• optional PlayAbilityConf play_conf = 2

  播放控件用户自定义配置

• optional PlayViewBusinessInfo business = 3

  业务需要的其他信息

• optional Event event = 4

  事件

• optional ViewInfo view_info = 5

  展示信息

• optional PlayAbilityExtConf play_ext_conf = 6

  自定义配置扩展信息

• optional PlayExtInfo play_ext_info = 7

  播放扩展信息

播放页信息-请求

Used as request type in: PlayURL.PlayView, PlayURL.PlayViewComic

• int64 epid = 1

  剧集epid

• int64 cid = 2

  视频cid

• int64 qn = 3

  清晰度

• int32 fnver = 4

  视频流版本

• int32 fnval = 5

  视频流格式

• uint32 download = 6

  下载模式 0:播放 1:flv下载 2:dash下载

• int32 force_host = 7

  流url强制是用域名 0:允许使用ip 1:使用http 2:使用https

• bool fourk = 8

  是否4K

• string spmid = 9

  当前页spm

• string from_spmid = 10

  上一页spm

• int32 teenagers_mode = 11

  青少年模式

• CodeType prefer_codec_type = 12

  视频编码

• bool is_preview = 13

  是否强制请求预览视频

• int64 room_id = 14

  一起看房间id

• bool is_need_view_info = 15

  是否需要展示信息

• optional SceneControl scene_control = 16

  场景控制

• InlineScene inline_scene = 17

• int64 material_no = 18

• int32 security_level = 19

  DRM 安全等级

• int64 season_id = 20

• optional DataControl data_control = 21

弹窗信息

Used in: CouponInfo, ViewInfo

• string title = 1

  弹窗标题 老字段

• repeated Coupon coupon = 2

  优惠券列表

• repeated ButtonInfo button = 3

  弹窗按钮列表

• string bottom_text = 4

  底部文案 老字段

• optional TextInfo pop_title = 5

  弹窗标题 新字段

• optional TextInfo subtitle = 6

  弹窗副标题

• optional ButtonInfo bottom_desc = 7

  底部描述 新字段

• string cover = 8

  弹窗小图

• string pop_type = 9

  弹窗类型

广告组件: 竖屏时视频下部提示栏

Used in: ViewInfo

• optional TextInfo title = 1

  主标题, 如: "本片含大会员专享内容"

• optional TextInfo sub_title = 2

  副标题, 如: "成为大会员可免费看全部剧集"

• string sub_title_icon = 3

  副标题前面的icon

• string bg_image = 4

  背景图

• optional GradientColor bg_gradient_color = 5

  背景渐变色

• repeated ButtonInfo button = 6

  按钮

• optional Report report = 7

  埋点上报信息

• string full_screen_ip_icon = 8

• optional GradientColor full_screen_bg_gradient_color = 9

云控拓展视频画质信息

Used in: PlayViewBusinessInfo

• bool trial_support = 1

  是否支持试看

备案信息

Used in: PlayViewBusinessInfo

• string record = 1

  记录

• string record_icon = 2

  记录图标

埋点上报信息

Used in: ButtonInfo, Dialog, HighDefinitionTrialInfo, PayTip, PromptBar, Toast

• string show_event_id = 1

  曝光事件

• string click_event_id = 2

  点击事件

• string extends = 3

  埋点透传参数

分段流条目

Used in: SegmentVideo

• uint32 order = 1

  分段序号

• uint64 length = 2

  分段时长

• uint64 size = 3

  分段大小

• string url = 4

  主线流

• repeated string backup_url = 5

  备用流

• string md5 = 6

  md5

权限信息

Used in: SeasonInfo

• int32 can_watch = 1

  是否可以观看

角色配音信息

Used in: PlayDubbingInfo

• int64 role_id = 1

  角色ID

• string role_name = 2

  角色名称

• string role_avatar = 3

  角色头像

• repeated AudioMaterialProto audio_material_list = 4

  音频素材列表

场景控制

Used in: PlayViewReq

• bool fav_playlist = 1

  是否收藏播单

• bool small_window = 2

  是否小窗

• bool pip = 3

  是否画中画

• bool was_he_inline = 4

• bool is_need_trial = 5

方案

Used in: StreamInfo

• Scheme.ActionType action_type = 1

• string toast = 2

Used in: Scheme

• UNKNOWN = 0

• SHOW_TOAST = 1

PGC SEASON 信息

Used in: EpisodeInfo

• int32 season_id = 1

  PGC SEASON ID

• int32 season_type = 2

  PGC SEASON 类型

• int32 season_status = 3

  PGC SEASON 状态

• string cover = 4

  封面

• string title = 5

  标题

• optional Rights rights = 6

  权限信息

• int32 mode = 7

  模式

DRM 安全等级

• LEVEL_UNKNOWN = 0

• LEVEL_L1 = 1

• LEVEL_L2 = 2

• LEVEL_L3 = 3

分段视频流

Used in: Stream

• repeated ResponseUrl segment = 1

  分段视频流列表

震动

Used in: Event

• string file = 1

  文件地址

视频流信息

Used in: VideoInfo

• optional StreamInfo info = 1

  元数据

• oneof content

  流数据

  • DashVideo dash_video = 2

    dash流

  • SegmentVideo segment_video = 3

    分段流

流媒体元数据

Used in: Stream

• int32 quality = 1

  视频质量

• string format = 2

  视频格式

• string description = 3

  描述信息

• int32 err_code = 4

  错误码

• optional StreamLimit limit = 5

  流限制信息

• bool need_vip = 6

  是否需要VIP

• bool need_login = 7

  是否需要登录

• bool intact = 8

  是否完整

• int64 attribute = 10

  权限信息

• string new_description = 11

  新版描述信息

• string display_desc = 12

  显示描述信息

• string superscript = 13

  上标

• optional Scheme scheme = 14

  方案信息

• bool support_drm = 15

  是否支持DRM

• string subtitle = 16

  字幕信息

清晰度不满足条件信息

Used in: StreamInfo

• string title = 1

  标题

• string uri = 2

  跳转地址

• string msg = 3

  提示信息

任务参数信息

Used in: ButtonInfo

• string task_type = 1

  任务类型

• int64 activity_id = 2

  活动ID

• int64 tips_id = 3

  提示ID

文案信息

Used in: BottomDisplay, ButtonInfo, Dialog, PopWin, PromptBar, Toast

• string text = 1

  文案

• string text_color = 2

  字体色值

• string text_color_night = 3

  字体色值-夜间模式

toast

Used in: HighDefinitionTrialInfo, ViewInfo, WatchProgress

• string text = 1

  toast文案 老字段

• optional ButtonInfo button = 2

  toast按钮

• int32 show_style_type = 3

  显示样式类型

• string icon = 4

  图标

• optional TextInfo toast_text = 5

  toast文案 新字段

• optional Report report = 6

  埋点上报信息

• map<string, string> order_report_params = 7

用户状态信息

Used in: PlayViewBusinessInfo

• bool pay_check = 1

  是否支付

• bool sponsor = 2

  是否承包

• optional WatchProgress watch_progress = 3

  观看进度

• optional WatchProgress aid_watch_progress = 4

  系列观看进度

视频url信息

Used in: PlayViewReply

• uint32 quality = 1

  视频清晰度

• string format = 2

  视频格式

• uint64 timelength = 3

  视频时长

• uint32 video_codecid = 4

  视频编码id

• repeated Stream stream_list = 5

  视频流

• repeated DashItem dash_audio = 6

  伴音流

• optional DolbyItem dolby = 7

  杜比伴音流

展示信息

Used in: app.playerunite.pgcanymodel.PGCAnyModel, PlayViewReply

• optional Dialog dialog = 1

  弹窗

• optional Toast toast = 2

  Toast

• optional CouponInfo coupon_info = 3

  优惠券信息

• repeated int64 demand_no_pay_epids = 4

  未支付剧集ID列表

• optional EndPage end_page = 5

  结束页

• map<string, bool> exp_config = 6

  扩展配置

• optional PopWin pop_win = 7

  弹窗

• optional PromptBar try_watch_prompt_bar = 8

  试看提示栏

• optional PayTip pay_tip = 9

  支付提示信息

• optional HighDefinitionTrialInfo high_definition_trial_info = 10

  高清试看提示信息

• map<string, Dialog> ext_dialog = 11

  弹窗扩展

• optional Animation animation = 12

  动画

• map<string, Toast> ext_toast = 13

  Toast扩展

观看进度信息

Used in: UserStatus

• int32 last_ep_id = 1

  上次观看的 EP ID

• string last_ep_index = 2

  上次观看到的EP INDEX

• int64 progress = 3

  上次观看的进度

• int64 last_play_cid = 4

  上次观看的 CID

• optional Toast toast = 5

  带时间的提示信息

• optional Toast toast_without_time = 6

  不带时间的提示信息

• int64 last_play_aid = 7

  上次观看的 AID