TVULiveRoomServer--企业直播-火山引擎

文档中心

导航

TVULiveRoomServer

最近更新时间：2024.05.17 17:41:20首次发布时间：2022.07.13 16:53:43

单独接入直播间组件时使用的类。

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

成员函数

TVULiveRoomServer

创建一个 TVULiveRoomServer 实例。

public TVULiveRoomServer(Context context, long activityId, String token, int serverType)

参数

名称	类型	说明
context	Context	直播间页面的上下文。
activityId	Long	要进入的直播间活动 ID，可以通过调用 CreateActivityAPIV2 获取。
token	String	进入该直播间所需的授权 token，可以通过调用 GetSDKTokenAPI 获取。
serverType	Integer	直播间的类型。默认值：`SERVER_TYPE_LIVEROOM`。 `SERVER_TYPE_LIVEROOM(1)`：横屏完整直播间。支持绑定聊天组件、独立播放器组件等多个直播间组件。说明 `TVULiveRoomServer` 实例以单例形式存在，同一时间只支持一个实例，如需使用新的实例，请先销毁旧的实例。 `SERVER_TYPE_PORTRAIT_LIVEROOM(2)`：竖屏完整直播间。支持绑定聊天组件、独立播放器组件等多个直播间组件。说明 `TVULiveRoomServer` 实例以单例形式存在，同一时间只支持一个实例，如需使用新的实例，请先销毁旧的实例。 `SERVER_TYPE_SINGLE(3)`：独立播放器直播间。仅支持绑定独立播放器组件。同一时间支持多个实例，适用于在您的自有页面展示多个独立播放器的场景。

返回值
TVULiveRoomServer 实例。

setPlayerView

设置与 TVULiveRoomServer 实例绑定的 PlayerView 实例。

public void setPlayerView(PlayerView playerView)

参数

名称	类型	说明
playerView	PlayerView	与 TVULiveRoomServer 实例绑定的 PlayerView 实例。

说明

确保在调用 start 方法前调用该方法。

setRoomAuthMode

设置直播间的鉴权模式。

public void setRoomAuthMode(TVULiveRoom.TVURoomAuthMode roomAuthMode)

参数

名称	类型	说明
roomAuthMode	TVURoomAuthMode	直播间的鉴权模式，包含公开（PUBLIC）和自定义（CUSTOM）两种。具体选择哪种取决于 GetSDKTokenAPI 传入的 `mode` 参数的值。 `PUBLIC`：`mode`=`1` 时设置为公开模式。观众以游客身份进入直播间，在点击评论输入框或点赞评论等需要用户信息的场景下，需要先完成游客注册（即输入昵称）。 `CUSTOM`：`mode`=`2` 时设置为自定义模式。观众在进入直播间时使用的是在您 App 内的用户信息，因此可以直接发送评论、点赞评论等。

名称

类型

说明

roomAuthMode

TVURoomAuthMode

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

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

说明

确保在调用 start 方法前调用该方法。

setListener

设置直播间的监听器。

public void setListener(ITVULiveRoomServerListener tVULiveRoomListener)

参数

名称	类型	说明
tVULiveRoomListener	ITVULiveRoomServerListener	直播间的监听器，包含直播间初始化相关和状态改变相关的回调。

说明

确保在调用 start 方法前调用该方法。

start

开启直播间。调用此方法后，TVULiveRoomServer 实例调用后端接口进行鉴权并获取直播间数据。start 方法调用成功后会初始化本地直播间数据。

public void start()

说明

如不再需要该直播间，请调用 closeRoom 方法销毁当前直播间，释放资源。

play

开始播放视频。

public void play()

说明

确保在调用 start 方法后、closeRoom 方法前调用该方法。

pause

暂停播放视频。

public void pause()

说明

确保在调用 start 方法后、closeRoom 方法前调用该方法。

onPause

暂停播放视频。适用于当前直播间的 Activity 被切换到后台的场景。

public void onPause()

说明

确保在调用 start 方法后、closeRoom 方法前调用该方法。

onResume

继续播放视频。适用于原直播间的 Activity 被切换回前台的场景。

public void onResume()

说明

确保在调用 start 方法后、closeRoom 方法前调用该方法。

adjustPlayer

调整播放器布局。

public void adjustPlayer(
    boolean isLandscape, 
    int horizontalMargin, 
    int height, 
    int width)

参数

名称	类型	说明
isLandscape	Boolean	是否为横屏模式。 `true`：横屏模式。 `false`：竖屏模式。
horizontalMargin	Integer	播放器左右两边的外边距。单位：px。
height	Integer	播放器的高度。单位：px。
width	Integer	播放器的宽度。单位：px。

说明

确保在调用 start 方法后、closeRoom 方法前调用该方法。
推荐在 ITVULiveRoomServerListener 中的 onFullScreenChange 回调中调用。

注意

该方法自 1.34.0 版本开始不再支持使用。

pausePollingData

TVULiveRoomServer 实例在初始化成功后会定时从企业直播控制台拉取并更新当前直播状态（直播中、回放、预告、已结束）。如果不想 TVULiveRoomServer 实例在控制台拉取、更新直播状态，调用此方法暂停拉取。

public void pausePollingData()

continuePollingData

控制 TVULiveRoomServer 实例继续从控制台拉取并更新直播状态。

public void continuePollingData()

closeRoom

销毁当前直播间。

public void closeRoom()

说明

确保在调用 start 方法后调用该方法。
调用此方法后不应再调用 TVULiveRoomServer 实例中的任何方法。您可以在调用此方法后将 TVULiveRoomServer 实例置为 Null。

getWsConnector

获取直播间内 IM（即时消息）信令的管理类。

public WSConnector getWsConnector()

返回值

类型	说明
WSConnector	直播间内 IM 信令的管理类。详见 WSConnector。

getCommentDataManager

获取直播间内消息列表的管理类。

public CommentDataManager getCommentDataManager()

返回值

类型	说明
CommentDataManager	直播间内消息列表的管理类。详见 CommentDataManager。