Web SDK
可参考 使用说明，并了解使用此 SDK 的简单步骤。
API
以下仅展示基本的 API 说明，更详细的 API 及类型说明，请参见 Docs。
主要的类或接口
- Client - RTC 客户端，可进行加入、离开房间，发布、订阅流等操作
- Stream - 本地流与远端流的父类
- LocalStream - 本地流，可用于本地预览，也可用 client 进行发布
- RemoteStream - 远端流，房间内其他用户发布的流，可通过 client 进行订阅
- User - 用户信息
- RtcError - 错误信息
- RtcEvent - 事件，主要有以下几类
全局属性或方法
- version - 当前 sdk 的版本号
- createClient - 创建客户端
- createStream - 创建本地流
- deviceDetection - 设备可用性检测，创建包含麦克风音频或摄像头视频的本地流时，有可能因为麦克风或摄像头设备问题（如驱动问题，或未经授权等），导致无法正确创建。此方法可用于设备检测，根据检测结果，再决定创建本地流时启用麦克风或摄像头或麦克风和摄像头
- generateToken - 根据 AppId，AppKey，RoomId，UserId 生成 token，用于开发阶段临时快速的加入房间并验证功能，由于 AppKey 不可暴露于公网，因此生产环境中不建议使用此方法生成 token
- getCameras - 获取摄像头设备列表
- getDevices - 获取音视频输入/输出设备列表
- getLoudspeakers - 获取扬声器设备列表
- getMicrophones - 获取麦克风设备列表
- isSupportScreenShare - 检测浏览器是否支持屏幕共享
- isSupportWebRTC - 检测浏览器是否完全（可访问本地音视频设备）支持 WebRTC
- getSupportedCodec - 检测浏览器支持的WebRTC的音视频编解码格式
- enableUploadLog - 开启日志（操作/错误/状态）的上报
- disableUploadLog - 关闭日志（操作/错误/状态）的上报
- setLogLevel - 设置日志打印级别，用于打印出更多日志来调试或定位问题
- setServers - 用于私有化部署时，指定部署的服务器地址
Client
Client 对象包含以下方法：
- getLocalStreams - 获取当前 Client 已发布的本地流
- getRemoteStreams - 获取当前 Client 已接收到的远端流（包含已订阅或未订阅的远端流）
- getRemoteUsers - 获取远端用户信息
- join - 加入房间
- leave - 离开房间
- off - 取消监听 Client 对象的事件
- on - 监听 Client 对象的事件，可监听的事件类型有 RtcConnectionEventType、RtcStreamEventType、RtcUserEventType
- publish - 发布一条本地流
- setRole - 修改用户角色
- subscribe - 订阅一条远端流
- unpublish - 取消发布一条本地流
- unsubscribe - 取消订阅一条远端流
Stream
Stream 为 LocalStream 及 RemoteStream 的父类
LocalStream
LocalStream 对象包含以下属性：
- audioMuted - 当前流是否 mute 了音频
- id - 当前流ID
- mediaStream - 当前流包含的媒体流，关于媒体流，请详见 MediaStream
- videoMuted - 当前流是否 mute 了视频
LocalStream 对象包含以下方法：
- addTrack - 添加一条媒体轨道（音轨或视轨）到当前流
- destroy - 销毁当前流，一般在本地流不再被使用时，可调用此方法销毁，解除摄像头或麦克风设备的占用
- getAudioLevel - 获取当前流的音量大小，只有当本地流或远端流中有音频数据才有效
- getMediaType - 获取流的媒体类型，主视频流/辅助视频流
- getStats - 获取流发布或订阅后的统计数据
- hasAudio - 判断当前流是否有音频
- hasVideo - 判断当前流是否有视频
- init - 初始化本地流对象，将读取麦克风、摄像头、屏幕共享等来初始化媒体流
- muteAudio - mute 当前流的音频
- muteVideo - mute 当前流的视频
- off - 取消监听流对象事件
- on - 监听流对象事件，可监听的事件类型有 RtcStreamEventType、RtcPlayerEventType
- play - 播放当前流
- removeTrack - 从当前流中删除一条媒体轨道（音轨或视轨）
- replaceTrack - 替换当前流中的媒体轨道
- resume - 恢复播放流，一般由于浏览器限制无法自动播放时，可提示用户手动触发该方法进行恢复播放
- setScreenProfile - 设置当前流（屏幕共享时）视频的 Profile，默认 '1080p'
- setVideoProfile - 设置当前流视频的 Profile，默认 '360p_2'
- snapshot - 对当前流进行截屏
- stop - 停止播放当前流
- switchDevice - 切换音视频设备
- switchImage - 切换图片 - 使用图片生成视频，并将当前流的视频使用其代替
- unmuteAudio - unmute 当前流的音频
- unmuteVideo - unmute 当前流的视频
RemoteStream
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 对象包含以下方法：
- getAudioLevel - 获取当前流的音量大小，只有当本地流或远端流中有音频数据才有效
- getMediaType - 获取流的媒体类型
- getStats - 获取流发布或订阅后的统计数据
- hasAudio - 判断当前流是否有音频
- hasVideo - 判断当前流是否有视频
- muteAudio - mute 当前流的音频
- muteVideo - mute 当前流的视频
- off - 取消监听流对象事件
- on - 监听流对象事件，可监听的事件类型有 RtcStreamEventType、RtcPlayerEventType
- play - 播放当前流
- resume - 恢复播放流，一般由于浏览器限制无法自动播放时，可提示用户手动触发该方法进行恢复播放
- setAudioVolume - 设置输出音量，默认为 100
- snapshot - 对当前流进行截屏
- stop - 停止播放当前流
- unmuteAudio - unmute 当前流的音频
- unmuteVideo - unmute 当前流的视频
User
- id - 用户ID