README.md

node-rtpengine

A Node client library for rtpengine.

Note: very much a work in progress!

The intent of this library is to make it easy to build tools that work with rtpengine. Rtpengine has a UDP-based API that involves sending a message of the following form:

[request cookie][space][bencoded request command payload]

It will respond with a message like:

[request cookie][space][bencoded reply payload]

This library abstracts away the UDP mess and makes it possible to work with rtpengine like this:

var client = new Client();

client.query({
	callId : "6eb82892-6804-4002-b2b6-363b7e11e435"
})
.then(function (reply) {
	// do something with the reply payload
})
.finally(client.destroy);

There is an example CLI in this repo that uses the library.