No Description

URTC Web SDK

安装

主要分两种项目类型：

  <script type="text/javascript" src="index.js"></script>

  npm install --save @urtc/sdk-web

针对上面两种项目的具体安装方法，可参考 使用说明，并了解使用此 SDK 的简单步骤。

以下仅展示基本的 API 说明，更详细的 API 及类型说明，请参见 Docs。

version - 当前 sdk 的版本号
createClient - 创建客户端
createStream - 创建本地流
deviceDetection - 设备可用性检测，创建包含麦克风音频或摄像头视频的本地流时，有可能因为麦克风或摄像头设备问题（如驱动问题，或未经授权等），导致无法正确创建。此方法可用于设备检测，根据检测结果，再决定创建本地流时启用麦克风或摄像头或麦克风和摄像头
generateToken - 根据 AppId，AppKey，RoomId，UserId 生成 token，用于开发阶段临时快速的加入房间并验证功能，由于 AppKey 不可暴露于公网，因此生产环境中不建议使用此方法生成 token
getCameras - 获取摄像头设备列表
getDevices - 获取音视频输入/输出设备列表
getLoudspeakers - 获取扬声器设备列表
getMicrophones - 获取麦克风设备列表
isSupportScreenShare - 检测浏览器是否支持屏幕共享
isSupportWebRTC - 检测浏览器是否完全（可访问本地音视频设备）支持 WebRTC
reportLog - 开启/关闭操作/错误/状态日志的上报
setLogLevel - 设置日志打印级别，用于打印出更多日志来调试或定位问题
setServers - 用于私有化部署时，指定部署的服务器地址

Client 对象包含以下方法：

getLocalStreams - 获取当前 Client 已发布的本地流
getRemoteStreams - 获取当前 Client 已接收到的远端流（包含已订阅或未订阅的远端流）
getRemoteUsers - 获取远端用户信息
join - 加入房间
leave - 离开房间
off - 取消监听 Client 对象的事件
on - 监听 Client 对象的事件，可监听的事件类型有 RtcConnectionEventType、RtcStreamEventType、RtcUserEventType
publish - 发布一条本地流
setRole - 修改用户角色
subscribe - 订阅一条远端流
unpublish - 取消发布一条本地流
unsubscribe - 取消订阅一条远端流

Stream 为 LocalStream 及 RemoteStream 的父类，其提供 use 方法，用于加载流插件，流插件请查看 - todo

LocalStream 对象包含以下属性：

LocalStream 对象包含以下方法：

RemoteStream 对象包含以下属性：

audioMuted - 当前流是否 mute 了音频
id - 当前流ID
mediaStream - 当前流包含的媒体流，关于媒体流，请详见 MediaStream
sourceAudioMuted - 音频源是否已 mute，当源端 mute/unmute 音频时，本端将收到 mute-audio 或 unmute-audio 事件的通知，同时此值将变为对应值
sourceVideoMuted - 视频源是否已 mute，当源端 mute/unmute 视频时，本端将收到 mute-video 或 unmute-video 事件的通知，同时此值将变为对应值
userId - 该流所属用户的ID
videoMuted - 当前流是否 mute 了视频

RemoteStream 对象包含以下方法：