matallui / artico

Artico - WebRTC made simple

Artico

Artico is a flexible set of libraries that help you create your own WebRTC-based solutions. It uses a RTCPeerConnection abstraction similar to simple-peer, in order to maintain each individual peer-to-peer connection, while providing integrated signaling (via Socket.io), all via simple APIs.

Motivation

WebRTC as a technology has grown significantly in the past few years, making it more and more appealing. However, WebRTC APIs are not always straightforward and easy to use. In addition, WebRTC specifications don't define a signaling protocol or a discovery mechanism.

Multiple projects, like PeerJS and simple-peer, attempt to abstract some of the WebRTC complexities away from the user, facilitating the use of the technology. Even though these are all great projects, they usually fall short on some needed features (i.e., simple-peer doesn't provide signaling, PeerJS provides signaling but misses renegotiation capabilities) or are no longer actively maintained.

Artico aims at being a flexible, yet powerful, set of abstraction tools that should accommodate most WebRTC project needs.

About

Artico provides three core packages:

• @rtco/peer - RTCPeerConnection abstraction, heavily inspired by simple-peer
• @rtco/client - provides a Socket.io signaling solution on top of @rtco/peer
• @rtco/server - Socket.io signaling server implementation

You can also find the implementation of three of our apps:

• artico-docs - Artico documentation website
• artico-server - Artico's public Socket.io signaling server
• artico-demo - A few Artico demos available for experimentation

The demo apps are used to support the development of the Artico ecosystem, whilst demonstrating how to use the library packages.

@rtco/peer

• provide WebRTC API abstraction
• facilitate individual peer to peer connections
• heavily inspired by simple-peer

@rtco/client

• integrated signaling out of the box
• dynamic number of streams in single connection (via @rtco/peer)
• facilitate different peer network topologies (e.g., 1-1 Calls or many-many Rooms)
• multi-platform support (i.e., browser, React Native, Node.js)

@rtco/server

• easy to use signaling server
• integration with existing Node.js servers
• provide all the needed support for @rtco/client

Usage

Please refer to Artico's documentation for more information.

References

• PeerJS - This project was inspired by PeerJS and aims at being as simple as PeerJS, while covering more complex scenarios.
• simple-peer - @rtco/peer is heavily inspired by simple-peer and maintains similar goals.
• Socket.io - Used as the connection protocol between peers and the signaling server.
• RTCMultiConnection - Artico aims at providing advanced features found in this great project.

artico's Issues

Unable to install @rtco/client

I stumbled upon this project searching for peerjs which is not maintained anymore. But I cant seem to install this..

error Couldn't find package "@rtco/logger@*" required by "@rtco/client" on the "npm" registry.

I tried both yarn and npm, both gave me the same error.

Unable to answer call in Edge

This is a simple implementation of the @rtco.client library.
GitHub | VercelHosted

So, when I attempt to call from Edge and answer it from any other browser (tried: OperaGX, Chrome Mobile), the answer call function is working correctly and the call is opening, but when I call from any browser (tried: Edge, OperaGX, Chrome Mobile) to Edge, the answer call function won't work, i.e. the call.on("open") is not being triggered.

How to setup custom TURN & STUN server in Room example ?

In Room example i can see

import { Artico } from "@rtco/client";

const rtco = new Artico();

I couldn't find the option to add custom TURN & STUN server in this Artico class, those are only available in Peer class which is in @rtco/peer

How can i add the RTCConfiguration in the Room example ?