webrtc

webrtc package for verbling - Web and Mobile

instructions

1 - Instantiate a new VerblingRTCSession from the view / app layer using the VerblingRTCSession constructor()

2 - Attach local stream to the session via VerblingRTCSession.attachLocalMediaStream()

3 - Join a session with a given id via VerblingRTCSession.joinSession()

4 - Get list of peers (including self peer) with VerblingRTCSession.getPeers()

cross-platform

Pass in RTCPeerConnection, RTCSessionDescription and RTCIceCandidate to VerblingRTCSession depending on platform.

e.g. - For web, pass in the default browser versions of these objects. For mobile, pass in versions of these objects for that platform.

emits

VerblingRTCSession emits the following EventEmitter events:
- 'changed' - whenever the WebRTC Session or a WebRTC Peer has changed
- 'statsReady' - when the WebRTC stats for a newly created WebRTC session are ready. From this event handler, call VerblingRTCPeer.getStats() on one of the session peers (VerblingRTCSession.getPeers()). That promise returns the complete stats report. You can then optionally call VerblingRTCPeer.getIceTypeFromStats(stats) to get the turn type (local, stun, relay, etc) for the active webrtc connection.

full api

See WebRTCSessionInterface and WebRTCPeerInterface within this package for full API. Also check the constructors for VerblingRTCSession and VerblingRTCPeer for information regarding options, etc.