最近更新时间:2024.04.15 18:18:36
首次发布时间:2022.07.13 16:53:43
直播间的鉴权模式。
public enum com.bytedance.live.sdk.player.TVULiveRoom.TVURoomAuthMode
枚举值
类型 | 值 | 说明 |
---|---|---|
PUBLIC | 1 | 公开模式:观众以游客身份进入直播间,在点击评论输入框或点赞评论等需要用户信息的场景下,需要先完成游客注册(即输入昵称)。 |
CUSTOM | 2 | 自定义模式:观众在进入直播间时使用的是在您 App 内的用户信息,因此可以直接发送评论、点赞评论等。 |
独立播放器初始化配置。
public class InitConfig { public SinglePlayerListener singlePlayerListener; public PlayConfig playConfig = new PlayConfig(); }
成员变量
名称 | 类型 | 说明 |
---|---|---|
singlePlayerListener | 独立播放器的回调类。 | |
playConfig | 播放配置。 |
注意
以下变量自 1.26.0 版本开始不再支持使用:
activityId
:Long
类型。要进入的直播间活动 ID,可以通过调用 CreateActivityAPIV2 获取。token
:String
类型。进入该直播间所需的授权 token,可以通过调用 GetSDKTokenAPI 获取。authMode
:TVURoomAuthMode 类型。直播间的鉴权模式,包含公开(PUBLIC)和自定义(CUSTOM)两种。具体选择哪种取决于 GetSDKTokenAPI 传入的 mode
参数的值。
PUBLIC
:mode
=1
时设置为公开模式。观众以游客身份进入直播间,在评论或点赞等需要用户信息的场景下,需要先进行登录操作。CUSTOM
:mode
=2
时设置为自定义模式。观众在进入直播间时使用的是在您 App 内的用户信息,因此可以直接进行评论、点赞等操作。播放配置。
public class PlayConfig { public boolean isLiveAutoPlay = true; public boolean isForeShowAutoPlay = true; public boolean isPlayBackAutoPlay = true; public boolean isForeShowLoop = true; public boolean isPlayBackLoop =true; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
isLiveAutoPlay | Boolean | 直播是否自动播放。默认为 |
isForeShowAutoPlay | Boolean | 预告是否自动播放。默认为 |
isPlayBackAutoPlay | Boolean | 回放是否自动播放。默认为 |
isForeShowLoop | Boolean | 预告是否自动循环播放。默认为 |
isPlayBackLoop | Boolean | 回放是否自动循环播放。默认为 |
实现跳转所需的信息。
public class RedirectInfo { public static final int CONTENT_TYPE_URL = 1; public static final int CONTENT_TYPE_COMMENT = 2; public static final int CONTENT_TYPE_TASK_AWARD_TICKET_URL = 3; private final String entrance; private final int contentType; private UrlRedirectInfo urlRedirectInfo; private SingleCommentModel commentModel; private Product product; private TaskAwardTicketInfo taskAwardTicketInfo; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
entrance | String | 点击事件入口。
|
contentType | Integer | 内容类型。
|
urlRedirectInfo | 点击 URL 跳转所需的信息。当 | |
commentModel | 点击评论区的用户昵称跳转所需的信息。当 | |
product | 点击菜单内商品卡片或商品浮窗跳转所需的商品信息。当 | |
taskAwardTicketInfo | 点击累计观看抽奖奖券奖品的前往领取奖品按钮跳转所需的信息。当 |
点击 URL 跳转所需的信息。
public class UrlRedirectInfo { private final String url; private final boolean enableFloating; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
url | String | 用户在企业直播控制台设置的跳转链接。 |
enableFloating | Boolean | 用户在企业直播控制台是否设置为观看页浮层展示内容。
|
点击评论区的用户昵称跳转所需的信息。
public class SingleCommentModel extends BaseObservable { protected final String mNickname; protected String externalUserId = null; protected final String mContent; protected final boolean mIsPresenter; protected final long mMsgId; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
mNickname | String | 发送评论的用户昵称。 |
externalUserId | String | 发送评论的用户的外部 |
mContent | String | 评论内容。 |
mIsPresenter | Boolean | 发送评论的用户是否为主持人。
|
mMsgId | Long | 评论 ID。 |
点击菜单内商品卡片或商品浮窗跳转所需的商品信息。
public class Product {}
成员变量
名称 | 类型 | 说明 |
---|---|---|
Title | String | 商品卡片标题。 |
Highlight | String | 商品卡片高亮文字。 |
Strikethrough | String | 商品卡片划线文字。 |
Remark | String | 商品卡片商品备注。 |
IntroduceImage | String | 商品卡片介绍图 URL。 |
RedirectImage | String | 商品卡片跳转图 URL。 |
点击累计观看抽奖奖券奖品的前往领取奖品按钮跳转所需的信息。
public class TaskAwardTicketInfo{}
成员变量
名称 | 类型 | 说明 |
---|---|---|
ticketUrl | String | 领奖页面链接。 |
taskAwardRule | 累计观看抽奖的奖品信息。 |
累计观看抽奖的奖品信息。
public class TaskAwardRule {}
成员变量
名称 | 类型 | 说明 |
---|---|---|
AwardItemName | String | 奖品名称。 |
AwardItemIcon | String | 奖品图片 URL。 |
TaskAwardItemId | String | 奖品 ID。 |
连麦中页面切到后台时,弹出的前台通知样式。
public class NotificationInfo { private int smallIconResId; private String contentTitle; private String contentText; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
smallIconResId | Integer | 前台通知图标的资源 ID。 |
contentTitle | String | 前台通知的标题。 |
contentText | String | 前台通知的内容。 |
视图的自定义位置。
public class SimpleLayoutParams { private int gravity; private int marginLeftDp; private int marginRightDp; private int marginTopDp; private int marginBottomDp; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
gravity | Integer | 定义视图在其父布局中的位置和对齐方式。具体取值,详见 android.view.Gravity。 |
marginLeftDp | Integer | 视图距其父布局左侧的边距。单位:dp。 |
marginRightDp | Integer | 视图距其父布局右侧的边距。单位:dp。 |
marginTopDp | Integer | 视图距其父布局顶部的边距。单位:dp。 |
marginBottomDp | Integer | 视图距其父布局底部的边距。单位:dp。 |
视图的自定义大小。
public class CustomSize { private int widthDp; private int heightDp; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
widthDp | Integer | 视图的宽度。单位:dp。 |
heightDp | Integer | 视图的高度。单位:dp。 |
竖屏直播间底部的图标。
public enum BottomBar { IMAGE_TEXT_ICON("imageTextIcon"), INTERACT_TOOL_MENU("interactToolMenu"), SHOPPING_CARD_MENU("shoppingCardMenu"), PRIVATE_CHAT_MENU("PrivateChatMenu"), EMBEDDEDWEB_URLS("embeddedWebUrls"), PORTRAIT_THUMB("portraitThumb"); BottomBar(String value){ this.value = value; } public String value; }
枚举值
类型 | 值 | 说明 |
---|---|---|
IMAGE_TEXT_ICON | "imageTextIcon" | 图文介绍图标。 |
INTERACT_TOOL_MENU | "interactToolMenu" | 互动工具图标。 |
SHOPPING_CARD_MENU | "shoppingCardMenu" | 商品卡片图标。 |
PRIVATE_CHAT_MENU | "PrivateChatMenu" | 私聊互动图标。 |
EMBEDDEDWEB_URLS | "embeddedWebUrls" | 内嵌链接图标。 |
PORTRAIT_THUMB | "portraitThumb" | 直播间点赞图标。 |