You need to enable JavaScript to run this app.
导航

回调

最近更新时间2024.01.23 17:31:14

首次发布时间2022.07.13 16:53:43

ITVULiveRoomServerListener

用于监听 TVULiveRoomServer 实例的回调类,您可以在回调中做相应处理。

public interface com.bytedance.live.sdk.player.listener.ITVULiveRoomServerListener

成员函数

onGetRoomDataSuccess

该回调在 TVULiveRoomServer.start 方法执行完成、成功获取服务端数据时触发。

void onGetRoomDataSuccess(ActivityResult activityResult)

参数

名称

类型

说明

activityResult

ActivityResult

返回的服务端直播间数据。

onGetRoomDataFailed

该回调在TVULiveRoomServer.start 方法执行完成、获取服务端数据失败时触发。

void onGetRoomDataFailed(int errCode, String errMsg)

参数

名称

类型

说明

errCode

Integer

错误码。

  • 0:ERR_BAD_DATA,即服务端数据解析错误。
  • 1:ERR_LIMITED_ROOM,即该直播间禁止手机观看。

errMsg

String

失败的原因。

onFullScreenChange

播放器全屏、退出全屏图标点击回调。您可以在该回调中实现横竖屏切换、状态栏的显示或隐藏等,并调用 adjustPlayer 方法自定义播放器尺寸。

void onFullScreenChange()

liveRoomStatusChange

直播状态变化回调。

void liveRoomStatusChange(int value)

参数

名称

类型

说明

value

Integer

当前直播状态。

  • 1:直播中
  • 2:预告
  • 3:回放
  • 4:已结束

playerStatusChange

播放状态变化回调。

void playerStatusChange(int playerStatus)

参数

名称

类型

说明

playerStatus

Integer

当前播放器的状态。

  • 0:暂停
  • 1:播放

onSpeedButtonDidTouch

播放器倍速按钮点击回调。

void onSpeedButtonDidTouch()

onReplayButtonDidTouch

播放器重放按钮点击回调。

void onReplayButtonDidTouch()

LanguageListener

点击多语言切换图标的回调类。

public interface LanguageListener

成员函数

onSelectLanguage

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

void onSelectLanguage(Activity activity,
                          ArrayList<LanguageManager.LANGUAGE> languages,
                          LanguageManager.LANGUAGE curLanguage,
                          SelectLanguageCallBack callBack)

参数

名称

类型

说明

activity

Activity

直播间 Activity。

languages

ArrayList<LanguageManager.LANGUAGE>

当前支持的语言列表。
可选值:

  • LanguageManager.LANGUAGE.ZH_HANS:简体中文
  • LanguageManager.LANGUAGE.EN:英文
  • LanguageManager.LANGUAGE.JA:日文
  • LanguageManager.LANGUAGE.ZH_HANT:繁体中文

curLanguage

LanguageManager.LANGUAGE

当前选中的语言。

callBack

SelectLanguageCallBack

语言选中的回调类。

SelectLanguageCallBack

语言选中的回调类。

interface SelectLanguageCallBack

成员函数

onLanguageSelected

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

void onLanguageSelected(LanguageManager.LANGUAGE language)

参数

名称

类型

说明

language

LanguageManager.LANGUAGE

要切换的语言。

LiveRoomStatusListener

直播间页面生命周期的回调类。

public interface LiveRoomStatusListener

成员函数

onLiveRoomActivityCreate

直播间 Activity 创建回调。

void onLiveRoomActivityCreate(Activity activity)

onLandLiveRoomBindingAvailable

横屏直播间页面 ViewBinding 实例初始化完成回调。在 SDK 触发该回调后,您可以通过获取到的 ViewBinding 实例按需修改横屏直播间的页面布局或图标。

default void onLandLiveRoomBindingAvailable(TvuLivePlayerLayoutBinding binding, LanguageManager languageManager)

参数

名称

类型

说明

binding

TvuLivePlayerLayoutBinding

直播间页面的 ViewBinding 实例。

languageManager

LanguageManager

多语言管理器。

onPortraitLiveRoomBindingAvailable

竖屏直播间页面 ViewBinding 实例初始化完成回调。在 SDK 触发该回调后,您可以通过获取到的 ViewBinding 实例按需修改竖屏直播间的页面布局或图标。

default void onPortraitLiveRoomBindingAvailable(TvuPortraitLiveRoomLayoutBinding binding, LanguageManager languageManager) {}

参数

名称

类型

说明

binding

TvuPortraitLiveRoomLayoutBinding

直播间页面的 ViewBinding 实例。

languageManager

LanguageManager

多语言管理器。

onLiveRoomActivityPause

直播间 Activity 切换到后台回调。

void onLiveRoomActivityPause(Activity activity)

onLiveRoomActivityResume

直播间 Activity 切换到前台回调。

void onLiveRoomActivityResume(Activity activity)

onActivityConfigurationChanged

直播间 Activity 配置变化回调。

default void onActivityConfigurationChanged(Activity activity, Configuration configuration)

参数

名称

类型

说明

activity

Activity

直播间 Activity。

configuration

Configuration

直播间 Activity 的配置。

onLiveRoomActivityDestroy

直播间 Activity 销毁回调。

void onLiveRoomActivityDestroy(Activity activity)

onLiveRoomFullDestroyed

在完整直播间页面和悬浮窗均销毁时,SDK 触发该回调。

void onLiveRoomFullDestroyed(long activityId)

参数

名称

类型

说明

activityId

Long

直播间活动 ID。

CustomLoginListener

公开鉴权模式下登录自有账号系统的回调类。

public interface CustomLoginListener

成员函数

onCustomLoginStart

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

void onCustomLoginStart(Context context, long activityId, LoginStateCallBack callBack)

参数

名称

类型

说明

context

Context

直播间页面的上下文。

activityId

long

直播间活动 ID。

callBack

LoginStateCallBack

观众登录结果的回调类。

LoginStateCallBack

观众登录结果的回调类。

interface LoginStateCallBack

成员函数

onLoginFinished

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

void onLoginFinished(String token)

参数

名称

类型

说明

token

String

用户 Token。

  • 如果观众登录成功,则传入通过调用 GetSDKTokenAPI 获取的用户 Token 到 SDK。

说明

在传入前,确保调用 URLDecoder.decode 方法对 Token 进行解码。

  • 如果观众取消登录或登录失败,则传入 Null 到 SDK。

FloatingAwardView.Listener

抽奖图标的回调类。

public interface Listener

成员函数

onUpdateAwardIcon

抽奖状态变化回调。抽奖状态变化时,SDK 触发该回调通知您更新图片。

void onUpdateAwardIcon(ImageView icon, int awardStatus);

参数

名称

类型

说明

icon

ImageView

抽奖图标的 ImageView。

awardStatus

Integer

当前的抽奖状态。

  • 2:待开奖。
  • 4:已开奖。

SinglePlayerListener

独立播放器的回调类。

public interface SinglePlayerListener

成员函数

liveRoomStatusChanged

直播状态变化回调。

public void liveRoomStatusChanged(int status);

参数

名称

类型

说明

status

Integer

当前直播状态:

  • 1:直播中
  • 2:预告
  • 3:回放
  • 4:已结束

playableStatusChanged

资源可播放状态回调。

public void playableStatusChanged(int playableStatus);

参数

名称

类型

说明

playableStatus

Integer

当前资源可播放状态:

  • 0:当前无任何资源可播放,无法调用 play
  • 1:当前有点播视频(预告和回放视频)可播放,可调用 play 播放视频。
  • 2:当前有直播可播放,可调用 play 播放视频。

playStatusChanged

播放状态变化回调。

public void playStatusChanged(int playStatus);

参数

名称

类型

说明

playStatus

Integer

当前播放状态:

  • 0:暂停
  • 1:播放

sizeChanged

视频画面尺寸变化回调。

public void sizeChanged(int width, int height);

参数

名称

类型

说明

width

Integer

视频宽度。

height

Integer

视频高度。

stallingStatusChanged

卡顿状态变化回调。您可以自行配置是否显示自定义加载动画。

public void stallingStatusChanged(boolean isStalling);

参数

名称

类型

说明

isStalling

Boolean

当前视频是否卡顿。

  • true:卡顿。
  • false:不卡顿。

vodErrorOccurred

点播发生错误回调。

public void (Error error);

参数

名称

类型

说明

error

Error

错误详情。

playErrorStatusChanged

视频播放发生错误回调。包括点播发生错误和直播发生错误。此时播放处于暂停状态,您可以自行配置重试画面,引导观众点击重试播放。

public void playErrorStatusChanged(boolean isPlayError);

参数

名称

类型

说明

isPlayError

Boolean

当前是否发生播放错误。

  • true:发生播放错误。
  • false:未发生播放错误。

vodPrepared

点播视频已准备完毕回调。您可以调用 seekVodTime 方法。

public void vodPrepared();

vodRenderStarted

点播视频画面渲染开始回调。

public void vodRenderStarted();

vodCurPlayTimeChanged

点播视频当前播放进度变化回调。每秒更新一次。

public void (int curTimeInMills);

参数

名称

类型

说明

curTimeInMills

Integer

当前播放进度。单位:ms

vodDurationChanged

点播视频总时长变化回调。此回调通常在视频切换时触发。

public void (int durationInMills);

参数

名称

类型

说明

durationInMills

Integer

当前视频的总时长。单位:ms

vodCompletion

视频播放完成回调。

public void vodCompletion();

livePrepared

直播已准备完毕回调。

public void livePrepared();

liveFirstFrameRendered

直播渲染开始回调。

public void liveFirstFrameRendered(boolean isFirstFrame);

参数

名称

类型

说明

isFirstFrame

Boolean

是否为真正渲染的第一帧。直播过程中可能会发生重试导致多次触发此回调。

  • true:当前是调用 play 方法后的第一帧。
  • false:当前不是调用 play 方法后的第一帧。

liveCompletion

直播结束回调。

public void liveCompletion();

coverImageVisibleChanged

封面可见状态回调。视频播放时封面不可见,无视频播放时封面可见。

public void coverImageVisibleChanged(boolean isVisible);

参数

名称

类型

说明

isVisible

Boolean

封面是否可见。

  • true:可见。
  • false:不可见。

resolutionInfoChanged

视频分辨率信息改变回调。此回调通常在视频切换时触发。

public void resolutionInfoChanged(String[] resolutions, String defaultResolution);

参数

名称

类型

说明

resolutions

String[]

当前支持的分辨率列表。

defaultResolution

String

当前默认选中的分辨率。

vodAutoSeekPreviousTime

点播视频自动断点续播回调。

void vodAutoSeekPreviousTime(int seekTimeInMills)

参数

名称

类型

说明

seekTimeInMills

Integer

自动断点续播后跳转到的视频播放位置。单位:ms

onCurVodVidChanged

当前正在播放的点播视频 Vid 改变回调。在观看页播放的点播视频变更时或者直播间状态发生变化时会触发该回调。

void onCurVodVidChanged(String vid)

参数

名称

类型

说明

vid

String

当前正在播放的点播视频 Vid。如果当前未播放点播视频,则返回空字符串。

onCurReplayListChanged

当前直播间的回放改变回调。在上下架回放时或者直播间状态发生变化时会触发该回调。

void onCurReplayListChanged(List<Replay> replayList)

参数

名称

类型

说明

replayList

List

直播间的回放列表。如果当前直播间没有回放视频,则返回空数组。

onCurLiveLineIdChanged

当前直播线路 ID 改变回调。

void onCurLiveLineIdChanged(long lineId)

参数

名称

类型

说明

lineId

Long

当前直播线路 ID。如果当前直播间并非直播中状态,则返回 0

onCurLiveLineListChanged

当前直播线路列表改变回调。

void onCurLiveLineListChanged(List<PullStreamUrl> liveLineList)

参数

名称

类型

说明

liveLineList

List

当前直播线路列表。如果当前直播间并非直播中状态,则返回空数组。

initFinished

TVUSinglePlayerView 实例初始化结果回调。

public void initFinished(boolean initSuccess);

参数

名称

类型

说明

initSuccess

Boolean

初始化是否成功。

  • true:成功。
  • false:失败。需重新调用 Init 方法。

注意

该方法自 1.26.0 版本开始不再支持使用,您可以使用 setListener 方法替代之。

SeekCompletionListener

跳转完成回调类。

public interface SeekCompletionListener

成员函数

onCompletion

跳转完成回调。

void onCompletion(boolean success);

参数

名称

类型

说明

success

Boolean

跳转是否成功。

  • true:跳转成功。
  • false:跳转失败。

RedirectPageListener

直播间内链接点击的回调类。

public interface RedirectPageListener

成员函数

redirectPage

链接点击回调。用户点击直播间内某一 URL 或评论区用户昵称时,SDK 会触发此回调。

public boolean redirectPage(Activity liveActivity, RedirectInfo redirectInfo)

参数

名称

类型

说明

liveActivity

Activity

直播间 Activity。

redirectInfo

RedirectInfo

实现跳转所需的信息。

返回值

类型

说明

Boolean

是否拦截后续 SDK 的默认跳转行为。

  • true:拦截,SDK 不会执行后续默认的跳转行为。
  • false:不拦截,SDK 会执行后续默认的跳转行为。

ITVUMultipleDrawableListener

自定义图标数组的回调类。

public interface ITVUMultipleDrawableListener

成员函数

onGetMultipleDrawable

自定义图标数组回调。当 SDK 内部需要图标数组时,会调用该回调。您需要自行实现该回调并返回自定义的图标数组。

Drawable[] onGetMultipleDrawable()

返回值

类型

说明

Drawable[]

您自定义的图标数组。

FloatViewActionListener

悬浮窗点击事件的回调类。

public interface FloatViewActionListener

成员函数

onClickFloatView

观众点击悬浮窗主体时,SDK 会触发该回调。

boolean onClickFloatView(long activityId)

参数

名称

类型

说明

activityId

Long

直播间活动 ID。

返回值

类型

说明

Boolean

是否拦截后续默认的点击行为。

  • true:拦截,即不执行后续默认的点击行为。
  • false:不拦截,即执行后续默认的点击行为。

说明

默认的点击行为指关闭悬浮窗并返回完整直播间。

onClickFloatViewExitBtn

观众点击悬浮窗的关闭按钮时,SDK 会触发该回调。

boolean onClickFloatViewExitBtn(long activityId)

参数

名称

类型

说明

activityId

Long

直播间活动 ID。

返回值

类型

说明

Boolean

是否拦截后续默认的点击行为。

  • true:拦截,即不执行后续默认的点击行为。
  • false:不拦截,即执行后续默认的点击行为。

说明

默认的点击行为指关闭悬浮窗。

LiveRoomActionListener

直播间操作事件的回调类。

public interface LiveRoomActionListener

成员函数

onClickExitLiveRoom

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

boolean onClickExitLiveRoom(Activity activity,long activityId)

参数

名称

类型

说明

activity

Activity

直播间 Activity。

activityId

Long

直播间活动 ID。

返回值

类型

说明

Boolean

是否拦截后续默认的点击行为。

  • true:拦截,即不执行后续默认的点击行为。
  • false:不拦截,即执行后续默认的点击行为。

说明

默认的点击行为指退出完整直播间,如正在播放直播或点播视频且在移动端开启了悬浮窗权限,则会在退出完整直播间的同时展示悬浮窗。

ShareListener

完整直播间分享按钮点击事件的回调类。

public interface ShareListener

成员函数

onShare

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

boolean onShare(Context context,String shareUrl)

参数

名称

类型

说明

context

Context

直播间页面的上下文。

shareUrl

String

直播间的分享地址。

返回值

类型

说明

Boolean

是否拦截后续默认的点击行为。

  • true:拦截,即不执行后续默认的点击行为。
  • false:不拦截,即执行后续默认的点击行为。

说明

默认的点击行为指 SDK 弹出分享弹窗。