SDK的说明和api介绍

1. SDK对象简介

介绍 功能
LOG_LEVEL 日志等级 日志等级枚举
CHATROOM_LIST_TYPE 列表类型 列表类型枚举
StarRtc.StarConfig 配置对象 保存配置信息
StarRtc.StarUserInfo 用户信息对象 保存用户信息
StarRtc.StarSDK SDK实例类 提供登录,收发IM消息,群组管理,收发群组消息, SDK的高级业务封装接口,允许多实例
StarRtc.StarRoomSDK 房间SDK 整合videoSDK和chatSDK,提供完整的room功能(voip,meeting,live)
StarRtc.StarSuperRoomSDK 超级对讲房间SDK 超级对讲房间SDK,半双工,自由上麦说话
StarRtc.StarChatRoomSDK 聊天室房间SDK 聊天室SDK的简单业务封装
StarRtc.StarVideoRoomSDK 视频房间SDK 视频SDK的简单业务封装
StarRtc.StarVideoSDK 视频SDK 负责音视频功能
StarRtc.StarChatSDK 聊天室SDK 负责聊天室功能

2. LOG_LEVEL

var LOG_LEVEL = {
LOG_LEVEL_DEBUG: i++,
LOG_LEVEL_INFO: i++,
LOG_LEVEL_WARN: i++,
LOG_LEVEL_ERROR: i++
};

/**
* 设置日志等级,开启低等级日志会包含高等级日志,如开启DEBUG,则同时开启INFO、WARN、ERROR,默认为开启DEBUG
* @param logLevel 日志等级,见LOG_LEVEL
*/
StarRtc.InitlogLevel = function (logLevel)

3. CHATROOM_LIST_TYPE

var CHATROOM_LIST_TYPE = {
//列表类型:聊天室
CHATROOM_LIST_TYPE_CHATROOM: i++,
//列表类型:直播
CHATROOM_LIST_TYPE_LIVE: i++,
//列表类型:直播推流
CHATROOM_LIST_TYPE_LIVE_PUSH: i++,
//列表类型:会议
CHATROOM_LIST_TYPE_MEETING: i++,
//列表类型:会议推流
CHATROOM_LIST_TYPE_MEETING_PUSH: i++,
//列表类型:小班课
CHATROOM_LIST_TYPE_CLASS: i++,
//列表类型:小班课推流
CHATROOM_LIST_TYPE_CLASS_PUSH: i++,
//列表类型:音频直播
CHATROOM_LIST_TYPE_AUDIO_LIVE: i++,
//列表类型:音频直播推流
CHATROOM_LIST_TYPE_AUDIO_LIVE_PUSH: i++,
//列表类型:超级对讲
CHATROOM_LIST_TYPE_SUPER_ROOM: i++,
//列表类型:超级对讲推流
CHATROOM_LIST_TYPE_SUPER_ROOM_PUSH: i++
};

4. StarRtc.StarConfig

//是否开启使用AEC
StarRtc.StarConfig.configUseAEC;

//msgServer地址
StarRtc.StarConfig.msgServerUrl;
//msgServer websocket端口
StarRtc.StarConfig.msgServerWebsocketPort;
//chatRoomServer地址
StarRtc.StarConfig.chatRoomServerUrl;
//chatRoomServer websocket端口
StarRtc.StarConfig.chatRoomServerWebsocketPort;
//srcServer地址
StarRtc.StarConfig.srcServerUrl;
//srcServer websocket端口
StarRtc.StarConfig.srcServerWebsocketPort;
//srcServer webrtc端口
StarRtc.StarConfig.srcServerWebrtcPort;
//vdnServer地址
StarRtc.StarConfig.vdnServerUrl;
//vdnServer websocket端口
StarRtc.StarConfig.vdnServerWebsocketPort;
//vdnServer webrtc端口
StarRtc.StarConfig.vdnServerWebrtcPort;
//voipServer地址
StarRtc.StarConfig.voipServerUrl;
//voipServer 端口
StarRtc.StarConfig.voipServerPort;
//voipServer websocket端口
StarRtc.StarConfig.voipServerWebsocketPort;
//voipServer webrtc端口
StarRtc.StarConfig.voipServerWebrtcPort;

5. StarRtc.StarUserInfo

//应用id
StarRtc.StarUserInfo.agentId = "";
//用户id
StarRtc.StarUserInfo.userId = "";
//应用id_用户id
StarRtc.StarUserInfo.starUid = "";
//token
StarRtc.StarUserInfo.starToken = "";

6. StarRtc.StarSDK

/**
* 构造函数
*/
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 存储视频会议房间的相关信息(idnamecreator),结构为{"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)

7. StarRtc.StarRoomSDK

/**
* 构造函数
* @param _type 类型:vdn,观看者;src,上传者
* @param _oper 操作类型:new,创建;open,加入
* @param _userCallback 消息回调
* @param _userData 存储聊天室的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}}
* @param _config 房间配置,可不传入
* @param _liveType 房间类型,见CHATROOM_LIST_TYPE
* @param _starImInterface 设置回调,用于接管login方法中设置的登录回调中的onVoipMessage部分
* @param _starUser 用户信息(见StarRtc.StarUserInfo)
* @param _starConfig star配置(见StarRtc.StarConfig)
*/
StarRtc.StarRoomSDK = function (_type, _oper, _userCallback, _userData, _config, _liveType, _starImInterface, _starUser, _starConfig)

/**
* 连接房间
*/
StarRtc.StarRoomSDK.sigConnect = function ()

/**
* 断连房间
* @param flag 是否主动断开连接的标志为,用于判断重连
*/
StarRtc.StarRoomSDK.sigDisconnect = function (_flag)

/**
* 创建房间
*/
StarRtc.StarRoomSDK.createNew = function ()

/**
* 删除房间
*/
StarRtc.StarRoomSDK.deleteCurrRoom = function ()

/**
* 创建本地视频流
* @param streamOption 流配置(分辨率等),如{ "video": true, "audio": { deviceId: { ideal: ["default"] } } }, 或{ "video": { width: { ideal: 640 }, height: { ideal: 480 }, frameRate: { ideal: 25 }, facingMode: { ideal: ["user"] } }, "audio": { deviceId: { ideal: ["default"] } }
}
*/
StarRtc.StarRoomSDK.createStream = function (streamOption)

/**
* 创建分享屏幕视频流
*/
StarRtc.StarRoomSDK.createScreenCaptureStream = function ()

/**
* 设置流可见性(会同时影响自己本地流和对端流)
* @param config 流可见性配置{"video":true, "audio":true}
*/
StarRtc.StarRoomSDK.publishStream = function (config)

/**
* 加入房间
*/
StarRtc.StarRoomSDK.joinRoom = function ()

/**
* 离开房间
* @param _flag 是否主动离开(可选)
*/
StarRtc.StarRoomSDK.leaveRoom = function (_flag)

/**
* 切换大小图
* @param streamConfig 切换大小图的配置,数组,1为小图,2为大图[1,2,1,2...]
*/
StarRtc.StarRoomSDK.streamConfigApply = function (streamConfig)

/**
* 发送聊天室消息
* @param msg 消息
*/
StarRtc.StarRoomSDK.sendChatMsg = function (msg)

/**
* 发送voip消息(IM单聊消息)
* @param msg 消息
*/
StarRtc.StarRoomSDK.sendVoipMsg = function (msg)

/**
* 发送聊天室私聊消息
* @param toUserId 发送对象
* @param msg 消息
*/
StarRtc.StarRoomSDK.sendChatPrivateMsg = function (userId, msg)

/**
* 发送申请上麦消息
*/
StarRtc.StarRoomSDK.sendApplyMsg = function ()

/**
* 发送同意申请上麦消息
* @param userId 待发送的用户id
*/
StarRtc.StarRoomSDK.sendApplyAgreeMsg = function (userId)

/**
* 发送拒绝申请上麦消息
* @param userId 待发送的用户id
*/
StarRtc.StarRoomSDK.sendApplyDisagreeMsg = function (userId)

/**
* 发送邀请上麦消息
* @param userId 待发送的用户id
*/
StarRtc.StarRoomSDK.sendInviteLinkMsg = function (userId)

/**
* 发送同意邀请上麦消息
*/
StarRtc.StarRoomSDK.sendInviteLinkAgreeMsg = function ()

/**
* 发送拒绝邀请上麦消息
*/
StarRtc.StarRoomSDK.sendInviteLinkDisagreeMsg = function ()

/**
* 发送开始邀请上麦消息
*/
StarRtc.StarRoomSDK.sendInviteLinkStartMsg = function ()

/**
* 发送断开上麦消息
* @param userId 待发送的用户id
*/
StarRtc.StarRoomSDK.sendLinkStopMsg = function (userId)

/**
* 聊天室踢人
* @param kickOutUserId 踢出的用户Id
*/
StarRtc.StarRoomSDK.kickOutUser = function (kickOutUserId)

/**
* 聊天室禁言
* @param banUserId 禁言的用户Id
* @param banTime 禁言的时间长度
*/
StarRtc.StarRoomSDK.banToSendMsg = function (banUserId, banTime)

/**
* 获取聊天室在线用户数
*/
StarRtc.StarRoomSDK.getRoomOnlineNum = function ()

/**
* 发送实时数据
* @param data 实时数据
*/
StarRtc.StarRoomSDK.sendStreamData = function (data)

/**
* 获取是主动断开还是被动断开
*/
StarRtc.StarRoomSDK.activeDisconnect = function ()

8. StarRtc.StarSuperRoomSDK

/**
* 构造函数
* @param _oper 操作类型:new,创建;open,加入
* @param _userCallback 消息回调
* @param _userData 存储聊天室的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}}
* @param _starUser 用户信息(见StarRtc.StarUserInfo)
* @param _starConfig star配置(见StarRtc.StarConfig)
*/
StarRtc.StarSuperRoomSDK = function (_oper, _userCallback, _userData, _starUser, _starConfig)

/**
* 连接房间
*/
StarRtc.StarSuperRoomSDK.sigConnect = function ()

/**
* 断连房间
* @param flag 是否主动断开连接的标志为,用于判断重连
*/
StarRtc.StarSuperRoomSDK.sigDisconnect = function (_flag)

/**
* 创建房间
*/
StarRtc.StarSuperRoomSDK.createNew = function ()

/**
* 删除房间
*/
StarRtc.StarSuperRoomSDK.deleteCurrRoom = function ()

/**
* 创建本地视频流
* @param streamOption 流配置(分辨率等),如{ "video": true, "audio": { deviceId: { ideal: ["default"] } } }, 或{ "video": { width: { ideal: 640 }, height: { ideal: 480 }, frameRate: { ideal: 25 }, facingMode: { ideal: ["user"] } }, "audio": { deviceId: { ideal: ["default"] } }
*/
StarRtc.StarSuperRoomSDK.createStream = function (streamOption)

/**
* 加入房间
*/
StarRtc.StarSuperRoomSDK.joinRoom = function ()

/**
* 离开房间
* @param _flag 是否主动离开(可选)
*/
StarRtc.StarSuperRoomSDK.leaveRoom = function (_flag)

/**
* 发送聊天室消息
* @param msg 消息
*/
StarRtc.StarSuperRoomSDK.sendChatMsg = function (msg)

/**
* 发送聊天室私聊消息
* @param toUserId 发送对象
* @param msg 消息
*/
StarRtc.StarSuperRoomSDK.sendChatPrivateMsg = function (userId, msg)

/**
* 聊天室踢人
* @param kickOutUserId 踢出的用户Id
*/
StarRtc.StarSuperRoomSDK.kickOutUser = function (kickOutUserId)

/**
* 聊天室禁言
* @param banUserId 禁言的用户Id
* @param banTime 禁言的时间长度
*/
StarRtc.StarSuperRoomSDK.banToSendMsg = function (banUserId, banTime)

/**
* 获取聊天室在线用户数
*/
StarRtc.StarSuperRoomSDK.getRoomOnlineNum = function ()

/**
* 获取是主动断开还是被动断开
*/
StarRtc.StarSuperRoomSDK.activeDisconnect = function ()

/**
* 开始对讲
*/
StarRtc.StarSuperRoomSDK.startTalk = function ()

/**
* 结束对讲
*/
StarRtc.StarSuperRoomSDK.endTalk = function ()

9. StarRtc.StarChatRoomSDK

/**
* 构造函数
* @param _oper 操作类型:new,创建;open,加入
* @param _userCallback 消息回调
* @param _userData 存储聊天室的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}}
* @param _liveType 房间类型,见CHATROOM_LIST_TYPE
* @param _starUser 用户信息(见StarRtc.StarUserInfo)
* @param _starConfig star配置(见StarRtc.StarConfig)
*/
StarRtc.StarChatRoomSDK = function (_oper, _userCallback, _userData, _liveType, _starUser, _starConfig)

/**
* 连接房间
*/
StarRtc.StarChatRoomSDK.sigConnect = function ()

/**
* 断连房间
* @param flag 是否主动断开连接的标志为,用于判断重连
*/
StarRtc.StarChatRoomSDK.sigDisconnect = function (_flag)

/**
* 创建房间
*/
StarRtc.StarChatRoomSDK.createNew = function ()

/**
* 发送聊天室消息
* @param msg 消息
*/
StarRtc.StarChatRoomSDK.sendChatMsg = function (msg)

/**
* 发送聊天室私聊消息
* @param toUserId 发送对象
* @param msg 消息
*/
StarRtc.StarChatRoomSDK.sendChatPrivateMsg = function (toUserId, msg)

/**
* 发送聊天室私聊控制消息
* @param toUserId 发送对象
* @param msg 消息
* @param code 控制码
*/
StarRtc.StarChatRoomSDK.sendChatCtrlPrivateMsg = function (toUserId, msg, code)

/**
* 聊天室踢人
* @param kickOutUserId 踢出的用户Id
*/
StarRtc.StarChatRoomSDK.kickOutUser = function (kickOutUserId)

/**
* 聊天室禁言
* @param banUserId 禁言的用户Id
* @param banTime 禁言的时间长度
*/
StarRtc.StarChatRoomSDK.banToSendMsg = function (banUserId, banTime)

/**
* 获取聊天室在线用户数
*/
StarRtc.StarChatRoomSDK.getRoomOnlineNum = function ()

/**
* 删除房间
*/
StarRtc.StarChatRoomSDK.deleteCurrRoom = function ()

/**
* 加入房间
*/
StarRtc.StarChatRoomSDK.joinRoom = function ()

/**
* 离开房间
*/
StarRtc.StarChatRoomSDK.leaveRoom = function ()

/**
* 获取是主动断开还是被动断开
*/
StarRtc.StarChatRoomSDK.activeDisconnect = function ()

10. StarRtc.StarVideoRoomSDK

/**
* 构造函数
* @param _type 类型:vdn,观看者;src,上传者
* @param _oper 操作类型:new,创建;open,加入
* @param _userCallback 消息回调
* @param _userData 存储聊天室的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}}
* @param _liveType 房间类型,见CHATROOM_LIST_TYPE
* @param _starUser 用户信息(见StarRtc.StarUserInfo)
* @param _starConfig star配置(见StarRtc.StarConfig)
*/
StarRtc.StarVideoRoomSDK = function (_type, _oper, _userCallback, _userData, _liveType, _starUser, _starConfig)

/**
* 连接房间
*/
StarRtc.StarVideoRoomSDK.sigConnect = function ()

/**
* 断连房间
* @param flag 是否主动断开连接的标志为,用于判断重连
*/
StarRtc.StarVideoRoomSDK.sigDisconnect = function (_flag)

/**
* 创建房间
*/
StarRtc.StarVideoRoomSDK.createNew = function ()

/**
* 创建超级对讲房间
*/
StarRtc.StarVideoRoomSDK.createNewSuperRoom = function ()

/**
* 删除房间
*/
StarRtc.StarVideoRoomSDK.deleteCurrRoom = function ()

/**
* 创建本地视频流
* @param streamOption 流配置(分辨率等),如{ "video": true, "audio": { deviceId: { ideal: ["default"] } } }, 或{ "video": { width: { ideal: 640 }, height: { ideal: 480 }, frameRate: { ideal: 25 }, facingMode: { ideal: ["user"] } }, "audio": { deviceId: { ideal: ["default"] } }
*/
StarRtc.StarVideoRoomSDK.createStream = function (streamOption)

/**
* 创建分享屏幕视频流
*/
StarRtc.StarVideoRoomSDK.createScreenCaptureStream = function ()

/**
* 设置流可见性(会同时影响自己本地流和对端流)
* @param config 流可见性配置{"video":true, "audio":true}
*/
StarRtc.StarVideoRoomSDK.publishStream = function (config)

/**
* 加入房间
*/
StarRtc.StarVideoRoomSDK.joinRoom = function ()

/**
* 离开房间
* @param _flag 是否主动离开(可选)
*/
StarRtc.StarVideoRoomSDK.leaveRoom = function (flag)

/**
* 切换大小图
* @param streamConfig 切换大小图的配置,数组,1为小图,2为大图[1,2,1,2...]
*/
StarRtc.StarVideoRoomSDK.streamConfigApply = function (streamConfig)

/**
* 发送实时数据
* @param data 实时数据
*/
StarRtc.StarVideoRoomSDK.sendStreamData = function (data)

/**
* 获取是主动断开还是被动断开
*/
StarRtc.StarVideoRoomSDK.activeDisconnect = function ()

11. StarRtc.StarVideoSDK

/**
* 构造函数
* @param _type 类型:vdn,观看者;src,上传者
* @param _oper 操作类型:new,创建;open,加入
* @param _userCallback 消息回调
* @param _userData 存储聊天室的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}}
* @param _liveType 房间类型,见CHATROOM_LIST_TYPE
* @param _starUser 用户信息(见StarRtc.StarUserInfo)
* @param _starConfig star配置(见StarRtc.StarConfig)
*/
StarRtc.StarVideoSDK = function (_type, _oper, _userCallback, _userData, _liveType, _starUser, _starConfig)

/**
* 连接房间
*/
StarRtc.StarVideoSDK.sigConnect = function ()

/**
* 断连房间
* @param flag 是否主动断开连接的标志为,用于判断重连
*/
StarRtc.StarVideoSDK.sigDisconnect = function (_flag)

/**
* 创建房间
*/
StarRtc.StarVideoSDK.createNew = function ()

/**
* 创建超级对讲房间
*/
StarRtc.StarVideoSDK.createNewSuperRoom = function ()

/**
* 删除房间
*/
StarRtc.StarVideoSDK.deleteCurrRoom = function ()

/**
* 创建本地视频流
* @param streamOption 流配置(分辨率等),如{ "video": true, "audio": { deviceId: { ideal: ["default"] } } }, 或{ "video": { width: { ideal: 640 }, height: { ideal: 480 }, frameRate: { ideal: 25 }, facingMode: { ideal: ["user"] } }, "audio": { deviceId: { ideal: ["default"] } }
*/
StarRtc.StarVideoSDK.createStream = function (streamOption)

/**
* 创建分享屏幕视频流
*/
StarRtc.StarVideoSDK.createScreenCaptureStream = function ()

/**
* 设置流可见性(会同时影响自己本地流和对端流)
* @param config 流可见性配置{"video":true, "audio":true}
*/
StarRtc.StarVideoSDK.publishStream = function (config)

/**
* 加入房间
*/
StarRtc.StarVideoSDK.joinRoom = function ()

/**
* 离开房间
* @param _flag 是否主动离开(可选)
*/
StarRtc.StarVideoSDK.leaveRoom = function (flag)

/**
* 切换大小图
* @param streamConfig 切换大小图的配置,数组,1为小图,2为大图[1,2,1,2...]
*/
StarRtc.StarVideoSDK.streamConfigApply = function (streamConfig)

/**
* 发送实时数据
* @param data 实时数据
*/
StarRtc.StarVideoSDK.sendStreamData = function (data)

/**
* 获取是主动断开还是被动断开
*/
StarRtc.StarVideoSDK.activeDisconnect = function ()

12. StarRtc.StarChatSDK

/**
* 构造函数
* @param _oper 操作类型:new,创建;open,加入
* @param _userCallback 消息回调
* @param _userData 存储聊天室的相关信息(id,name,creator),结构为{"roomInfo":{"id":"", "name":"", "creator":""}}
* @param _liveType 房间类型,见CHATROOM_LIST_TYPE
* @param _starUser 用户信息(见StarRtc.StarUserInfo)
* @param _starConfig star配置(见StarRtc.StarConfig)
*/
StarRtc.StarChatSDK = function (_oper, _userCallback, _userData, _liveType, _starUser, _starConfig)

/**
* 连接房间
*/
StarRtc.StarChatSDK.sigConnect = function ()

/**
* 断连房间
* @param flag 是否主动断开连接的标志为,用于判断重连
*/
StarRtc.StarChatSDK.sigDisconnect = function (_flag)

/**
* 创建房间
*/
StarRtc.StarChatSDK.createNew = function ()

/**
* 发送聊天室消息
* @param msg 消息
*/
StarRtc.StarChatSDK.sendChatMsg = function (msg)

/**
* 发送聊天室私聊消息
* @param toUserId 发送对象
* @param msg 消息
*/
StarRtc.StarChatSDK.sendChatPrivateMsg = function (toUserId, msg)

/**
* 发送聊天室私聊控制消息
* @param toUserId 发送对象
* @param msg 消息
* @param code 控制码
*/
StarRtc.StarChatSDK.sendChatCtrlPrivateMsg = function (toUserId, msg, code)

/**
* 聊天室踢人
* @param kickOutUserId 踢出的用户Id
*/
StarRtc.StarChatSDK.kickOutUser = function (kickOutUserId)

/**
* 聊天室禁言
* @param banUserId 禁言的用户Id
* @param banTime 禁言的时间长度
*/
StarRtc.StarChatSDK.banToSendMsg = function (banUserId, banTime)

/**
* 获取聊天室在线用户数
*/
StarRtc.StarChatSDK.getRoomOnlineNum = function ()

/**
* 删除房间
*/
StarRtc.StarChatSDK.deleteCurrRoom = function ()

/**
* 加入房间
*/
StarRtc.StarChatSDK.joinRoom = function ()

/**
* 离开房间
*/
StarRtc.StarChatSDK.leaveRoom = function ()

/**
* 获取是主动断开还是被动断开
*/
StarRtc.StarChatSDK.activeDisconnect = function ()