多人视频组件通信接口协议.doc

TCM2M多人视频组件通信接口协议
目录TOC\o"1-3"\h\z\u
HYPERLINK\l"_桌面快捷方式接口"1. 桌面快捷方式接口: PAGEREF_Toc\h1
HYPERLINK\l"_房间信息接口:"2. 房间信息接口： 2
HYPERLINK\l"_用户登录会话验证接口:"3. 用户登录会话验证接口: 3
HYPERLINK\l"_用户登录接口:"4. 用户登录接口: 4
HYPERLINK\l"_录制视频接口:"5. 录制视频接口： 5
HYPERLINK\l"_保存共享文献接口:"6. 保存共享文献接口： 6HYPERLINK\l"_Toc"
HYPERLINK\l"_房间共享文献列表接口:"7. 房间共享文献列表接口： 7
HYPERLINK\l"_删除共享文献接口:"8. 删除共享文献接口： 8
HYPERLINK\l"_保存聊天记录接口:"9. 保存聊天记录接口： 9HYPERLINK\l"_Toc"HYPERLINK\l"_修改昵称接口:"10. 修改昵称接口： 10HYPERLINK\l"_Toc"
HYPERLINK\l"_修改密码接口:"11. 修改密码接口： 11
HYPERLINK\l"_解散房间接口:"12. 解散房间接口： 12HYPERLINK\l"_Toc"
HYPERLINK\l"_聊天表情列表接口:"13. 聊天表情接口： 12HYPERLINK\l"_Toc"


RevisionAuthorChangelogV2.0Yong92023-9-8说明：接口地址由合作商提醒，并和我司约定接口参数，由用户操作Flash软件时触发接口请求．接口以http方式通信，并返回XML格式广本流
桌面快捷方式接口
http://接口文献地址/proxy.jsp?action=setDesktop&roomID=xxx&roomName=xxx&roomUrl=xxx
请求方式:POST
接口地址:由合作方提供
参数约定说明:
参数标记类型值说明action字符串setDesktop接口执行的方法名roomID字符串房间IDroomName字符串房间名称roomUrl字符串房间地址http响应内容类型:text/xml
应响结果示例:
<?xmlversion="1.0"encoding="utf-8"?>
<root>
</root>
应响结果说明:无返回值

房间信息接口:
http://接口文献地址/proxy.jsp?action=roomInfo&roomID=xxx
请求方式:POST
接口地址:由合作方提供
参数约定说明:
参数标记类型值说明action字符串roomInfo接口执行的方法名roomID字符串房间ID
http响应内容类型:text/xml
应响结果示例:
<?xmlversion="1.0"encoding="utf-8"?>
<root>
<room>
<id>1</id>
<roomName>课堂</roomName>
<roomMaxUsers>10</roomMaxUsers>
<roomMaxVideos>25</roomMaxVideos>
<discussFlag>1</discussFlag>
<roomMode>1</roomMode>
<autoMic>0</autoMic>
<visitor>0</visitor>
<time></time>
<note>好好学习,天天向上</note>
<rtmptURL></rtmptURL>
</room>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:输出请求房间结果
字段说明:id(房间ID),roomName(房间名称),roomMaxUsers(最大用户数),roomMaxVideos(讨论模式时,视频最多个数,不超过25个),discussFlag(是否允许讨论模式,值只能是1表达允许,0表达不允许),roomMode(0表达培训模式，1表达讨论模式),autoMic(是否设立为自动上麦,值只能是1表达允许自动上麦,0表达不允许),visitor(是否游客进入,值只能是1表达允许游客,0表达不允许),time(上课时间),note(课堂公告),rtmptURL(流媒体地址<red5连接地址>,默认为空,假如有多台服务器才考虑),result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

注意：房间表字段有[id,roomName,room