Janode is a Node.js, browser compatible, adapter for the Janus WebRTC server.
Internally uses WebSockets or Unix DGRAM Sockets to connect to Janus.
The library wraps the Janus core API, the Janus Admin API and some of the most popular plugins APIs.
The supported Janus plugins currently are:
- EchoTest
- AudioBridge
- Streaming
- VideoRoom
The library is available on npm and the source code is on github.
This is just a pretty simple hello world for the echotest plugin. Read the examples on the git repo to have some more details.
import Janode from 'janode';
const { Logger } = Janode;
import EchoTestPlugin from 'janode/plugins/echotest';
const connection = await Janode.connect({
is_admin: false,
address: {
url: 'ws://127.0.0.1:8188/',
apisecret: 'secret'
}
});
const session = await connection.create();
// Attach to a plugin using the plugin descriptor
const echoHandle = await session.attach(EchoTestPlugin)
// Janode exports "EVENT" property with core events
echoHandle.on(Janode.EVENT.HANDLE_WEBRTCUP, _ => Logger.info('webrtcup event'));
echoHandle.on(Janode.EVENT.HANDLE_MEDIA, evtdata => Logger.info('media event', evtdata));
echoHandle.on(Janode.EVENT.HANDLE_SLOWLINK, evtdata => Logger.info('slowlink event', evtdata));
echoHandle.on(Janode.EVENT.HANDLE_HANGUP, evtdata => Logger.info('hangup event', evtdata));
echoHandle.on(Janode.EVENT.HANDLE_DETACHED, evtdata => Logger.info('detached event', evtdata));
// Refer to plugin documentation
// plugins export "EVENT" property with specific plugin events
echoHandle.on(EchoTestPlugin.EVENT.ECHOTEST_RESULT, evtdata => Logger.info('echotest result event', evtdata));
// Specific method exported by the plugin
// "offer" got from the client
const { jsep: answer } = await echoHandle.start({ video: true, jsep: offer });
// detach the handle
await echoHandle.detach();import Janode from 'janode';
const admin = await Janode.connect({
is_admin: true,
address: {
url: 'ws://127.0.0.1:7188/',
apisecret: 'secret'
}
});
// Get the list of active sessions
const data = await admin.listSessions();The kind of transport used for a connection depends on the protocol/scheme defined in the url field of the configuration.
/* Use UNIX DGRAM Sockets */
const admin = await Janode.connect({
is_admin: true,
address: {
url: 'file://tmp/janusapi',
apisecret: 'secret'
}
});/* Use WebSockets */
const admin = await Janode.connect({
is_admin: true,
address: {
url: 'ws://127.0.0.1:7188/',
apisecret: 'secret'
}
});Installing the library from npm is as easy as:
npm install janodeOn the other hand, in case you got the code from git you must build the library through:
npm run buildExamples are only available in the code fetched from git repo and are not published on npm.
cd examples/echotest
npm run build
npm run build-config
node src/echotest.js --janode-log=infoTo change the configuration edit config.js under src.
Janode should work in browsers. You need to create a bundle with the core library and the needed plugins using a tool that can:
- shim native node modules (e.g.
EventEmitter) - import commonjs modules (some dependencies could still use that format)
- parse the
browserfield in thepackage.json
If you get the code from the repo, you can find a rollup bundling sample in the bundle.sh script under examples/browser/.
The output will be a bundle.js script that defines an App global object with the members Janode and EchoTestPlugin.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent