SIP.js

• update several dependencies
• change Travis testing behaviors
• Allow overriding mediaHandlerFactory in UA#invite
• change hold event behavior to be more usable.
• Include REFER into allowed methods, and update REFER handling to be more in line with RFC 3515
• remove deprecation warning about iceServers

This release is mainly for changes to the Subscription logic which allow for correct behavior while unsubscribing, resubscribing, and some other edge cases. There are also several fixes to correct the build process. There are no known breaking changes, and we recommend upgrading if you are doing anything involving Subscriptions or plan to build SIP.js.

Full list of changes: https://github.com/onsip/SIP.js/compare/0.7.2...0.7.3

This release is primarily intended to address the removal of MediaStream.stop() from Chrome 47. There are no known breaking changes, and we recommend upgrading to maintain full compatibility with Chrome 47.

Full list of changes: https://github.com/onsip/SIP.js/compare/0.7.1...0.7.2

Bug fixes:

• Better Chrome Packaged App support: 36c1e30
• Session 'terminated' event is emitted with multiple args instead of an object: #173
• Registration options are preserved across re-registration: #179
• Multiple calls to UA#start before the UA has connected are ignored: #178
• Better iceCheckingTimeout support: 9e79141, 873c9da

New features:

• Add closeWithHeaders option to RegisterContext#register: #181, 608407e
• Try to renegotiate media on re-INVITE: #170
• Support sending double-CRLF keep-alive pings: #190
• npm run repl opens a browser with the SIP variable defined: https://github.com/onsip/SIP.js/commit/635c0ac27c763800a7eb48023bce0a62b93a0739
• (a handful of changes to allow UDP signaling via a custom Transport.js): 9b6bbff, 9097033, 620773c, 0bce005

As of 0.7.0, SIP.js no longer runs on browsers which do not support Promises. All WebRTC-capable browsers already support Promises, but this may affect browsers that were only supported at the signaling layer. Specifically, Internet Explorer.

Brief notes:

• BREAKING CHANGE: The options.media.render argument to UA#invite and Session#accept no longer has audio/video subfields. See MediaHandler#render
• Dependencies on global objects can now be injected at runtime: https://github.com/onsip/SIP.js/pull/108
• Our WebSocket dependency is now included using require('ws'). Thanks to Browserify, this shouldn't affect most users. Node.js users will have one less thing to worry about. https://github.com/onsip/SIP.js/commit/16bb9d0e44ddc50ce39fe16aba066e187b6dd329
• We are now using Promises internally. This has been the case on the Master branch for some time. Node.js users will be polyfilled to use promiscuous, or Node.js native Promises if available.
• The MediaHandler and MediaStreamManager interfaces use Promises instead of callbacks, and support zero/multiple streams. #175
• We are now using the Node.js native EventEmitter, bundled in Browserify. There are slight changes to the EventEmitter API due to this change, but old methods are supported (though deprecated) for now. https://github.com/onsip/SIP.js/commit/b07a368727c19676cb143479eb204ea2852f4992
• Session has a new terminated method. (Okay, it's not new, but we fixed how it works and document it now.)
• Session termination events (rejected, failed, cancel, bye, and terminated) have been cleaned up and now behave more consistently, both in terms of internal behavior and RFC specs. https://github.com/onsip/SIP.js/commit/6d8d79bec1ca6f9a6ebefdcc44c3aab46d2876a2
• The WebRTC MediaHandler now has many more events for ICE connection states and candidate gathering.
• Support for REFER with Replaces and INVITE with Replaces. https://github.com/onsip/SIP.js/commit/5170cfd4cca3cc15ba53ea65cc52b3a5e87d2f24
• A handful of other bug fixes.

1. Firefox 34 Support

Added a hack to allow Firefox 34 compatibility with some SIP clients. This issue is documented on FreeSWITCH Jira: https://freeswitch.org/jira/browse/FS-6955

2. Syntax sugar for rendering media

Usage:

new SIP.UA().invite('[email protected]', document.getElementsByTagName('audio')[0]);

See https://github.com/onsip/SIP.js/commit/d238523754ad4f6e2845ffd487c2961596a7c9ad

3. Support for Multiple/Zero STUN Servers

See 18ce4d8 (#93) and 28523b6 (#117)

4. Add hackWssInTransport to UA configuration to fix Asterisk problems

See 32bffbe

1. SIP.js can now be used as a Cordova plugin.

Caveats:

1. iOS support is broken at the time of this commit, see joseph-onsip/sipjs-cordova#6
2. config.xml doesn't reflect the plugin registry entry. See #83

Usage:

Shell:

  cordova plugin add com.onsip.sipjs # see https://github.com/onsip/SIP.js/issues/83
  # The following lines are needed for media support:
  cordova plugin add https://github.com/alongubkin/phonertc
  cordova plugin add com.sipjs.phonertc # This is already published to the registry

JS:

  var SIP = cordova.require('com.sipjs.sipjs');
  // The following line is needed for media support:
  var PhoneRTCMediaHandler = cordova.require('com.sipjs.phonertc.mediahandler')(SIP);
  var ua = new SIP.UA({
    // The following line is needed for media support:
    mediaHandlerFactory: PhoneRTCMediaHandler
  });

2. REFERs to non-SIP resources are supported.

Usage:
See https://github.com/onsip/SIP.js/commit/469a581f604fdcae9be6126d41fda4e1779c2b6b and https://github.com/onsip/SIP.js/commit/1406cba427a8962044526452f1b2f6f1b9cac844.

• browserify is now used to build SIP.js: https://github.com/onsip/SIP.js/pull/62 Notably, this means that applications using RequireJS should load SIP.js as an AMD module, instead of assuming SIP will be defined globally. See the Google Group thread for more detail.

• The syntax for the media property has changed slightly. You now need to put the constraints inside a constraints property. For example:

session.accept({
  media: {
    constraints: {
      audio: true,
      video: false
    }
  }
});

• UA#invite and Session#accept now allow an option specifying <audio> and <video> elements within which session media will be rendered. For example:

  var session = new SIP.UA().invite('[email protected]', {
    media: {
      render: {
        remote: {
          audio: document.createElement('audio'),
          video: document.createElement('video')
        },
        local: {
          audio: document.createElement('audio'),
          video: document.createElement('video')
        }
      }
    }
  });

• The Session's referred event has been removed. See the commit message of https://github.com/onsip/SIP.js/commit/3115223d0482dcfdb278da956d61da18d099c6b2 for an alternative.
• The Session's refer event handler's first argument is now a request, not a uri. The uri can be obtained as follows:

session.on('refer', function handleRefer (request) {
  var uri = request.parseHeader('refer-to').uri;
});

• If your application calls SIP.WebRTC.* functions directly, it should first call SIP.WebRTC.isSupported to ensure they are available.
• Using string constants for the rel100 UA Configuration Parameter has been deprecated (but still works for now). Applications should use SIP.C.supported constants instead. See http://sipjs.com/api/0.6.0/ua_configuration_parameters/#rel100