You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

TVULiveRoom

最近更新时间：2024.04.15 18:17:45

首次发布时间：2022.07.13 16:53:43

我的收藏

接入完整直播间时使用的类，包含进入和退出直播间的功能。

public class com.bytedance.live.sdk.player.TVULiveRoom

成员函数

joinLiveRoom

进入完整直播间。

public static void joinLiveRoom(
    final Context context, 
    final long activityId, 
    String token, 
    TVURoomAuthMode roomAuthMode, 
    boolean isPortrait)

参数

名称

类型

说明

context

Context

直播间页面的上下文。

activityId

Long

要进入的直播间活动 ID，可以通过调用 CreateActivityAPIV2 获取。

token

String

进入该直播间所需的授权 token，可以通过调用 GetSDKTokenAPI 获取。

roomAuthMode

TVURoomAuthMode

直播间的鉴权模式，包含公开（PUBLIC）和自定义（CUSTOM）两种。具体选择哪种取决于 GetSDKTokenAPI 传入的 mode 参数的值。

  • PUBLIC：mode=1 时设置为公开模式。观众以游客身份进入直播间，在点击评论输入框或点赞评论等需要用户信息的场景下，需要先完成游客注册（即输入昵称）。
  • CUSTOM：mode=2 时设置为自定义模式。观众在进入直播间时使用的是在您 App 内的用户信息，因此可以直接发送评论、点赞评论等。

isPortrait

Boolean

要进入的是竖屏直播间还是横屏直播间。

  • true：竖屏直播间
  • false：横屏直播间

说明

在调用此方法前，可以通过调用 CustomSettings.Holder.mSettings 中的方法定制直播间。详情请参见 mSettings 类的相关方法。

leaveLiveRoom

退出直播间，同时销毁当前悬浮窗。

public static void leaveLiveRoom(final Context context)

参数

名称

类型

说明

context

Context

直播间页面的上下文。

说明

在调用 joinLiveRoom 方法后再调用该方法。

destroyFloatWindow

销毁当前悬浮窗，同时销毁悬浮窗的播放资源。建议在调用 setLiveRoomStatusListener 方法监听到直播间销毁后再调用该方法。

public static void destroyFloatWindow()

说明

在调用 joinLiveRoom 方法后再调用该方法。

manualClickFloatWindow

模拟手动点击当前悬浮窗。

public static void manualClickFloatWindow()

说明

在调用 joinLiveRoom 方法后再调用该方法。

manualClickFloatWindowExitBtn

模拟手动点击当前悬浮窗的关闭按钮。

public static void manualClickFloatWindowExitBtn()

说明

在调用 joinLiveRoom 方法后再调用该方法。

manualClickLiveRoomExitBtn

模拟手动点击退出直播间图标，之后的行为和观众正常点击退出直播间图标的行为一致。

public static void manualClickLiveRoomExitBtn(final Context context)

参数

名称

类型

说明

context

Context

直播间页面的上下文。

说明

在调用 joinLiveRoom 方法后再调用该方法。

clearCache

清除直播间的本地缓存。本地缓存包含：

  • 弹出风险提示弹窗的记录。清除后，观众重进该直播间，风险提示弹窗会重新弹出。
  • 在系统日历预约直播的记录。清除后，预约按钮会恢复为立即预约，但不会清除系统日历中的日程。
  • 点播视频断点续播的记录。清除后，观众重进该直播间，点播视频会从头播放。
public static void clearCache(Context context)

参数

名称

类型

说明

context

Context

直播间页面的上下文。

getCookieId

获取 SDK 本地存储的 cookieId，用于查询日志。

public static String getCookieId(Context context)

参数

名称

类型

说明

context

Context

直播间页面的上下文。