- 模块接口
- loginByToken
- logout
- loadCourses
- setWhiteBoardView
- stopSendOperateCommand
- redoDrawable
- setPaintColor
- setTextSize
- setStrokeSize
- setDrawType
- addWhiteBoard
- scrollUp
- scrollDown
- setScroll
- destoryWhiteBoard
- checkAllowedToLive
- whiteboardBringToFront
- setLineRgbColor
- getCurrentIndex
- getCurrentSubPage
- getCurrentSubIndex
- closeWhiteboard
- hideWhiteboard
- clearData
- getCacheSize
- getBeauty
- setBeauty
- getGraffiti
- setGraffiti
- getAutoUpload
- setAutoUpload
- getDocumentListOfCourse
- addDocument
- scanLocalFile
- getScanDocList
- cancelUpload
- setUpdateChatListener
- socketConnect
- socketIsConnected
- setSocketEmitListener
- setSocketConnectListener
- stopAll
- processProgress
- shutdownManager
- setLiveView
- closeLiveView
- showLiveView
- getSendFrameRate
- isMute
- setIsMute
- isCloseCamera
- setOrientation
- getOrientation
- getZoomPercent
- setZoomByPercent
- applyPermission
- startLive
- cameraStart
- cameraStop
- pauseLive
- liveOnEvent
- liveOffEvent
- getSpeedLineList
- setSpeedup
- destroyRtcEngineKit
- getRtcEngineKitInfo
- emitRtcEngineKit
- startRtcLive
- stopRtcLive
- openRtcLive
- closeRtcLive
- switchRtcCamera
- closeRtcVideo
- closeRtcAudio
- cancelDrawPower
- upRtc
- getRtcMemberList
- getRtcAllStudents
- getRtcApplyList
- getRtcUserEntityList
- setWhiteBoardPresenter
- setLiveDurationListener
- setLiveDurationListener
- setLiveListener
- setRtcMediaStatusListener
- setRtcErrorListener
- setWhiteboardPowerListener
- setWhiteboardRecoverListener
- setRtcStatusListener
- setRtcMemberListener
talkFunLive
概述
欢拓是一家以直播技术为核心的网络平台,旨在帮助人们通过网络也能实现真实互动通讯。从2010年开始,欢拓就专注于音频、视频的采样、编码、后处理及智能传输研究,并于2013年底正式推出了针对企业/开发者的直播云服务系统,帮助开发者轻松实现真人互动。该系统适用场景包括在线教育、游戏语音、娱乐互动、远程会议(PC、移动均可)等等。详情参考欢拓云官方网站:https://www.talk-fun.com。
欢拓云有观看端 SDK 和直播端 SDK。原生 SDK 下载地址是:.
talkFun 模块封装了欢拓云的观看端 SDK。
talkFunLive 模块封装了欢拓云的直播端 SDK。
initCloudLive loginByToken logout isLogin
直播公共接口——课程
直播公共接口——白板
setWhiteBoardView setTextSize nextPage gotoPage undoDrawable clearPage scrollDown destoryWhiteBoard getTotalPage stopSendOperateCommand setStrokeSize
直播类接口补充——登录
直播类接口补充——课程
直播类接口补充——白板
whiteboardBringToFront getCurrentIndex getCurrentSubIndex hideWhiteboard canUndo insertWhiteboard execute
设置接口
getCacheSize setBeauty setGraffiti
setAutoUpload
文档接口
getDocument insertDocument stopScanLocalFile upload stopAll
isUploadOrCovering
直播公共接口——聊天
直播公共接口——Socket
socketDisconnect socketEmit cancleSocketEmitListener
大班直播
initLiveManager getLiveManagerInfo setLiveView hideLiveView
liveViewBringToFront
liveStatusChangedListener
livePacketLossListener
swapCamera isMute isCloseCamera getOrientation applyPermission
cameraStart
pauseLive
stopLive
liveOnEvent liveOffEvent
setDefinition
setSpeedup
getMemberList
小班直播
destroyRtcEngineKit getRtcEngineKitInfo onEventRtcEngineKit
stopRtcLive
closeRtcLive
getVideoState
closeRtcVideo
closeRtcAudio
cancelDrawPower
upRtc
getRtcMemberList
getRtcApplyList
setWhiteBoardPresenter setLiveListener setRtcErrorListener setWhiteboardRecoverListener setRtcMemberListener
模块接口
initCloudLive
初始化云直播
initCloudLive
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
示例代码
talkFunLive.initCloudLive(function(ret){
alert(JSON.stringify(ret));
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
loginByUserId
通过用户id登录
loginByUserId
Params
userId:
- 类型:字符串
- 描述:用户ID
password:
- 类型:字符串
- 描述:密码
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;登录是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:0, // 数字类型;错误码
msg:'' // 字符串;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.loginByUserId({
userId:'',
password:''
},function(ret,err){
alert(JSON.stringify(ret));
});
可用性
Android 、 iOS 系统
可提供的 1.0.0 及更高版本
loginByToken
通过token登录
loginByToken
Params
token:
- 类型:字符串
- 描述:令牌
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;登录是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:0, // 数字类型;错误码
msg:'' // 字符串;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.loginByToken({
token:''
},function(ret,err){
alert(JSON.stringify(ret));
});
可用性
Android 、 iOS 系统
可提供的 1.0.0 及更高版本
cancelLogin
取消登录,iOS端无此接口
cancelLogin
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.cancelLogin();
可用性
Android 系统
可提供的 1.0.0 及更高版本
logout
退出登录
logout
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.logout();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
isLogin
判断是否已登录
isLogin
callback(ret)
ret:
- 类型:JSON 对象
- 描述:返回值
{
isLogin:true
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.isLogin(function(ret){
alert(JSON.stringify(ret));
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getUserInfo
获取用户信息
getUserInfo
callback(ret)
ret:
- 类型:JSON 对象
- 描述:返回值
{
userInfo:{} // JSON对象;用户信息
}
Android userInfo 详细字段可参考
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getUserInfo(function(ret){
alert(JSON.stringify(ret));
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
createCourse
创建课程
createCourse
Params
courseName:
- 类型:字符串
- 描述:课程名称
startTime:
- 类型:字符串
- 描述:开始时间
endTime:
- 类型:字符串
- 描述:结束时间
modeType:
- 类型:数字
- 描述:创建模式
- 取值:
- 3 :大班模式
- 5 :rtc模式
- 6 :混合模式
scenes:
- 类型:数字
- 描述:课程场景,
- 取值:
- 1 : 教育直播 2 : 生活直播 注意:iOS只有在modeType为3时,才能创建生活直播
- 默认:1
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;创建课程是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:0, // 数字类型;错误码
msg:'' // 字符串;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.destory();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
loadCourses
加载课程
loadCourses
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回对象
{
courseList:[{courseData}] // JSON列表;返回课程列表
}
- 注意:courseData为课程数据
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.loadCourses(function(ret){
alert(JSON.stringify(ret));
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
setWhiteBoardView
设置白板
setWhiteBoardView({params},function(ret))
Params
rect:
- 描述:视频播放器的窗口位置及大小
- 类型:JSON对象
{
x:0, // 窗口的左边距;默认:0
y:0, // 窗口的上边距;默认:0
w:300, // 窗口的宽度;默认:300
h:300 // 窗口的高度;默认:300
}
fixedOn:
- 描述:附着frame或window的名称
- 类型:字符串
fixed:
- 描述:是否固定
- 类型:布尔类型
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回对象
{
status:true // 布尔类型;是否设置成功
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setWhiteBoardView({
ret:{
x:0,
y:0,
w:200,
h:200
},
fixedOn:'',
fixed:true
},function(ret){
alert(JSON.stringify(ret));
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
startSendOperateCommand
发送操作命令,仅支持 Android 端
startSendOperateCommand
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.startSendOperateCommand();
可用性
Android 系统
可提供的 1.0.0 及更高版本
stopSendOperateCommand
停止发送操作命令,仅支持 Android 端
stopSendOperateCommand
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.stopSendOperateCommand();
可用性
Android 系统
可提供的 1.0.0 及更高版本
addPageDatas
添加文档数据,仅支持 Android 端
addPageDatas
Params
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.addPageDatas();
可用性
Android 系统
可提供的 1.0.0 及更高版本
nextPage
下一页
nextPage
var talkFunLive = api.require('talkFunLive');
talkFunLive.nextPage();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
prePage
上一页
prePage
var talkFunLive = api.require('talkFunLive');
talkFunLive.prePage();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
gotoPage
跳转到指定页
gotoPage
Params
position:
- 类型:数字
- 描述:跳转页
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.gotoPage({
position:2
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getTotalPage
获取总页数
getTotalPage
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
totalPage:1
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getTotalPage(function(ret){
alert(JSON.stringify(ret));
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getCurrentPage
获取当前页数
getCurrentPage
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
currentPage:1
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getCurrentPage(function(ret){
alert(JSON.stringify(ret));
});
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
undoDrawable
撤销
undoDrawable
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.undoDrawable();
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
redoDrawable
还原
redoDrawable
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.redoDrawable();
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
clearPage
清除当前页涂鸦
clearPage
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.clearPage();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
setPaintColor
设置画笔颜色
setPaintColor
Params
color:
- 类型:字符串
- 描述:画笔颜色,支持#FFF,#FFFFFF, rgba()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setPaintColor({
color:'#000'
});
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
setTextSize
设置文字大小
setTextSize
Params
textSize
- 类型:数字类型
- 描述:文字大小,仅支持Android端
textSizeStr
- 类型:字符串
- 描述:文字大小,仅支持iOS端
- 取值范围:
- small:
- middle:
- big:
- huge:
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setTextSize({
textSize:15
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
setStrokeSize
画笔的粗细,仅支持 Android 端
setStrokeSize
Params
strokeSize
- 类型:数字类型
- 描述:画笔粗细
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setStrokeSize({
strokeSize:15
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setDrawType
涂鸦类型
setDrawType
Params
type:
- 类型:字符串
- 描述:画笔粗细
- 取值:
- path 曲线 (仅支持安卓)
- line 直线.
- rectangle 矩形.
- oval 圆.
- arrow 箭头.
- text 文字.
- dotted_line 虚线.
- image 图片 (仅支持安卓)
- mixed 混合 (仅支持安卓)
- clear 清除 (仅支持安卓)
- stroke 画笔 (仅支持iOS)
- boxDelete 框删除 (仅支持iOS)
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setDrawType({
type:'path'
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
addWhiteBoard
添加白板
addWhiteBoard
Params
color:
- 类型:字符串
- 描述:白板颜色,支持#FFF,#FFFFFF, rgba()
isInsertDocBefore:
- 类型:布尔
- 描述:是否将白板插到文档之前
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.addWhiteBoard({
color:'#000'
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
scrollUp
向上滚动
scrollUp
Params
offset:
- 类型:数字
- 描述:(可选项)滚动距离,仅支持iOS端
- 默认:10
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.scrollUp();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
scrollDown
向下滚动
scrollDown
Params
offset:
- 类型:数字
- 描述:(可选项)滚动距离,仅支持iOS端
- 默认:10
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.scrollDown();
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
setScroll
设置是否可以滚动
setScroll
Params
isScroll:
- 类型:布尔
- 描述:是否可以滚动 (只有长图才能滚动)
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setScroll({
isScroll:true
});
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
destoryWhiteBoard
数据清除
destoryWhiteBoard
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.destoryWhiteBoard();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getUserFolder
获取user information(已经登录才有)
getUserFolder
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
- 内部字段
{
userFolder:'' //字符串类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getUserFolder(function(ret){
alert(JSON.stringify(ret));
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getID
获取ID(登录过才有)(仅iOS支持)
getID
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
- 内部字段
{
ID:'' //字符串类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getID(function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
createCurriculum
根据参数创建课程
createCurriculum
params
params:
- 描述:参数
title:
- 类型:字符串类型(仅android支持)
- 描述:标题
startTime:
- 类型:字符串类型(仅android支持)
- 描述:开始时间,格式:”yyyy-MM-dd HH:mm”
endTime:
- 类型:字符串类型(仅android支持)
- 描述:结束时间,格式:”yyyy-MM-dd HH:mm”
modeType:
- 类型:数字类型(仅android支持)
- 描述:(可选项)创建模式,3/普通模式、5/rtc模式
- 默认:3
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.createCurriculum({
params:{}
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
checkAllowedToLive
进入课程检测是否允许进入直播(仅android支持)
checkAllowedToLive
params
courseId:
- 类型:字符串类型
- 描述:loadCourses 接口返回课程信息中course_id
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否允许直播
course:. //Json对象类型;允许直播课程
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.checkAllowedToLive({
courseId:'',
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
verifyLivingOrNot
验证账号是否在直播(仅iOS支持)
verifyLivingOrNot
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.verifyLivingOrNot(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
launch
启动课程直播(仅iOS支持)
launch
params
courseID:
- 类型:字符串
- 描述:课程ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.launch({
courseID:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
whiteboardBringToFront
蒋白板置为最上层显示(仅iOS支持)
whiteboardBringToFront
params
fixedOn:
- 描述:附着frame或window的名称
- 类型:字符串
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.whiteboardBringToFront({
fixedOn:''
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
setLineRgbColor
设置line颜色(仅iOS支持,android参考setPaintColor接口)
setLineRgbColor
params
color:
- 类型:字符串
- 描述:设置line颜色,支持rgba、rgb、#
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setLineRgbColor({
color:''
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getCurrentIndex
获取当前索引(仅iOS支持,android参考getCurrentPage)
getCurrentIndex(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
currentIndex:1
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getCurrentIndex(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
getCurrentSubPage
获取当前子页码(仅iOS支持)
getCurrentSubPage(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
currentSubPage:1
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getCurrentSubPage(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
getCurrentSubIndex
获取当前子页索引(仅iOS支持)
getCurrentSubIndex(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
currentSubIndex:1
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getCurrentSubIndex(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
closeWhiteboard
关闭白板
closeWhiteboard
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.closeWhiteboard();
可用性
android、iOS 系统
可提供的 1.0.0 及更高版本
showWhiteboard
显示白板
showWhiteboard
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.showWhiteboard();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
hideWhiteboard
隐藏白板
hideWhiteboard
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.hideWhiteboard();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
canUndo
是否能够撤退(仅iOS支持)
canUndo(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
canUndo:false //布尔类型
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.canUndo(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
canRedo
是否能够前进(仅iOS支持)
canRedo(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
canRedo:false //布尔类型
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.canRedo(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
insertWhiteboard
插入白板,根据当前的索引,再添加在后面(仅iOS支持,android参考addWhiteBoard接口)
insertWhiteboard(callback(ret))
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.insertWhiteboard();
可用性
iOS 系统
可提供的 1.0.0 及更高版本
clearData
清除所有页码的涂鸦(仅iOS支持,android参考clearPage接口)
clearData(callback(ret))
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.clearData();
可用性
iOS 系统
可提供的 1.0.0 及更高版本
execute
传入指令 执行操作,仅支持 iOS 端
setScroll
Params
command:
- 类型:JSON对象
- 描述:命令集
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.execute({
command:true
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
clearCache
清除缓存
getDocumentListOfCourse()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.clearCache();
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
getCacheSize
获取缓存大小
getCacheSize(callback(ret,err))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
cacheSize: //数字类型;(仅iOS支持)
seze:'', //字符串类型;(仅android支持)
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getCacheSize(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android、iOS 系统
可提供的 1.0.0 及更高版本
getBeauty
获取是否美颜
getBeauty(callback(ret,err))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
beauty: //布尔类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getBeauty(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
setBeauty
设置是否开启美颜
setBeauty({params},callback(ret,err))
params
isOn:
- 类型:布尔
- 描述:是否开启美颜
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setBeauty({
isOn:false
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getGraffiti
获取是否开启涂鸦状态
getGraffiti(callback(ret,err))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
graffiti: //布尔类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getGraffiti(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
setGraffiti
设置涂鸦开关状态
setGraffiti({params},callback(ret,err))
- 类型:布尔
- 描述:是否开启涂鸦
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setGraffiti({
isOn:false
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getAutoUpload
获取 自动上传开关 状态
getAutoUpload(callback(ret,err))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
autoUpload: //布尔类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getAutoUpload(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
setAutoUpload
设置 自动上传开关 状态
setAutoUpload({params},callback(ret,err))
params
isOn:
- 类型:布尔
- 描述:是否开启自动上传
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setAutoUpload({
isOn:false
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getDocumentListOfCourse
获取文档列表
getDocumentListOfCourse({params},callback(ret,err))
params
course_id:
- 类型:字符串
- 描述:课程名称id(仅iOS支持)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
data:[{ //数组类型;
thumbnail:,
name:,
ID:‘’
}]
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getDocumentListOfCourse({
course_id:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getDocument
根据PPT课件ID获取相应课件信息(仅iOS支持)
getDocument
params
courseWareID:
- 类型:字符串
描述:课件ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getDocument({
courseWareID:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
addDocument
根据PPT课件ID加载课件 清空原文档与清空白板(仅iOS支持)
addDocument
params
courseWareID:
- 类型:字符串
描述:课件ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.addDocument({
courseWareID:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
insertDocument
根据PPT课件ID加载课件 清空原文档,保留白板
insertDocument
params
courseWareID:
- 类型:字符串
描述:课件ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.insertDocument({
courseWareID:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
scanLocalFile
扫描本地文件接口(仅android支持)
scanLocalFile
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.scanLocalFile({
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
stopScanLocalFile
停止扫描本地文件接口(仅android支持)
stopScanLocalFile
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
可用性
Android 系统
可提供的 1.0.0 及更高版本
getScanDocList
获取已扫描本地文件接口(仅android支持)
getScanDocList
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
data:[{}] //数组类型;扫描到的本地文件
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getScanDocList({
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
upload
提供courseID和文件文件的地址 上传图片或文档,返回上传结果
upload
params
files:
- 类型:数组
- 描述:文件路径组成的数组,元素为字符串类型,要求本地路径(fs://)(仅iOS支持)
courseID:
- 类型:字符串
- 描述:课程ID(仅iOS支持)
index:
- 类型:数字类型
- 描述:getScanDocList接口返回数据中index,调用此接口前需先调用接口(仅android支持)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.upload({
courseID:'',
index:,
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
cancelUpload
取消上传某个文档
cancelUpload
params
courseID:
- 类型:字符串
- 描述:课程ID
index:
- 类型:数字类型
- 描述:getScanDocList接口返回数据中index,调用此接口前需先调用接口(仅android支持)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.cancelUpload({
courseID:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
sendMessage
发送消息(仅android支持)
sendMessage
params
content:
- 类型:字符串
- 描述:消息内容
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.sendMessage({
content:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setUpdateChatListener
设置更新聊天内容监听(仅android支持)
setUpdateChatListener
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
newNum:, //数字类型;更新条数
chatMessages: //JSON数组类型;消息列表
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setUpdateChatListener({
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
socketConnect
连接socket(仅android支持)
socketConnect
示例代码
var talkFunLive = api.require('talkFunLive');
可用性
Android 系统
可提供的 1.0.0 及更高版本
socketDisconnect
断开socket(仅android支持)
socketDisconnect
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.socketDisconnect();
可用性
Android 系统
可提供的 1.0.0 及更高版本
socketIsConnected
判断socket是否已连接(仅android支持)
sendMessage
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否已连接
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.socketIsConnected({
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
socketEmit
发送消息(仅android支持)
socketEmit
params
cmd:
- 类型:字符串类型
- 描述:指令
args:
- 类型:Json对象类型
- 描述:参数
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否出错
}
err:
- 类型:JSON 对象
- 内部字段:
{
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.socketEmit({
cmd:'',
args:{},
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setSocketEmitListener
注册指令事件监听(仅android支持)
setSocketEmitListener
params
cmd:
- 类型:字符串类型
- 描述:指令
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
args:[], //Json数组类型;收到该指令的参数
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setSocketEmitListener({
cmd:'',
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
cancleSocketEmitListener
取消指令事件监听(仅android支持)
cancleSocketEmitListener
params
cmd:
- 类型:字符串类型
- 描述:(可选项)指令,不传此参数则取消所有指令监听
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:, //J布尔类型;是否取消成功
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.cancleSocketEmitListener({
cmd:'',
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setSocketConnectListener
设置socket连接监听(仅android支持)
setSocketConnectListener
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:, //J布尔类型;
state:, //数字类型;当前连接状态
//1:连接中
//2:重连中
//3:连接成功
//4:连接失败
//5:重连失败
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setSocketConnectListener({
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
stopAll
停止所有文档上传和转换(仅android支持 )
stopAll
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.stopAll({
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android
可提供的 1.0.0 及更高版本
processProgress
轮询文件处理进度
processProgress(callback(ret))
params
courseID:
- 类型:字符串
- 描述:课程ID(仅iOS支持)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
file:{}, //Json对象类型;上传文件信息
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.processProgress({
courseID:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
isUploadOrCovering
是否正在上传或转换文档(仅android支持)
isUploadOrCovering(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
isUploading:, //布尔类型;是否正在上传或转换文档
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.isUploadOrCovering({
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android
可提供的 1.0.0 及更高版本
initLiveManager
初始化大班直播管理器
initLiveManager({params},callback(ret))
params
courseID:
- 类型:字符串
- 描述:课程ID(仅iOS支持)
courseName:
- 类型:字符串
- 描述:课程名(仅iOS支持)
startTimeDetai:
- 类型:字符串
- 描述:课程ID(仅iOS支持)
endTimeDetail:
- 类型:字符串
- 描述:课程名(仅iOS支持)
rect:
- 类型:JSON对象
- 描述:视频播放器的窗口位置及大小(仅android支持)
{
x:0, // 窗口的左边距;默认:0
y:0, // 窗口的上边距;默认:0
w:300, // 窗口的宽度;默认:300
h:300 // 窗口的高度;默认:300
}
fixedOn:
- 类型:字符串
- 描述:附着frame或window的名称(仅android支持)
fixed:
- 类型:布尔类型
- 描述:是否固定(仅android支持)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.initLiveManager({
courseID:'',
courseName:'',
startTimeDetai:'',
endTimeDetail:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
shutdownManager
销毁大班直播管理器
shutdownManager()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.shutdownManager();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getLiveManagerInfo
获取大班直播管理器信息(仅iOS支持)
getLiveManagerInfo(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
courseID:'', //字符串类型;ID
micGain:, //数字类型;麦克风音量增益因子,初始化时默认为1.0,推流开始后可以修改,其取值范围为[0, 1]
memberTotal:, //数字类型;课程在线人数
timeoutSeconds:, //数字类型;客户端断网直播超时时间
duration:, //数字类型;已直播时长
zoomScale:, //数字类型;对原始视频进行缩放的比例,初始化时默认为1,推流开始后可以修改,其取值范围为(1, 3]
networkStatus:, //数字类型;网络状态
//1:没有网络
//2:wifi
//3:WWAN
//4:其它
beauty:, //布尔类型;是否设置美颜
saveLocalVideo:, //布尔类型;视频录制 开关
autorotate:, //布尔类型;是否自动旋转(这里只支持 left 变 right portrait 变 portraitUpsideDown)
outputImageOrientation://字符串类型;视频输出方向
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getLiveManagerInfo(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
setLiveManagerInfo
配置大班直播管理器(仅iOS支持)
setLiveManagerInfo({params},callback(ret))
params
micGain:
- 类型:数字
- 描述:(可选项)麦克风音量增益因子,初始化时默认为1.0,推流开始后可以修改,其取值范围为[0, 1](仅iOS支持)
- 默认:0
zoomScale:
- 类型:数字
- 描述:(可选项)对原始视频进行缩放的比例,初始化时默认为1,推流开始后可以修改,取值范围为(1, 3]
- 默认:1
beauty:
- 类型:布尔
- 描述:(可选项)是否设置美颜
- 默认:false
saveLocalVideo:
- 类型:布尔
- 描述:(可选项)视频录制 开关
- 默认:false
autorotate:
- 类型:布尔
- 描述:(可选项)自动旋转(这里只支持 left 变 right portrait 变 portraitUpsideDown)
- 默认:false
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
courseID:'' //字符串类型;配置的对象的ID
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setLiveManagerInfo({
micGain:0.5,
zoomScale:2,
beauty:true
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
setLiveView
设置大班直播的画面(仅iOS支持,android在initLiveManager接口配置)
setLiveView({params})
Params
rect:
- 类型:JSON对象
- 描述:视频播放器的窗口位置及大小
{
x:0, // 窗口的左边距;默认:0
y:0, // 窗口的上边距;默认:0
w:300, // 窗口的宽度;默认:auto
h:300 // 窗口的高度;默认:auto
}
fixedOn:
- 类型:字符串
- 描述:附着frame或window的名称
fixed:
- 类型:布尔类型
- 描述:是否固定
bgColor:
- 类型:字符串
- 描述:背景色,支持rgba、rgb、#
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setLiveView({
ret:{
x:0,
y:0,
w:200,
h:200
},
fixedOn:'',
fixed:true
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
closeLiveView
关闭大班直播的画面
closeLiveView()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.closeLiveView();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
hideLiveView
隐藏大班直播的画面
hideLiveView()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.hideLiveView();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
showLiveView
显示大班直播的画面
showLiveView()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.showLiveView();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
liveViewBringToFront
蒋大班直播画面置为最上层显示(仅iOS支持)
liveViewBringToFront
params
fixedOn:
- 描述:附着frame或window的名称
- 类型:字符串
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.liveViewBringToFront({
fixedOn:''
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
streamStatusChangedListener
设置大班直播视频流状态改变的监听
streamStatusChangedListener(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
state: 0 // 数字类型;取值范围
//0:准备(仅iOS支持)
//1:连接中
//2:已连接
//3:已断开(仅iOS支持)
//4:连接出错
//5:正在刷新(仅iOS支持)
//6:推流成功 (仅android支持)
//7:推流失败(仅android支持)
//8:写入失败(仅android支持)
//9:停止直播推流成功(仅android支持)
//10:停止直播推流失败(仅android支持)
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.streamStatusChangedListener(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
liveStatusChangedListener
设置大班直播状态的监听
liveStatusChangedListener(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: 0 // 数字类型;取值范围
//0:结束(仅iOS支持)
//1:暂停(仅iOS支持)
//2:直播(仅iOS支持)
//3:准备完毕(仅iOS支持)
//4:失败 (仅iOS支持)
//5:开始直播成功(仅android支持)
//6:开始直播失败(仅android支持)
//7: 结束直播成功(仅android支持)
//8:结束直播失败(仅android支持)
reason:'', //字符串类型,开始失败或结束失败原因(仅android支持)
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.liveStatusChangedListener(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
liveDelayListener
设置大班直播延时的监听(仅iOS支持)
liveDelayListener(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
delay: '' //字符串类型;延时
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.liveDelayListener(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
livePacketLossListener
设置大班直播的丢包的监听(仅iOS支持)
livePacketLossListener(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
percentage:'' //字符串类型;丢包
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.livePacketLossListener(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
setLiveCameraFront
蒋大班直播画面置为前置摄像头(仅iOS支持)
setLiveCameraFront({params})
params
isFront:
- 类型:字符串
- 描述:是否启用前置摄像头
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setLiveCameraFront({
isFront:false
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
swapCamera
切换摄像头(仅android支持)
swapCamera({params})
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.swapCamera({
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
getSendFrameRate
获取直播流帧率(仅android支持)
getSendFrameRate({params})
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
rate: //数字类型;帧率
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getSendFrameRate(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
isMute
获取是否静音(仅android支持)
isMute({params})
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
mute: //布尔类型;是否静音
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.isMute(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setIsMute
设置是否静音(仅android支持)
setIsMute({params})
param
mute:
- 类型:布尔类型
- 描述:是否静音
- 默认值:true
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setIsMute({
mute:true
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
isCloseCamera
获取是否已关闭摄像头(仅android支持)
isCloseCamera({params})
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
closed: //布尔类型;是否关闭
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.isCloseCamera(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setOrientation
设置屏幕方向(仅android支持)
setOrientation({params})
param
orientation:
- 类型:数字类型
- 描述:屏幕方向
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setOrientation({
orientation:,
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
getOrientation
获取屏幕方向(仅android支持)
getOrientation({params})
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
orientation: //数字类型;屏幕方向
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getOrientation(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
getZoomPercent
获取焦距缩放百分比(仅android支持)
getZoomPercent({params})
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
percent: //小数类型;焦距缩放百分比
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getZoomPercent(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setZoomByPercent
设置摄像头显示焦距缩放百分比(仅android支持)
setZoomByPercent({params})
param
percent:
- 类型:小数类型
- 描述:焦距百分比值
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setZoomByPercent({
percent:,
},function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
applyPermission
设备授权相关的接口(仅iOS支持)
applyPermission(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
state:'' //布尔类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.applyPermission(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
startLive
开始直播
startLive(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.startLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
cameraStart
开启摄像头
cameraStart(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.cameraStart(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
cameraStop
关闭摄像头
cameraStop(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
var talkFunLive = api.require('talkFunLive');
talkFunLive.cameraStop(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
pauseLive
暂停直播
pauseLive(callback(ret))
param
resetCamera:
- 类型:布尔类型
- 描述:是否释放摄像头(仅android支持)
- 默认:false
callback(ret)
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.pauseLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
resumeLive
恢复直播
resumeLive(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.resumeLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
stopLive
停止直播
stopLive(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.stopLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
liveEmit
触发某个事件(有回调)(仅iOS支持)
liveEmit({params},callback(ret))
params
event:
- 类型:字符串
- 描述:事件
params:
- 类型:JSON对象
- 描述:参数
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.liveEmit({
event:'chat:private',
params:{{"xid":123,"msg":"我是信息内容"}}
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
liveOnEvent
设置问答监听事件
liveOnEvent({params},callback(ret))
params
event:
- 类型:字符串
- 描述:事件,取值范围参考欢拓云官方文档:。(仅iOS支持)
callback(ret)
ret:
- 类型:JSON 对象 Android问答事件参考文档
- 内部字段:
{
status: true, // 布尔类型;是否成功
data:, // Json对象类型;问答消息
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.liveOnEvent({
event:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
bQASendMessage
大班问答发送回复消息(仅android支持)
bQASendMessage({params},callback(ret))
params
replyId:
- 类型:字符串
- 描述:提问id
content:
- 类型:字符串
- 描述:回复内容
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.bQASendMessage({
replyId:'',
content:'',
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
liveOffEvent
取消监听事件
liveOffEvent({params},callback(ret))
params
event:
- 类型:字符串
- 描述:事件
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.liveOffEvent({
event:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getDefinitionList
获取分辨率列表(仅iOS支持)
getDefinitionList(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getDefinitionList(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
setDefinition
设置分辨率(仅iOS支持)
setDefinition({params},callback(ret))
params
config:
- 类型:JSON对象
- 描述:配置参数
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setDefinition({
config:{}
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
可用性
iOS 系统
可提供的 1.0.0 及更高版本
getSpeedLineList
获取可加速的列表(仅iOS支持)
getSpeedLineList(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
speedLineList:[] //数组类型;可加速列表
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getSpeedLineList(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
setSpeedup
设置加速(仅iOS支持)
setSpeedup({params},callback(ret))
params
config:
- 类型:JSON对象
- 描述:配置参数
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setSpeedup({
config:{}
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
setUpdateMemberListener
大班新人数监听(仅android支持)
setUpdateMemberListener({params},callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
eventType: , // 数字类型,1:更新人数,2:更新成员列表
memberNum:, //数字类型,总人数,eventType为1时返回
members:[], //JSON数组类型,成员列表,eventType为2时返回
}
err:
- 类型:JSON 对象
- 内部字段:
{
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setUpdateMemberListener({
},function(ret,err){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
android 系统
可提供的 1.0.0 及更高版本
getMemberList
获取成员列表,需要先连接socket(仅android支持)
getMemberList({params},callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:, //布尔类型;是否成功获取
members:[], //JSON数组类型,成员列表,eventType为2时返回
}
err:
- 类型:JSON 对象
- 内部字段:
{
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getMemberList({
},function(ret,err){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
android 系统
可提供的 1.0.0 及更高版本
initRtcEngineKit
初始化小班直播管理器
initRtcEngineKit({params},callback(ret))
params
courseID:
- 类型:字符串
- 描述:课程ID(仅iOS支持)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.initRtcEngineKit({
courseID:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
destroyRtcEngineKit
销毁小班直播管理器
destroyRtcEngineKit()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.initRtcEngineKit();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
reloadRtcEngineKit
重新加载小班直播管理器
reloadRtcEngineKit()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.reloadRtcEngineKit();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getRtcEngineKitInfo
获取小班直播管理器信息(仅iOS支持)
getRtcEngineKitInfo(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
streamMode:, //数字类型;取值范围
//1:多人合流模式,不自动上讲台
//2:双人合流模式,不自动上讲台
//3:多人合流模式,自动上讲台
//4:双人合流模式,自动上讲台
RTCStatus:, //数字类型;课程在线人数
//0:关闭
//1:开启
liveState:, //数字类型;客户端断网直播超时时间
//0:结束状态
//1:开始状态
orientationMode: //字符串类型;视频输出方向
//portrait
//landscape
//adaptative
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getRtcEngineKitInfo(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
emitRtcEngineKit
触发某个事件(有回调)(仅iOS支持)
emitRtcEngineKit({params},callback(ret))
params
event:
- 类型:字符串
- 描述:课程ID
params:
- 类型:JSON对象
- 描述:参数
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.emitRtcEngineKit({
event:'',
params:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
onEventRtcEngineKit
监听事件,处理回调数据(仅iOS支持)
onEventRtcEngineKit({params},callback(ret))
params
event:
- 类型:字符串
- 描述:课程ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.onEventRtcEngineKit({
event:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
startRtcLive
开始直播
startRtcLive(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.startRtcLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
stopRtcLive
停止直播
stopRtcLive(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.stopRtcLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
openRtcLive
开启讲台
openRtcLive(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码(android返回固定值-1)
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.openRtcLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
closeRtcLive
关闭讲台
closeRtcLive(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.closeRtcLive(function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
switchRtcCamera
切换摄像头
switchRtcCamera()
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.switchRtcCamera();
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getVideoState
获取状态(仅iOS支持)
getVideoState(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
state: true //布尔类型;是否成功
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getVideoState(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
openRtcVideo
打开摄像头
openRtcVideo({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.openRtcVideo({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
closeRtcVideo
关闭摄像头
closeRtcVideo({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.closeRtcVideo({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
openRtcAudio
打开麦克风
openRtcAudio({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.openRtcAudio({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
closeRtcAudio
关闭麦克风
closeRtcAudio({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.closeRtcAudio({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
giveDrawPower
打开涂鸦
giveDrawPower({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.giveDrawPower({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
cancelDrawPower
关闭涂鸦
cancelDrawPower({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.cancelDrawPower({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
awardRtc
奖励(仅iOS支持)
awardRtc({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
score:
- 类型:字符串
- 描述:数量
goodsId:
- 类型:字符串
- 描述:奖励的物品ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.awardRtc({
xid:'',
score:'',
goodsId:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
upRtc
允许上讲台的申请
upRtc({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.upRtc({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
kickRtc
踢下讲台
kickRtc({params},callback(ret))
params
xid:
- 类型:字符串
- 描述:ID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, // 布尔类型;是否成功
}
err:
- 类型:JSON 对象
- 内部字段:
{
code:, // 数字类型;错误码
msg:'' // 字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.kickRtc({
xid:''
},function(ret){
if(ret.status) {
api.alert({msg:JSON.stringify(ret)});
} else {
api.alert({msg:JSON.stringify(err)});
}
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getRtcMemberList
所有在线人员数据(仅iOS支持)
getRtcMemberList(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
result:[] //数组类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getRtcMemberList(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
getRtcAllStudents
所有学员(仅iOS支持)
getRtcAllStudents(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
result:[] //数组类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getRtcAllStudents(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
iOS 系统
可提供的 1.0.0 及更高版本
getRtcApplyList
获取申请上讲台的列表
getRtcApplyList(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
applyList:[] //数组类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getRtcApplyList(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
getRtcUserEntityList
讲台上的用户列表
getRtcUserEntityList(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
userEntityList:[] //数组类型;
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.getRtcUserEntityList(function(ret){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android 、iOS 系统
可提供的 1.0.0 及更高版本
setWhiteBoardPresenter
添加白板操作,需要先初始化白板(仅android支持)
setWhiteBoardPresenter(callback(ret))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setWhiteBoardPresenter(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setLiveDurationListener
直播时长监听(仅android支持)
setLiveDurationListener(callback(ret))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
duration:, //数字类型;直播时长
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setLiveDurationListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setLiveDurationListener
直播时长监听(仅android支持)
setLiveDurationListener(callback(ret))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
duration:, //数字类型;直播时长
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setLiveDurationListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setLiveListener
设置开启直播,关闭直播,及主播被踢出的监听(仅android支持)
setLiveListener(callback(ret))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
state:, //数字类型;监听状态
//1:开启直播成功
//2:开启直播失败
//3:关闭直播成功
//4:关闭直播失败
//5:主播被踢出,服务端可以将主播踢出直播间。
errMsg:'', //字符串类型;失败错误信息
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setLiveListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setRtcMediaStatusListener
设置视频连麦多媒体状态的监听(仅android支持)
setRtcMediaStatusListener(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
state:, //数字类型;监听状态
//1:摄像头开启
//2:摄像头关闭
//3:音频 开启
//4:音频关闭
userEntity:'', //Json对象类型;用户数据
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setRtcMediaStatusListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setRtcErrorListener
设置连麦错误监听(仅android支持)
setRtcErrorListener(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
errCode: //数字类型;错误码
errMsg:, //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setRtcErrorListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setWhiteboardPowerListener
设置涂鸦权限的监听(仅android支持)
setWhiteboardPowerListener(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
state:, //数字类型;监听状态
//1:白板授权
//2:白板取消
userEntity:'', //Json对象类型;用户数据
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setWhiteboardPowerListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setWhiteboardRecoverListener
设置涂鸦权限的监听(仅android支持)
setWhiteboardRecoverListener(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
recoverSuccess:, //布尔类型;
}
err:
- 类型:JSON对象
内部字段:
{
code:, //数字类型;错误码
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setWhiteboardRecoverListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setRtcStatusListener
设置视频状态连接监听(仅android支持)
setRtcStatusListener(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
state:, //数字类型;
//1:连接中断
//2:重连成功
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setRtcStatusListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
});
可用性
Android
可提供的 1.0.0 及更高版本
setRtcMemberListener
rtc人员相关监听(仅android支持)
setRtcMemberListener(callback(ret,err))
callback(ret,err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;
state:, //数字类型;变化状态
//1:踢出
//2:上线
//3:下线
//4:离线
//5:申请
//6:取消申请
userEntity:, //Json对象类型;学员数据,state为1、2、3、4时返回
applyEntity:, //Json对象类型;申请学员数据,state为5、6时返回
}
err:
- 类型:JSON对象
内部字段:
{
msg:'', //字符串类型;错误信息
}
示例代码
var talkFunLive = api.require('talkFunLive');
talkFunLive.setRtcMemberListener(function(ret,err){
api.alert({msg:JSON.stringify(ret)});
可提供的 1.0.0 及更高版本