rtc-sip v1.1.0

rtc-sip

This is an experiment at providing an integration between the rtc.io modules and the SIP.js library. This is done by providing a custom SIP.js mediaHandlerFactory that can be used to override the default WebRTC behaviour of SIP.js

NOTE: Incomplete

This package has been implemented to the point that it is usable for the following purpose:

• Using a SIP endpoint to attach to a WebRTC call for the purposes of recording audio.

While other features will be implemented over time, these are not as high a priority as other implementation tasks within the rtc.io suite.

Example Usage

Displayed below is an example of how you can use the rtc-sip/media-handler-factor to integrate with some of the rtc.io packages:

var config = require('rtc-sip/config.json');
var SIP = require('sip.js');
var ua = new SIP.UA({
  // initialise with the custom rtc.io media handler factory
  // specify any rtc.io plugins that you wish to use with in the plugins option
  mediaHandlerFactory: require('../media-handler-factory')({ plugins: [] }),

  // initialise the uri, authorizationUser and password
  uri: config.user + '@getonsip.com',
  displayName: 'rtc-sip demo user',

  authorizationUser: 'getonsip_' + config.user,
  password: config.password
});

// invite someone :)
ua.invite('damonoehlman@getonsip.com', {
  media: {
    constraints: {
      audio: true,
      video: true
    }
  }
});

To get this example running, you will need to signup for a free getonsip account and provide configuration information in an examples/config.json file (something like what is shown below):

{
  "user": "username",
  "password": "sippassword-check-your-profile"
}

License(s)

Apache 2.0

Copyright 2015 National ICT Australia Limited (NICTA)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.