直播间的鉴权模式。
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 | 用户在企业直播控制台是否设置为观看页浮层展示内容。
|
单条评论的数据信息 Model。
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" | 直播间点赞图标。 |
评论发送成功后的结果。
public class SendCommentResult { private String H5MsgId; private String Nickname; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
H5MsgId | String | 评论 ID。 |
Nickname | String | 发送评论的用户昵称。 |
直播间网络请求服务器返回的失败的错误类。
public class Error { private String Code; private String Message; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
Code | String | 错误码。 |
Message | String | 错误信息。 |
直播间网络请求通用的描述信息。
public class ResponseMetadata { private String RequestId; private long SystemTime; private Error Error; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
RequestId | String | 网络请求的唯一 ID,用于服务器定位网络请求。 |
SystemTime | Long | 网络请求返回时服务器的系统时间(Unix 秒级时间戳)。 |
Error | Error | 网络请求服务器返回的失败的错误类。详见 Error。
|
发送评论网络请求服务器返回的结果。
public class SendCommentResponse extends BaseResponse { private SendCommentResult Result; private ResponseMetadata ResponseMetadata; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
Result | SendCommentResult | 评论发送成功后的结果。详见 SendCommentResult。 |
ResponseMetadata | ResponseMetadata | 网络请求通用的描述信息。详见 ResponseMetadata。 |
直播间的语言类型。
public enum com.bytedance.live.sdk.player.logic.LanguageManager.LANGUAGE
枚举值
类型 | 值 | 说明 |
---|---|---|
ZH_HANS | 0 | 简体中文。 |
EN | 1 | 英文。 |
JA | 2 | 日文。 |
ZH_HANT | 3 | 繁体中文。 |
直播预约信息。
public class ActivityBookingModel { String activityName; long activityId; long startTimeMillis; long endTimeMillis; String nickName; String externalUserId; long userId; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
activityName | String | 直播名称。 |
activityId | Long | 直播间的活动 ID。 |
startTimeMillis | Long | 直播开始时间(Unix 毫秒级时间戳)。 |
endTimeMillis | Long | 直播结束时间(Unix 毫秒级时间戳)。 |
nickName | String | 观众昵称。 说明 观众未输入昵称或未登录直播间时,取值为空。 |
externalUserId | String | 观众在第三方平台的唯一标识。 说明 仅在鉴权模式为自定义,且观众已登录直播间时有值。 |
userId | Long | 用户 ID,观众在企业直播的唯一标识。 说明 观众未输入昵称或未登录直播间时,取值为 |
按钮信息。
public class BDThemeIconModel { private Drawable lightModeIcon; private Drawable darkModeIcon; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
lightModeIcon | Drawable | 非暗黑模式主题下使用的按钮图标。 |
darkModeIcon | Drawable | 暗黑模式主题下使用的按钮图标。 |
直播间评论配置 Model。
public class CommentConfigModel extends BaseObservable { private boolean commentSendEnable; private boolean commentImageSendEnable; private boolean commentTranslateEnable; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
commentSendEnable | Boolean | 是否允许发送评论,包括文字评论和图片评论。
|
commentImageSendEnable | Boolean | 是否允许发送图片评论。
|
commentTranslateEnable | Boolean | 是否开启评论翻译。
|
直播间 UI 主题颜色配置 Model。
public class UIConfigModel extends BaseObservable { private int commentFontColor; private int hostCommentColor; private boolean isLightTheme; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
commentFontColor | Integer | 非主持人发送的评论内容颜色。 |
hostCommentColor | Integer | 主持人发送的评论内容颜色。 |
isLightTheme | Boolean | 直播间的外观主题是否为非暗黑模式。
|
进入完整直播间需要的配置信息。
public class JoinRoomConfig { public long activityId; public String token; public boolean isPortraitLiveRoom; public TVULiveRoom.TVURoomAuthMode authMode; public JoinResultListener joinResultListener; }
成员变量
名称 | 类型 | 说明 |
---|---|---|
activityId | Long | 要进入的直播间活动 ID,可以通过调用 CreateActivityAPIV2 或 ListActivityAPI 获取。 |
token | String | 进入该直播间所需的授权 token,可以通过调用 GetSDKTokenAPI 获取。 |
isPortraitLiveRoom | Boolean | 要进入的是竖屏直播间还是横屏直播间。
|
authMode | TVURoomAuthMode | 直播间的鉴权模式,包含公开(PUBLIC)和自定义(CUSTOM)两种。具体选择哪种取决于 GetSDKTokenAPI 传入的
|
joinResultListener | JoinResultListener | 进入直播间结果的回调类。可传空。详见 JoinResultListener。 |
观众被强制退出直播间的原因。
public enum BDLForceOfflineReason
枚举值
类型 | 值 | 说明 |
---|---|---|
BDLiveForceOfflineReasonMultiLogin | 0 | 在开启禁止重复登录功能后,同一观众在多端同时登录同一直播间。 |
BDLiveForceOfflineReasonUnCheckIn | 1 | 超时未签到。 |
本地的观众连麦状态。
public enum com.bytedance.live.sdk.player.logic.link.AudienceLinkState
枚举值
类型 | 值 | 说明 |
---|---|---|
UNKNOWN | 0 | 未知。该状态仅在从未从企业直播服务端进行过同步时出现。 |
UNLINKED | 1 | 未连麦。 |
RINGING | 2 | 正在申请连麦中。 |
LINKING | 3 | 连麦申请已通过,正在连麦中。 |
LINKED | 4 | 已加入连麦。 |