提供定制化相关的各类方法。 :::tip SDK 的定制化优先级高于企业直播控制台和服务端 OpenAPI 的自定义配置，例如同时通过 SDK 的 `setThumbIcon` 方法和控制台自定义了直播间点赞图标，观看页会展示 `setThumbIcon` 方法自定义的图标。 ::: ## 播放器定制 ### setPlayerLayoutMode 设置横屏直播间内，视频画面的填充模式。 ```java public void setPlayerLayoutMode(int playerLayoutMode) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |playerLayoutMode |Integer |横屏直播间内，视频画面的填充模式。默认值：0 |\ | | | |\ | | |* 0：ImageAspectFit。保持视频原有宽高比例填充播放器，视频的宽度或高度会填满播放器的宽度或高度。如果视频宽高比与播放器宽高比不同，视频会缩放显示。 |\ | | |* 1：ImageToFill。视频内容完全填充播放器，但视频宽高比可能发生变化。 |\ | | |* 2：ImageAspectFill。保持视频原有宽高比例填充播放器，视频的宽高会填满播放器的宽高。如果视频宽高比与播放器宽高比不同，会有部分视频内容被裁剪掉。 | ### setPortraitPlayerLayoutMode 设置竖屏直播间内，视频画面的填充模式。 ```java public void setPortraitPlayerLayoutMode(int playerLayoutMode) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |playerLayoutMode |Integer |竖屏直播间内，视频画面的填充模式。默认值：2 |\ | | | |\ | | |* 0：ImageAspectFit。保持视频原有宽高比例填充播放器，视频的宽度或高度会填满播放器的宽度或高度。如果视频宽高比与播放器宽高比不同，视频会缩放显示。 |\ | | |* 1：ImageToFill。视频内容完全填充播放器，但视频宽高比可能发生变化。 |\ | | |* 2：ImageAspectFill。保持视频原有宽高比例填充播放器，视频的宽高会填满播放器的宽高。如果视频宽高比与播放器宽高比不同，会有部分视频内容被裁剪掉。 | ### setPeopleCountFontStyle 设置人气标签文字的字体。 ```java public void setPeopleCountFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |人气标签文字的字体。 | ### setPeopleCountFontSize 设置人气标签文字的字号。 ```Java public void setPeopleCountFontSize(int peopleCountFontSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |peopleCountFontSiz |Integer |人气标签文字的字号。单位：sp。 | ### setPeopleCountTextColor 设置人气标签文字的颜色。 ```Java public void setPeopleCountTextColor(int peopleCountTextColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |peopleCountTextColor |Integer |人气标签文字的颜色。 | ### setPeopleCountIconDrawable 设置人气图标。 ```java public void setPeopleCountIconDrawable(Drawable drawable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |drawable |Drawable |人气图标。 | ### setPlayerThemeColor 设置播放器的主题颜色，即倍速按钮、进度条和清晰度按钮的颜色。 ```java public void setPlayerThemeColor(int playerThemeColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |playerThemeColor |Integer |播放器的主题颜色，即倍速按钮、进度条和清晰度按钮的颜色。 | ### setRoomStatusTextTipFontSize 设置直播状态的字号。 ```java public void setRoomStatusTextTipFontSize(int roomStatusTextTipFontSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |roomStatusTextTipFontSize |Integer |直播状态的字号。单位：sp | ### setRoomStatusTextTipCenterOffset 设置直播状态文字距离播放器居中位置的纵向偏移量。 ```java public void setRoomStatusTextTipCenterOffset(int roomStatusTextTipCenterOffset) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |roomStatusTextTipCenterOffset |Integer |直播状态文字距离播放器居中位置的纵向偏移量。单位：dp | ### setRoomStatusTextTipRadius 设置直播状态文字背景的圆角。 ```java public void setRoomStatusTextTipRadius(int roomStatusTextTipRadius) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |roomStatusTextTipRadius |Integer |直播状态文字背景的圆角。单位：dp | ### setRoomStatusTextTipHorizontalPadding 设置直播状态文字的横向内边距。 ```java public void setRoomStatusTextTipHorizontalPadding(int roomStatusTextTipHorizontalPadding) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |roomStatusTextTipHorizontalPadding |Integer |直播状态文字的横向内边距。参数值非负数。单位：dp | ### setRoomStatusTextTipVerticalPadding 设置直播状态文字的纵向内边距。 ```java public void setRoomStatusTextTipVerticalPadding(int roomStatusTextTipVerticalPadding) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |roomStatusTextTipVerticalPadding |Integer |直播状态文字的纵向内边距。参数值非负数。单位：dp | ### setPlayerTimeColor 设置点播时间的颜色。 ```java public void setPlayerTimeColor(int playerTimeColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |playerTimeColor |Integer |点播时间的颜色。 | ### setFullScreenIcon 设置全屏图标。 ```java public void setFullScreenIcon(Drawable fullScreenIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |fullScreenIcon |Drawable |全屏图标。 | ### setSmallScreenIcon 设置退出全屏图标。 ```java public void setSmallScreenIcon(Drawable smallScreenIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |smallScreenIcon |Drawable |退出全屏图标。 | ### setLiveRefreshIcon 设置直播中状态下播放器左下角的刷新图标。 ```java public void setLiveRefreshIcon(Drawable liveRefreshIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |liveRefreshIcon |Drawable |直播中状态下播放器左下角的刷新图标。 | ### setPlayerStartIcon 设置播放器左下角的播放图标。 ```java public void setPlayerStartIcon(Drawable playerStartIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |playerStartIcon |Drawable |播放器左下角的播放图标。 | ### setPlayerPauseIcon 设置播放器左下角的暂停图标。 ```java public void setPlayerPauseIcon(Drawable playerPauseIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |playerPauseIcon |Drawable |播放器左下角的暂停图标。 | ### setPlayerPausedCenterIcon 设置播放器中央的暂停状态图标。 ```java public void setPlayerPausedCenterIcon(Drawable playerPausedCenterIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |playerPausedCenterIcon |Drawable |播放器中央的暂停状态图标。 | ### setCustomLiveName 设置直播标题。 ```java public void setCustomLiveName(String customLiveName) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |customLiveName |String |直播标题。设置后以传入的标题为准，空字符串则隐藏标题。 | ### setSpeedSettingDialogAutoClose 设置在倍速选择对话框中选中倍速后，是否自动关闭倍速选择对话框。 ```java public void setSpeedSettingDialogAutoClose(boolean speedSettingDialogAutoClose) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |speedSettingDialogAutoClose |Boolean |在倍速选择对话框中选中倍速后，是否自动关闭倍速选择对话框。默认为 `false`。 |\ | | | |\ | | |* `true`：自动关闭 |\ | | |* `false`：不自动关闭 | ### setResolutionSettingDialogAutoClose 设置在**清晰度选择**对话框中选中清晰度后，是否自动关闭**清晰度选择**对话框。 ```java public void setResolutionSettingDialogAutoClose(boolean resolutionSettingDialogAutoClose) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |resolutionSettingDialogAutoClose |Boolean |在**清晰度选择**对话框中选中清晰度后，是否自动关闭**清晰度选择**对话框。默认为 `false`。 |\ | | | |\ | | |* `true`：自动关闭 |\ | | |* `false`：不自动关闭 | ### setSimpleControlBar 设置是否开启横屏直播间的简版控制栏，即无倍速和清晰度选择按钮。 ```java public void setSimpleControlBar(boolean mSimpleControlBar) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mSimpleControlBar |Boolean |是否开启横屏直播间的简版控制栏，即无倍速和清晰度选择按钮。 |\ | | | |\ | | |* `true`：开启简版控制栏 |\ | | |* `false`：不开启简版控制栏 | ### setReplayTipText 设置回放的重新播放按钮文案。 ```java public void setReplayTipText(String mReplayTipText) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mReplayTipText |String |回放的重新播放按钮文案。 | ### setLiveAutoPlay 设置是否自动播放直播。 ```java public void setLiveAutoPlay(boolean mLiveAutoPlay) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mLiveAutoPlay |Boolean |是否自动播放直播。 |\ | | | |\ | | |* `true`：自动播放 |\ | | |* `false`：不自动播放 | ### setPlayBackAutoPlay 设置横屏直播间内，是否自动播放回放。 ```java public void setPlayBackAutoPlay(boolean mPlayBackAutoPlay) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPlayBackAutoPlay |Boolean |横屏直播间内，是否自动播放回放。 |\ | | | |\ | | |* `true`：自动播放 |\ | | |* `false`：不自动播放 | ### setPortraitPlayBackAutoPlay 设置竖屏直播间内，是否自动播放回放。 ```java public void setPortraitPlayBackAutoPlay(boolean mPortraitPlayBackAutoPlay) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPortraitPlayBackAutoPlay |Boolean |竖屏直播间内，是否自动播放回放。 |\ | | | |\ | | |* `true`：自动播放 |\ | | |* `false`：不自动播放 | ### setForceShowAutoPlay 设置横屏直播间内，是否自动播放预告。 ```java public void setForceShowAutoPlay(boolean mForceShowAutoPlay) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mForceShowAutoPlay |Boolean |横屏直播间内，是否自动播放预告。 |\ | | | |\ | | |* `true`：自动播放 |\ | | |* `false`：不自动播放 | ### setPortraitForceShowAutoPlay 设置竖屏直播间内，是否自动播放预告。 ```java public void setPortraitForceShowAutoPlay(boolean mPortraitForceShowAutoPlay) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPortraitForceShowAutoPlay |Boolean |竖屏直播间内，是否自动播放预告。 |\ | | | |\ | | |* `true`：自动播放 |\ | | |* `false`：不自动播放 | ### setPlayBackLoop 设置横屏直播间内，是否自动重播回放。 ```java public void setPlayBackLoop(boolean mIsPlayBackLoop) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mIsPlayBackLoop |Boolean |横屏直播间内，是否自动重播回放。 |\ | | | |\ | | |* `true`：自动重播 |\ | | |* `false`：不自动重播 | ### setPortraitPlayBackLoop 设置竖屏直播间内，是否自动重播回放。 ```java public void setPortraitPlayBackLoop(boolean mIsPortraitPlayBackLoop) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mIsPortraitPlayBackLoop |Boolean |竖屏直播间内，是否自动重播回放。 |\ | | | |\ | | |* `true`：自动重播 |\ | | |* `false`：不自动重播 | ### setForceShowLoop 设置横屏直播间内，是否自动重播预告。 ```java public void setForceShowLoop(boolean mIsForceShowLoop) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mIsForceShowLoop |Boolean |横屏直播间内，是否自动重播预告。 |\ | | | |\ | | |* `true`：自动重播 |\ | | |* `false`：不自动重播 | ### setPortraitForceShowLoop 设置竖屏直播间内，是否自动重播预告。 ```java public void setPortraitForceShowLoop(boolean mIsPortraitForceShowLoop) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mIsPortraitForceShowLoop |Boolean |竖屏直播间内，是否自动重播预告。 |\ | | | |\ | | |* `true`：自动重播 |\ | | |* `false`：不自动重播 | ### setVodAutoContinuePlayback 设置是否开启点播视频的自动断点续播。开启后，如果观众退出直播间再进入，点播视频会自动从上次播放结束位置开始继续播放。 ```java public void setVodAutoContinuePlayback(boolean isVodAutoContinuePlayback) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |isVodAutoContinuePlayback |Boolean |是否开启点播视频的自动断点续播。默认值为 `true`。 |\ | | | |\ | | |* `true`：开启自动断点续播 |\ | | |* `false`：不开启自动断点续播 | ### setVodAutoSeekTipTextVisible 设置直播间内是否显示点播视频自动断点续播后的提示。 ```java public void setVodAutoSeekTipTextVisible(boolean mVodAutoSeekTipTextVisible) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mVodAutoSeekTipTextVisible |Boolean |是否显示点播视频自动断点续播后的提示。默认值为 `true`。 |\ | | | |\ | | |* `true`：显示提示 |\ | | |* `false`：不显示提示 | ### setVodAutoSeekTipTextSize 设置直播间内点播视频自动断点续播提示的文字大小。 ```java public void setVodAutoSeekTipTextSize(float mVodAutoSeekTipTextSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mVodAutoSeekTipTextSize |float |点播视频自动断点续播提示的文字大小。默认值为 `11`。单位：sp | ### setEnterFullScreenEnable 设置是否支持进入全屏模式。 ```Java public void setEnterFullScreenEnable(boolean enterFullScreenEnable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |enterFullScreenEnable |Boolean |是否支持进入全屏模式。默认值为 `true`。 |\ | | | |\ | | |* `true`：支持，播放器内显示全屏按钮。全屏按钮可在竖屏直播间的直播或点播源流画面宽大于高时以及横屏直播间内显示。 |\ | | |* `false`：不支持，播放器内不显示全屏按钮。 | ### setNeedAutoDemote 设置直播期间遇到卡顿时，是否支持自动降级或提供提示信息。 ```Java public void setNeedAutoDemote(boolean needAutoDemote) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |needAutoDemote |Boolean |直播期间遇到卡顿时，是否支持自动降级或提供提示信息。默认值为 `true`。 |\ | | | |\ | | |* `true`： |\ | | | * 当 [setBackupDowngradeWhenStall](https://www.volcengine.com/docs/3019/125705#setbackupdowngradewhenstall) 的参数取值为 `true` 时，直接切换主备流。 |\ | | | * 当 [setBackupDowngradeWhenStall](https://www.volcengine.com/docs/3019/125705#setbackupdowngradewhenstall) 的参数取值为 `false` 时，智能档位下，自动降级到较低的清晰度，如果降到最低清晰度依然卡顿，则切换主备流。非智能档位下，提示观众是否切换到较低的清晰度，观众可按需自行选择是否切换，如果观众切换到最低清晰度依然卡顿，则切换主备流。 |\ | | |* `false`：智能档位下，不自动降级。非智能档位下，不提示观众切换到较低的清晰度。 | ### setBackupDowngradeWhenStall 设置直播期间遇到卡顿时，是否直接切换主备流。 ```Java public void setBackupDowngradeWhenStall(boolean backupDowngradeWhenStall) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |backupDowngradeWhenStall |boolean |直播期间遇到卡顿时，是否直接切换主备流。默认值为 `false`。该方法仅在 [setNeedAutoDemote](https://www.volcengine.com/docs/3019/125705#setneedautodemote) 的参数取值为 `true` 时生效。 |\ | | | |\ | | |* `true`：直接切换主备流。 |\ | | |* `false`：智能档位下，自动降级到较低的清晰度，如果降到最低清晰度依然卡顿，则切换主备流。非智能档位下，提示观众是否切换到较低的清晰度，观众可按需自行选择是否切换，如果观众切换到最低清晰度依然卡顿，则切换主备流。 | ## 菜单定制 ### setMenuTabBackgroundDrawable 设置横屏直播间内，菜单栏的背景。 ```java public void setMenuTabBackgroundDrawable(Drawable drawable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |drawable |Drawable |横屏直播间内，菜单栏的背景。 | ### setMenuFontColor 设置横屏直播间内，菜单栏被选中或未被选中时的文字颜色。 ```java public void setMenuFontColor(new Pair<>(unSelectedColor,selectedColor)) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |unSelectedColor |Integer |横屏直播间内，菜单栏未被选中时的文字颜色。 | | | | | \ |selectedColor |Integer |横屏直播间内，菜单栏被选中时的文字颜色。 | ### setMenuFontStyle 设置菜单栏的字体。 ```java public void setMenuFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |菜单栏的字体。 | ### setLandMenuFlowingTagColor 设置横屏直播间中，菜单栏被选中的下标颜色。 ```java public void setLandMenuFlowingTagColor(int landMenuFlowingTagColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |landMenuFlowingTagColor |Integer |横屏直播间中，菜单栏被选中的下标颜色。默认值为 `0xFF3370FF`。 | ### setMenuDialogFlowingTagColor 设置竖屏直播间中，内嵌链接和图文介绍菜单栏被选中的下标颜色。 ```Java public void setMenuDialogFlowingTagColor(int menuDialogFlowingTagColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |menuDialogFlowingTagColor |Integer |竖屏直播间中，内嵌链接和图文介绍菜单栏被选中的下标颜色。默认值为 `0xFF161823`。 | ### setImageEmbeddedWebUrlsIcon 设置竖屏直播间内嵌链接菜单的图标。 ```Java public void setImageEmbeddedWebUrlsIcon(Drawable imageEmbeddedWebUrlsIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |imageEmbeddedWebUrlsIcon |Drawable |竖屏直播间内嵌链接菜单的图标。 | ### setMenuDialogTabFontSize 设置内嵌链接和图文介绍菜单栏标题的字号。 ```Java public void setMenuDialogTabFontSize(int menuDialogTabFontSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |menuDialogTabFontSize |Integer |内嵌链接和图文介绍菜单栏标题的字号。单位：sp | ### setMenuDialogTabSelectedFontColor 设置内嵌链接和图文介绍菜单栏被选中后的标题文字颜色。 ```java public void setMenuDialogTabSelectedFontColor(int menuDialogTabSelectedFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |menuDialogTabSelectedFontColor |Integer |内嵌链接和图文介绍菜单栏被选中后的标题文字颜色。默认值为 `0xFF161823`。 | ### setMenuDialogTabUnSelectedFontColor 设置内嵌链接和图文介绍菜单栏未被选中时的标题文字颜色。 ```java public void setMenuDialogTabUnSelectedFontColor(int menuDialogTabUnSelectedFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |menuDialogTabUnSelectedFontColor |Integer |内嵌链接和图文介绍菜单栏未被选中时的标题文字颜色。默认值为 `0xFF161823`。 | ## 评论区定制 ### setNoCommentIconDrawable 设置评论区无评论时的占位图标。 ```java public void setNoCommentIconDrawable(Drawable drawable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |drawable |Drawable |评论区无评论时的占位图标。 | ### setCommentNicknameFontStyle 设置非主持人昵称的字体。 ```java public void setCommentNicknameFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |非主持人昵称的字体。 | ### setCommentNicknameFontColor 设置非主持人昵称的颜色。 ```java public void setCommentNicknameFontColor(int commentNicknameFontColor) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |commentNicknameFontColor |Integer |非主持人昵称的颜色。 | ### setCommentNicknameFontSize 设置非主持人昵称的字号。 ```Java public void setCommentNicknameFontSize(int commentNicknameFontSize) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |commentNicknameFontSize |Integer |非主持人昵称的字号。单位：sp。 | ### setCommentContentFontColor 设置非主持人评论的文字颜色。 ```java public void setCommentContentFontColor(int commentContentFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |commentContentFontColor |Integer |非主持人评论的文字颜色。 | ### setCommentLinkColor 设置评论链接的颜色。 ```java public void setCommentLinkColor(int mCommentLinkColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mCommentLinkColor |Integer |评论链接的颜色。 | ### setAudienceCommentLinkClickable 设置非主持人评论的链接是否可以点击。 ```java public void setAudienceCommentLinkClickable(boolean mAudienceCommentLinkClickable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mAudienceCommentLinkClickable |Boolean |非主持人评论的链接是否可以点击。有关评论链接点击的自定义行为，详见 [setRedirectPageListener](/docs/3019/125705#setredirectpagelistener)。 |\ | | | |\ | | |* `true`：可以点击 |\ | | |* `false`：不可以点击 | ### setCommentContentFontStyle 设置非主持人评论的字体。 ```java public void setCommentContentFontStyle(Typeface typeface) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |typeface |Typeface |非主持人评论的字体。 | ### setCommentContentFontSize 设置非主持人评论的字号。 ```Java public void setCommentContentFontSize(int commentContentFontSize) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |commentContentFontSize |Integer |非主持人评论的字号。单位：sp。 | ### setHostTagFontStyle 设置主持人标签的字体。 ```java public void setHostTagFontStyle(Typeface typeface) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |typeface |Typeface |主持人标签的字体。 | ### setHostTagFontSize 设置主持人标签的字号。 ```Java public void setHostTagFontSize(int hostTagFontSize) ``` 参数 | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |hostTagFontSize |Integer |主持人标签的字号。单位：sp。 | ### setTopCommentTagFontStyle 设置置顶标签的字体。 ```java public void setTopCommentTagFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |置顶标签的字体。 | :::warning 该方法自 1.51.0 版本开始不再支持使用。 ::: ### setTopCommentFontStyle 设置置顶内容的字体。 ```java public void setTopCommentFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |置顶内容的字体。 | ### setTopCommentFontColor 设置置顶内容的文字颜色。 ```java public void setTopCommentFontColor(int topCommentFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |topCommentFontColor |Integer |置顶内容的文字颜色。 | ### setTopCommentRowCount 设置置顶评论最大显示行数。 ```java public void setTopCommentRowCount(int count) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |count |Integer |置顶评论最大显示行数。默认值为 `1`。 | ### setTopCommentDialogTitleAtStart 设置置顶内容详情的对话框标题是否在最左侧。 ```java public void setTopCommentDialogTitleAtStart(boolean mTopCommentDialogAtStart) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mTopCommentDialogAtStart |Boolean |置顶内容详情的对话框标题是否在最左侧。 |\ | | | |\ | | |* `true`：在最左侧 |\ | | |* `false`：不在最左侧 | ### setPortraitCommentAreaHeight 设置竖屏直播间内评论区的高度。 ```java public void setPortraitCommentAreaHeight(int mPortraitCommentAreaHeight) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPortraitCommentAreaHeight |Integer |竖屏直播间内评论区的高度。参数值非负数。默认值为 `194`。单位：dp。 | ### setPortraitCommentLineCount 设置竖屏直播间内单条评论的最大显示行数。 ```java public void setPortraitCommentLineCount(int mPortraitCommentLineCount) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPortraitCommentLineCount |Integer |竖屏直播间内单条评论的最大显示行数。 | ### setCommentThumbedIcon 设置评论已点赞状态的点赞图标。 ```java public void setCommentThumbedIcon(Drawable commentThumbedIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |commentThumbedIcon |Drawable |评论已点赞状态的点赞图标。 | :::warning 该方法自 1.38.0 版本开始不再支持使用，您可以使用 [setCommentLikedIcon ](/docs/3019/125705#6893cf3a)方法替代之。 ::: ### setCommentNotThumbedIcon 设置评论未点赞状态的点赞图标。 ```java public void setCommentNotThumbedIcon(Drawable commentNotThumbedIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |commentNotThumbedIcon |Drawable |评论未点赞状态的点赞图标。 | :::warning 该方法自 1.38.0 版本开始不再支持使用，您可以使用 [setCommentLikeIcon ](/docs/3019/125705#4f7598a0)方法替代之。 ::: ### setCommentEditViewHintTextColor 设置评论输入框的提示文字颜色。 ```java public void setCommentEditViewHintTextColor(int color) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |color |Integer |评论输入框的提示文字颜色。默认值： `0xB3FFFFFF` | ### setCommentEditViewTextColor 设置评论输入框内输入的文字颜色。 ```java public void setCommentEditViewTextColor(int mCommentEditViewTextColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mCommentEditViewTextColor |Integer |评论输入框内输入的文字颜色。默认值：`0xFF000000` | ### setCommentIntervalTip 设置发言间隔的提示内容。 ```java public void setCommentIntervalTip(String tip) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |tip |String |发言间隔的提示内容。 | ### setCommentIntervalFontStyle 设置发言间隔的提示内容字体。 ```java public void setCommentIntervalFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |发言间隔的提示内容字体。 | ### setCommentItemBgColor 设置聊天欢迎语、进场消息以及非主持人的评论底色。 ```java public void setCommentItemBgColor(int commentItemBgColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |commentItemBgColor |Integer |聊天欢迎语、进场消息以及非主持人的评论底色。默认值为 `#33000000`。 | ### setPullCommentCount 设置每次能拉取的评论条数。 ```java public void setPullCommentCount(int count) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |count |Integer |每次能拉取的评论条数。 | ### setPullHistoryCommentTotalCount 设置可以拉取的历史评论总数。 ```java public void setPullHistoryCommentTotalCount(int count) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |count |Integer |可以拉取的历史评论总数。 | ### setThumbIcon 设置直播间点赞图标。 ```java public void setThumbIcon(Drawable drawable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |drawable |Drawable |直播间点赞图标。 | ### setJoinRoomMsgNicknameColor 设置直播间进场消息中昵称的文字颜色。 ```java public void setJoinRoomMsgNicknameColor(int mJoinRoomMsgNicknameColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mJoinRoomMsgNicknameColor |Integer |直播间进场消息中昵称的文字颜色。 | ### setJoinRoomMsgContentColor 设置直播间进场消息中内容的文字颜色。 ```java public void setJoinRoomMsgContentColor(int mJoinRoomMsgContentColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mJoinRoomMsgContentColor |Integer |直播间进场消息中内容的文字颜色。 | ### setWelcomeMsgFontColor 设置直播间聊天欢迎语的文字颜色。 ```java public void setWelcomeMsgFontColor(int mWelcomeMsgFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mWelcomeMsgFontColor |Integer |直播间聊天欢迎语的文字颜色。 | :::warning 该方法自 1.53.0 版本开始不再支持使用，替代方法为 [setSystemCommentColor](/docs/3019/125705#560feb35)。 ::: ### setLandscapeCommentShouldShowAvatar 设置横屏直播间的评论区内是否展示用户头像。您可以调用 [setHostDefaultAvatar](/docs/3019/125705#sethostdefaultavatar) 和 [setCommentDefaultAvatar](/docs/3019/125705#setcommentdefaultavatar) 分别设置主持人和非主持人的默认头像，也可以在自定义模式下（`roomAuthMode` 为 `CUSTOM`）通过 [GetSDKTokenAPI](/docs/3019/105049) 接口传入指定用户的头像图片 URL。 ```java public void setLandscapeCommentShouldShowAvatar(boolean landscapeCommentShouldShowAvatar) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |landscapeCommentShouldShowAvatar |Boolean |横屏直播间的评论区内是否展示用户头像。默认值为 `true`。 |\ | | | |\ | | |* `true`：展示用户评论的头像 |\ | | |* `false`：不展示用户评论的头像 | ### setPortraitCommentShouldShowAvatar 设置竖屏直播间的评论区内是否展示用户头像。您可以调用 [setHostDefaultAvatar](/docs/3019/125705#sethostdefaultavatar) 和 [setCommentDefaultAvatar](/docs/3019/125705#setcommentdefaultavatar) 分别设置主持人和非主持人的默认头像，也可以在自定义模式下（`roomAuthMode` 为 `CUSTOM`）通过 [GetSDKTokenAPI](/docs/3019/105049) 接口传入指定用户的头像图片 URL。 ```java public void setPortraitCommentShouldShowAvatar(boolean portraitCommentShouldShowAvatar) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |portraitCommentShouldShowAvatar |Boolean |竖屏直播间的评论区内是否展示用户头像。默认值为 `false`。 |\ | | | |\ | | |* `true`：展示用户评论的头像 |\ | | |* `false`：不展示用户评论的头像 | ### setHostDefaultAvatar 设置评论区主持人的默认头像。 ```java public void setHostDefaultAvatar(Drawable hostDefaultAvatar) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |hostDefaultAvatar |Drawable |评论区主持人的默认头像。 | ### setCommentDefaultAvatar 设置评论区非主持人的默认头像。设置后，所有非主持人的评论前均显示该头像。 ```java public void setCommentDefaultAvatar(Drawable commentDefaultAvatar) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |commentDefaultAvatar |Drawable |评论区非主持人的默认头像。 | ### setThumbFloatingDrawableListener 设置点赞直播间后漂浮动画图标的监听器。相关回调，详见 [ITVUMultipleDrawableListener](/docs/3019/125700#itvumultipledrawablelistener)。 ```java public void setThumbFloatingDrawableListener(ITVUMultipleDrawableListener listener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |listener |ITVUMultipleDrawableListener |点赞直播间后漂浮动画图标的监听器。 | ### setHostCommentColor 设置主持人的评论文字颜色。 ```Java public void setHostCommentColor(int hostCommentColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |hostCommentColor |Integer |主持人的评论文字颜色。 | ### setHostCommentBackgroundColor 设置主持人的评论底色。 ```Java public void setHostCommentBackgroundColor(int hostCommentBackgroundColor) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |hostCommentBackgroundColor |Integer |主持人的评论底色。 | ### setHostTagFontColor 设置主持人标签的颜色。 ```Java public void setHostTagFontColor(int hostTagFontColor) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |hostTagFontColor |Integer |主持人标签的颜色。 | ### setHostCommentFontSize 设置主持人评论的字号。 ```Java public void setHostCommentFontSize(int mHostCommentFontSize) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |mHostCommentFontSize |Integer |主持人评论的字号。单位：sp。 | ### setHostCommentFontStyle 设置主持人评论的字体。 ```Java public void setHostCommentFontStyle(Typeface hostCommentFontStyle) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |hostCommentFontStyle |Typeface |主持人评论的字体。 | ### setSystemCommentTagFontStyle 设置聊天欢迎语和竖屏模式下直播描述的标签字体。 ```Java public void setSystemCommentTagFontStyle(Typeface systemCommentTagFontStyle) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |systemCommentTagFontStyle |Typeface |聊天欢迎语和竖屏模式下直播描述的标签字体。 | ### setSystemCommentTagFontSize 设置聊天欢迎语和竖屏模式下直播描述的标签字号。 ```Java public void setSystemCommentTagFontSize(int systemCommentTagFontSize ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |systemCommentTagFontSize |Integer |聊天欢迎语和竖屏模式下直播描述的标签字号。单位：sp。 | ### setSystemCommentTagFontColor 设置聊天欢迎语和竖屏模式下直播描述的标签颜色。 ```Java public void setSystemCommentTagFontColor(int systemCommentTagFontColor) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |systemCommentTagFontColor |Integer |聊天欢迎语和竖屏模式下直播描述的标签颜色。 | ### setSystemCommentFontStyle 设置聊天欢迎语和竖屏模式下直播描述的正文字体。 ```Java public void setSystemCommentFontStyle(Typeface systemCommentFontStyle) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |systemCommentFontStyle |Typeface |聊天欢迎语和竖屏模式下直播描述的正文字体。 | ### setSystemCommentFontSize 设置聊天欢迎语和竖屏模式下直播描述的正文字号。 ```Java public void setSystemCommentFontSize(int systemCommentFontSize) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |systemCommentFontSize |Integer |聊天欢迎语和竖屏模式下直播描述的正文字号。单位：sp。 | ### setSystemCommentColor 设置聊天欢迎语和竖屏模式下直播描述的正文颜色。 ```Java public void setSystemCommentColor(int systemCommentColor) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |systemCommentColor |Integer |聊天欢迎语和竖屏模式下直播描述的正文颜色。 | ### setCommentItemSpacing 设置相邻评论之间的间距。 ```Java public void setCommentItemSpacing(int mDistanceBetweenCommentItem ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |mDistanceBetweenCommentItem |Integer |相邻评论之间的间距。默认值：`6`。单位：dp。 | ### setRoomCommentListViewBottomMargin 设置评论列表底部与评论输入框顶部的间距。 ```Java public void setRoomCommentListViewBottomMargin(int roomCommentListViewBottomMargin) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |roomCommentListViewBottomMargin |Integer |评论列表底部与评论输入框顶部的间距。默认值：`0`。单位：dp。 | ### setCommentListPullToRefreshColor 设置下拉刷新组件内容的颜色，例如 `↓ 下拉加载更多评论`。 ```Java public void setCommentListPullToRefreshColor(int mCommentListPullToRefreshColor) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |mCommentListPullToRefreshColor |Integer |下拉刷新组件内容的颜色，例如 `↓ 下拉加载更多评论`。 | ### setCommentLikedIcon 设置评论已点赞状态的点赞按钮图标。 ```Java public void setCommentLikedIcon(BDThemeIconModel commentLikedIcon) { mCommentLikedIcon = commentLikedIcon; } ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |commentLikedIcon |BDThemeIconModel |按钮信息。详见 [BDThemeIconModel](/docs/3019/125701#405f0459)。 | ### setCommentLikeIcon 设置评论未点赞状态的点赞按钮图标。 ```Java public void setCommentLikeIcon(BDThemeIconModel commentLikeIcon) { mCommentLikeIcon = commentLikeIcon; } ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |commentLikeIcon |BDThemeIconModel |按钮信息。详见 [BDThemeIconModel](/docs/3019/125701#405f0459)。 | ### setCommentInputCountLimit 设置聊天互动菜单下评论输入框内的最大字符数限制。 ```Java public void setCommentInputCountLimit(int commentInputCountLimit) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |commentInputCountLimit |Integer |聊天互动菜单下评论输入框内的最大字符数限制。默认值为 `200`。 | ### setPrivateChatInputCountLimit 设置私聊互动菜单下评论输入框内的最大字符数限制。 ```Java public void setPrivateChatInputCountLimit(int privateChatInputCountLimit) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |privateChatInputCountLimit |Integer |私聊互动菜单下评论输入框内的最大字符数限制。默认值为 `200`。 | ### setCommentCustomListener 设置直播间评论自定义监听器。 ```Java public void setCommentCustomizeListener(CommentCustomizeListener commentCustomizeListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |commentCustomizeListener |CommentCustomizeListener |直播间评论自定义监听器。详见 [CommentCustomizeListener](/docs/3019/125700#aa60119c)。 | **示例代码** 以下示例代码将文字评论中的 `123` 变为黄色，将微笑表情替换为其他图片。 ```Java settings.setCommentCustomizeListener((commentModel, commentConfigModel, uiConfigModel, languageManager, spannableStringBuilder, textView) -> { boolean presenter = commentModel.isPresenter(); // 判断评论是否为主持人发送 boolean lightTheme = uiConfigModel.isLightTheme(); // 判断当前是否为非暗黑模式 LanguageManager.LANGUAGE currentLanguage = languageManager.getCurrentLanguage();// 获取直播间当前选中的语言 String s = spannableStringBuilder.toString(); // 将文字评论中的 123 变为黄色 if (s.contains("123")) { spannableStringBuilder.setSpan(new ForegroundColorSpan(Color.YELLOW), s.indexOf("123"), s.indexOf("123") + 3, Spannable.SPAN_INCLUSIVE_EXCLUSIVE); } // 将微笑表情替换为其他图片 if (s.contains("[微笑]")) { spannableStringBuilder.setSpan(new GlideImageSpan(textView, "https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/055f8e4f26c04fd39aa3a3935a43866e~tplv-goo7wpa0wc-image.image"), s.indexOf("[微笑]"), s.indexOf("[微笑]") + "[微笑]".length(), Spannable.SPAN_INCLUSIVE_EXCLUSIVE); } // 重新设置 textView，使改动生效 textView.setText(spannableStringBuilder); }); ``` ## 注册对话框定制 ### setNicknameDialogHeadFontStyle 设置标题的字体。 ```java public void setNicknameDialogHeadFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |标题的字体。 | ### setNicknameDialogEditTextFontStyle 设置输入框内的文字字体。 ```java public void setNicknameDialogEditTextFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |输入框内的文字字体。 | ### setNicknameDialogHintText 设置输入框内的占位符。 ```java public void setNicknameDialogHintText(String tip) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |tip |String |输入框内的占位符。 | ### setNicknameDialogButtonColor 设置**确定**按钮的背景颜色。 ```java public void setNicknameDialogButtonColor(int color) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |color |Integer |**确定**按钮的背景颜色。 | ### setNicknameDialogButtonTextFontStyle 设置**确定**按钮的字体。 ```java public void setNicknameDialogButtonTextFontStyle(Typeface typeface) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |typeface |Typeface |**确定**按钮的字体。 | ### setNicknameDialogCloseButtonIconDrawable 设置关闭图标。 ```java public void setNicknameDialogCloseButtonIconDrawable(Drawable drawable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |drawable |Drawable |关闭图标。 | ## 图文定制 ### setRichTextPadding 设置图文区域上下左右的外边距。 ```java public void setRichTextPadding(int padding) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |padding |Integer |图文区域上下左右的外边距。参数值非负数。单位：dp | ### setImageTextContentColor 设置图文内容的文字颜色。 ```java public void setImageTextContentColor(int mImageTextContentColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mImageTextContentColor |Integer |图文内容的文字颜色。 |\ | | |取值为 `0` 或为空，则使用服务端返回的文字颜色。 | ## 广告定制 ### setPageCenterAdRatio 设置页中广告的宽高比。 ```java public void setPageCenterAdRatio(float pageCenterAdRatio) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |pageCenterAdRatio |float |页中广告的宽高比。 | ### setCenterAdStrokeColor 设置页中广告的边框颜色。 ```java public void setCenterAdStrokeColor(int centerAdStrokeColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |centerAdStrokeColor |Integer |页中广告的边框颜色。 | ### setCenterAdRadius 设置页中广告的圆角。 ```java public void setCenterAdRadius(int centerAdRadius) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |centerAdRadius |Integer |页中广告的圆角。 | ### setCenterAdRotationInterval 设置页中广告的轮播速度。 ```java public void setCenterAdRotationInterval(int centerAdRotationInterval) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |centerAdRotationInterval |Integer |页中广告的轮播速度，即每隔多少时间向右滚动一次。单位：ms | ### setFloatAdLayoutParams 设置浮标广告的默认位置。 ```Java public void setFloatAdLayoutParams(SimpleLayoutParams floatAdLayoutParams) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatAdLayoutParams |SimpleLayoutParams |浮标广告的默认位置。具体配置，详见 [SimpleLayoutParams](/docs/3019/125701#d0799e15)。 | ### setFloatAdSize 设置浮标广告的大小。 ```Java public void setFloatAdSize(CustomSize floatAdSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatAdSize |CustomSize |浮标广告的大小。具体配置，详见 [CustomSize](/docs/3019/125701#74cc9196)。 | ### setFloatAdMovable 设置浮标广告是否支持拖动。 ```Java public void setFloatAdMovable(boolean FloatAdMovable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |FloatAdMovable |Boolean |浮标广告是否支持拖动。默认值为 `false`。 |\ | | | |\ | | |* `true`：支持拖动。 |\ | | |* `false`：不支持拖动。 | ### setFloatAdShowBounds 设置浮标广告是否显示白色边框和背景。 ```Java public void setFloatAdShowBounds(boolean floatAdShowBounds) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatAdShowBounds |Boolean |浮标广告是否显示白色边框和背景。默认值为 `true`。 |\ | | | |\ | | |* `true`：显示。 |\ | | |* `false`：不显示。 | ### setFloatAdMarginBottom 设置浮标广告的底部边距。 ```java public void setFloatAdMarginBottom(int mFloatAdMarginBottom) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatAdMarginBottom |Integer |浮标广告的底部边距。参数值非负数。单位：dp | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatAdLayoutParams](/docs/3019/125705#8c894f61) 方法替代之。 ::: ### setFloatAdMarginRight 设置浮标广告的右边距。 ```java public void setFloatAdMarginRight(int mFloatAdMarginRight) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatAdMarginRight |Integer |浮标广告的右边距。参数值非负数。单位：dp | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatAdLayoutParams](/docs/3019/125705#8c894f61) 方法替代之。 ::: ### setFloatAdWidth 设置浮标广告的宽度。 ```java public void setFloatAdWidth(int mFloatAdWidth) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatAdWidth |Integer |浮标广告的宽度。参数值非负数。单位：dp | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatAdSize](/docs/3019/125705#2e13fd4b) 方法替代之。 ::: ### setFloatAdHeight 设置浮标广告的高度。 ```java public void setFloatAdHeight(int mFloatAdHeight) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatAdHeight |Integer |浮标广告的高度。参数值非负数。单位：dp | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatAdSize](/docs/3019/125705#2e13fd4b) 方法替代之。 ::: ### setShowPageHeaderImage 设置是否显示页头图。 ```Java public void setShowPageHeaderImage(boolean show) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |show |Boolean |是否显示页头图。默认值为 `true`。 |\ | | | |\ | | |* `true`：显示页头图。 |\ | | |* `false`：不显示页头图。 | ### setShowPageCenterAd 设置是否显示页中广告。 ```Java public void setShowPageCenterAd(boolean show) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |show |Boolean |是否显示页中广告。默认值为 `true`。 |\ | | | |\ | | |* `true`：显示页中广告。 |\ | | |* `false`：不显示页中广告。 | ## 播放器网络状态变化相关定制 ### setShowNonWiFiToast 设置在直播间内使用手机流量时是否开启提示。 ```java public void setShowNonWiFiToast(boolean mShowNonWiFiToast) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mShowNonWiFiToast |Boolean |在直播间内使用手机流量时是否开启提示。默认值为 `true`。 |\ | | | |\ | | |* `true`：开启提示 |\ | | |* `false`：不开启提示 | ### setLandNonWifiToastCount 设置在横屏直播间内使用手机流量时，弹出提示文案的次数。 ```java public void setLandNonWifiToastCount(int mNonWifiToastCount) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mNonWifiToastCount |Integer |在横屏直播间内使用手机流量时，弹出提示文案的次数。默认为 1 次。 |\ | | | |\ | | |* -1：每次均提示 |\ | | |* 0：不提示 |\ | | |* ≥ 1：1 次或以上 | ### setRetryBtnBackgroundColor 设置横屏直播间内，**重试**按钮的背景颜色。 ```java public void setRetryBtnBackgroundColor(int btnBackGround) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |btnBackGround |Integer |横屏直播间内，**重试**按钮的背景颜色。 | ### setPorRetryBtnBackgroundColor 设置竖屏直播间内，**重试**按钮的背景颜色。 ```java public void setPorRetryBtnBackgroundColor(int btnBackGround) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |btnBackGround |Integer |竖屏直播间内，**重试**按钮的背景颜色。 | ### setLandscapeRetryBtnCornerRadius 设置横屏直播间内，**重试**按钮的圆角。 ```java public void setLandscapeRetryBtnCornerRadius(float btnCorner) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |btnCorner |Float |横屏直播间内，**重试**按钮的圆角。 | ### setPortraitRetryBtnCornerRadius 设置竖屏直播间内，**重试**按钮的圆角。 ```java public void setPortraitRetryBtnCornerRadius(float btnCorner) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |btnCorner |Float |竖屏直播间内，**重试**按钮的圆角。 | ### setNetErrorBtn 设置网络异常的按钮文案。 ```java public void setNetErrorBtn(String mNetErrorBut) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mNetErrorBut |String |网络异常的按钮文案。 | ### setNonWIFIBtn 设置非 WiFi 状态的按钮文案。 ```java public void setNonWIFIBtn(String mNonWIFIBut) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mNonWIFIBut |String |非 WiFi 状态的按钮文案。 | ### setNetErrorText 设置网络异常的提示文案。 ```java public void setNetErrorText(String mNetErrorText) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mNetErrorText |String |网络异常的提示文案。 | ### setNonWIFIText 设置非 WiFi 状态的提示文案。 ```java public void setNonWIFIText(String mNonWIFIText) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mNonWIFIText |String |非 WiFi 状态的提示文案。 | ### setNetWorkChangeTextColor 设置使用手机流量的提示文案颜色。 ```java public void setNetWorkChangeTextColor(int mNetWorkChangeTextColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mNetWorkChangeTextColor |Integer |使用手机流量的提示文案颜色。默认为白色。 | ### setLoadingDrawable 设置横屏直播间的加载图标。 ```java public void setLoadingDrawable(Drawable mLoadingDrawable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mLoadingDrawable |Drawable |横屏直播间的加载图标。 | ### setPorLoadingDrawable 设置竖屏直播间的加载图标。 ```java public void setPorLoadingDrawable(Drawable mLoadingDrawable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mLoadingDrawable |Drawable |竖屏直播间的加载图标。 | ### setLoadingDrawableSize 设置横屏直播间加载图标的大小。 ```java public void setLoadingDrawableSize(int size) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |size |Integer |横屏直播间加载图标的大小。 | ### setPorLoadingDrawableSize 设置竖屏直播间加载图标的大小。 ```java public void setPorLoadingDrawableSize(int size) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |size |Integer |竖屏直播间加载图标的大小。 | ## 主播账号定制 ### setAccountImageSize 设置主播账号的头像尺寸。 ```java public void setAccountImageSize(int mAccountImageSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mAccountImageSize |Integer |主播账号的头像尺寸。 | ### setAccountViewColor 设置主播账号的背景颜色。 ```java public void setAccountViewColor(int mAccountViewColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mAccountViewColor |Integer |主播账号的背景颜色。 | ### setAccountFontSize 设置主播账号的字号。 ```java public void setAccountFontSize(int mAccountFontSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mAccountFontSize |Integer |主播账号的字号。单位：sp | ### setAccountFontColor 设置主播账号的文字颜色。 ```java public void setAccountFontColor(int accountFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |accountFontColor |Integer |主播账号的文字颜色。 | ## 悬浮窗定制悬浮窗，即画中画（PiP）窗口。 ### setOpenLiveFloatWindow 设置是否开启直播悬浮窗，即是否支持以画中画模式展示直播画面。 ```java public void setOpenLiveFloatWindow(boolean mOpenFloatWindow) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mOpenFloatWindow |Boolean |是否开启直播悬浮窗。默认为 `true`。 |\ | | | |\ | | |* `true`：开启 |\ | | |* `false`：不开启 | ### setOpenVodFloatWindow 设置是否开启点播悬浮窗，即是否支持以画中画模式展示预告或回放视频。 ```java public void setOpenVodFloatWindow(boolean mOpenFloatWindow) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mOpenFloatWindow |Boolean |是否开启点播悬浮窗。默认为 `true`。 |\ | | | |\ | | |* `true`：开启 |\ | | |* `false`：不开启 | ### setFloatWindowBorderWidth 设置悬浮窗边框的宽度。 ```java public void setFloatWindowBorderWidth(int mFloatWindowBorderWidth) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatWindowBorderWidth |Integer |悬浮窗边框的宽度。参数值非负数。单位：dp | ### setFloatWindowBorderColor 设置悬浮窗边框的颜色。 ```java public void setFloatWindowBorderColor(int mFloatWindowBorderColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatWindowBorderColor |Integer |悬浮窗边框的颜色。 | ### setFloatWindowExitBtn 设置悬浮窗的关闭图标。 ```java public void setFloatWindowExitBtn(Drawable mFloatWindowExitBtn) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatWindowExitBtn |Drawable |悬浮窗的关闭图标。 | ### setFloatWindowCorner 设置悬浮窗的圆角。 ```java public void setFloatWindowCorner(float mFloatWindowCorner) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatWindowCorner |Float |悬浮窗的圆角。 | ### setFloatViewActionListener 设置悬浮窗主体或其关闭按钮的点击事件监听器。完成设置后，观众点击悬浮窗主体或其关闭按钮时，SDK 会将点击事件通知给 `FloatViewActionListener`，但不会执行后续默认的点击行为。相关回调，详见 [FloatViewActionListener](/docs/3019/125700#floatviewactionlistener)。 ```java public void setFloatViewActionListener(FloatViewActionListener floatViewActionListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatViewActionListener |FloatViewActionListener |悬浮窗主体或其关闭按钮的点击事件监听器。 | ## 多语言切换定制 ### setLanguageType 设置需要的语言类型，默认为支持的所有语言，即简体中文、繁体中文、英文和日文。仅适用于以下定制文案。如需设置观看页面的语言，请调用 [setPreferLanguage](/docs/3019/125705#setpreferlanguage) 方法。 * 发言间隔提示文案 * 重播按钮文案 * 直播间内使用手机流量的提示文案 * 网络断开按钮文案 * 网络断开提示文案 ```java public void setLanguageType(LanguageManager.LANGUAGE[] mLanguageType) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mLanguageType |LanguageManager.LANGUAGE[] |需要的语言类型。 | 实现直播间定制文案的多语言，需要先传入需要的语言类型数组，并在定制文案中按数组下标顺序以 "\|" 隔开。以定制重播按钮文案为例： ```java LanguageManager.LANGUAGE[] mLanguageType = {LanguageManager.LANGUAGE.ZH_HANS, LanguageManager.LANGUAGE.EN , LanguageManager.LANGUAGE.JA, LanguageManager.LANGUAGE.ZH_HANT}; settings.setLanguageType(mLanguageType); settings.setReplayTipText("重新观看|Watch again|もう一度見る|重新觀看"); ``` :::warning 该方法自 1.52.1 版本开始不再支持使用。 ::: ### setMultiLanguageIcon 设置多语言切换的图标。 ```java public void setMultiLanguageIcon(Drawable mMultiLanguageIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mMultiLanguageIcon |Drawable |多语言切换的图标。 | ### setLanguageListener 设置多语言切换的监听器。相关回调，详见 [LanguageListener](/docs/3019/125700#languagelistener)。 ```java public void setLanguageListener(LanguageListener mLanguageListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mLanguageListener |LanguageListener |多语言切换的监听器。 | ### setPreferLanguage 设置观看页优先使用的语言。 ```java public void setPreferLanguage(LanguageManager.LANGUAGE mPreferLanguage) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPreferLanguage |LanguageManager.LANGUAGE |观看页优先使用的语言。 |\ | | |:::tip |\ | | |只有在[企业直播控制台](https://console.volcengine.com/livesaas/liveManagement/)开启的语言才会生效。 |\ | | |::: | ## 商品卡片定制 ### setShowGoodsCount 设置是否显示商品卡片的总数。 ```java public void setShowGoodsCount(boolean mShowGoodsCount) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mShowGoodsCount |Boolean |是否显示商品卡片的总数。 |\ | | | |\ | | |* `true`：显示 |\ | | |* `false`：不显示 | ### setShoppingCardIcon 设置直播间内展示的购物车图标。 ```java public void setShoppingCardIcon(Drawable shoppingCardIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardIcon |Drawable |直播间内展示的购物车图标。 | ### setShopCardItemImageCorner 设置商品卡片条目背景的圆角。 ```java public void setShopCardItemImageCorner(int mShopCardItemImageCorner) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mShopCardItemImageCorner |Integer |商品卡片条目背景的圆角。 | ### setShoppingCardDialogHeight 设置商品卡片对话框的高度。 ```java public void setShoppingCardDialogHeight(int shoppingCardDialogHeight) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardDialogHeight |Integer |商品卡片对话框的高度。参数值非负数。默认值为屏幕高度的 0.73 倍。单位：dp | ### setShoppingCardDialogBackgroundColor 设置商品卡片对话框的背景颜色。 ```java public void setShoppingCardDialogBackgroundColor(int shoppingCardDialogBackgroundColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardDialogBackgroundColor |Integer |商品卡片对话框的背景颜色。 | ### setShoppingCardTabFontStyle 设置商品卡片菜单栏的字体。 ```java public void setShoppingCardTabFontStyle(Typeface shoppingCardTabFontStyle) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardTabFontStyle |Typeface |商品卡片菜单栏的字体。 | ### setShoppingCardTitleFontStyle 设置商品名称的字体。 ```java public void setShoppingCardTitleFontStyle(Typeface shoppingCardTitleFontStyle) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardTitleFontStyle |Typeface |商品名称的字体。 | ### setShoppingCardTitleFontSize 设置商品名称的字号。 ```java public void setShoppingCardTitleFontSize(int shoppingCardTitleFontSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardTitleFontSize |Integer |商品名称的字号。单位：sp | ### setShoppingCardTitleFontColor 设置商品名称的颜色。 ```java public void setShoppingCardTitleFontColor(int shoppingCardTitleFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardTitleFontColor |Integer |商品名称的颜色。 | ### setShoppingCardHighLightFontStyle 设置商品卡片售卖价的字体。 ```java public void setShoppingCardHighLightFontStyle(Typeface shoppingCardHighLightFontStyle) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardHighLightFontStyle |Typeface |商品卡片售卖价的字体。 | ### setShoppingCardHighLightFontSize 设置商品卡片售卖价的字号。 ```java public void setShoppingCardHighLightFontSize(int shoppingCardHighLightFontSize) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardHighLightFontSize |Integer |商品卡片售卖价的字号。单位：sp | ### setShoppingCardHighLightFontColor 设置商品卡片售卖价的颜色。 ```java public void setShoppingCardHighLightFontColor(int shoppingCardHighLightFontColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardHighLightFontColor |Integer |商品卡片售卖价的颜色。 | ### setProductOriginalPriceShowStrikethrough 设置是否显示商品参考价的删除线。 ```Java public void setProductOriginalPriceShowStrikethrough(boolean productOriginalPriceShowStrikethrough) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |productOriginalPriceShowStrikethrough |Boolean |是否显示商品参考价的删除线。默认值为 `false`。取值如下： |\ | | | |\ | | |* `true`：显示。 |\ | | |* `false`：不显示。 | ### setShoppingCardBackgroundColor 设置商品卡片的背景颜色。 ```java public void setShoppingCardBackgroundColor(int shoppingCardBackgroundColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shoppingCardBackgroundColor |Integer |商品卡片的背景颜色。 | ### setEnableDirectUrl 设置是否开启商品直达链接。 ```java public void setEnableDirectUrl(boolean mEnableDirectUrl) { this.mEnableDirectUrl = mEnableDirectUrl; } ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mEnableDirectUrl |Boolean |是否开启商品直达链接。 |\ | | | |\ | | |* `true`: 如果在[企业直播控制台](https://console.volcengine.com/livesaas/liveManagement/)设置了直达链接，则优先读取直达链接。 |\ | | |* `false`: 读取跳转链接。 | ## 浮窗商品卡片定制浮窗商品卡片，即以浮标形式展示的商品卡片。 ### setFloatingShoppingCardBuyBtn 设置浮窗商品卡片按钮。 ```java public void setFloatingShoppingCardBuyBtn(Drawable floatingShoppingCardBuyBtn) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatingShoppingCardBuyBtn |Drawable |浮窗商品卡片按钮。 | ### setFloatingShopCardBtnText 设置浮窗商品卡片按钮的文案。 ```typescript public void setFloatingShopCardBtnText(String mFloatingShopCardBtnText) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatingShopCardBtnText |String |浮窗商品卡片按钮的文案。默认为[企业直播控制台](https://console.volcengine.com/livesaas/liveManagement/)配置的商品售卖价，设置后显示该文案。 | ### setFloatingShoppingCardLayoutParams 设置浮窗商品卡片的默认位置。 ```Java public void setFloatingShoppingCardLayoutParams(SimpleLayoutParams floatingShoppingCardLayoutParams) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatingShoppingCardLayoutParams |SimpleLayoutParams |浮窗商品卡片的默认位置。具体配置，详见 [SimpleLayoutParams](/docs/3019/125701#d0799e15)。 |\ | | | | ### setFloatShoppingCardMovable 设置浮窗商品卡片是否支持拖动。 ```Java public void setFloatShoppingCardMovable(boolean FloatShoppingCardMovable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |FloatShoppingCardMovable |Boolean |浮窗商品卡片是否支持拖动。默认值为 `false`。 |\ | | | |\ | | |* `true`：支持拖动。 |\ | | |* `false`：不支持拖动。 | ### setFloatingShoppingCardMarginBottom 设置浮窗商品卡片的底部边距。 ```java public void setFloatingShoppingCardMarginBottom(int floatingShoppingCardMarginBottom) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatingShoppingCardMarginBottom |Integer |浮窗商品卡片的底部边距。参数值非负数。单位：dp | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatingShoppingCardLayoutParams](/docs/3019/125705#eabd6888) 方法替代之。 ::: ### setFloatingShoppingCardMarginRight 设置浮窗商品卡片的右边距。 ```java public void setFloatingShoppingCardMarginRight(int floatingShoppingCardMarginRight) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatingShoppingCardMarginRight |Integer |浮窗商品卡片的右边距。参数值非负数。单位：dp | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatingShoppingCardLayoutParams](/docs/3019/125705#eabd6888) 方法替代之。 ::: ### setFloatShopCardCorner 设置浮窗商品卡片的外层圆角。 ```java public void setFloatShopCardCorner(int mFloatShopCardCorner) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatShopCardCorner |Integer |浮窗商品卡片的外层圆角。内层图片圆角自动适配外层圆角。 | ## 直播间内链接跳转定制 * 点击菜单内商品卡片、主播账号头像、浮窗商品卡片、页中广告、浮标广告、评论中的链接、页头广告后，SDK 默认跳转至 WebView 或外部浏览器。如果您想要实现自定义跳转，可调用 `setRedirectPageListener` 监听点击事件，然后根据点击事件实现自定义跳转。 * 用户以自定义模式登录直播间时，点击评论区的用户昵称后，SDK 没有默认的跳转行为。您必须调用 `setRedirectPageListener` 监听点击事件，然后根据点击事件实现自定义跳转。 ### setRedirectPageListener 设置直播间内链接点击事件监听器。完成设置后，用户点击上述链接时，SDK 会触发相应的点击事件。您需要根据点击事件实现自定义跳转。 ```java public void setRedirectPageListener(RedirectPageListener mRedirectPageListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mRedirectPageListener |[RedirectPageListener](/docs/3019/125700#redirectpagelistener) |直播间内链接点击事件监听器。 | **示例代码** ```Java CustomSettings.Holder.mSettings.setRedirectPageListener(new RedirectPageListener() { /** * * * @param liveActivity 直播间所在的 Activity * @param redirectInfo 实现跳转所需的信息 * @return 是否拦截后续 SDK 的默认跳转行为。true：拦截，SDK 不会执行后续默认的跳转行为。false：不拦截，SDK 会执行后续默认的跳转行为 */ @Override public boolean redirectPage(Activity liveActivity, RedirectInfo redirectInfo) { // 通过 entrance 字段查看点击事件入口 String entrance = redirectInfo.getEntrance(); switch (redirectInfo.getContentType()){ case RedirectInfo.CONTENT_TYPE_URL: // 当内容类型为 URL 时，获取 urlRedirectInfo 字段 UrlRedirectInfo urlRedirectInfo = redirectInfo.getUrlRedirectInfo(); if (entrance.equals(Entrance.FLOATING_ADVERTISEMENT.value)){ // 如仅需拦截浮标广告的默认跳转行为，可在 entrance 为浮标广告时返回 true，其他情况返回 false 即可 // 弹出 SDK 内部的 WebViewDialog。您也可以使用自定义的 Dialog new CommonWebViewDialog(liveActivity,urlRedirectInfo.getUrl(), R.style.TvuLiveBottomDialog).show(); return true; } case RedirectInfo.CONTENT_TYPE_COMMENT: // 当内容类型为 comment 时，获取 commentModel 字段 SingleCommentModel commentModel = redirectInfo.getCommentModel(); // 获取到 commentModel 字段后，实现自定义跳转 return true; } return false; } }); ``` ## 直播间状态定制 ### setLiveRoomStatusListener 设置直播间状态的监听器。相关回调，详见 [LiveRoomStatusListener](/docs/3019/125700#liveroomstatuslistener)。 ```java public void setLiveRoomStatusListener(LiveRoomStatusListener mLiveRoomStatusListener) ``` | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mLiveRoomStatusListener |LiveRoomStatusListener |直播间状态的监听器。 | ### setLiveRoomActionListener 设置完整直播间的退出事件监听器。完成设置后，观众点击退出按钮或物理返回键退出完整直播间时，SDK 会将点击事件通知给 `LiveRoomActionListener`，但不会执行后续默认的点击行为。相关回调，详见 [LiveRoomActionListener](/docs/3019/125700#liveroomactionlistener)。 ```java public void setLiveRoomActionListener(LiveRoomActionListener liveRoomActionListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |liveRoomActionListener |LiveRoomActionListener |完整直播间的退出事件监听器。 | ## 抽奖定制 ### setFloatAwardPosition 设置抽奖图标的默认位置。 ```java public void setFloatAwardPosition(Pair mFloatAwardPosition) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatAwardPosition |Integer |抽奖图标的默认位置。参数值非负数。单位：dp |\ | | | |\ | | |* `pair.first`：右外边距。 |\ | | |* `pair.second`：下外边距。 | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatInteractToolLayoutParams](/docs/3019/125705#1cc26ab7) 方法替代之。 ::: ### setFloatAwardMovable 设置是否允许观众拖拽移动抽奖图标。 ```java public void setFloatAwardMovable(boolean mFloatAwardMovable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatAwardMovable |Boolean |是否允许观众拖拽移动抽奖图标。默认为 `fasle`。 |\ | | | |\ | | |* `true`：允许。 |\ | | |* `false`：不允许。 | :::warning 该方法自 1.28.0 版本开始不再支持使用，您可以使用 [setFloatInteractToolMovable](/docs/3019/125705#10347e23) 方法替代之。 ::: ### setFloatAwardListener 设置抽奖图标的监听器。相关回调，详见 [FloatingAwardView.Listener](/docs/3019/125700#floatingawardview-listener)。 ```java public void setFloatAwardListener(FloatingAwardView.Listener mFloatAwardListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mFloatAwardListener |FloatingAwardView.Listener |抽奖图标的监听器。 | ### setNeedFillAwardInfo 设置观众中奖后是否需要填写中奖信息。 ```java public void setNeedFillAwardInfo(boolean mNeedFillAwardInfo) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mNeedFillAwardInfo |Boolean |观众中奖后是否需要填写中奖信息。默认为 `true`。 |\ | | | |\ | | |* `true`：需要。 |\ | | |* `false`：不需要。 | ## **互动工具定制** ### setFloatInteractToolLayoutParams 设置整组互动工具图标的默认位置。整组互动工具图标包含观看页展示的所有互动工具图标。 ```Java public void setFloatInteractToolLayoutParams(SimpleLayoutParams floatInteractToolLayoutParams) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |floatInteractToolLayoutParams |SimpleLayoutParams |整组互动工具图标的默认位置。具体配置，详见 [SimpleLayoutParams](/docs/3019/125701#d0799e15)。 | ### setFloatInteractToolMovable 设置是否允许观众拖拽移动整组互动工具图标。整组互动工具图标包含观看页展示的所有互动工具图标。 ```Java public void setFloatInteractToolMovable(boolean FloatInteractToolMovable) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |FloatInteractToolMovable |Boolean |是否允许观众拖拽移动整组互动工具图标。默认为 `true`。 |\ | | | |\ | | |* `true`：允许。 |\ | | |* `false`：不允许。 | ### setVotePeopleCountVisible 设置是否显示参与投票人数。 ```Java public void setVotePeopleCountVisible(boolean visible) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |visible |Boolean |是否显示参与投票人数。默认值：`true`。 |\ | | | |\ | | |* `true`：显示。 |\ | | |* `false`：不显示。 | ## 其他定制 ### setPortraitExitIconPosition 设置竖屏直播间退出图标的位置。 ```java public void setPortraitExitIconPosition(boolean mPortraitExitIconPosition) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPortraitExitIconPosition |Boolean |竖屏直播间退出图标的位置。 |\ | | | |\ | | |* `true`：位于直播间右侧。 |\ | | |* `false`：位于直播间左侧。 | ### setLandScapeExitIconPosition 设置横屏直播间退出图标的位置。 ```java public void setLandScapeExitIconPosition(boolean mLandScapeExitIconPosition) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mLandScapeExitIconPosition |Boolean |横屏直播间退出图标的位置。 |\ | | | |\ | | |* `true`：位于直播间右侧。 |\ | | |* `false`：位于直播间左侧。 | ### setCommentLinkToWebView 设置点击超链接后跳转内容是否在当前直播页面展示。 ```java public void setCommentLinkToWebView(boolean mCommentLinkToWebView) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mCommentLinkToWebView |Boolean |点击超链接后跳转内容是否在当前直播页面展示。 |\ | | | |\ | | |* `true`：在当前直播页面展示 |\ | | |* `false`：在新页面展示 | ### setExitRoomIcon 设置退出直播间的图标。 ```java public void setExitRoomIcon(Drawable exitRoomIcon) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |exitRoomIcon |Drawable |退出直播间的图标。 | ### setPageBackGroundColor 设置直播间的背景颜色。 ```java public void setPageBackGroundColor(int mPageBackGroundColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mPageBackGroundColor |Integer |直播间的背景颜色。 | ### setTransitionPage 设置竖屏直播间的加载页面。建议使用黑色底色的图片。 ```java public void setTransitionPage(Drawable transitionPage) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |transitionPage |Drawable |竖屏直播间的加载页面。 | ### setCustomLoginListener 设置公开鉴权模式下登录自有账号系统的监听器。相关回调，详见 [CustomLoginListener](/docs/3019/125700#customloginlistener)。 ```java public void setCustomLoginListener(CustomLoginListener mCustomLoginListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mCustomLoginListener |CustomLoginListener |公开鉴权模式下登录自有账号系统的监听器。 | ### setBookSuccessText 设置预约直播成功后的提示文案。 ```java public void setBookSuccessText(String bookSuccessText) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |bookSuccessText |String |预约直播成功后的提示文案。 | ### setBookFailText 设置预约直播失败后的提示文案。 ```java public void setBookFailText(String bookFailText) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |bookFailText |String |预约直播失败后的提示文案。 | ### setAudienceLinkNotification 设置连麦中页面切到后台时，弹出的前台通知样式。 ```java public void setAudienceLinkNotification(NotificationInfo mAudienceLinkNotification) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mAudienceLinkNotification |[NotificationInfo](/docs/3019/125701#notificationinfo) |连麦中页面切到后台时，弹出的前台通知样式。 | ### setActivityBottomNavBarColor 设置当直播间中显示系统底部导航栏时，系统底部导航栏的底色。 ```Java public void setActivityBottomNavBarColor(int activityBottomNavBarColor) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |activityBottomNavBarColor |Integer |当直播间中显示系统底部导航栏时，系统底部导航栏的底色。 |\ | | |默认为纯黑（`#000000`）。 | ### setShareListener 设置完整直播间的分享按钮点击事件监听器。完成设置后，观众点击完整直播间的分享按钮时，SDK 会将点击事件通知给 `ShareListener`，但不会执行后续默认的点击行为。相关回调，详见 [ShareListener](/docs/3019/125700#dedd7ab8)。 ```Java public void setShareListener(ShareListener shareListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |shareListener |[ShareListener](/docs/3019/125700#dedd7ab8) |完整直播间的分享按钮点击事件监听器。 | ### setPortraitRoomClearScreenEnable 设置是否开启竖屏直播间的清屏功能。 :::tip 仅竖屏直播间支持清屏功能。 ::: ```Java public void setPortraitRoomClearScreenEnable(boolean portraitRoomClearScreenEnable) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |portraitRoomClearScreenEnable |Boolean |是否开启竖屏直播间的清屏功能。默认值：`true`。 |\ | | | |\ | | |* `true`：开启。观众可以右滑清屏或者点击更多（...）图标 > **清屏**实现清屏效果。 |\ | | |* `false`：不开启。 | ### setShowCloseButtonWhenClearingScreen 设置清屏期间是否显示关闭直播间按钮。 ```Java public void setShowCloseButtonWhenClearingScreen(boolean showCloseButtonWhenClearingScreen) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |showCloseButtonWhenClearingScreen |Boolean |清屏期间是否显示关闭直播间按钮。默认值为` false`。 |\ | | | |\ | | |* `true`：显示。 |\ | | |* `false`：不显示。 | ### setShowRetryPageWhenJoinRoomFail 设置是否在完整直播间所在页面初始化失败时显示重试页。 ```Java public void setShowRetryPageWhenJoinRoomFail(boolean showRetryPageWhenJoinRoomFail) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |showRetryPageWhenJoinRoomFail |Boolean |是否在完整直播间所在页面初始化失败时显示重试页。默认值：`true`。 |\ | | | |\ | | |* `true`：显示。 |\ | | |* `false`：不显示。 | ### setActivityBookListener 设置直播预约监听器。相关回调，详见 [ActivityBookListener](/docs/3019/125700#18ab169e)。 ```Java public void setActivityBookListener(ActivityBookListener listener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |listener |ActivityBookListener |直播预约监听器。 | ### setCustomLanguageStringListener 设置自定义系统文案监听器。相关回调，详见 [CustomLanguageStringListener](/docs/3019/125700#d973da9e)。 ```Java public void setCustomLanguageStringListener(CustomLanguageStringListener mCustomLanguageStringListener) ``` **参数** | | | | \ |**名称** |**类型** |**说明** | |---|---|---| | | | | \ |mCustomLanguageStringListener |CustomLanguageStringListener |自定义系统文案监听器。 | **示例代码** 以下示例代码将观看页语言为简体中文、`key` 为 `more` 的文案变更为 `123`。 ```Java CustomSettings settings = CustomSettings.Holder.mSettings; settings.setCustomLanguageStringListener(new CustomLanguageStringListener() { @Override public String onCustomLanguageString(LanguageManager.LANGUAGE language, String key, String originString) { if (language == ZH_HANS && "more".equals(key)) { return "123"; } return originString; } }); ``` ### setPublicCommentNickName 直播间鉴权模式为公开时，为进入直播间的观众设置默认昵称。 ```Java public void setPublicCommentNickName(String publicRegisterNickName, PublicNickNameRegisterListener nameRegisterListener) ``` **参数** | | | | \ |**名称** |\ | |**类型** |**说明** | |---|---|---| | | | | \ |publicRegisterNickName |String |昵称。为空则不做任何处理。 | | | | | \ |nameRegisterListener |PublicNickNameRegisterListener |直播间鉴权模式为公开时，昵称注册结果的回调类。可传空。详见 [PublicNickNameRegisterListener](/docs/3019/125700#c29b787b)。 | ### setShowSelfVideoInRemoteView 设置是否在连麦画面 view 中显示当前连麦观众的画面。 :::tip 连麦画面 view 即展示当前连麦观众和其他连麦参与者画面的 view。 ::: ```Java public void setShowSelfVideoInRemoteView(boolean showSelfVideoInRemoteView) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |showSelfVideoInRemoteView |Boolean |是否在连麦画面 view 中显示当前连麦观众的画面。默认值为 `false`。取值如下： |\ | | | |\ | | |* `true`：在连麦画面 view 中显示。 |\ | | |* `false`：在连麦本地画面预览 view 中显示。 | ### setShowPortraitRoomTopShadow 设置是否在竖屏直播间顶部显示渐变蒙层。 ```Java public void setShowPortraitRoomTopShadow(boolean showPortraitRoomTopShadow) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |showPortraitRoomTopShadow |Boolean |是否在竖屏直播间顶部显示渐变蒙层。默认值为 `true`。 |\ | | | |\ | | |* `true`：显示。如果您的视频画面背景为白色，显示渐变蒙层可使直播间顶部的白色文字更明显。 |\ | | |* `false`：不显示。 | ### setBdlExternalReportConfiguration 设置数据上报配置。 ```Java public void setBdlExternalReportConfiguration(BDLExternalReportConfiguration bdlExternalReportConfiguration) ``` **参数** | | | | \ |名称 |类型 |说明 | |---|---|---| | | | | \ |bdlExternalReportConfiguration |BDLExternalReportConfiguration |数据上报配置。详见 [BDLExternalReportConfiguration](/docs/3019/125701#158fe0ca)。 |