Module: SdpParser

Simplify SDP parser.

Source: utils/SdpParser.js, line 25

Methods

(inner) adaptCodecName(sdp, codec, newCodecName) → {String}

Replace codec name of a SDP.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.
`codec`	String	Codec name to be replaced.
`newCodecName`	String	New codec name to replace.

Source: utils/SdpParser.js, line 215

Returns:

SDP updated with new codec name.

Type:: String

(inner) getAvailableHeaderExtensionIdRange(sdp) → {Array.<Number>}

Gets all available header extension IDs of the current Session Description.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.

Source: utils/SdpParser.js, line 290

Returns:

All available header extension IDs.

Type:: Array.<Number>

(inner) getAvailablePayloadTypeRange(sdp) → {Array.<Number>}

Gets all available payload type IDs of the current Session Description.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.

Source: utils/SdpParser.js, line 269

Returns:

All available payload type ids.

Type:: Array.<Number>

(inner) removeSdpLine(sdp, sdpLine) → {String}

Remove SDP line.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.
`sdpLine`	String	SDP line to remove.

Source: utils/SdpParser.js, line 194

Returns:

SDP without the line.

Type:: String

Example

SdpParser.removeSdpLine(sdp, 'custom line')

(inner) renegotiate(localDescription, remoteDescription)

Renegotiate remote sdp based on previous description. This function will fill missing m-lines cloning on the remote description by cloning the codec and extensions already negotiated for that media

Parameters:

Name	Type	Description
`localDescription`	String	Updated local sdp
`remoteDescription`	String	Previous remote sdp

Source: utils/SdpParser.js, line 311

(inner) setAbsoluteCaptureTime(sdp) → {String}

Mangle SDP for adding absolute capture time header extension.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.

Source: utils/SdpParser.js, line 126

Returns:

SDP mungled with abs-capture-time header extension.

Type:: String

Example

SdpParser.setAbsoluteCaptureTime(sdp)

(inner) setDTX(sdp) → {String}

Set DTX (Discontinuous Transmission) to the connection. Advanced configuration of the opus audio codec that allows for a large reduction in the audio traffic. For example, when a participant is silent, the audio packets won't be transmitted.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.

Source: utils/SdpParser.js, line 107

Returns:

SDP parsed with dtx support.

Type:: String

Example

SdpParser.setDTX(sdp)

(inner) setDependencyDescriptor(sdp) → {String}

Mangle SDP for adding dependency descriptor header extension.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.

Source: utils/SdpParser.js, line 148

Returns:

SDP mungled with abs-capture-time header extension.

Type:: String

Example

SdpParser.setAbsoluteCaptureTime(sdp)

(inner) setMultiopus(sdp, mediaStream) → {String}

Parse SDP for support multiopus. Only available in Google Chrome.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.
`mediaStream`	MediaStream	MediaStream offered in the stream.

Source: utils/SdpParser.js, line 233

Returns:

SDP parsed with multiopus support.

Type:: String

Example

SdpParser.setMultiopus(sdp, mediaStream)

(inner) setSimulcast(sdp, codec) → {String}

Parse SDP for support simulcast. Only available in Google Chrome.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.
`codec`	String	Codec.

Source: utils/SdpParser.js, line 30

Returns:

SDP parsed with simulcast support.

Type:: String

Example

SdpParser.setSimulcast(sdp, 'h264')

(inner) setStereo(sdp) → {String}

Parse SDP for support stereo.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.

Source: utils/SdpParser.js, line 88

Returns:

SDP parsed with stereo support.

Type:: String

Example

SdpParser.setStereo(sdp)

(inner) setVideoBitrate(sdp, bitrate) → {String}

Parse SDP for desired bitrate.

Parameters:

Name	Type	Description
`sdp`	String	Current SDP.
`bitrate`	Number	Bitrate value in kbps or 0 for unlimited bitrate.

Source: utils/SdpParser.js, line 170

Returns:

SDP parsed with desired bitrate.

Type:: String

Example

SdpParser.setVideoBitrate(sdp, 1000)

(inner) updateMissingVideoExtensions(localDescription, remoteDescription) → {String}

Adds missing extensions of each video section in the localDescription

Parameters:

Name	Type	Description
`localDescription`	String	Previous local sdp
`remoteDescription`	String	Remote sdp

Source: utils/SdpParser.js, line 353

Returns:

SDP updated with missing extensions.

Type:: String