StarRtc.StarSDK = function () /** * 获取SDK版本号 */ StarRtc.StarSDK.version = function ()
/** * 设置msgServer地址和端口 * @param msgServerUrl msgServer地址 * @param msgServerWebsocketPort msgServer websocket 端口 */ StarRtc.StarSDK.setMsgServerInfo = function (msgServerUrl, msgServerWebsocketPort)
/** * 设置chatRoomServer地址和端口 * @param chatRoomServerUrl chatRoomServer地址 * @param chatRoomServerWebsocketPort chatRoomServer websocket 端口 */ StarRtc.StarSDK.setChatRoomServerInfo = function (chatRoomServerUrl, chatRoomServerWebsocketPort)
/** * 设置srcServer地址和端口 * @param srcServerUrl srcServer地址 * @param srcServerWebsocketPort srcServer websocket 端口 * @param srcServerWebrtcPort srcServer webrtc 端口 * @param srcServerWebrtcIP srcServer webrtc IP(chrome72版本以下、firefox、safari使用),可选,不填写时与Server地址相同 */ StarRtc.StarSDK.setSrcServerInfo = function (srcServerUrl, srcServerWebsocketPort, srcServerWebrtcPort, srcServerWebrtcIP)
/** * 设置vdnServer地址和端口 * @param vdnServerUrl vdnServer地址 * @param vdnServerWebsocketPort vdnServer websocket 端口 * @param vdnServerWebrtcPort vdnServer webrtc 端口 * @param vdnServerWebrtcIP vdnServer webrtc IP(chrome72版本以下、firefox、safari使用),可选,不填写时与Server地址相同 */ StarRtc.StarSDK.setVdnServerInfo = function (vdnServerUrl, vdnServerWebsocketPort, vdnServerWebrtcPort, vdnServerWebrtcIP)
/** * 设置voipServer地址和端口 * @param voipServerUrl voipServer地址 * @param voipServerPort voipServer端口 * @param voipServerWebsocketPort voipServer websocket 端口 * @param voipServerWebrtcPort voipServer webrtc 端口 * @param voipServerWebrtcIP voipServer webrtc IP(chrome72版本以下、firefox、safari使用),可选,不填写时与Server地址相同 */ StarRtc.StarSDK.setVoipServerInfo = function (voipServerUrl, voipServerPort, voipServerWebsocketPort, voipServerWebrtcPort, voipServerWebrtcIP)
/** * 设置是否启用AEC * @param flag 启用标志位 */ StarRtc.StarSDK.setConfigUseAEC = function (flag)
/** * 登录 * @param _agentId 应用id(私有部署时无意义,可为"") * @param _userId 用户id * @param _callback 处理登录的回调函数 */ StarRtc.StarSDK.login = function (_agentId, _userId, _callback)
/** * 登出 */ StarRtc.StarSDK.logout = function ()
/** * 发送单聊消息 * @param _targetId 目标userId * @param _digest digest * @param _txt 正文 * @param _type 消息类型(可选参数) */ StarRtc.StarSDK.sendSingleMsg = function (_targetId, _digest, _txt, _type)
/** * 发送群组消息 * @param _targetGroupId 群组id * @param _digest digest * @param _txt 正文 */ StarRtc.StarSDK.sendGroupMsg = function (_targetGroupId, _digest, _txt)
/** * 发送voip控制消息 * @param _targetId 对方用户Id * @param _code 控制码 */ StarRtc.StarSDK.sendVoipCtrlMsg = function (_targetId, _code)
/** * 发送voip呼叫消息 * @param _targetId 对方用户Id * @param _ts 时间戳(可选) * @param _flag 是否是音频呼叫,默认为false(可选) */ StarRtc.StarSDK.sendVoipCallMsg = function (_targetId, _ts, _flag)
/** * 发送voip拒绝消息 * @param _targetId 对方用户Id */ StarRtc.StarSDK.sendVoipRefuseMsg = function (_targetId)
/** * 发送voip挂断消息 * @param _targetId 对方用户Id */ StarRtc.StarSDK.sendVoipHungupMsg = function (_targetId)
/** * 发送voip忙碌消息 * @param _targetId 对方用户Id */ StarRtc.StarSDK.sendVoipBusyMsg = function (_targetId)
/** * 发送voip同意连接消息 * @param _targetId 对方用户Id */ StarRtc.StarSDK.sendVoipConnectMsg = function (_targetId)
/** * 设置回调,用于接管login方法中设置的登录回调中的onVoipMessage部分 * @param _callback 回调函数 */ StarRtc.StarSDK.setIMExtraback = function (_callback)
/** * 创建视频会议房间 * @param _oper 操作类型:new,创建;open,加入 * @param _userCallback 消息回调 * @param _userData 存储视频会议房间的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}} */ StarRtc.StarSDK.getVideoMeetingRoomSDK = function (_oper, _userCallback, _userData)
/** * 创建直播房间 * @param _type 类型:vdn,观看者;src,上传者 * @param _oper 操作类型:new,创建;open,加入 * @param _userCallback 消息回调 * @param _userData 存储直播房间的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}} */ StarRtc.StarSDK.getVideoLiveRoomSDK = function (_type, _oper, _userCallback, _userData)
/** * 创建voip房间 * @param _oper 操作类型:call,呼叫者;response,应答者 * @param _userCallback 消息回调 * @param _userData 存储voip房间对方id信息,结构为{"roomInfo":{"targetId":对方id, "audioOnly":是否仅进行音频聊天(可不传入,默认值为false,视频聊天)}} */ StarRtc.StarSDK.getVoipRoomSDK = function (_oper, _userCallback, _userData)
/** * 创建聊天室房间 * @param _oper 操作类型:new,创建;open,加入 * @param _userCallback 消息回调 * @param _userData 存储直播房间的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}} */ StarRtc.StarSDK.getChatRoomSDK = function (_oper, _userCallback, _userData)
/** * 创建视频房间(仅支持视频功能,无聊天室) * @param _type 类型:vdn,观看者;src,上传者 * @param _oper 操作类型:new,创建;open,加入 * @param _userCallback 消息回调 * @param _userData 存储聊天室的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}} * @param _liveType 房间类型,见CHATROOM_LIST_TYPE */ StarRtc.StarSDK.getVideoRoomSDK = function (_type, _oper, _userCallback, _userData, _liveType)
/** * 查询列表(非AEC下使用此接口做演示) * @param listTypes 数组,值见CHATROOM_LIST_TYPE * @param callback 回调函数 */ StarRtc.StarSDK.queryRoom = function (listTypes, callback)
/** * 设置群免打扰 * @param ignore true:设置免打扰;false:取消免打扰 */ StarRtc.StarSDK.setGroupMsgPush = function (ignore)
/** * 移除指定群用户 * @param groupId 群组id * @param removeUsers 待移除的用户,类型为数组 */ StarRtc.StarSDK.removeGroupUsers = function (groupId, removeUsers)
/** * 添加指定群用户 * @param groupId 群组id * @param addUsers 待添加的用户,类型为数组 * @param userDefineData */ StarRtc.StarSDK.addGroupUsers = function (groupId, addUsers, userDefineData)
/** * 删除指定群组 * @param groupId 群组id */ StarRtc.StarSDK.delGroup = function (groupId)
/** * 创建群组 * @param addUsers 待添加的用户,类型为数组 * @param userDefineData */ StarRtc.StarSDK.createGroup = function (addUsers, userDefineData)
/** * 请求群组列表 */ StarRtc.StarSDK.getGroupList = function ()
/** * 请求指定群用户列表 * @param groupId 群组id */ StarRtc.StarSDK.getGroupUserList = function (groupId)
/** * 请求当前在线人数 */ StarRtc.StarSDK.getOnlineNumber = function ()
/** * 请求全部用户列表 * @param reqPageNum 页码,StarRtc.Instance.getOnlineNumber调用后,会在回调中返回总数量和总页数 */ StarRtc.StarSDK.getAllUserList = function (reqPageNum)
/** * 创建超级对讲房间 * @param _oper 操作类型:new,创建;open,加入 * @param _userCallback 消息回调 * @param _userData 存储超级对讲房间的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}} */ StarRtc.StarSDK.getSuperRoomSDK = function (_oper, _userCallback, _userData)
/** * 保存房间信息(非AEC下使用此接口做演示) * @param listType 保存类型,见CHATROOM_LIST_TYPE * @param roomInfo 结构为{"id":"", "name":"", "creator":""} * @param callback 回调函数 */ StarRtc.StarSDK.reportRoom = function (listType, roomInfo, callback)
/** * 删除房间信息(非AEC下使用此接口做演示) * @param listType 保存类型,见CHATROOM_LIST_TYPE * @param roomInfo 结构为{"id":"", "name":"", "creator":""} * @param callback 回调函数 */ StarRtc.StarSDK.delRoom = function (listType, roomInfo, callback)
|