方法 | 说明 |
|---|---|
进入完整直播间。 | |
退出直播间,同时销毁当前悬浮窗。 | |
销毁当前悬浮窗。 | |
模拟手动点击当前悬浮窗。 | |
模拟手动点击当前悬浮窗的关闭按钮。 | |
模拟手动点击退出直播间图标。 | |
清除观众当前设备上 SDK 的所有本地缓存。 | |
获取 SDK 本地存储的 | |
在完整直播间中弹出悬浮窗权限申请弹窗。仅在完整直播间页面存在时生效。 |
方法 | 说明 |
|---|---|
初始化独立播放器 | |
刷新当前直播内容。 | |
开始播放视频。 | |
暂停播放视频。 | |
获取是否正在播放视频。 | |
获取当前资源的可播放状态。 | |
获取当前视频是否卡顿。 | |
设置视频画面填充模式。 | |
获取当前支持的分辨率列表。 | |
获取当前选中的分辨率。 | |
为当前视频设置分辨率。 | |
获取当前点播视频的播放进度。 | |
跳转到点播视频的指定播放进度。 | |
获取当前点播视频的时长。 | |
获取当前点播视频的播放倍速。 | |
设置是否静音播放。 | |
设置点播视频是否循环播放。 | |
设置点播视频播放倍速。 | |
当独立播放器所在的页面进入后台运行时,可调用此方法通知播放器。 | |
获取当前直播间的状态。 | |
获取当前点播视频的 Vid。 | |
获取当前的回放列表。 | |
获取当前直播频道 ID。 | |
获取当前的直播频道列表。 | |
设置直播封面图容器的显示状态。 |
方法 | 说明 |
|---|---|
创建一个 | |
设置与 | |
设置直播间的鉴权模式。 | |
设置直播间的监听器。 | |
开启直播间。调用此方法后, | |
开始播放视频。 | |
暂停播放视频。 | |
暂停播放视频。适用于当前直播间的 Activity 被切换到后台的场景。 | |
继续播放视频。适用于原直播间的 Activity 被切换回前台的场景。 | |
暂停拉取当前直播状态。 | |
继续拉取当前直播状态。 | |
销毁当前直播间。 | |
获取直播间内 IM 信令的管理类。 | |
获取直播间内消息列表的管理类。 | |
获取直播间中的动态配置类。在观众进入直播间之前或之后,可以调用该方法,自定义直播间的相关配置。 |
方法 | 说明 |
|---|---|
创建一个 | |
开始播放视频。 | |
暂停播放视频。 |
方法 | 说明 |
|---|---|
添加直播间内的 IM 信令监听器。 | |
移除直播间内的 IM 信令监听器。 |
方法 | 说明 |
|---|---|
在直播间内发送文字评论。 |
方法 | 说明 |
|---|---|
创建一个 | |
将 | |
设置是否显示底部的评论输入框。 |
方法 | 说明 |
|---|---|
获取 | |
创建连麦入口 view,用于展示申请连麦按钮。 | |
创建连麦本地画面预览 view,用于展示当前连麦观众的本地视频画面。 | |
创建连麦画面容器 view,用于展示当前连麦观众和其他连麦参与者的画面。 |
方法 | 说明 |
|---|---|
在观众点击申请连麦后,弹出弹窗。观众可选择视频或音频连麦。 | |
开始申请连麦,主持人同意后当前观众会自动加入连麦。 | |
设置当前连麦观众本地摄像头画面的渲染视图。 | |
翻转本地摄像头。 | |
设置是否开启本地麦克风。 | |
设置是否开启本地摄像头。 | |
断开连麦。 | |
获取当前连麦状态。 | |
判断当前本地摄像头是否已开启。 | |
判断当前本地麦克风是否已开启。 |
方法 | 说明 |
|---|---|
在 | |
在 | |
将竖屏直播间底部图标的点击事件替换为您自定义的点击事件。观众点击图标触发自定义的点击事件后,即可执行自定义的点击行为。 |
方法 | 说明 |
|---|---|
设置横屏直播间内,视频画面的填充模式。 | |
设置竖屏直播间内,视频画面的填充模式。 | |
设置人气标签文字的字体。 | |
设置人气标签文字的字号。 | |
设置人气标签文字的颜色。 | |
设置人气图标。 | |
设置播放器的主题颜色,即倍速按钮、进度条和清晰度按钮的颜色。 | |
设置直播状态的字号。 | |
设置直播状态文字距离播放器居中位置的纵向偏移量。 | |
设置直播状态文字背景的圆角。 | |
设置直播状态文字的横向内边距。 | |
设置直播状态文字的纵向内边距。 | |
设置点播时间的颜色。 | |
设置全屏图标。 | |
设置退出全屏图标。 | |
设置直播中状态下播放器左下角的刷新图标。 | |
设置播放器左下角的播放图标。 | |
设置播放器左下角的暂停图标。 | |
设置播放器中央的暂停状态图标。 | |
设置直播标题。 | |
设置在倍速选择对话框中选中倍速后,是否自动关闭倍速选择对话框。 | |
设置在清晰度选择对话框中选中清晰度后,是否自动关闭清晰度选择对话框。 | |
设置是否开启竖屏直播间的简版控制栏,即无倍速和清晰度选择按钮。 | |
设置回放的重新播放按钮文案。 | |
设置是否自动播放直播。 | |
设置横屏直播间内,是否自动播放回放。 | |
设置竖屏直播间内,是否自动播放回放。 | |
设置横屏直播间内,是否自动播放预告。 | |
设置竖屏直播间内,是否自动播放预告。 | |
设置横屏直播间内,是否自动重播回放。 | |
设置竖屏直播间内,是否自动重播回放。 | |
设置横屏直播间内,是否自动重播预告。 | |
设置竖屏直播间内,是否自动重播预告。 | |
设置是否开启点播视频的自动断点续播。 | |
设置直播间内是否显示点播视频自动断点续播后的提示。 | |
设置直播间内点播视频自动断点续播提示的文字大小。 | |
设置是否支持进入全屏模式。 | |
设置直播期间遇到卡顿时,是否支持自动降级或提供提示信息。 | |
设置直播期间遇到卡顿时,是否直接切换主备流。 |
方法 | 说明 |
|---|---|
设置横屏直播间内,菜单栏的背景。 | |
设置横屏直播间内,菜单栏被选中或未被选中时的文字颜色。 | |
设置菜单栏的字体。 | |
设置横屏直播间中,菜单栏被选中的下标颜色。 | |
设置竖屏直播间中,内嵌链接和图文介绍菜单栏被选中的下标颜色。 | |
设置竖屏直播间内嵌链接菜单的图标。 | |
设置内嵌链接和图文介绍菜单栏标题的字号。 | |
设置内嵌链接和图文介绍菜单栏被选中后的标题文字颜色。 | |
设置内嵌链接和图文介绍菜单栏未被选中时的标题文字颜色。 |
方法 | 说明 |
|---|---|
设置评论区无评论时的占位图标。 | |
设置非主持人昵称的字体。 | |
设置非主持人昵称的颜色。 | |
设置非主持人昵称的字号。 | |
设置非主持人评论的文字颜色。 | |
设置评论链接的颜色。 | |
设置非主持人评论的链接是否可以点击。 | |
设置非主持人评论的字体。 | |
设置非主持人评论的字号。 | |
设置主持人标签的字体。 | |
设置主持人标签的字号。 | |
设置置顶内容的字体。 | |
设置置顶内容的文字颜色。 | |
设置置顶评论最大显示行数。 | |
设置置顶内容详情的对话框标题是否在最左侧。 | |
设置竖屏直播间内评论区的高度。 | |
设置竖屏直播间内单条评论的最大显示行数。 | |
设置评论输入框的提示文字颜色。 | |
设置评论输入框内输入的文字颜色。 | |
设置发言间隔的提示内容。 | |
设置发言间隔的提示内容字体。 | |
设置聊天欢迎语、进场消息以及非主持人的评论底色。 | |
设置每次能拉取的评论条数。 | |
设置可以拉取的历史评论总数。 | |
设置直播间点赞图标。 | |
设置直播间进场消息中昵称的文字颜色。 | |
设置直播间进场消息中内容的文字颜色。 | |
设置横屏直播间的评论区内是否展示用户头像。 | |
设置竖屏直播间的评论区内是否展示用户头像。 | |
设置评论区主持人的默认头像。 | |
设置评论区非主持人的默认头像。 | |
设置点赞直播间后漂浮动画图标的监听器。 | |
设置主持人的评论文字颜色。 | |
设置主持人的评论底色。 | |
设置主持人标签的颜色。 | |
设置主持人评论的字号。 | |
设置主持人评论的字体。 | |
设置聊天欢迎语和竖屏模式下直播描述的标签字体。 | |
设置聊天欢迎语和竖屏模式下直播描述的标签字号。 | |
设置聊天欢迎语和竖屏模式下直播描述的标签颜色。 | |
设置聊天欢迎语和竖屏模式下直播描述的正文字体。 | |
设置聊天欢迎语和竖屏模式下直播描述的正文字号。 | |
设置聊天欢迎语和竖屏模式下直播描述的正文颜色。 | |
设置相邻评论之间的间距。 | |
设置评论列表底部与评论输入框顶部的间距。 | |
设置下拉刷新组件内容的颜色,例如 | |
设置评论已点赞状态的点赞按钮图标。 | |
设置评论未点赞状态的点赞按钮图标。 | |
设置聊天互动菜单下评论输入框内的最大字符数限制。 | |
设置私聊互动菜单下评论输入框内的最大字符数限制。 | |
设置直播间评论自定义监听器。 |
方法 | 说明 |
|---|---|
设置标题的字体。 | |
设置输入框内的文字字体。 | |
设置输入框内的占位符。 | |
设置确定按钮的背景颜色。 | |
设置确定按钮的字体。 | |
设置关闭图标。 |
方法 | 说明 |
|---|---|
设置图文区域上下左右的外边距。 | |
设置图文内容的文字颜色。 |
方法 | 说明 |
|---|---|
设置页中广告的宽高比。 | |
设置页中广告的边框颜色。 | |
设置页中广告的圆角。 | |
设置页中广告的轮播速度。 | |
设置浮标广告的默认位置。 | |
设置浮标广告的大小。 | |
设置是否显示页头图。 | |
设置是否显示页中广告。 | |
设置浮标广告是否支持拖动。 | |
设置浮标广告是否显示白色边框和背景。 |
方法 | 说明 |
|---|---|
设置在直播间内使用手机流量时是否开启提示。 | |
设置在横屏直播间内使用手机流量时,弹出提示文案的次数。 | |
设置横屏直播间内,重试按钮的背景颜色。 | |
设置竖屏直播间内,重试按钮的背景颜色。 | |
设置横屏直播间内,重试按钮的圆角。 | |
设置竖屏直播间内,重试按钮的圆角。 | |
设置网络异常的按钮文案。 | |
设置非 WiFi 状态的按钮文案。 | |
设置网络异常的提示文案。 | |
设置非 WiFi 状态的提示文案。 | |
设置使用手机流量的提示文案颜色。 | |
设置横屏直播间的加载图标。 | |
设置竖屏直播间的加载图标。 | |
设置横屏直播间加载图标的大小。 | |
设置竖屏直播间加载图标的大小。 |
方法 | 说明 |
|---|---|
设置主播账号的头像尺寸。 | |
设置主播账号的背景颜色。 | |
设置主播账号的字号。 | |
设置主播账号的文字颜色。 |
方法 | 说明 |
|---|---|
设置是否开启直播悬浮窗。 | |
设置是否开启点播悬浮窗。 | |
设置悬浮窗边框的宽度。 | |
设置悬浮窗边框的颜色。 | |
设置悬浮窗的关闭图标。 | |
设置悬浮窗的圆角。 | |
设置悬浮窗主体或其关闭按钮的点击事件监听器。 | |
设置画中画窗口在锁屏后是否暂停播放。 |
方法 | 说明 |
|---|---|
设置多语言切换的图标。 | |
设置多语言切换的监听器。 | |
设置观看页优先使用的语言。 |
方法 | 说明 |
|---|---|
设置是否显示商品卡片的总数。 | |
设置直播间内展示的购物车图标。 | |
设置商品卡片条目背景的圆角。 | |
设置商品卡片对话框的高度。 | |
设置商品卡片对话框的背景颜色。 | |
设置商品卡片菜单栏的字体。 | |
设置商品名称的字体。 | |
设置商品名称的字号。 | |
设置商品名称的颜色。 | |
设置商品卡片售卖价的字体。 | |
设置商品卡片售卖价的字号。 | |
设置商品卡片售卖价的颜色。 | |
设置是否显示商品参考价的删除线。 | |
设置商品卡片的背景颜色。 | |
设置是否开启商品直达链接。 |
方法 | 说明 |
|---|---|
设置浮窗商品卡片按钮。 | |
设置浮窗商品卡片按钮的文案。 | |
设置浮窗商品卡片的默认位置。 | |
设置浮窗商品卡片的外层圆角。 | |
设置浮窗商品卡片是否支持拖动。 |
方法 | 说明 |
|---|---|
设置直播间内的链接跳转监听器。 |
方法 | 说明 |
|---|---|
设置直播间状态的监听器。 | |
设置完整直播间的退出事件监听器。 |
方法 | 说明 |
|---|---|
设置抽奖图标的监听器。 | |
设置观众中奖后是否需要填写中奖信息。 |
方法 | 说明 |
|---|---|
设置整组互动工具图标的默认位置。 | |
设置是否允许观众拖拽移动整组互动工具图标。 | |
设置是否显示参与投票人数。 |
方法 | 说明 |
|---|---|
设置竖屏直播间退出图标的位置。 | |
设置横屏直播间退出图标的位置。 | |
设置点击超链接后跳转内容是否在当前直播页面展示。 | |
设置退出横屏直播间的图标。 | |
设置直播间的背景颜色。 | |
设置竖屏直播间的加载页面。 | |
直播间鉴权模式为公开时,为进入直播间的观众设置默认昵称。 | |
设置公开鉴权模式下登录自有账号系统的监听器。 | |
设置预约直播成功后的提示文案。 | |
设置预约直播失败后的提示文案。 | |
设置连麦中页面切到后台时,弹出的前台通知样式。 | |
设置在横竖屏直播间中,当显示系统底部导航栏时,系统底部导航栏的底色。 | |
设置完整直播间的分享按钮点击事件监听器。 | |
设置是否开启竖屏直播间的清屏功能。 | |
设置清屏期间是否显示关闭直播间按钮。 | |
设置是否在完整直播间所在页面初始化失败时显示重试页。 | |
设置直播预约监听器。 | |
设置自定义系统文案监听器。 | |
设置是否在连麦画面 view 中显示当前连麦观众的画面。 | |
设置是否在竖屏直播间顶部显示渐变蒙层。 | |
设置数据上报配置 |
回调 | 说明 |
|---|---|
该回调在 | |
该回调在 | |
播放器全屏、退出全屏图标点击回调。您可以在该回调中切换横竖屏播放、显示或隐藏状态栏等。 | |
直播状态变化回调。 | |
播放状态变化回调。 | |
播放器倍速按钮点击回调。 | |
播放器重放按钮点击回调。 | |
在观众被强制退出直播间时,SDK 触发该回调。 |
回调 | 说明 |
|---|---|
多语言切换图标点击回调。观众点击多语言切换图标时,SDK 调用该回调通知您的 App 该点击事件。 |
回调 | 说明 |
|---|---|
语言选中回调。您可以在您的 App 中自定义一个多语言选择对话框,并在观众选择语言后,调用该回调通知 SDK 切换语言。 |
回调 | 说明 |
|---|---|
直播间 Activity 创建回调。 | |
横屏直播间页面 | |
竖屏直播间页面 | |
直播间 Activity 切换到后台回调。 | |
直播间 Activity 切换到前台回调。 | |
直播间 Activity 配置变化回调。 | |
直播间 Activity 销毁回调。 | |
在完整直播间页面和悬浮窗均销毁时,SDK 触发该回调。 | |
在悬浮窗即将出现时,SDK 触发该回调。 | |
在悬浮窗即将消失时,SDK 触发该回调。 | |
在观众被强制退出直播间时,SDK 触发该回调。 | |
|
回调 | 说明 |
|---|---|
公开鉴权模式下登录自有账号系统回调。观众以公开模式进入直播间后,在评论或点赞等需要登录的场景下,SDK 调用该回调通知您的 App 观众需进行登录。您可以通过自有账号体系实现观众的登录。 |
回调 | 说明 |
|---|---|
观众登录结果回调。观众登录您的自有账号体系后,调用该回调告知 SDK 观众的登录结果。 |
回调 | 说明 |
|---|---|
抽奖状态变化回调。 |
回调 | 说明 |
|---|---|
直播状态变化回调。 | |
资源可播放状态回调。 | |
播放状态变化回调。 | |
视频画面尺寸变化回调。 | |
卡顿状态变化回调。 | |
点播发生错误回调。 | |
直播发生错误回调。 | |
视频播放发生错误回调。 | |
点播视频已准备完毕回调。 | |
点播视频画面渲染开始回调。 | |
点播视频当前播放进度变化回调。 | |
点播视频总时长变化回调。 | |
视频播放完成回调。 | |
直播已准备完毕回调。 | |
直播渲染开始回调。 | |
直播结束回调。 | |
封面可见状态回调。 | |
视频分辨率信息改变回调。 | |
点播视频自动断点续播回调。 | |
当前正在播放的点播视频 Vid 改变回调。 | |
当前直播间的回放改变回调。 | |
当前直播频道 ID 改变回调。 | |
当前直播频道列表改变回调。 | |
在观众被强制退出直播间时,SDK 触发该回调。 |
回调 | 说明 |
|---|---|
跳转完成回调。 |
回调 | 说明 |
|---|---|
链接点击回调。 |
回调 | 说明 |
|---|---|
自定义图标数组回调。 |
回调 | 说明 |
|---|---|
观众点击悬浮窗主体时,SDK 会触发该回调。 | |
观众点击悬浮窗的关闭按钮时,SDK 会触发该回调。 |
回调 | 说明 |
|---|---|
观众点击退出按钮或物理返回键退出完整直播间时,SDK 会触发该回调。 |
回调 | 说明 |
|---|---|
观众点击完整直播间的分享按钮时,SDK 会触发该回调并传入直播间的分享地址。 |
回调 | 说明 |
|---|---|
IM 建立连接失败回调。 | |
IM 建立连接成功回调。 | |
IM 信令收到回调。 |
回调 | 说明 |
|---|---|
通过 |
回调 | 说明 |
|---|---|
网络请求成功回调。 | |
网络请求失败回调。 |
回调 | 说明 |
|---|---|
在显示系统文案时触发该回调,用于自定义系统文案。 |
回调 | 说明 |
|---|---|
直播预约按钮点击回调。 | |
系统日历日程创建结果回调。 |
回调 | 说明 |
|---|---|
创建系统日历日程成功回调。 |
回调 | 说明 |
|---|---|
在 SDK 渲染完单条评论内容后触发该回调,用于自定义评论的文字内容、样式或替换表情图片。 |
回调 | 说明 |
|---|---|
进入完整直播间成功回调。 | |
进入完整直播间失败回调。 |
回调 | 说明 |
|---|---|
昵称注册成功回调。 | |
昵称注册失败回调。 |
回调 | 说明 |
|---|---|
企业直播服务端观众连麦开关状态变化回调。 | |
本地连麦状态变化回调。 | |
本地麦克风开启状态变化回调。 | |
本地摄像头开启状态变化回调。 | |
首次从企业直播服务端获取到连麦布局信息时,即连麦布局已经加载完成时,会触发该回调。 | |
在即将弹出申请连麦中弹窗时,SDK 会触发该回调。您可以通过返回值,选择是否允许弹出该弹窗。 |
回调 | 说明 |
|---|---|
单个连麦参与者画面的点击回调。 |
回调 | 说明 |
|---|---|
在显示关注主播按钮时,SDK 调用该方法获取观众的关注状态。您可以在该方法内执行具体的获取关注状态逻辑,并在执行完成后,通过 | |
在观众点击关注或取消关注主播按钮时,SDK 调用该方法。您可以在该方法内执行具体的关注或取消关注逻辑,并在执行完成后,通过 |
回调 | 说明 |
|---|---|
观众点击评论输入框后即将弹出键盘时,SDK 会触发该回调。 |