SimpleWebRTC API 完全参考手册：方法、事件与配置详解

SimpleWebRTC 是全球最简单的 WebRTC 库，为开发者提供了极简的 API 来构建实时音视频通信应用。无论你是新手还是经验丰富的开发者，这个完整的 API 参考手册都将帮助你快速掌握 SimpleWebRTC 的核心功能和使用方法。🎯

🔧 核心配置选项详解

SimpleWebRTC 提供了丰富的配置选项，让你能够灵活定制应用行为：

基本连接配置

• url: 信令服务器地址，默认为 https://sandbox.simplewebrtc.com:443/
• socketio: Socket.IO 连接选项对象
• connection: 自定义信令连接对象

媒体流控制

• localVideoEl: 本地视频元素容器
• remoteVideosEl: 远程视频元素容器
• autoRequestMedia: 是否自动请求摄像头权限
• media: 媒体约束配置，支持视频和音频设置

高级功能配置

• enableDataChannels: 启用数据通道功能
• adjustPeerVolume: 自动调节对等方音量
• peerVolumeWhenSpeaking: 说话时的对等方音量级别

📡 完整事件系统参考

SimpleWebRTC 的事件系统让你能够监控和控制整个通信流程：

连接事件

• connectionReady: 信令连接就绪时触发
• readyToCall: 准备发起呼叫时触发

房间事件

• joinedRoom: 成功加入房间时触发
• leftRoom: 离开房间时触发

媒体流事件

• videoAdded: 新增视频流时触发
• videoRemoved: 移除视频流时触发
• localScreenAdded: 本地屏幕共享开始时触发

🚀 核心方法完整指南

房间管理方法

• joinRoom(roomName, callback): 加入指定房间
• createRoom(roomName, callback): 创建新房间
• leaveRoom(): 离开当前房间

媒体控制方法

• startLocalVideo(): 启动本地视频流
• stopLocalVideo(): 停止本地视频流
• shareScreen(callback): 开始屏幕共享

通信控制方法

• mute(): 静音本地音频
• unmute(): 取消静音
• pauseVideo(): 暂停视频发送
• resumeVideo(): 恢复视频发送

🎯 最佳实践与使用技巧

快速启动指南

var webrtc = new SimpleWebRTC({
    localVideoEl: 'localVideo',
    remoteVideosEl: 'remoteVideos', 
    autoRequestMedia: true
});

webrtc.on('readyToCall', function() {
    webrtc.joinRoom('your-room-name');
});

错误处理策略

• 监听 localMediaError 事件处理媒体获取失败
• 使用 error 事件捕获一般性错误

🔗 自定义连接支持

SimpleWebRTC 支持自定义信令连接，只需要实现四个核心方法：

• on(event, handler): 事件监听
• emit(): 发送消息
• getSessionId(): 获取会话ID
• disconnect(): 断开连接

通过这个完整的 API 参考手册，你将能够充分利用 SimpleWebRTC 的强大功能，快速构建高质量的实时通信应用。无论是简单的视频聊天还是复杂的多人群组通话，SimpleWebRTC 都能提供简洁而强大的解决方案。✨