播放器相关方法 #

其他方法 #

IM 相关方法 #

IDanmuItem #

发送的弹幕配置信息。

ILang #

观看页语言信息。

ILangMap #

观看页语言。

WebSDKBase #

类型：class

getActivityInfos() #

获取控制台中配置的页头图、页头广告、移动端背景图、背景色以及菜单等信息。

类型

() => { MobileHeaderImageUrl: string; PCHeaderImageUrl: string; IsHeaderAdEnable: 0 | 1; HeaderAd: { IsPageHeaderAdFloatingEnable: number; AdvertisementRedirectUrl: string; }; MobileBackImage: string; MobileBackgroundColor: string; IsMobileBackImageEnable: 0 | 1 | 2; Menus: {...

返回值

{ MobileHeaderImageUrl: string; PCHeaderImageUrl: string; IsHeaderAdEnable: 0 | 1; HeaderAd: { IsPageHeaderAdFloatingEnable: number; AdvertisementRedirectUrl: string; }; MobileBackImage: string; MobileBackgroundColor: string; IsMobileBackImageEnable: 0 | 1 | 2; Menus: { Menus: Menu[]; Product: ProductV2; }; }

• MobileHeaderImageUrl：移动端页头图 URL。
• PCHeaderImageUrl：PC 端页头图 URL。
• IsHeaderAdEnable：页头广告是否开启。取值如下：
  • 0：未开启。
  • 1：开启。
• HeaderAd：页头广告。
• IsPageHeaderAdFloatingEnable：页头广告交互展示样式。取值如下：
  • 0：点击页头广告后，广告在新页面展示，观众无法同时观看直播与广告。
  • 1：点击页头广告后，广告在直播间内浮层展示，观众可在看直播的同时查看广告。仅移动端生效。
• AdvertisementRedirectUrl：页头广告的跳转链接。
• MobileBackImage：移动端背景图 URL。
• MobileBackgroundColor：移动端背景色。
• IsMobileBackImageEnable：移动端是否开启背景图或背景色。取值如下：
  • 0：关闭背景图。
  • 1：开启背景图。
  • 2：开启背景色。
• Menus：菜单配置。
• Product：商品卡片配置。

on() #

监听事件。

类型

(action: string, func: (...args: any[]) => void) => void

参数

emit() #

触发事件。

类型

(action: string, payload?: any) => void

参数

sendDanmu() #

发送弹幕。

类型

(payload: IDanmuItem[]) => void

参数

getHistoryMessages() #

获取历史评论消息。

类型

(callback: (data: CommentItem[]) => void) => void

参数

getLikeCount() #

获取当前直播间的累计点赞总数。

类型

() => number

返回值

number 当前直播间的点赞总数。如果获取失败，则返回 0。

sendChatMessage() #

发送评论消息。

类型

(data: { TextContent: string; repalyList?: string[]; ContentType?: MessageContentType;}, callback?: ((result: { success: boolean; error?: string;}) => void) | undefined) => any

参数

返回值

any

sendLikeMessage() #

发送点赞消息。当用户点击点赞按钮时，调用此方法向直播间发送指定数量的点赞。

类型

(count: number, callback: (result: { success: boolean; error?: string;}) => void) => any

参数

返回值

any

initIM() #

初始化 IM（即时通信）数据并建立长连接。

类型

(callback?: ((result: { state: boolean; message?: string;}) => void) | undefined) => Promise<void>

参数

返回值

Promise<void> 用于表示初始化过程的异步完成状态。

attendLottery() #

参与实时抽奖。当用户点击参与抽奖按钮时，调用此方法允许用户参与指定的实时抽奖。

类型

(params: LotteryAwardParams) => Promise<{ status: boolean; info: string;}>

参数

返回值

Promise<{ status: boolean; info: string }>

• status：是否参与成功。取值如下：
  • true：成功。
  • false：失败。
• info：错误信息。

getLotteryResult() #

获取实时抽奖的配置信息。

类型

(params: LotteryAwardParams) => Promise<{ status: boolean; info: LotteryAwardResult;}>

参数

返回值

Promise<{ status: boolean; info: LotteryAwardResult }>

• status：是否获取成功。取值如下：
  • true：成功。
  • false：失败。
• info：错误信息。

updateLotteryInfo() #

更新实时抽奖。当抽奖结果更新时，调用此方法更新实时抽奖的信息，如抽奖结果详情等。

类型

(params: LotteryAwardResult) => Promise<{ status: boolean; info: string;}>

参数

返回值

Promise<{ status: boolean; info: string }>

• status：是否更新成功。取值如下：
  • true：成功。
  • false：失败。
• info：错误信息。

once() #

监听事件。事件处理函数只执行一次。

类型

(action: string, func: (...args: any[]) => void) => void

参数

off() #

解绑或移除事件监听。

类型

(action: string, func: (...args: any[]) => void) => void

参数

getPlayerInstance() #

获取播放器实例。

类型

() => any

返回值

any

updateModulesConf() #

动态更新 SDK modules 或 options 的配置。例如，您可以通过调用该方法实现移动端小窗模式，详见移动端小窗模式。

类型

(conf: Partial<SDKConfAll>) => void

参数

addDynamicMenuTab() #

在移动端横屏直播间中动态插入自定义菜单页签。你可以在直播间初始化完成后调用此方法。

类型

(items: LandscapeMenuConf[]) => void

参数

destroy() #

销毁 SDK。

类型

() => void

updateMode2Token() #

更新公开权限 Token（mode = 1）为带有用户信息的 Token（mode = 2）。使用场景参见第三方用户态登录和关注主播。

类型

(token: string) => Promise<{ status: boolean; info: string;}>

参数

返回值

Promise<{ status: boolean; info: string; }>

• status：是否更新成功。取值如下：
  • true：成功。
  • false：失败。
• info：错误信息。

seekVideo() #

跳转到预告或回放的某个时间点。例如，您可以传入 ExplainTime 的值，跳转至商品讲解的时间点。

类型

(param: { time: number;}) => void

参数

getVodPlayInfo() #

获取点播视频（预告和回放）的播放信息。

类型

() => { vid: string; currentTime: number; duration: number;}

返回值

{ vid: string; currentTime: number; duration: number; }

• vid：视频 ID，视频的唯一标识。
• currentTime：当前播放位置。单位为秒。
• duration：视频总时长。单位为秒。

getPageLanguage() #

获取观看页支持的语言以及当前的观看页语言。

类型

() => ILangMap

返回值

ILangMap

switchLanguage() #

切换至指定观看页语言。

类型

(lang: number) => void

参数

backLiveTimeShift() #

直播间开启直播时移后，调用此方法跳转至 8 小时内任意过去时间点。例如，您可以传入 ExplainTime 的值，跳转至商品讲解的时间点。

类型

(param?: { time?: number;}) => Promise<{ status: boolean; info: string;}>

参数

返回值

Promise<{ status: boolean; info: string }>

• status：是否操作成功。取值如下：
  • true：成功。
  • false：失败。
• info：错误信息。

switchChannel() #

当直播状态为直播中时，切换至指定直播频道。当直播状态为回放时，切换至指定回放视频。

类型

(index: number) => void

参数

requestPip() #

开启或关闭 PC 端的画中画模式。

类型

(value?: boolean) => boolean

参数

返回值

boolean

• true：操作成功。
• false：操作失败。

checkIn() #

执行签到操作。

类型

(checkInParams: { CheckInId: string; ActivityId: number; PersonInfo?: string;}) => Promise<{ status: boolean; info: string;}>

参数

返回值

Promise<{ status: boolean; info: string; }>

• { status: true, info: '' }：操作成功。
• { status: false, info: '具体失败信息' }：操作失败，返回具体失败信息。

createPlayer() #

初始化播放器。需配合初始化参数 disablePlayer 使用。

类型

() => void