Home > @bilibili-live/web-player-biz > IRoomPlayer
# IRoomPlayer interface
roomPlayer上可以调用的方法
Signature:
export interface IRoomPlayer
# Properties
Property | Type | Description |
---|---|---|
addLoadingPicture | (src: string) => void | |
capturePic | (imgType: string, quality: number) => string | null | 截取当前播放的图像,返回 DataURL,若为开播,返回 null |
changeCtrlVisible | (value: boolean) => void | 外部控制控制栏是否显示 |
changeUIStatus | (args: { logo?: boolean; feedback?: boolean; recommend?: boolean; }) => void | 改变logo, 用户反馈, 以及关播推荐用户是否展示 |
destroy | () => void | |
discardFrame | (seconds: number) => void | 跳帧 |
freeze | () => void | 断流播放器,但是保持最后一帧画面 |
getOperableElements | () => { mainElement: HTMLDivElement; } | 调节音量 {{mainElement: HTMLDivElement}}返回一个div className 为 web-player-inject-wrap 这个容器高度关播时高度为100px,直播轮播为100% |
getPlayerInfo | () => { type: number; version: string; playerType: string; liveStatus: RoomStatus; playerStatus: number; playingStatus: boolean; playurl: string; guid: string; quality: string; qualityCandidates: never[]; } | |
getVideoEl | HTMLVideoElement | null | 获取正在播放的Video节点,如果关播状态,返回 null 一般发版 (HTMLVideoElement),如果正则通过软解播放HEVC,则返回 |
init | (type: string, data: any) => void | |
injectInitAPIData | (data: IInjectParam) => void | 初始化时外部注入数据,仅用于弹幕屏蔽规则 |
NAME | string | |
notifyAnnouncement | () => void | 展示公告, 弹幕避让 |
notifyInOperation | (operating: boolean) => void | 改变他的层级getOperableElements返回的对象 operating? 9: -1 |
on | (evtType: ExternalEventType, fn: Function) => (() => void) | undefined | |
once | (evtType: ExternalEventType, fn: Function) => (() => void) | undefined | |
pause | () => void | |
play | () => void | |
refresh | () => void | |
reload | () => Promise<void> | |
remainBufferLength | () => number | 获取buffer长度 |
resize | () => void | 弹幕显示区域重新自适应 |
sendDanmaku | (data: any) => Promise<{ uniqueID: any; response: Response; }> | |
set | (args: { component: 'block'; action: string; data: any; callback?: Function; }) => void | 设置弹幕屏蔽规则 |
setFullscreenDanmaku | (fullscreenDmInput: FullscreenDanmakuInput) => void | 全屏发送弹幕 |
stopPlayback | (opts?: { url?: string; }) => void | 外部断流,url是断流是视频区域显示的图片 |
userFeedback | (value: { type: number; details: string; }) => void | 用户反馈埋点 |
VERSION | string | |
volume | (v: number) => void | 调节音量 |