talkFun

立即使用

概述

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

注意:

如果talkFun模块不和scrollVideo模块一块使用,需要添加附加模块

下载 changeIconAppendix 模块

直播接口

画板操作类

RTC操作类

点播播放

模块接口

getRoomInfo

获取房间信息

getRoomInfo(callback)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    action:'',         // 字符串;直播状态
    roomid:'',         // 字符串;房间ID(仅支持安卓)
    user:obj,          // JSON对象;用户信息(仅支持安卓)
    zhuBo:obj,         // JSON对象;主播信息(仅支持安卓)
    liveTitle:'',      // 字符串;直播标题(仅支持安卓)
    noticeEntity:obj,  // JSON对象;公告信息 (仅支持安卓)
    rollEntity:obj,    // JSON对象;滚动信息 (仅支持安卓)
    disableall:0,       // 数字;禁言状态; (仅支持安卓)
    startTime:11111       // 数字;直播起始时间 (仅支持安卓)

    roomInfo:''        //JSON对象;房间信息(仅支持iOS)
    visitorInfo:''        //JSON对象;访客信息(仅支持iOS)

}

示例代码

var talkFun = api.require('talkFun');
talkFun.getRoomInfo(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getInitLiveStatus

获取直播状态

getInitLiveStatus

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:'wait',         // 字符串;直播状态
}
  • status 取值范围:
    • wait 等待
    • start 开始
    • stop 停止

示例代码

var talkFun = api.require('talkFun');
talkFun.getInitLiveStatus(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setLiveListener

直播事件监听

setLiveListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'onLaunch',         // 字符串;事件类型
    msg:''                    // 字符串;错误消息(仅onInitFail事件返回)
}
  • event 取值范围:
    • onLaunch 初始化完成 (仅支持安卓)
    • onInitFail 初始化失败 (仅支持安卓)
    • onLiveStart 直播开始
    • onLiveStop 直播结束
    • memberForceout 被挤下线
    • memberKick 被踢出房间

示例代码

var talkFun = api.require('talkFun');
talkFun.setLiveListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

init

初始化播放器和白板

init

Params

videoRect:

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

whiteBoardRect:

  • 描述:白板的窗口位置及大小
  • 类型:JSON对象
{
    x:0,    // 窗口的左边距;默认:0
    y:0,    // 窗口的上边距;默认:0
    w:100,  // 窗口的宽度;默认:100
    h:100   // 窗口的高度;默认:100
}

mode: (仅支持安卓)

  • 描述:播放模式
  • 类型:字符串
  • 取值:
    • normal 大班模式
    • mix 大班互动模式
    • rtc 小班模式

accessToken:

  • 描述:访问token
  • 类型:字符串

videoBgColor:

  • 描述:视频播放器背景颜色;默认:(#FFFFFF)(支持 #FFFFFF,#rgba)
  • 类型:字符串

whiteBoardBgColor:

  • 描述:白板背景颜色;默认:(#FFFFFF)(支持 #FFFFFF,#rgba)
  • 类型:字符串

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

  • 类型:布尔
  • 描述:((可选项)模块是否随所属 Window 或 Frame 滚动
  • 默认值:false

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,         // 布尔类型;状态返回
}

示例代码

var talkFun = api.require('talkFun');
talkFun.init({
    videoRect:{
        x:0,
        y:0,
        w:300,
        h:300
    },
    whiteBoardRect:{
        x:0,
        y:0,
        w:100,
        h:100
    },
    accessToken:''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

close

关闭直播或点播播放器

close

示例代码

var talkFun = api.require('talkFun');
talkFun.close();

可用性

Android & ios系统

可提供的1.0.0及更高版本

setOnVideoChangeListener

播放器状态监听事件

setOnVideoChangeListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event: onVideoStart,         // 字符串类型;播放器事件
    mode:'',                     // 字符串类型;视频模式类型
    onVideoModeChanging:''       // 字符串类型;当前视频模式(仅onVideoModeChanging事件返回)
}
  • event取值范围:

    • onVideoStart 开始播放
    • onVideoStop 播放停止
    • onVideoModeChanging 模式切换 (仅支持安卓)
    • onVideoModeChanged 模式切换完成
    • onCameraShow 摄像头显示
    • onCameraHide 摄像头隐藏
  • mode取值范围

    • camera 摄像头视频类型
    • desktop 桌面分享视频类型
    • rtc RTC 视频类型

示例代码

var talkFun = api.require('talkFun');
talkFun.setOnVideoChangeListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setOnUserEventListener

播放器状态监听事件

setOnUserEventListener

Params

cmdType:

  • 描述:用户事件类型
  • 类型:字符串类型
  • 取值范围:
    • MEMBER_JOIN_OTHER 新用户进入直播间
    • MEMBER_TOTAL 在线用户总数
    • MEMBER_LEAVE 用户离开房间
    • MEMBER_KICK 踢人
    • MEMBER_FORCEOUT 被人强迫下线

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    result:{}  // 返回结果;JSON对象
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setOnUserEventListener({
    cmdType:'MEMBER_JOIN_OTHER'
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

chatSend

发送聊天

chatSend

Params

text:

  • 描述:文本消息
  • 类型:字符串类型

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true, // 布尔类型;消息发送状态;
    info:obj     // JSON对象;返回信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.chatSend({
    text:'Hello world!!!'
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setOnChatEventListener

聊天事件监听

setOnChatEventListener

Params

cmdType:

  • 描述:用户事件类型
  • 类型:字符串类型
  • 取值范围:
    • CHAT_DISABLE 禁言 //ios禁言与解除禁言切换
    • CHAT_ENABLE 解除禁言 //ios禁言与解除禁言切换
    • CHAT_DISABLE_ALL 全体禁言 //ios全体禁言与解除全体禁言切换
    • CHAT_ENABLE_ALL 全体解禁 //ios全体禁言与解除全体禁言切换

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    result:{}  // 返回结果;JSON对象
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setOnChatEventListener({
    cmdType:'CHAT_DISABLE'
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtDispatchChatMessageListener

数据接收接口

setHtDispatchChatMessageListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    chatEntity : {                // JSON对象;返回结果;聊天信息
        xid:'',               // 字符串;用户唯一ID
        uid:'',                  // 字符串;合作方用户ID
        nickname:'',          // 字符串;用户昵称
        role:'',              // 字符串;用户角色
        gender:'',            // 字符串;用户性别
        avatar:'',            // 字符串;用户头像地址
        msg:'',               // 字符串;消息内容
        time:''               // 字符串;时间戳
    }
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtDispatchChatMessageListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

questionAsk

提问

questionAsk

Params

text:

  • 描述:文本消息
  • 类型:字符串类型

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true, // 布尔类型;消息发送状态;
    info:obj     // JSON对象;返回信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.questionAsk({
    text:'Hello world!!!'
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

questionReply

回答提问

questionReply

Params

replyId:

  • 描述:回复的提问ID
  • 类型:字符串类型

text:

  • 描述:文本消息
  • 类型:字符串类型

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true, // 布尔类型;消息发送状态;
    info:obj     // JSON对象;返回信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.questionReply({
    text:'Hello world!!!'
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtDispatchQuestionListener

接收问答

setHtDispatchQuestionListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    questionEntity : {                // JSON对象;返回结果;问答信息
        id:'',                   // 字符串;问答ID
        xid:'',           // 字符串;用户唯一ID
        uid:'',           // 字符串;合作方用户ID
        replyId:'',           // 字符串;回复的问题ID
        role:'',          // 字符串;角色
        content:'',           // 字符串;内容
        nickname:'',          // 字符串;昵称
        answerList:array,     // JSONArray;回复列表
        isAnswer:'',           // 布尔类型    ;是否为回复
        isHasAnswer:'',       // 布尔类型;是否有回复
        time:''           // 字符串;时间戳
    }
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtDispatchQuestionListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

sendVote

发送投票

sendVote

Params

vid:

  • 描述:投票id
  • 类型:字符串

opts:

  • 描述:选择序号(从1开始算起)数组的字符串 ;例:"[1,2]"
  • 类型:字符串

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true, // 布尔类型;投票是否成功;
}

示例代码

var talkFun = api.require('talkFun');
talkFun.sendVote({
    vid:'',
    opts:"[1, 2]"
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtVoteListener

投票监听

setHtVoteListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'voteStart',
    voteEntity:obj
}
  • event 取值范围

    • voteStart 投票开始
    • voteStop 投票结束
  • Android voteEntity 字段信息可参考

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtVoteListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtLotteryListener

抽奖监听

setHtLotteryListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'lotteryStart', // 字符串;抽奖时间
    lotteryEntity:obj    //(仅在event为lotteryStop时有值)
}
  • event 取值范围

    • lotteryStart 抽奖开始
    • lotteryStop 抽奖结束
  • Android lotteryEntity 字段信息可参考

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtLotteryListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

sendFlower

送花

sendFlower

示例代码

var talkFun = api.require('talkFun');
talkFun.sendFlower();

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtDispatchFlowerListener

花朵事件监听

setHtDispatchFlowerListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'flowerNum', // 字符串;抽奖时间
    flowerNum:10, // 字符串;鲜花数量(仅在event为flowerNum时)
    flowerLeftTime:0, // 数字;花朵获取剩余时间(仅在event为flowerLeftTime时)
    flowerSuccessMsg:'' // 字符串;发送花朵成功后信息(仅在event为sendFlowerSuccess时)仅支持安卓
}
  • event 取值范围
    • flowerNum 鲜花数量
    • flowerLeftTime 花朵获取剩余时间
    • sendFlowerSuccess 发送花朵成功

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtDispatchFlowerListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtDispatchNoticeListener

发布公告事件监听

setHtDispatchNoticeListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    noticeEntity:obj, //JSON对象;公告信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtDispatchNoticeListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtDispatchRollAnnounceListener

发布滚动公告事件监听

setHtDispatchRollAnnounceListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    rollEntity:obj, //JSON对象;公告信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtDispatchNoticeListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setHtBroadcastListener

发布广播公告事件监听

setHtBroadcastListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    broadcastEntity :obj, //JSON对象;公告信息
}
  • Android broadcastEntity 字段信息可参考

示例代码

var talkFun = api.require('talkFun');
talkFun.setHtBroadcastListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getBroadcastsUnreceived

获取未收到的广播数据

getBroadcastsUnreceived

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true, // 布尔;获取是否成功
    result :obj, // JSON对象;广播数据
    errMsg:''    // 字符串;错误信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.getBroadcastsUnreceived(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getAllBroadcasts

获取全部的广播数据

getAllBroadcasts

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true, // 布尔;获取是否成功
    result :obj, // JSON对象;广播数据
    errMsg:''    // 字符串;错误信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.getAllBroadcasts(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

sendScore

发送评分

sendScore

Params

contentScore:

  • 描述:教学内容评分
  • 类型:数字
  • 取值:[1,30]

methodScore:

  • 描述:教学方法评分
  • 类型:数字
  • 取值:[1,30]

effectScore:

  • 描述:教学效果评分
  • 类型:数字
  • 取值:[1,40]

msg:

  • 描述:留言消息
  • 类型:字符串

示例代码

var talkFun = api.require('talkFun');
talkFun.sendScore({
    contentScore:20,
    methodScore:20,
    effectScore:20,
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setRtcStatusListener

rtc状态监听

setRtcStatusListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'onOpen', // 布尔;获取是否成功
}
  • event 取值:
    • onOpen rtc开启
    • onClose rtc关闭
    • onConnectionInterrupted rtc中断
    • onReConnectSuccess rtc重连成功

示例代码

var talkFun = api.require('talkFun');
talkFun.setRtcStatusListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setLiveDurationListener

直播时长监听

setLiveDurationListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    totalTime:1000000, // 数字;直播总时长
    time:''   //JSON类型;(仅支持iOS)
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setLiveDurationListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setPaintColor

设置画笔颜色

setPaintColor

params

color:

  • 描述:画笔颜色
  • 类型:字符串
  • 默认:黑色 BlackColor, //黑 RedColor, //红 YellowColor, //黄 GreenColor, //绿 BlueColor, //蓝 BrownColor , //棕 WhiteColor , //白 WhiteCyanColor , //青色 WhitePurpleColor //紫色

示例代码

var talkFun = api.require('talkFun');
talkFun.setPaintColor(function(ret){
    color:'#F00'
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setStrokeWidth

设置画笔粗细

setStrokeWidth

params

size:

  • 描述:画笔粗细
  • 类型:数字
  • 默认:2
  • 2, //小 4, //中 6, //大 8, 10 // 特大

示例代码

var talkFun = api.require('talkFun');
talkFun.setStrokeWidth({
    size:10
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setTextSize

文字大小

setTextSize

params

textSize:

  • 描述:字体大小
  • 类型:数字
  • 默认:20
  • 20, //小 25, //中 30, //大 35 //特大

示例代码

var talkFun = api.require('talkFun');
talkFun.setTextSize({
    textSize:10
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setDrawType

涂鸦类型

setDrawType

params

type:

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

示例代码

var talkFun = api.require('talkFun');
talkFun.setDrawType({
    type:'arrow'
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

undoDrawable

撤销

undoDrawable

示例代码

var talkFun = api.require('talkFun');
talkFun.undoDrawable();

可用性

Android & ios系统

可提供的1.0.0及更高版本

redoDrawable

还原

redoDrawable

示例代码

var talkFun = api.require('talkFun');
talkFun.redoDrawable();

可用性

Android & ios系统

可提供的1.0.0及更高版本

setWhiteboardPowerListener

涂鸦权限监听

setWhiteboardPowerListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'onDrawEnable' // 涂鸦是否可用
}
  • event 取值:
    • onDrawEnable 涂鸦可用
    • onDrawDisable 涂鸦不可用

示例代码

var talkFun = api.require('talkFun');
talkFun.setWhiteboardPowerListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setRtcMemberListener

人员上麦监听

setRtcMemberListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'onKick'     // 字符串;事件类型
    rtcUserEntity:obj, // JSON对象;rtc用户信息(在event为onInvite是该参数为空)
    reason:0           // 数字;离线原因(仅在event为onOffline时有效)
}
  • event 取值:
    • onKick 用户被踢下讲台。
    • onUp 用户上讲台
    • onDown 用户下讲台。
    • onOffline 用户离线。
    • onInvite 用户被邀请上讲台。

示例代码

var talkFun = api.require('talkFun');
talkFun.setRtcMemberListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setRtcMediaStatusListener (仅支持安卓)

音视频状态监听

setRtcMediaStatusListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'onVideoClose'     // 字符串;事件类型
    rtcUserEntity:obj, // JSON对象;rtc用户信息
}
  • event 取值:
    • onVideoClose 用户关闭视频
    • onVideoOpen 用户打开视频
    • onAudioOpen 用户打开音频
    • onAudioClose 用户关闭音频

示例代码

var talkFun = api.require('talkFun');
talkFun.setRtcMediaStatusListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

apply

申请上讲台

apply

示例代码

var talkFun = api.require('talkFun');
talkFun.apply();

可用性

Android & ios系统

可提供的1.0.0及更高版本

down

主动下讲台

down

示例代码

var talkFun = api.require('talkFun');
talkFun.down();

可用性

Android & ios系统

可提供的1.0.0及更高版本

cancel

取消上讲台申请

cancel

示例代码

var talkFun = api.require('talkFun');
talkFun.cancel();

可用性

Android & ios系统

可提供的1.0.0及更高版本

closeVideo

关闭摄像头

closeVideo

示例代码

var talkFun = api.require('talkFun');
talkFun.closeVideo();

可用性

Android & ios系统

可提供的1.0.0及更高版本

openVideo

打开摄像头

openVideo

示例代码

var talkFun = api.require('talkFun');
talkFun.openVideo();

可用性

Android & ios系统

可提供的1.0.0及更高版本

openAudio

麦克风 关闭静音

openAudio

示例代码

var talkFun = api.require('talkFun');
talkFun.openAudio();

可用性

Android & ios系统

可提供的1.0.0及更高版本

closeAudio

麦克风 打开静音

closeAudio

示例代码

var talkFun = api.require('talkFun');
talkFun.closeAudio();

可用性

Android & ios系统

可提供的1.0.0及更高版本

swapVideo (仅支持iOS)

前后摄像头调换

swapVideo

示例代码

var talkFun = api.require('talkFun');
talkFun.swapVideo();

可用性

Android & ios系统

可提供的1.0.0及更高版本

respondInvite

邀请上讲台响应

respondInvite

Params

type:

  • 类型:字符串
  • 描述:响应邀请
  • 取值:
    • accept 接受邀请
    • reject 拒绝邀请

示例代码

var talkFun = api.require('talkFun');
talkFun.respondInvite({
    type:'accept'
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setRtcErrorListener

Rtc错误监听

setRtcErrorListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    code:0, // 数字;错误码
    msg:''  // 字符串;错误信息
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setRtcErrorListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setPlaybackListener (仅支持安卓)

初始化监听

setPlaybackListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'initSuccess', // 字符串;事件类型
    msg:''  // 字符串;错误信息(仅在event为initFail时回调)
}
  • event取值
    • initSuccess 初始化成功
    • initFail 初始化失败

示例代码

var talkFun = api.require('talkFun');
talkFun.setPlaybackListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

playbackResume

播放

playbackResume

示例代码

var talkFun = api.require('talkFun');
talkFun.playbackResume();

可用性

Android & ios系统

可提供的1.0.0及更高版本

playbackPause

暂停

playbackPause

示例代码

var talkFun = api.require('talkFun');
talkFun.playbackPause();

可用性

Android & ios系统

可提供的1.0.0及更高版本

playbackStop (仅支持安卓)

停止

playbackStop

示例代码

var talkFun = api.require('talkFun');
talkFun.playbackStop();

可用性

Android & ios系统

可提供的1.0.0及更高版本

playbackSeekTo

跳转的时间

playbackSeekTo

Params

time:

  • 类型:数字
  • 描述:跳转的时间
  • 单位:秒

示例代码

var talkFun = api.require('talkFun');
talkFun.playbackSeekTo({
    time:10
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

replayVideo (仅支持安卓)

重新播放

replayVideo

示例代码

var talkFun = api.require('talkFun');
talkFun.replayVideo();

可用性

Android & ios系统

可提供的1.0.0及更高版本

getVideoCurrentTime (仅支持安卓)

获取当前播放时间

getVideoCurrentTime

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    currentTime:10   // 数字;当前播放时间
}

示例代码

var talkFun = api.require('talkFun');
talkFun.getVideoCurrentTime(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getVideoCurrentStatus

获取当前播放状态

getVideoCurrentStatus

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    state:''   // 字符串;当前播放状态
     - Stop    
    - Playing 
    - Pause   
    - Seeking 
    - Error   
}

示例代码

var talkFun = api.require('talkFun');
talkFun.getVideoCurrentStatus(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getPlaybackInfo

获取点播信息(需要在初始化成功后调用即 initSuccess 事件后调用)

getPlaybackInfo

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   result:{}
}

示例代码

var talkFun = api.require('talkFun');
talkFun.getPlaybackInfo(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

initPlayback

初始化点播播放器

initPlayback

Params

videoRect:

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

whiteBoardRect:

  • 描述:白板的窗口位置及大小
  • 类型:JSON对象
{
    x:0,    // 窗口的左边距;默认:0
    y:0,    // 窗口的上边距;默认:0
    w:100,  // 窗口的宽度;默认:100
    h:100   // 窗口的高度;默认:100
}

videoBgColor:

  • 描述:视频播放器背景颜色;默认:(#FFFFFF)(支持 #FFFFFF,#rgba)
  • 类型:字符串

whiteBoardBgColor:

  • 描述:白板背景颜色;默认:(#FFFFFF)(支持 #FFFFFF,#rgba)
  • 类型:字符串

accessToken:

  • 描述:访问token
  • 类型:字符串

playBackId:

  • 描述:房间ID
  • 类型:字符串

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

  • 类型:布尔
  • 描述:((可选项)模块是否随所属 Window 或 Frame 滚动
  • 默认值:false

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,         // 布尔类型;状态返回
}

示例代码

var talkFun = api.require('talkFun');
talkFun.initPlayback({
    videoRect:{
        x:0,
        y:0,
        w:300,
        h:300
    },
    whiteBoardRect:{
        x:0,
        y:0,
        w:100,
        h:100
    },
    accessToken:''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setOnVideoChangeListener (仅支持安卓)

初始化监听

setOnVideoChangeListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'initSuccess', // 字符串;事件类型
    msg:''  // 字符串;错误信息(仅在event为initFail时回调)
}
  • event取值
    • initSuccess 初始化成功
    • initFail 初始化失败

示例代码

var talkFun = api.require('talkFun');
talkFun.setPlaybackListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setOnPlayerLoadStateChangeListener (仅支持安卓)

视频缓冲监听

setOnPlayerLoadStateChangeListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'bufferingStart', // 字符串;事件类型
}
  • event取值
    • bufferingStart 缓冲开始
    • bufferingEnd 缓冲结束

示例代码

var talkFun = api.require('talkFun');
talkFun.setPlaybackListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getChatList

获取聊天列表

getChatList

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    chatList:[{chatEntity}] // JSONArray类型;聊天列表
}

示例代码

var talkFun = api.require('talkFun');
talkFun.getChatList(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setChatListener (仅支持安卓)

设置回放聊天获取数据监听

setChatListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'msgSuccess', // 字符串;事件类型
    position:100,       // 数字类型;当前消息在消息列表中的位置
}
  • event取值
    • msgSuccess 获取消息成功
    • msgFailed 获取消息失败

示例代码

var talkFun = api.require('talkFun');
talkFun.setChatListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getRawQuestionList

获取问答数据

getRawQuestionList

Params

duration: (仅支持iOS)

  • 描述:问答的时间点
  • 类型:数字

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    questionList:[{questionEntity}] // JSONArray类型;问答列表
}
  • Android questionEntity详细参数可参考

示例代码

var talkFun = api.require('talkFun');
talkFun.getRawQuestionList(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setQuestionListener (仅支持安卓)

设置回放问答获取数据监听

setQuestionListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'msgSuccess', // 字符串;事件类型
    position:100,       // 数字类型;当前消息在问答列表中的位置
}
  • event取值
    • msgSuccess 获取问答成功
    • msgFailed 获取问答失败

示例代码

var talkFun = api.require('talkFun');
talkFun.setQuestionListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getAlbumList

获取专辑信息

getAlbumList

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    albumList:[{AlbumItemEntity}] // JSONArray类型;专辑信息列表
}
  • Android AlbumItemEntity详细参数可参考

示例代码

var talkFun = api.require('talkFun');
talkFun.getAlbumList(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getCurrentAlbumIndex (仅支持安卓)

获取当前播放专辑索引

getCurrentAlbumIndex

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    albumIndex:0   // 数字;当前专辑的索引
}

示例代码

var talkFun = api.require('talkFun');
talkFun.getCurrentAlbumIndex(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

playAlbum (仅支持安卓)

播放专辑

playAlbum

Params

index:

  • 类型:数字
  • 描述:需要播放专辑的索引

示例代码

var talkFun = api.require('talkFun');
talkFun.playAlbum({
    index:0
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setPlaybackPlaySpeed

倍数播放

setPlaybackPlaySpeed

Params

speed:

  • 类型:浮点数
  • 描述:播放倍速
  • 取值范围:(0-2],传入0即为暂停

示例代码

var talkFun = api.require('talkFun');
talkFun.setPlaybackPlaySpeed({
    speed:1.25
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

requestPlaybackData (仅支持安卓)

预加载点播信息

requestPlaybackData

Params

token:

  • 类型:字符串
  • 描述:视频点播token

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    data:obj,   // JSON对象;点播数据
    code:0,     // 数字;错误码(获取信息失败时返回)
    msg:''      // 字符串;错误信息(获取信息失败时返回)
}

示例代码

var talkFun = api.require('talkFun');
talkFun.requestPlaybackData({
    token:''
}, function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setADVideoContainer

添加广告容器

setADVideoContainer

Params

adRect:

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

示例代码

var talkFun = api.require('talkFun');
talkFun.setADVideoContainer({
    adRect:{
        x:0,
        y:0,
        w:300,
        h:300
    }
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setADVideoContainerConfig (仅支持安卓)

添加广告容器

setADVideoContainerConfig

Params

bgColor:

  • 描述:视频容器背景颜色(#FFF,#FFFFFF,#rgba)
  • 类型:字符串

示例代码

var talkFun = api.require('talkFun');
talkFun.setADVideoContainerConfig({
    bgColor:'#F00'
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

skipAD

跳过广告

skipAD

示例代码

var talkFun = api.require('talkFun');
talkFun.skipAD();

可用性

Android & ios系统

可提供的1.0.0及更高版本

setADVideoListener

广告视频监听

setADVideoListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    event:'prepare', // 字符串;事件类型
    adConfig:obj,    // JSON对象;广告配置(event为prepare时返回)
    status:0,        // 数字;播放状态(event为videoStatusChange时返回)
    time:10000       // 数字;倒计时时长(event为countDownTime时返回)
}
  • event取值
    • prepare 广告配置
    • videoStatusChange 播放状态
    • countDownTime 倒计时时长

adConfig & status 参数详情参考

示例代码

var talkFun = api.require('talkFun');
talkFun.setADVideoListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setBroadcastListener

设置广播监听

setBroadcastListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    onBroadcast:obj,        // JSON对象;与播放时间同步的广播 (仅支持安卓)
    onBroadcastArray:array  // JSONArray;当前课程所有的广播
}

示例代码

var talkFun = api.require('talkFun');
talkFun.setBroadcastListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

desktopListener (仅支持iOS)

桌面分享监听

desktopListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    event:'', // 字符串;事件类型
       - start,    
        - stop 
}

示例代码

var talkFun = api.require('talkFun');
talkFun.desktopListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

vodCameraShowHideLisener (仅支持iOS)

点播摄像头的显示与隐藏的监听

vodCameraShowHideLisener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    state:'', // 字符串;
   - show  //显示
   - hide  //隐藏

}

示例代码

var talkFun = api.require('talkFun');
talkFun.vodCameraShowHideLisener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

setLiveNetworkSpeedListener (仅支持iOS)

直播网速监听

setLiveNetworkSpeedListener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    speed:'', // 字符串;
    status:'', // 数字类型;0:网速好;1:网速一般;2:网速差



}

示例代码

var talkFun = api.require('talkFun');
talkFun.setLiveNetworkSpeedListener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

liveCameraShowHideLisener (仅支持iOS)

直播摄像头显示还是隐藏的监听

liveCameraShowHideLisener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    state:'', // 字符串;
   - show  //显示
   - hide  //隐藏

}

示例代码

var talkFun = api.require('talkFun');
talkFun.liveCameraShowHideLisener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

liveDesktopShareLisener (仅支持iOS)

直播桌面分享监听

liveDesktopShareLisener

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    event:'', // 字符串;
   - start  //开始
   - stop  //停止
   - pause //暂停

}

示例代码

var talkFun = api.require('talkFun');
talkFun.liveDesktopShareLisener(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getLiveAllVote (仅支持iOS)

直播获取全部投票

getLiveAllVote

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    result:'', // JSON对象


}

示例代码

var talkFun = api.require('talkFun');
talkFun.getLiveAllVote(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

getLiveUnreciveVote (仅支持iOS)

直播获取未收到的投票

getLiveUnreciveVote

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

    result:'', // JSON对象


}

示例代码

var talkFun = api.require('talkFun');
talkFun.getLiveUnreciveVote(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本

RTCinit

初始化小班(RTC)播放器

RTCinit

Params

videoRect:

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

whiteBoardRect:

  • 描述:白板的窗口位置及大小
  • 类型:JSON对象
{
    x:0,    // 窗口的左边距;默认:0
    y:0,    // 窗口的上边距;默认:0
    w:100,  // 窗口的宽度;默认:100
    h:100   // 窗口的高度;默认:100
}

accessToken:

  • 描述:访问token
  • 类型:字符串

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,         // 布尔类型;状态返回
}

示例代码

var talkFun = api.require('talkFun');
talkFun.RTCinit({
    videoRect:{
        x:0,
        y:0,
        w:300,
        h:300
    },
    whiteBoardRect:{
        x:0,
        y:0,
        w:100,
        h:100
    },
    accessToken:''
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android & ios系统

可提供的1.0.0及更高版本