在线教学、视频会议 Webus Fox（3） 客户端开发手册

本文主要介绍webus fox 客户端的配置及接口说明。

1. 文件列表和配置

1.1 文件列表

1.2 common.xml 配置

根据服务器端的部署， 替换[ServerUrl] , [RtmpPort], [GatewayPort]

[GatewayPort]: 指的是iis 里的site的port

2. 相关接口说明

2.1. 消息

2.1.1 MessageClient/MsgClient.as

API名称	start
应用场景	启动message消息， 连接服务并登陆
异常

API名称	close
应用场景	关闭连接
异常

API名称	getAllOnlineUsers
应用场景	获取在线用户列表
Contract	QueryAllOnlineUserReqContract
异常

API名称	sendMsg
应用场景	发送消息给制定用户
Contract	CommonMessageContract
异常

API名称	broadcast
应用场景	广播消息， 发送通知给其他用户
Contract	BroadcastContract
异常

API名称	BeingKickedOut
应用场景	用户被挤出或者被踢出
Contract
异常

2.1.2. MessageClient/MsgClientHandler.as

API名称	onFriendConnected
应用场景	接收到其他用户上下线通知
Contract	FriendNotifyContract
异常

API名称	onCommMsg
应用场景	接收到其他用户消息 information type = 0为文本消息
Contract	CommonMessageContract
异常

API名称	onBroadcast
应用场景	接收到其他用户发出的广播消息 information type = 0为文本消息
Contract	BroadcastContract
异常

API名称	onGetUsers
应用场景	得到服务器端发送的在线用户列表
Contract	QueryAllOnlineUserResContract
异常

2.2. 视频 音频

2.2.1. Videoclient/videoClientHandler.as

API名称	onMicBtnClick
应用场景	选择或者取消 发布本地的音频
异常

API名称	onCarmerBtnClick
应用场景	选择或者取消发布本地视频
异常

API名称	onSoundBtnClick
应用场景	选择或者取消静音
异常

API名称	audioAutoPlay
应用场景	登录以后 自动开启语音
异常

2.2.2. AudioVideoController

API名称	playVideoStream
应用场景	播放视频流
异常

API名称	closePlayVideoStream
应用场景	停止播放视频流
异常

API名称	playAudioMulticast
应用场景	播放音频
异常

API名称	closeAudioMulticast
应用场景	停止播放音频
异常

API名称	publishVideoStream
应用场景	发布视频流
异常

API名称	closeVideoStreamPublish
应用场景	停止发布视频流
异常

API名称	publishAudioStream
应用场景	发布音频流
异常

API名称	closeAudioStreamPublish
应用场景	停止发布音频流
异常

2.3. 白板

PaintClient/PaintClientHandler.as

API名称	onDeleteView
应用场景	删除图形
异常

API名称	onAddView
应用场景	添加图形
异常

API名称	onChangePage
应用场景	改变课件页数
异常

API名称	initSO
应用场景	初始化shared object
异常

API名称	handleSyncTest
应用场景	同步shared object
异常

2.4. 上传下载

Utils/UploadFileHandler.as

API名称	onFileHandlerComplete
应用场景	已选择文件， 准备上传
异常

API名称	uploadFile
应用场景	上传文件
异常

API名称	uploadResult
应用场景	文件上传进度 结果
异常

API名称	onShareFile
应用场景	共享文件 生成课件
异常

API名称	onDownloadFile
应用场景	下载文件
异常

API名称	onDeleteFile
应用场景	删除文件
异常

3. 客户端下载

http://yunpan.cn/cmeTGGzPxJDLF  访问密码 7e2f

在线教学、视频会议 Webus Fox（1）文本、语音、视频聊天及电子白板基本用法

在线教学、视频会议 Webus Fox（2） 服务端开发手册

在线教学、视频会议 Webus Fox（3） 客户端开发手册