talkFunLive

立即使用

概述

欢拓是一家以直播技术为核心的网络平台，旨在帮助人们通过网络也能实现真实互动通讯。从2010年开始，欢拓就专注于音频、视频的采样、编码、后处理及智能传输研究,并于2013年底正式推出了针对企业/开发者的直播云服务系统，帮助开发者轻松实现真人互动。该系统适用场景包括在线教育、游戏语音、娱乐互动、远程会议（PC、移动均可）等等。详情参考欢拓云官方网站：https://www.talk-fun.com。

欢拓云有观看端 SDK 和直播端 SDK。原生 SDK 下载地址是：https://www.talk-fun.com/newsArticle/156.html.

talkFun 模块封装了欢拓云的观看端 SDK。

talkFunLive 模块封装了欢拓云的直播端 SDK。

直播公共接口——登录

initCloudLive loginByUserId loginByToken cancelLogin logout getUserInfo isLogin

直播公共接口——课程

createCourse loadCourses
checkAllowedToLive

直播公共接口——白板

setWhiteBoardView setPaintColor setTextSize setDrawType nextPage prePage gotoPage addWhiteBoard undoDrawable redoDrawable clearPage scrollUp scrollDown setScroll destoryWhiteBoard getCurrentPage getTotalPage startSendOperateCommand stopSendOperateCommand addPageDatas setStrokeSize

直播类接口补充——登录

getUserFolder getID

直播类接口补充——课程

createCurriculum verifyLivingOrNot launch

直播类接口补充——白板

whiteboardBringToFront setLineRgbColor getCurrentIndex getCurrentSubPage getCurrentSubIndex closeWhiteboard hideWhiteboard showWhiteboard canUndo canRedo insertWhiteboard clearData execute

设置接口

clearCache getCacheSize getBeauty setBeauty getGraffiti setGraffiti getAutoUpload
setAutoUpload

文档接口

getDocumentListOfCourse getDocument addDocument insertDocument scanLocalFile stopScanLocalFile getScanDocList upload processProgress stopAll cancelUpload
isUploadOrCovering

直播公共接口——聊天

sendMessage setUpdateChatListener

直播公共接口——Socket

socketConnect socketDisconnect socketIsConnected socketEmit setSocketEmitListener cancleSocketEmitListener setSocketConnectListener

大班直播

initLiveManager shutdownManager getLiveManagerInfo setLiveManagerInfo setLiveView closeLiveView hideLiveView
showLiveView liveViewBringToFront
streamStatusChangedListener liveStatusChangedListener
liveDelayListener livePacketLossListener
setLiveCameraFront swapCamera getSendFrameRate isMute setIsMute isCloseCamera setOrientation getOrientation getZoomPercent applyPermission
startLive
cameraStart cameraStop
pauseLive
resumeLive stopLive
liveEmit
liveOnEvent bQASendMessage liveOffEvent
getDefinitionList setDefinition
getSpeedLineList setSpeedup
setUpdateMemberListener getMemberList

小班直播

initRtcEngineKit destroyRtcEngineKit reloadRtcEngineKit getRtcEngineKitInfo emitRtcEngineKit onEventRtcEngineKit startRtcLive
stopRtcLive openRtcLive
closeRtcLive switchRtcCamera
getVideoState openRtcVideo
closeRtcVideo openRtcAudio
closeRtcAudio
giveDrawPower cancelDrawPower
awardRtc
upRtc kickRtc
getRtcMemberList
getRtcAllStudents getRtcApplyList
getRtcUserEntityList setWhiteBoardPresenter setLiveDurationListener setLiveListener setRtcMediaStatusListener setRtcErrorListener setWhiteboardPowerListener setWhiteboardRecoverListener setRtcStatusListener setRtcMemberListener

模块接口

initCloudLive

初始化云直播

initCloudLive

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；初始化是否成功
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.initCloudLive(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

loginByUserId

通过用户id登录

loginByUserId

Params

userId:

  • 类型：字符串
  • 描述：用户ID

password：

  • 类型：字符串
  • 描述：密码

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；登录是否成功
  3. }

err:

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:0,             // 数字类型；错误码
  3.     msg:''              // 字符串；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.loginByUserId({
  3.     userId:'',
  4.     password:''
  5. },function(ret,err){
  6.     alert(JSON.stringify(ret));
  7. });

可用性

Android 、 iOS 系统

可提供的 1.0.0 及更高版本

loginByToken

通过token登录

loginByToken

Params

token:

  • 类型：字符串
  • 描述：令牌

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；登录是否成功
  3. }

err:

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:0,             // 数字类型；错误码
  3.     msg:''              // 字符串；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.loginByToken({
  3.     token:''
  4. },function(ret,err){
  5.     alert(JSON.stringify(ret));
  6. });

可用性

Android 、 iOS 系统

可提供的 1.0.0 及更高版本

cancelLogin

取消登录，iOS端无此接口

cancelLogin

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.cancelLogin();

可用性

Android 系统

可提供的 1.0.0 及更高版本

logout

退出登录

logout

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.logout();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

isLogin

判断是否已登录

isLogin

callback(ret)

ret:

  • 类型：JSON 对象
  • 描述：返回值
  1. {
  2.     isLogin:true
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.isLogin(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getUserInfo

获取用户信息

getUserInfo

callback(ret)

ret:

  • 类型：JSON 对象
  • 描述：返回值
  1. {
  2.     userInfo:{}    // JSON对象；用户信息
  3. }

  • Android userInfo 详细字段可参考 详情

    示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getUserInfo(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

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 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；创建课程是否成功
  3. }

err:

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:0,             // 数字类型；错误码
  3.     msg:''              // 字符串；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.destory();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

loadCourses

加载课程

loadCourses

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回对象
  1. {
  2.     courseList:[{courseData}] // JSON列表；返回课程列表
  3. }
  • 注意：courseData为课程数据

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.loadCourses(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

setWhiteBoardView

设置白板

setWhiteBoardView({params},function(ret))

Params

rect:

  • 描述：视频播放器的窗口位置及大小
  • 类型：JSON对象
  1. {
  2.     x:0,    // 窗口的左边距；默认：0
  3.     y:0,    // 窗口的上边距；默认：0
  4.     w:300,  // 窗口的宽度；默认：300
  5.     h:300   // 窗口的高度；默认：300
  6. }

fixedOn：

  • 描述：附着frame或window的名称
  • 类型：字符串

fixed:

  • 描述：是否固定
  • 类型：布尔类型

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：返回对象
  1. {
  2.     status:true // 布尔类型；是否设置成功
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setWhiteBoardView({
  3.     ret:{
  4.         x:0,
  5.         y:0,
  6.         w:200,
  7.         h:200
  8.     },
  9.     fixedOn:'',
  10.     fixed:true
  11. },function(ret){
  12.     alert(JSON.stringify(ret));
  13. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

startSendOperateCommand

发送操作命令，仅支持 Android 端

startSendOperateCommand

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.startSendOperateCommand();

可用性

Android 系统

可提供的 1.0.0 及更高版本

stopSendOperateCommand

停止发送操作命令，仅支持 Android 端

stopSendOperateCommand

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.stopSendOperateCommand();

可用性

Android 系统

可提供的 1.0.0 及更高版本

addPageDatas

添加文档数据，仅支持 Android 端

addPageDatas

Params

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.addPageDatas();

可用性

Android 系统

可提供的 1.0.0 及更高版本

nextPage

下一页

nextPage

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.nextPage();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

prePage

上一页

prePage

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.prePage();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

gotoPage

跳转到指定页

gotoPage

Params

position：

  • 类型：数字
  • 描述：跳转页

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.gotoPage({
  3.     position:2
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getTotalPage

获取总页数

getTotalPage

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     totalPage:1
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getTotalPage(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getCurrentPage

获取当前页数

getCurrentPage

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     currentPage:1
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getCurrentPage(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

undoDrawable

撤销

undoDrawable

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.undoDrawable();

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

redoDrawable

还原

redoDrawable

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.redoDrawable();

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

clearPage

清除当前页涂鸦

clearPage

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.clearPage();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

setPaintColor

设置画笔颜色

setPaintColor

Params

color：

  • 类型：字符串
  • 描述：画笔颜色，支持#FFF，#FFFFFF， rgba()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setPaintColor({
  3.     color:'#000'
  4. });

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

setTextSize

设置文字大小

setTextSize

Params

textSize

  • 类型：数字类型
  • 描述：文字大小，仅支持Android端

textSizeStr

  • 类型：字符串
  • 描述：文字大小，仅支持iOS端
  • 取值范围：
    • small：
    • middle：
    • big：
    • huge：

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setTextSize({
  3.     textSize:15
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

setStrokeSize

画笔的粗细，仅支持 Android 端

setStrokeSize

Params

strokeSize

  • 类型：数字类型
  • 描述：画笔粗细

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setStrokeSize({
  3.     strokeSize:15
  4. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

setDrawType

涂鸦类型

setDrawType

Params

type：

  • 类型：字符串
  • 描述：画笔粗细
  • 取值：
    • path 曲线 (仅支持安卓)
    • line 直线.
    • rectangle 矩形.
    • oval 圆.
    • arrow 箭头.
    • text 文字.
    • dotted_line 虚线.
    • image 图片 (仅支持安卓)
    • mixed 混合 (仅支持安卓)
    • clear 清除 (仅支持安卓)
    • stroke 画笔 （仅支持iOS）
    • boxDelete 框删除 （仅支持iOS）

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setDrawType({
  3.     type:'path'
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

addWhiteBoard

添加白板

addWhiteBoard

Params

color：

  • 类型：字符串
  • 描述：白板颜色，支持#FFF，#FFFFFF， rgba()

isInsertDocBefore：

  • 类型：布尔
  • 描述：是否将白板插到文档之前

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.addWhiteBoard({
  3.     color:'#000'
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

scrollUp

向上滚动

scrollUp

Params

offset：

  • 类型：数字
  • 描述：（可选项）滚动距离，仅支持iOS端
  • 默认：10

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.scrollUp();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

scrollDown

向下滚动

scrollDown

Params

offset：

  • 类型：数字
  • 描述：（可选项）滚动距离，仅支持iOS端
  • 默认：10

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.scrollDown();

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

setScroll

设置是否可以滚动

setScroll

Params

isScroll:

  • 类型：布尔
  • 描述：是否可以滚动 （只有长图才能滚动）

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setScroll({
  3.     isScroll:true
  4. });

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

destoryWhiteBoard

数据清除

destoryWhiteBoard

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.destoryWhiteBoard();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getUserFolder

获取user information(已经登录才有）

getUserFolder

callback(ret)

ret：

  • 类型：JSON对象
  • 描述：返回值
  • 内部字段
  1. {
  2.        userFolder:''        //字符串类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getUserFolder(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getID

获取ID（登录过才有）（仅iOS支持）

getID

callback(ret)

ret：

  • 类型：JSON对象
  • 描述：返回值
  • 内部字段
  1. {
  2.        ID:''        //字符串类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getID(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

createCurriculum

根据参数创建课程

createCurriculum

params

params：

  • 类型：JSON对象（仅iOS支持）
  • 描述：参数

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 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.createCurriculum({
  3.    params:{}
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.         api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

checkAllowedToLive

进入课程检测是否允许进入直播（仅android支持）

checkAllowedToLive

params

courseId：

  • 类型：字符串类型
  • 描述：loadCourses 接口返回课程信息中course_id

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否允许直播 
  3.     course:.            //Json对象类型；允许直播课程
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.checkAllowedToLive({
  3.    courseId:'',
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.         api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

verifyLivingOrNot

验证账号是否在直播（仅iOS支持）

verifyLivingOrNot

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.verifyLivingOrNot(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.         api.alert({msg:JSON.stringify(err)});
  7.     }
  8. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

launch

启动课程直播（仅iOS支持）

launch

params

courseID：

  • 类型：字符串
  • 描述：课程ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.launch({
  3.    courseID:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.         api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

whiteboardBringToFront

蒋白板置为最上层显示（仅iOS支持）

whiteboardBringToFront

params

fixedOn：

  • 描述：附着frame或window的名称
  • 类型：字符串

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.whiteboardBringToFront({ 
  3.     fixedOn:''
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

setLineRgbColor

设置line颜色（仅iOS支持，android参考setPaintColor接口）

setLineRgbColor

params

color：

  • 类型：字符串
  • 描述：设置line颜色，支持rgba、rgb、#

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setLineRgbColor({ 
  3.     color:''
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getCurrentIndex

获取当前索引（仅iOS支持，android参考getCurrentPage）

getCurrentIndex(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     currentIndex:1
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getCurrentIndex(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

getCurrentSubPage

获取当前子页码（仅iOS支持）

getCurrentSubPage(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     currentSubPage:1
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getCurrentSubPage(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

getCurrentSubIndex

获取当前子页索引（仅iOS支持）

getCurrentSubIndex(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     currentSubIndex:1
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getCurrentSubIndex(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

closeWhiteboard

关闭白板

closeWhiteboard

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.closeWhiteboard();

可用性

android、iOS 系统

可提供的 1.0.0 及更高版本

showWhiteboard

显示白板

showWhiteboard

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.showWhiteboard();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

hideWhiteboard

隐藏白板

hideWhiteboard

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.hideWhiteboard();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

canUndo

是否能够撤退（仅iOS支持）

canUndo(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     canUndo:false        //布尔类型
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.canUndo(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

canRedo

是否能够前进（仅iOS支持）

canRedo(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     canRedo:false        //布尔类型
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.canRedo(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

insertWhiteboard

插入白板,根据当前的索引,再添加在后面（仅iOS支持，android参考addWhiteBoard接口）

insertWhiteboard(callback(ret))

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.insertWhiteboard();

可用性

iOS 系统

可提供的 1.0.0 及更高版本

clearData

清除所有页码的涂鸦（仅iOS支持，android参考clearPage接口）

clearData(callback(ret))

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.clearData();

可用性

iOS 系统

可提供的 1.0.0 及更高版本

execute

传入指令 执行操作，仅支持 iOS 端

setScroll

Params

command:

  • 类型：JSON对象
  • 描述：命令集

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.execute({
  3.     command:true
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

clearCache

清除缓存

getDocumentListOfCourse()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.clearCache();

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

getCacheSize

获取缓存大小

getCacheSize(callback(ret,err))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     cacheSize:         //数字类型；（仅iOS支持）
  3.     seze:'',         //字符串类型；（仅android支持）
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getCacheSize(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android、iOS 系统

可提供的 1.0.0 及更高版本

getBeauty

获取是否美颜

getBeauty(callback(ret,err))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     beauty:         //布尔类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getBeauty(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

setBeauty

设置是否开启美颜

setBeauty({params},callback(ret,err))

params

isOn：

  • 类型：布尔
  • 描述：是否开启美颜

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setBeauty({ 
  3.     isOn:false
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getGraffiti

获取是否开启涂鸦状态

getGraffiti(callback(ret,err))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     graffiti:         //布尔类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getGraffiti(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

setGraffiti

设置涂鸦开关状态

setGraffiti({params},callback(ret,err))

params

isOn：

  • 类型：布尔
  • 描述：是否开启涂鸦

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setGraffiti({ 
  3.     isOn:false
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getAutoUpload

获取 自动上传开关 状态

getAutoUpload(callback(ret,err))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     autoUpload:         //布尔类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getAutoUpload(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

setAutoUpload

设置 自动上传开关 状态

setAutoUpload({params},callback(ret,err))

params

isOn：

  • 类型：布尔
  • 描述：是否开启自动上传

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setAutoUpload({ 
  3.     isOn:false
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getDocumentListOfCourse

获取文档列表

getDocumentListOfCourse({params},callback(ret,err))

params

course_id：

  • 类型：字符串
  • 描述：课程名称id（仅iOS支持）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功
  3.     data:[{               //数组类型；
  4.        thumbnail:,
  5.        name:,
  6.        ID:‘’
  7.     }]
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getDocumentListOfCourse({ 
  3.     course_id:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getDocument

根据PPT课件ID获取相应课件信息（仅iOS支持）

getDocument

params

courseWareID：

  • 类型：字符串

  • 描述：课件ID

    callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getDocument({ 
  3.     courseWareID:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

addDocument

根据PPT课件ID加载课件 清空原文档与清空白板（仅iOS支持）

addDocument

params

courseWareID：

  • 类型：字符串

  • 描述：课件ID

    callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.addDocument({ 
  3.     courseWareID:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

insertDocument

根据PPT课件ID加载课件 清空原文档,保留白板

insertDocument

params

courseWareID：

  • 类型：字符串

  • 描述：课件ID

    callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.insertDocument({ 
  3.     courseWareID:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

scanLocalFile

扫描本地文件接口（仅android支持）

scanLocalFile

params

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.scanLocalFile({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

stopScanLocalFile

停止扫描本地文件接口（仅android支持）

stopScanLocalFile

params

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.stopScanLocalFile({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

getScanDocList

获取已扫描本地文件接口（仅android支持）

getScanDocList

params

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3.     data:[{}]             //数组类型；扫描到的本地文件
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getScanDocList({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

upload

提供courseID和文件文件的地址 上传图片或文档，返回上传结果

upload

params

files：

  • 类型：数组
  • 描述：文件路径组成的数组，元素为字符串类型，要求本地路径（fs://）(仅iOS支持)

courseID：

  • 类型：字符串
  • 描述：课程ID（仅iOS支持）

index：

  • 类型：数字类型
  • 描述：getScanDocList接口返回数据中index，调用此接口前需先调用getScanDocList接口（仅android支持）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.upload({ 
  3.     courseID:'',
  4.     index:,
  5. },function(ret){
  6.     if(ret.status) {
  7.         api.alert({msg:JSON.stringify(ret)});
  8.     } else {
  9.        api.alert({msg:JSON.stringify(err)});
  10.     }
  11. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

cancelUpload

取消上传某个文档

cancelUpload

params

courseID：

  • 类型：字符串
  • 描述：课程ID

index：

  • 类型：数字类型
  • 描述：getScanDocList接口返回数据中index，调用此接口前需先调用getScanDocList接口（仅android支持）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.cancelUpload({ 
  3.     courseID:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

sendMessage

发送消息（仅android支持）

sendMessage

params

content：

  • 类型：字符串
  • 描述：消息内容

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.sendMessage({ 
  3.     content:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

setUpdateChatListener

设置更新聊天内容监听（仅android支持）

setUpdateChatListener

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     newNum:,        //数字类型；更新条数
  4.     chatMessages:   //JSON数组类型；消息列表
  5. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setUpdateChatListener({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

socketConnect

连接socket（仅android支持）

socketConnect

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.socketConnect();

可用性

Android 系统

可提供的 1.0.0 及更高版本

socketDisconnect

断开socket（仅android支持）

socketDisconnect

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.socketDisconnect();

可用性

Android 系统

可提供的 1.0.0 及更高版本

socketIsConnected

判断socket是否已连接（仅android支持）

sendMessage

params

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否已连接
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.socketIsConnected({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

socketEmit

发送消息（仅android支持）

socketEmit

params

cmd：

  • 类型：字符串类型
  • 描述：指令

args：

  • 类型：Json对象类型
  • 描述：参数

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否出错
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:''         // 字符串类型；错误信息
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.socketEmit({ 
  3. cmd:'',
  4. args:{},
  5. },function(ret){
  6.     if(ret.status) {
  7.         api.alert({msg:JSON.stringify(ret)});
  8.     } else {
  9.        api.alert({msg:JSON.stringify(err)});
  10.     }
  11. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

setSocketEmitListener

注册指令事件监听（仅android支持）

setSocketEmitListener

params

cmd：

  • 类型：字符串类型
  • 描述：指令

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     args:[],         //Json数组类型；收到该指令的参数
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setSocketEmitListener({ 
  3. cmd:'',
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

cancleSocketEmitListener

取消指令事件监听（仅android支持）

cancleSocketEmitListener

params

cmd：

  • 类型：字符串类型
  • 描述：（可选项）指令，不传此参数则取消所有指令监听

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:,         //J布尔类型；是否取消成功
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.cancleSocketEmitListener({ 
  3. cmd:'',
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

setSocketConnectListener

设置socket连接监听（仅android支持）

setSocketConnectListener

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:,         //J布尔类型；
  3.         state:,       //数字类型；当前连接状态
  4.                           //1：连接中
  5.                           //2：重连中
  6.                           //3：连接成功
  7.                           //4：连接失败
  8.                           //5：重连失败
  9. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setSocketConnectListener({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

stopAll

停止所有文档上传和转换（仅android支持 ）

stopAll

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.stopAll({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android

可提供的 1.0.0 及更高版本

processProgress

轮询文件处理进度

processProgress(callback(ret))

params

courseID：

  • 类型：字符串
  • 描述：课程ID（仅iOS支持）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3.     file:{},       //Json对象类型；上传文件信息
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.processProgress({ 
  3.     courseID:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

isUploadOrCovering

是否正在上传或转换文档（仅android支持）

isUploadOrCovering(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3.     isUploading:,       //布尔类型；是否正在上传或转换文档
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.isUploadOrCovering({ 
  3. },function(ret){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

Android

可提供的 1.0.0 及更高版本

initLiveManager

初始化大班直播管理器

initLiveManager({params},callback(ret))

params

courseID：

  • 类型：字符串
  • 描述：课程ID（仅iOS支持）

courseName：

  • 类型：字符串
  • 描述：课程名（仅iOS支持）

startTimeDetai：

  • 类型：字符串
  • 描述：课程ID（仅iOS支持）

endTimeDetail：

  • 类型：字符串
  • 描述：课程名（仅iOS支持）

rect:

  • 类型：JSON对象
  • 描述：视频播放器的窗口位置及大小（仅android支持）
  1. {
  2.     x:0,    // 窗口的左边距；默认：0
  3.     y:0,    // 窗口的上边距；默认：0
  4.     w:300,  // 窗口的宽度；默认：300
  5.     h:300   // 窗口的高度；默认：300
  6. }

fixedOn：

  • 类型：字符串
  • 描述：附着frame或window的名称（仅android支持）

fixed:

  • 类型：布尔类型
  • 描述：是否固定（仅android支持）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.initLiveManager({ 
  3.     courseID:'',
  4.     courseName:'',
  5.     startTimeDetai:'',
  6.     endTimeDetail:''
  7. },function(ret){
  8.     if(ret.status) {
  9.         api.alert({msg:JSON.stringify(ret)});
  10.     } 
  11. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

shutdownManager

销毁大班直播管理器

shutdownManager()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.shutdownManager();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getLiveManagerInfo

获取大班直播管理器信息（仅iOS支持）

getLiveManagerInfo(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     courseID:'',         //字符串类型；ID
  3.     micGain:,            //数字类型；麦克风音量增益因子，初始化时默认为1.0，推流开始后可以修改，其取值范围为[0, 1]
  4.     memberTotal:,        //数字类型；课程在线人数
  5.     timeoutSeconds:,     //数字类型；客户端断网直播超时时间
  6.     duration:,           //数字类型；已直播时长
  7.     zoomScale:,          //数字类型；对原始视频进行缩放的比例，初始化时默认为1，推流开始后可以修改，其取值范围为(1, 3]
  8.     networkStatus:,      //数字类型；网络状态
  9.                          //1:没有网络
  10.                          //2:wifi
  11.                          //3:WWAN
  12.                          //4:其它
  13.     beauty:,             //布尔类型；是否设置美颜
  14.     saveLocalVideo:,     //布尔类型；视频录制 开关
  15.     autorotate:,         //布尔类型；是否自动旋转(这里只支持 left 变 right  portrait 变 portraitUpsideDown)
  16.     outputImageOrientation://字符串类型；视频输出方向
  17. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getLiveManagerInfo(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

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 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3.     courseID:''           //字符串类型；配置的对象的ID
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setLiveManagerInfo({ 
  3.     micGain:0.5,
  4.     zoomScale:2,
  5.     beauty:true
  6. },function(ret){
  7.     if(ret.status) {
  8.         api.alert({msg:JSON.stringify(ret)});
  9.     } 
  10. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

setLiveView

设置大班直播的画面（仅iOS支持，android在initLiveManager接口配置）

setLiveView({params})

Params

rect:

  • 类型：JSON对象
  • 描述：视频播放器的窗口位置及大小
  1. {
  2.     x:0,    // 窗口的左边距；默认：0
  3.     y:0,    // 窗口的上边距；默认：0
  4.     w:300,  // 窗口的宽度；默认：auto
  5.     h:300   // 窗口的高度；默认：auto
  6. }

fixedOn：

  • 类型：字符串
  • 描述：附着frame或window的名称

fixed:

  • 类型：布尔类型
  • 描述：是否固定

bgColor：

  • 类型：字符串
  • 描述：背景色，支持rgba、rgb、#

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setLiveView({
  3.     ret:{
  4.         x:0,
  5.         y:0,
  6.         w:200,
  7.         h:200
  8.     },
  9.     fixedOn:'',
  10.     fixed:true
  11. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

closeLiveView

关闭大班直播的画面

closeLiveView()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.closeLiveView();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

hideLiveView

隐藏大班直播的画面

hideLiveView()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.hideLiveView();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

showLiveView

显示大班直播的画面

showLiveView()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.showLiveView();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

liveViewBringToFront

蒋大班直播画面置为最上层显示（仅iOS支持）

liveViewBringToFront

params

fixedOn：

  • 描述：附着frame或window的名称
  • 类型：字符串

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.liveViewBringToFront({ 
  3.     fixedOn:''
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

streamStatusChangedListener

设置大班直播视频流状态改变的监听

streamStatusChangedListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     state: 0         // 数字类型；取值范围
  3.                      //0:准备（仅iOS支持）
  4.                      //1:连接中
  5.                      //2:已连接
  6.                      //3:已断开（仅iOS支持）
  7.                      //4:连接出错
  8.                      //5:正在刷新（仅iOS支持）
  9.                      //6：推流成功 （仅android支持）
  10.                      //7：推流失败（仅android支持）
  11.                      //8：写入失败（仅android支持）
  12.                      //9：停止直播推流成功（仅android支持）
  13.                      //10：停止直播推流失败（仅android支持）
  14. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.streamStatusChangedListener(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

liveStatusChangedListener

设置大班直播状态的监听

liveStatusChangedListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: 0         // 数字类型；取值范围
  3.                      //0:结束（仅iOS支持）
  4.                      //1:暂停（仅iOS支持）
  5.                      //2:直播（仅iOS支持）
  6.                      //3:准备完毕（仅iOS支持）
  7.                      //4:失败 （仅iOS支持）
  8.                      //5：开始直播成功（仅android支持）
  9.                      //6：开始直播失败（仅android支持）
  10.                      //7： 结束直播成功（仅android支持）
  11.                      //8：结束直播失败（仅android支持）
  12.      reason:'',       //字符串类型，开始失败或结束失败原因（仅android支持）
  13. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.liveStatusChangedListener(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

liveDelayListener

设置大班直播延时的监听（仅iOS支持）

liveDelayListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     delay: ''         //字符串类型；延时
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.liveDelayListener(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

livePacketLossListener

设置大班直播的丢包的监听（仅iOS支持）

livePacketLossListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     percentage:''         //字符串类型；丢包
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.livePacketLossListener(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

setLiveCameraFront

蒋大班直播画面置为前置摄像头（仅iOS支持）

setLiveCameraFront({params})

params

isFront：

  • 类型：字符串
  • 描述：是否启用前置摄像头

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setLiveCameraFront({ 
  3.     isFront:false
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

swapCamera

切换摄像头（仅android支持）

swapCamera({params})

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.swapCamera({ 
  3. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

getSendFrameRate

获取直播流帧率（仅android支持）

getSendFrameRate({params})

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     rate:        //数字类型；帧率
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getSendFrameRate(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

isMute

获取是否静音（仅android支持）

isMute({params})

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     mute:        //布尔类型；是否静音
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.isMute(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

setIsMute

设置是否静音（仅android支持）

setIsMute({params})

param

mute：

  • 类型：布尔类型
  • 描述：是否静音
  • 默认值：true

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setIsMute({
  3. mute:true
  4. },function(ret){
  5.         api.alert({msg:JSON.stringify(ret)});
  6. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

isCloseCamera

获取是否已关闭摄像头（仅android支持）

isCloseCamera({params})

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     closed:        //布尔类型；是否关闭
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.isCloseCamera(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

setOrientation

设置屏幕方向（仅android支持）

setOrientation({params})

param

orientation：

  • 类型：数字类型
  • 描述：屏幕方向

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setOrientation({
  3.     orientation:,
  4. },function(ret){
  5.         api.alert({msg:JSON.stringify(ret)});
  6. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

getOrientation

获取屏幕方向（仅android支持）

getOrientation({params})

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     orientation:        //数字类型；屏幕方向
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getOrientation(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

getZoomPercent

获取焦距缩放百分比（仅android支持）

getZoomPercent({params})

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     percent:        //小数类型；焦距缩放百分比
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getZoomPercent(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

setZoomByPercent

设置摄像头显示焦距缩放百分比（仅android支持）

setZoomByPercent({params})

param

percent：

  • 类型：小数类型
  • 描述：焦距百分比值

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setZoomByPercent({
  3.     percent:,
  4. },function(ret){
  5.         api.alert({msg:JSON.stringify(ret)});
  6. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

applyPermission

设备授权相关的接口（仅iOS支持）

applyPermission(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     state:''         //布尔类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.applyPermission(function(ret){
  3.         api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

startLive

开始直播

startLive(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.startLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     }
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

cameraStart

开启摄像头

cameraStart(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.cameraStart(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     }
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

cameraStop

关闭摄像头

cameraStop(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.cameraStop(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     }
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

pauseLive

暂停直播

pauseLive(callback(ret))

param

resetCamera:

  • 类型：布尔类型
  • 描述：是否释放摄像头(仅android支持)
  • 默认：false

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.pauseLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     }
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

resumeLive

恢复直播

resumeLive(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.resumeLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     }
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

stopLive

停止直播

stopLive(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.stopLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     }
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

liveEmit

触发某个事件(有回调)（仅iOS支持）

liveEmit({params},callback(ret))

params

event：

  • 类型：字符串
  • 描述：事件

params：

  • 类型：JSON对象
  • 描述：参数

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.liveEmit({ 
  3.     event:'chat:private',
  4.     params:{{"xid":123,"msg":"我是信息内容"}}
  5. },function(ret){
  6.     if(ret.status) {
  7.         api.alert({msg:JSON.stringify(ret)});
  8.     } else {
  9.        api.alert({msg:JSON.stringify(err)});
  10.     }
  11. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

liveOnEvent

设置问答监听事件

liveOnEvent({params},callback(ret))

params

event：

callback(ret)

ret：

  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3.     data:,            // Json对象类型；问答消息
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.liveOnEvent({ 
  3.     event:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

bQASendMessage

大班问答发送回复消息（仅android支持）

bQASendMessage({params},callback(ret))

params

replyId：

  • 类型：字符串
  • 描述：提问id

content：

  • 类型：字符串
  • 描述：回复内容

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.bQASendMessage({ 
  3.     replyId:'',
  4.     content:'',
  5. },function(ret){
  6.     if(ret.status) {
  7.         api.alert({msg:JSON.stringify(ret)});
  8.     } else {
  9.        api.alert({msg:JSON.stringify(err)});
  10.     }
  11. });

可用性

Android 系统

可提供的 1.0.0 及更高版本

liveOffEvent

取消监听事件

liveOffEvent({params},callback(ret))

params

event：

  • 类型：字符串
  • 描述：事件

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.liveOffEvent({ 
  3.     event:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getDefinitionList

获取分辨率列表（仅iOS支持）

getDefinitionList(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     definitionList:[]         //数组类型；分辨率列表 
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getDefinitionList(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

setDefinition

设置分辨率（仅iOS支持）

setDefinition({params},callback(ret))

params

config：

  • 类型：JSON对象
  • 描述：配置参数

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setDefinition({ 
  3.     config:{}
  4. },function(ret){
  5.    if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

getSpeedLineList

获取可加速的列表（仅iOS支持）

getSpeedLineList(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     speedLineList:[]         //数组类型；可加速列表 
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getSpeedLineList(function(ret){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

setSpeedup

设置加速（仅iOS支持）

setSpeedup({params},callback(ret))

params

config：

  • 类型：JSON对象
  • 描述：配置参数

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setSpeedup({ 
  3.     config:{}
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     }
  10. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

setUpdateMemberListener

大班新人数监听（仅android支持）

setUpdateMemberListener({params},callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: ,         // 数字类型，1：更新人数，2：更新成员列表
  3.     memberNum:,  //数字类型，总人数，eventType为1时返回
  4.     members:[],      //JSON数组类型，成员列表，eventType为2时返回
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:''         // 字符串类型；错误信息
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setUpdateMemberListener({ 
  3. },function(ret,err){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

android 系统

可提供的 1.0.0 及更高版本

getMemberList

获取成员列表,需要先连接socket（仅android支持）

getMemberList({params},callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:,  //布尔类型；是否成功获取
  3.     members:[],      //JSON数组类型，成员列表，eventType为2时返回
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:''         // 字符串类型；错误信息
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getMemberList({ 
  3. },function(ret,err){
  4.     if(ret.status) {
  5.         api.alert({msg:JSON.stringify(ret)});
  6.     } else {
  7.        api.alert({msg:JSON.stringify(err)});
  8.     }
  9. });

可用性

android 系统

可提供的 1.0.0 及更高版本

initRtcEngineKit

初始化小班直播管理器

initRtcEngineKit({params},callback(ret))

params

courseID：

  • 类型：字符串
  • 描述：课程ID（仅iOS支持）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.initRtcEngineKit({ 
  3.     courseID:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } 
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

destroyRtcEngineKit

销毁小班直播管理器

destroyRtcEngineKit()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.initRtcEngineKit();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

reloadRtcEngineKit

重新加载小班直播管理器

reloadRtcEngineKit()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.reloadRtcEngineKit();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getRtcEngineKitInfo

获取小班直播管理器信息（仅iOS支持）

getRtcEngineKitInfo(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. { 
  2.     streamMode:,     //数字类型；取值范围
  3.                      //1:多人合流模式，不自动上讲台
  4.                      //2:双人合流模式，不自动上讲台
  5.                      //3:多人合流模式，自动上讲台
  6.                      //4:双人合流模式，自动上讲台
  7.     RTCStatus:,      //数字类型；课程在线人数
  8.                      //0:关闭
  9.                      //1:开启
  10.     liveState:,      //数字类型；客户端断网直播超时时间
  11.                      //0:结束状态
  12.                      //1:开始状态
  13.     orientationMode: //字符串类型；视频输出方向
  14.                      //portrait
  15.                      //landscape
  16.                      //adaptative
  17. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getRtcEngineKitInfo(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

emitRtcEngineKit

触发某个事件(有回调)（仅iOS支持）

emitRtcEngineKit({params},callback(ret))

params

event：

  • 类型：字符串
  • 描述：课程ID

params：

  • 类型：JSON对象
  • 描述：参数

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.emitRtcEngineKit({ 
  3.     event:'',
  4.     params:''
  5. },function(ret){
  6.     if(ret.status) {
  7.         api.alert({msg:JSON.stringify(ret)});
  8.     } else {
  9.        api.alert({msg:JSON.stringify(err)});
  10.     } 
  11. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

onEventRtcEngineKit

监听事件，处理回调数据（仅iOS支持）

onEventRtcEngineKit({params},callback(ret))

params

event：

  • 类型：字符串
  • 描述：课程ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.onEventRtcEngineKit({ 
  3.     event:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

startRtcLive

开始直播

startRtcLive(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.startRtcLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     } 
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

stopRtcLive

停止直播

stopRtcLive(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.stopRtcLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     } 
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

openRtcLive

开启讲台

openRtcLive(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码（android返回固定值-1）
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.openRtcLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     } 
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

closeRtcLive

关闭讲台

closeRtcLive(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.closeRtcLive(function(ret){
  3.     if(ret.status) {
  4.         api.alert({msg:JSON.stringify(ret)});
  5.     } else {
  6.        api.alert({msg:JSON.stringify(err)});
  7.     } 
  8. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

switchRtcCamera

切换摄像头

switchRtcCamera()

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.switchRtcCamera();

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getVideoState

获取状态（仅iOS支持）

getVideoState(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     state: true         //布尔类型；是否成功 
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getVideoState(function(ret){
  3.     api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

openRtcVideo

打开摄像头

openRtcVideo({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.openRtcVideo({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

closeRtcVideo

关闭摄像头

closeRtcVideo({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.closeRtcVideo({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

openRtcAudio

打开麦克风

openRtcAudio({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.openRtcAudio({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

closeRtcAudio

关闭麦克风

closeRtcAudio({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.closeRtcAudio({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

giveDrawPower

打开涂鸦

giveDrawPower({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.giveDrawPower({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

cancelDrawPower

关闭涂鸦

cancelDrawPower({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.cancelDrawPower({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

awardRtc

奖励（仅iOS支持）

awardRtc({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

score：

  • 类型：字符串
  • 描述：数量

goodsId：

  • 类型：字符串
  • 描述：奖励的物品ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.awardRtc({ 
  3.     xid:'',
  4.     score:'',
  5.     goodsId:''
  6. },function(ret){
  7.     if(ret.status) {
  8.         api.alert({msg:JSON.stringify(ret)});
  9.     } else {
  10.        api.alert({msg:JSON.stringify(err)});
  11.     } 
  12. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

upRtc

允许上讲台的申请

upRtc({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.upRtc({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

kickRtc

踢下讲台

kickRtc({params},callback(ret))

params

xid：

  • 类型：字符串
  • 描述：ID

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,         // 布尔类型；是否成功 
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:,         // 数字类型；错误码
  3.     msg:''         // 字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.kickRtc({ 
  3.     xid:''
  4. },function(ret){
  5.     if(ret.status) {
  6.         api.alert({msg:JSON.stringify(ret)});
  7.     } else {
  8.        api.alert({msg:JSON.stringify(err)});
  9.     } 
  10. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getRtcMemberList

所有在线人员数据（仅iOS支持）

getRtcMemberList(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     result:[]         //数组类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getRtcMemberList(function(ret){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

getRtcAllStudents

所有学员（仅iOS支持）

getRtcAllStudents(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     result:[]         //数组类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getRtcAllStudents(function(ret){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

iOS 系统

可提供的 1.0.0 及更高版本

getRtcApplyList

获取申请上讲台的列表

getRtcApplyList(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     applyList:[]         //数组类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getRtcApplyList(function(ret){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

getRtcUserEntityList

讲台上的用户列表

getRtcUserEntityList(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     userEntityList:[]         //数组类型；
  3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.getRtcUserEntityList(function(ret){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android 、iOS 系统

可提供的 1.0.0 及更高版本

setWhiteBoardPresenter

添加白板操作，需要先初始化白板（仅android支持）

setWhiteBoardPresenter(callback(ret))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setWhiteBoardPresenter(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setLiveDurationListener

直播时长监听（仅android支持）

setLiveDurationListener(callback(ret))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     duration:,      //数字类型；直播时长
  4. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setLiveDurationListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setLiveDurationListener

直播时长监听（仅android支持）

setLiveDurationListener(callback(ret))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     duration:,      //数字类型；直播时长
  4. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setLiveDurationListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setLiveListener

设置开启直播，关闭直播，及主播被踢出的监听（仅android支持）

setLiveListener(callback(ret))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     state:,      //数字类型；监听状态
  4.                     //1：开启直播成功
  5.                     //2：开启直播失败
  6.                     //3：关闭直播成功
  7.                     //4：关闭直播失败
  8.                     //5：主播被踢出，服务端可以将主播踢出直播间。
  9.       errMsg:'',     //字符串类型；失败错误信息
  10. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setLiveListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setRtcMediaStatusListener

设置视频连麦多媒体状态的监听（仅android支持）

setRtcMediaStatusListener(callback(ret,err))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     state:,      //数字类型；监听状态
  4.                     //1：摄像头开启
  5.                     //2：摄像头关闭
  6.                     //3：音频 开启
  7.                     //4：音频关闭
  8.       userEntity:'',     //Json对象类型；用户数据
  9. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setRtcMediaStatusListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setRtcErrorListener

设置连麦错误监听（仅android支持）

setRtcErrorListener(callback(ret,err))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     errCode:         //数字类型；错误码
  3.     errMsg:,      //字符串类型；错误信息
  4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setRtcErrorListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setWhiteboardPowerListener

设置涂鸦权限的监听（仅android支持）

setWhiteboardPowerListener(callback(ret,err))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     state:,      //数字类型；监听状态
  4.                     //1：白板授权
  5.                     //2：白板取消
  6.       userEntity:'',     //Json对象类型；用户数据
  7. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setWhiteboardPowerListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setWhiteboardRecoverListener

设置涂鸦权限的监听（仅android支持）

setWhiteboardRecoverListener(callback(ret,err))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     recoverSuccess:,      //布尔类型；
  4. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. code:,           //数字类型；错误码
    3. msg:'',         //字符串类型；错误信息
    4. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setWhiteboardRecoverListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setRtcStatusListener

设置视频状态连接监听（仅android支持）

setRtcStatusListener(callback(ret,err))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     state:,      //数字类型；
  4.                     //1：连接中断
  5.                     //2：重连成功
  6. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setRtcStatusListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本

setRtcMemberListener

rtc人员相关监听（仅android支持）

setRtcMemberListener(callback(ret,err))

callback(ret,err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；
  3.     state:,      //数字类型；变化状态
  4.                     //1：踢出
  5.                     //2：上线
  6.                     //3：下线
  7.                     //4：离线
  8.                     //5：申请
  9.                     //6：取消申请
  10.      userEntity:,  //Json对象类型；学员数据，state为1、2、3、4时返回
  11.      applyEntity:,   //Json对象类型；申请学员数据，state为5、6时返回
  12. }

err：

  • 类型：JSON对象

  • 内部字段：

    1. {
    2. msg:'',         //字符串类型；错误信息
    3. }

示例代码

  1. var talkFunLive = api.require('talkFunLive');
  2. talkFunLive.setRtcMemberListener(function(ret,err){
  3.      api.alert({msg:JSON.stringify(ret)});
  4. });

可用性

Android

可提供的 1.0.0 及更高版本