文档中心

概览

最近更新时间：2024.04.15 20:18:23

首次发布时间：2022.07.14 13:14:06

方法

完整直播间接入

TVULiveRoom

方法	说明
joinLiveRoom	进入完整直播间。
leaveLiveRoom	退出直播间，同时销毁当前悬浮窗。
destroyFloatWindow	销毁当前悬浮窗。
manualClickFloatWindow	模拟手动点击当前悬浮窗。
manualClickFloatWindowExitBtn	模拟手动点击当前悬浮窗的关闭按钮。
manualClickLiveRoomExitBtn	模拟手动点击退出直播间图标。
clearCache	清除直播间的本地缓存。
getCookieId	获取 SDK 本地存储的 `cookieId`，用于查询日志。

独立播放器接入

TVUSinglePlayerView

方法	说明
Init	初始化独立播放器 `TVUSinglePlayerView` 实例。
refreshLive	刷新当前直播内容。
play	开始播放视频。
pause	暂停播放视频。
isPlaying	获取是否正在播放视频。
getPlayableStatus	获取当前资源的可播放状态。
isStalling	获取当前视频是否卡顿。
setPlayerLayoutMode	设置视频画面填充模式。
getResolutions	获取当前支持的分辨率列表。
getCurResolution	获取当前选中的分辨率。
setCurResolution	为当前视频设置分辨率。
getCurVodPlayTime	获取当前点播视频的播放进度。
seekVodTime	跳转到点播视频的指定播放进度。
getCurVodDuration	获取当前点播视频的时长。
getCurVodPlaySpeed	获取当前点播视频的播放倍速。
setMute	设置是否静音播放。
setVodLoop	设置点播视频是否循环播放。
setVodPlaySpeed	设置点播视频播放倍速。
setInBackground	当独立播放器所在的页面进入后台运行时，可调用此方法通知播放器。
getLiveRoomStatus	获取当前直播间的状态。
getCurVodVid	获取当前点播视频的 Vid。
getCurReplayList	获取当前的回放列表。
getCurLiveLineId	获取当前直播线路 ID。
getCurLiveLineList	获取当前的直播线路列表。

完整播放器接入

TVULiveRoomServer

方法	说明
TVULiveRoomServer	创建一个 `TVULiveRoomServer` 实例。
setPlayerView	设置与 `TVULiveRoomServer` 实例绑定的 `PlayerView` 实例。
setRoomAuthMode	设置直播间的鉴权模式。
setListener	设置直播间的监听器。
start	开启直播间。调用此方法后，`TVULiveRoomServer` 实例调用后端接口进行鉴权并获取直播间数据。`start` 方法调用成功后会初始化本地直播间数据。
play	开始播放视频。
pause	暂停播放视频。
onPause	暂停播放视频。适用于当前直播间的 Activity 被切换到后台的场景。
onResume	继续播放视频。适用于原直播间的 Activity 被切换回前台的场景。
pausePollingData	暂停拉取当前直播状态。
continuePollingData	继续拉取当前直播状态。
closeRoom	销毁当前直播间。

PlayerView

方法	说明
PlayerView	创建一个 `PlayerView` 实例。
play	开始播放视频。
pause	暂停播放视频。

直播间 UI 定制

方法	说明
addChildViewInFrameLayout	在 `floatingContainer` 中添加自定义悬浮 View 组件。该 View 组件不与 `floatingContainer` 中 SDK 默认的 View 组件进行位置联动，展示位置仅由 View 组件的配置决定。
addChildViewInLinearLayout	在 `floatingContainer` 中添加自定义悬浮 View 组件。该 View 组件与 `floatingContainer` 中 SDK 默认的 View 组件进行位置联动，即参与 View 组件展示顺序的重新排列。
setBottomOnClickListener	将竖屏直播间底部图标的点击事件替换为您自定义的点击事件。观众点击图标触发自定义的点击事件后，即可执行自定义的点击行为。

功能定制

播放器定制

方法	说明
setPlayerLayoutMode	设置横屏直播间内，视频画面的填充模式。
setPortraitPlayerLayoutMode	设置竖屏直播间内，视频画面的填充模式。
setPeopleCountFontStyle	设置人气的字体。
setPeopleCountIconDrawable	设置人气图标。
setPlayerThemeColor	设置播放器的主题颜色，即倍速按钮、进度条和清晰度按钮的颜色。
setRoomStatusTextTipFontSize	设置直播状态的字号。
setRoomStatusTextTipCenterOffset	设置直播状态文字距离播放器居中位置的纵向偏移量。
setRoomStatusTextTipRadius	设置直播状态文字背景的圆角。
setRoomStatusTextTipHorizontalPadding	设置直播状态文字的横向内边距。
setRoomStatusTextTipVerticalPadding	设置直播状态文字的纵向内边距。
setPlayerTimeColor	设置点播时间的颜色。
setFullScreenIcon	设置全屏图标。
setSmallScreenIcon	设置退出全屏图标。
setLiveRefreshIcon	设置直播中状态下播放器左下角的刷新图标。
setPlayerStartIcon	设置播放器左下角的播放图标。
setPlayerPauseIcon	设置播放器左下角的暂停图标。
setPlayerPausedCenterIcon	设置播放器中央的暂停状态图标。
setCustomLiveName	设置直播标题。
setSpeedSettingDialogAutoClose	设置在倍速选择对话框中选中倍速后，是否自动关闭倍速选择对话框。
setResolutionSettingDialogAutoClose	设置在清晰度选择对话框中选中清晰度后，是否自动关闭清晰度选择对话框。
setSimpleControlBar	设置是否开启竖屏直播间的简版控制栏，即无倍速和清晰度选择按钮。
setReplayTipText	设置回放的重新播放按钮文案。
setLiveAutoPlay	设置是否自动播放直播。
setPlayBackAutoPlay	设置横屏直播间内，是否自动播放回放。
setPortraitPlayBackAutoPlay	设置竖屏直播间内，是否自动播放回放。
setForceShowAutoPlay	设置横屏直播间内，是否自动播放预告。
setPortraitForceShowAutoPlay	设置竖屏直播间内，是否自动播放预告。
setPlayBackLoop	设置横屏直播间内，是否自动重播回放。
setPortraitPlayBackLoop	设置竖屏直播间内，是否自动重播回放。
setForceShowLoop	设置横屏直播间内，是否自动重播预告。
setPortraitForceShowLoop	设置竖屏直播间内，是否自动重播预告。
setVodAutoContinuePlayback	设置是否开启点播视频的自动断点续播。
setVodAutoSeekTipTextVisible	设置直播间内是否显示点播视频自动断点续播后的提示。
setVodAutoSeekTipTextSize	设置直播间内点播视频自动断点续播提示的文字大小。
setEnterFullScreenEnable	设置是否支持进入全屏模式。

菜单定制

方法	说明
setMenuTabBackgroundDrawable	设置横屏直播间内，菜单栏的背景。
setMenuFontColor	设置横屏直播间内，菜单栏被选中或未被选中时的文字颜色。
setMenuFontStyle	设置菜单栏的字体。
setMenuFlowingTagColor	设置菜单栏被选中的下标颜色。
setImageEmbeddedWebUrlsIcon	设置竖屏直播间内嵌链接菜单的图标。

评论区定制

方法	说明
setNoCommentIconDrawable	设置评论区无评论时的占位图标。
setCommentNicknameFontStyle	设置昵称的字体。
setCommentNicknameFontColor	设置观众的昵称颜色。
setCommentContentFontColor	设置观众的评论文字颜色。
setCommentLinkColor	设置评论链接的颜色。
setAudienceCommentLinkClickable	设置观众评论的链接是否可以点击。
setCommentContentFontStyle	设置评论的字体。
setHostTagFontStyle	设置主持人标签的字体。
setTopCommentTagFontStyle	设置置顶标签的字体。
setTopCommentFontStyle	设置置顶内容的字体。
setTopCommentFontColor	设置置顶内容的文字颜色。
setTopCommentRowCount	设置置顶最大显示的行数。
setTopCommentDialogTitleAtStart	设置置顶内容详情的对话框标题是否在最左侧。
setPortraitCommentAreaHeight	设置竖屏直播间内评论区的高度。
setPortraitCommentLineCount	设置竖屏直播间内单条评论的最大显示行数。
setCommentThumbedIcon	设置评论已点赞状态的点赞图标。
setCommentNotThumbedIcon	设置评论未点赞状态的点赞图标。
setCommentEditViewHintTextColor	设置评论输入框提示文字的颜色。
setCommentEditViewTextColor	设置横屏直播间内评论输入框的文字颜色。
setCommentIntervalTip	设置发言间隔的提示内容。
setCommentIntervalFontStyle	设置发言间隔的提示内容字体。
setCommentItemBgColor	设置直播间评论的背景色。
setPullCommentCount	设置每次能拉取的评论条数。
setPullHistoryCommentTotalCount	设置可以拉取的历史评论总数。
setThumbIcon	设置直播间点赞图标。
setJoinRoomMsgNicknameColor	设置直播间进场消息中昵称的文字颜色。
setJoinRoomMsgContentColor	设置直播间进场消息中内容的文字颜色。
setWelcomeMsgFontColor	设置直播间聊天欢迎语的文字颜色。
setLandscapeCommentShouldShowAvatar	设置横屏直播间的评论区内是否展示用户头像。
setPortraitCommentShouldShowAvatar	设置竖屏直播间的评论区内是否展示用户头像。
setHostDefaultAvatar	设置评论区主持人的默认头像。
setCommentDefaultAvatar	设置评论区观众的默认头像。
setThumbFloatingDrawableListener	设置点赞直播间后漂浮动画图标的监听器。

注册对话框定制

方法	说明
setNicknameDialogHeadFontStyle	设置标题的字体。
setNicknameDialogEditTextFontStyle	设置输入框内的文字字体。
setNicknameDialogHintText	设置输入框内的占位符。
setNicknameDialogButtonColor	设置确定按钮的背景颜色。
setNicknameDialogButtonTextFontStyle	设置确定按钮的字体。
setNicknameDialogCloseButtonIconDrawable	设置关闭图标。

图文定制

方法	说明
setRichTextPadding	设置图文区域上下左右的外边距。
setImageTextContentColor	设置图文内容的文字颜色。

广告定制

方法	说明
setPageCenterAdRatio	设置页中广告的宽高比。
setCenterAdStrokeColor	设置页中广告的边框颜色。
setCenterAdRadius	设置页中广告的圆角。
setCenterAdRotationInterval	设置页中广告的轮播速度。
setFloatAdLayoutParams	设置浮标广告的默认位置。
setFloatAdSize	设置浮标广告的大小。
setShowPageHeaderImage	设置是否显示页头图。
setShowPageCenterAd	设置是否显示页中广告。

播放器网络状态变化相关定制

方法	说明
setShowNonWiFiToast	设置在直播间内使用手机流量时是否开启提示。
setLandNonWifiToastCount	设置在横屏直播间内使用手机流量时，弹出提示文案的次数。
setRetryBtnBackgroundColor	设置横屏直播间内，重试按钮的背景颜色。
setPorRetryBtnBackgroundColor	设置竖屏直播间内，重试按钮的背景颜色。
setLandscapeRetryBtnCornerRadius	设置横屏直播间内，重试按钮的圆角。
setPortraitRetryBtnCornerRadius	设置竖屏直播间内，重试按钮的圆角。
setNetErrorBtn	设置网络异常的按钮文案。
setNonWIFIBtn	设置非 WiFi 状态的按钮文案。
setNetErrorText	设置网络异常的提示文案。
setNonWIFIText	设置非 WiFi 状态的提示文案。
setNetWorkChangeTextColor	设置使用手机流量的提示文案颜色。
setLoadingDrawable	设置横屏直播间的加载图标。
setPorLoadingDrawable	设置竖屏直播间的加载图标。
setLoadingDrawableSize	设置横屏直播间加载图标的大小。
setPorLoadingDrawableSize	设置竖屏直播间加载图标的大小。

主播账号定制

方法	说明
setAccountImageSize	设置主播账号的头像尺寸。
setAccountViewColor	设置主播账号的背景颜色。
setAccountFontSize	设置主播账号的字号。
setAccountFontColor	设置主播账号的文字颜色。

悬浮窗定制

方法	说明
setOpenLiveFloatWindow	设置是否开启直播悬浮窗。
setOpenVodFloatWindow	设置是否开启点播悬浮窗。
setFloatWindowBorderWidth	设置悬浮窗边框的宽度。
setFloatWindowBorderColor	设置悬浮窗边框的颜色。
setFloatWindowExitBtn	设置悬浮窗的关闭图标。
setFloatWindowCorner	设置悬浮窗的圆角。
setFloatViewActionListener	设置悬浮窗主体或其关闭按钮的点击事件监听器。

多语言切换定制

方法	说明
setLanguageType	设置需要的语言类型，默认为支持的所有语言，即简体中文、繁体中文、英文和日文。
setMultiLanguageIcon	设置多语言切换的图标。
setLanguageListener	设置多语言切换的监听器。
setPreferLanguage	设置观看页优先使用的语言。

商品卡片定制

方法	说明
setShowGoodsCount	设置是否显示商品卡片的总数。
setShoppingCardIcon	设置竖屏直播间内展示商品卡片的图标。
setShopCardItemImageCorner	设置商品卡片条目背景的圆角。
setShoppingCardDialogHeight	设置竖屏直播间内商品卡片对话框的高度。
setShoppingCardDialogBackgroundColor	设置竖屏直播间内商品卡片对话框的背景颜色。
setShoppingCardTabFontStyle	设置商品卡片菜单栏的字体。
setShoppingCardTabFontSize	设置商品卡片菜单栏的字号。
setShoppingCardTabSelectedFontColor	设置商品卡片菜单栏被选中后的文字颜色。
setShoppingCardTabUnSelectedFontColor	设置商品卡片菜单栏未被选中时的文字颜色。
setShoppingCardTitleFontStyle	设置商品卡片标题的字体。
setShoppingCardTitleFontSize	设置商品卡片标题的字号。
setShoppingCardTitleFontColor	设置商品卡片标题的颜色。
setShoppingCardHighLightFontStyle	设置商品卡片高亮文字的字体。
setShoppingCardHighLightFontSize	设置商品卡片高亮文字的字号。
setShoppingCardHighLightFontColor	设置商品卡片高亮文字的颜色。
setShoppingCardBackgroundColor	设置商品卡片的背景颜色。
setEnableDirectUrl	设置是否开启商品直达链接。

商品浮窗定制

方法	说明
setFloatingShoppingCardBuyBtn	设置商品浮窗按钮。
setFloatingShopCardBtnText	设置商品浮窗按钮的文案。
setFloatingShoppingCardLayoutParams	设置商品浮窗的默认位置。
setFloatShopCardCorner	设置商品浮窗的外层圆角。

直播间内链接跳转定制

方法	说明
setRedirectPageListener	设置直播间内的链接跳转监听器。

直播间状态定制

方法	说明
setLiveRoomStatusListener	设置直播间状态的监听器。
setLiveRoomActionListener	设置完整直播间的退出事件监听器。

抽奖定制

方法	说明
setFloatAwardListener	设置抽奖图标的监听器。
setNeedFillAwardInfo	设置观众中奖后是否需要填写中奖信息。

互动工具定制

方法	说明
setFloatInteractToolLayoutParams	设置整组互动工具图标的默认位置。
setFloatInteractToolMovable	设置是否允许观众拖拽移动整组互动工具图标。
setVotePeopleCountVisible	设置是否显示参与投票人数。

其他定制

方法	说明
setPortraitExitIconPosition	设置竖屏直播间退出图标的位置。
setLandScapeExitIconPosition	设置横屏直播间退出图标的位置。
setCommentLinkToWebView	设置点击超链接后跳转内容是否在当前直播页面展示。
setExitRoomIcon	设置退出横屏直播间的图标。
setPageBackGroundColor	设置直播间的背景颜色。
setTransitionPage	设置竖屏直播间的加载页面。
setPublicCommentNickName	设置直播间鉴权模式为公开时的用户昵称。
setCustomLoginListener	设置公开鉴权模式下登录自有账号系统的监听器。
setBookSuccessText	设置预约直播成功后的提示文案。
setBookFailText	设置预约直播失败后的提示文案。
setAudienceLinkNotification	设置连麦中页面切到后台时，弹出的前台通知样式。
setActivityBottomNavBarColor	设置在横竖屏直播间中，当显示系统底部导航栏时，系统底部导航栏的底色。
setShareListener	设置完整直播间的分享按钮点击事件监听器。
setPortraitRoomClearScreenEnable	设置是否开启竖屏直播间的清屏功能。
setShowRetryPageWhenJoinRoomFail	设置是否在完整直播间所在页面初始化失败时显示重试页。

回调

ITVULiveRoomServerListener

回调	说明
onGetRoomDataSuccess	该回调在 `TVULiveRoomServer.start` 方法执行完成、成功获取服务端数据时触发。
onGetRoomDataFailed	该回调在`TVULiveRoomServer.start` 方法执行完成、获取服务端数据失败时触发。
onFullScreenChange	播放器全屏、退出全屏图标点击回调。您可以在该回调中切换横竖屏播放、显示或隐藏状态栏等。
liveRoomStatusChange	直播状态变化回调。
playerStatusChange	播放状态变化回调。
onSpeedButtonDidTouch	播放器倍速按钮点击回调。
onReplayButtonDidTouch	播放器重放按钮点击回调。

LanguageListener

回调	说明
onSelectLanguage	多语言切换图标点击回调。观众点击多语言切换图标时，SDK 调用该回调通知您的 App 该点击事件。

SelectLanguageCallBack

回调	说明
onLanguageSelected	语言选中回调。您可以在您的 App 中自定义一个多语言选择对话框，并在观众选择语言后，调用该回调通知 SDK 切换语言。

LiveRoomStatusListener

回调	说明
onLiveRoomActivityCreate	直播间 Activity 创建回调。
onLandLiveRoomBindingAvailable	横屏直播间页面 `ViewBinding` 实例初始化完成回调。
onPortraitLiveRoomBindingAvailable	竖屏直播间页面 `ViewBinding` 实例初始化完成回调。
onLiveRoomActivityPause	直播间 Activity 切换到后台回调。
onLiveRoomActivityResume	直播间 Activity 切换到前台回调。
onActivityConfigurationChanged	直播间 Activity 配置变化回调。
onLiveRoomActivityDestroy	直播间 Activity 销毁回调。
onLiveRoomFullDestroyed	在完整直播间页面和悬浮窗均销毁时，SDK 触发该回调。

CustomLoginListener

回调	说明
onCustomLoginStart	公开鉴权模式下登录自有账号系统回调。观众以公开模式进入直播间后，在评论或点赞等需要登录的场景下，SDK 调用该回调通知您的 App 观众需进行登录。您可以通过自有账号体系实现观众的登录。

LoginStateCallBack

回调	说明
onLoginFinished	观众登录结果回调。观众登录您的自有账号体系后，调用该回调告知 SDK 观众的登录结果。

FloatingAwardView.Listener

回调	说明
onUpdateAwardIcon	抽奖状态变化回调。

SinglePlayerListener

回调	说明
liveRoomStatusChanged	直播状态变化回调。
playableStatusChanged	资源可播放状态回调。
playStatusChanged	播放状态变化回调。
sizeChanged	视频画面尺寸变化回调。
stallingStatusChanged	卡顿状态变化回调。
vodErrorOccurred	点播发生错误回调。
liveErrorOccurred	直播发生错误回调。
playErrorStatusChanged	视频播放发生错误回调。
vodPrepared	点播视频已准备完毕回调。
vodRenderStarted	点播视频画面渲染开始回调。
vodCurPlayTimeChanged	点播视频当前播放进度变化回调。
vodDurationChanged	点播视频总时长变化回调。
vodCompletion	视频播放完成回调。
livePrepared	直播已准备完毕回调。
liveFirstFrameRendered	直播渲染开始回调。
liveCompletion	直播结束回调。
coverImageVisibleChanged	封面可见状态回调。
resolutionInfoChanged	视频分辨率信息改变回调。
vodAutoSeekPreviousTime	点播视频自动断点续播回调。
onCurVodVidChanged	当前正在播放的点播视频 Vid 改变回调。
onCurReplayListChanged	当前直播间的回放改变回调。
onCurLiveLineIdChanged	当前直播线路 ID 改变回调。
onCurLiveLineListChanged	当前直播线路列表改变回调。

SeekCompletionListener

回调	说明
onCompletion	跳转完成回调。

RedirectPageListener

回调	说明
redirectPage	链接点击回调。

ITVUMultipleDrawableListener

回调	说明
onGetMultipleDrawable	自定义图标数组回调。

FloatViewActionListener

回调	说明
onClickFloatView	观众点击悬浮窗主体时，SDK 会触发该回调。
onClickFloatViewExitBtn	观众点击悬浮窗的关闭按钮时，SDK 会触发该回调。

LiveRoomActionListener

回调	说明
onClickExitLiveRoom	观众点击退出按钮或物理返回键退出完整直播间时，SDK 会触发该回调。

ShareListener

回调	说明
onShare	观众点击完整直播间的分享按钮时，SDK 会触发该回调并传入直播间的分享地址。

企业直播

概览

完整直播间接入

TVULiveRoom

独立播放器接入

TVUSinglePlayerView

完整播放器接入

TVULiveRoomServer

PlayerView

直播间 UI 定制

功能定制

播放器定制

菜单定制

评论区定制

注册对话框定制

图文定制

广告定制

播放器网络状态变化相关定制

主播账号定制

悬浮窗定制

多语言切换定制

商品卡片定制

商品浮窗定制

直播间内链接跳转定制

直播间状态定制

抽奖定制

互动工具定制

其他定制

ITVULiveRoomServerListener

LanguageListener

SelectLanguageCallBack

LiveRoomStatusListener

CustomLoginListener

LoginStateCallBack

FloatingAwardView.Listener

SinglePlayerListener

SeekCompletionListener

RedirectPageListener

ITVUMultipleDrawableListener

FloatViewActionListener

LiveRoomActionListener

ShareListener