sdp-lines

SDP in-place line modification library

npm install sdp-lines
2 downloads in the last week
4 downloads in the last month

sdp-lines

This is a simple SDP library designed for in-place modification of sdp lines.

NPM

Build Status

Why?

SDP parsing in browsers is relatively brittle (and not currently compliant with the latest SDP RFC: 4566). This library has been developed as an interim approach for dealing with SDP generated by a browser.

It follows the following rules:

  • The order of SDP lines is never modified (in order = out order)

  • SDP lines are not modified unless a specific tweak requires modifying the line. That is, a line is not parsed and regenerated unless a particular modification operation requires it.

  • Any new lines added to the SDP are added either after existing lines of the same time (for instance a lines), or if no other lines exist within the relevant scope, then immediately after the line type specified in the 4566 RFC.

Example Usage

To be completed.

Alternative Options

If you are looking for an SDP parser which works with an intermediate JS object format, then any of the libraries below will do what you need:

The following standard documents are related to SDP with regards to WebRTC:

modify(regex, modifier)

The modify method is used to apply a change to the underlying data. When a line matches the specified regex, the modifier function is invoked with the following function signature:

function modifier(line, match, type, payload) {
  // return the line to reinject back into the sdp
  return line;
}

The arguments to the following are as follows:

  • line: the full line that matched the regex
  • match: the match result from executing the regex
  • type: the line type which is specified prior to the = (e.g. a)
  • payload: the payload of the line (after the = character)

In the sample modifier above, we simply return the line unchanged, but we can reformat the line or replace it entirely.

toString()

Convert back to a string representation

License(s)

MIT

Copyright (c) 2013 Damon Oehlman damon.oehlman@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you