semantic-sdp 3.23.0 | Documentation

semantic-sdp

3.23.0

CandidateInfo ▸
- Static members
- .expand
- Instance members
- #equals
- #clone
- #plain
- #getFoundation
- #getComponentId
- #getTransport
- #getPriority
- #getAddress
- #getPort
- #getType
- #getRelAddr
- #getRelPort
CryptoInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getSessionParams
- #getKeyParams
- #getSuite
- #getTag
RTCPFeedbackInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getId
- #getParams
SourceInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getCName
- #setCName
- #getStreamId
- #setStreamId
- #getTrackId
- #setTrackId
- #getSSRC
CodecInfo ▸
- Static members
- .expand
- .MapFromNames
- Instance members
- #clone
- #plain
- #setRTX
- #getType
- #setType
- #getCodec
- #getParams
- #addParam
- #hasParam
- #getParam
- #hasRTX
- #getRTX
- #hasChannels
- #getChannels
- #setChannels
- #addRTCPFeedback
- #getRTCPFeedbacks
SimulcastStreamInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #isPaused
- #getId
SourceGroupInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getSemantics
- #getSSRCs
StreamInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getId
- #addTrack
- #getFirstTrack
- #getTracks
- #removeAllTracks
- #getTrack
TrackEncodingInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getId
- #getCodecs
- #addCodec
- #getParams
- #setParams
- #addParam
- #isPaused
DTLSInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getFingerprint
- #getHash
- #getSetup
- #setSetup
Direction ▸
- Static members
- .byValue
- .toString
- .reverse
DirectionWay ▸
- Static members
- .byValue
- .toString
- .reverse
ICEInfo ▸
- Static members
- .generate
- .expand
- Instance members
- #clone
- #plain
- #getUfrag
- #getPwd
- #isLite
- #setLite
RIDInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getId
- #getDirection
- #getDirection
- #setDirection
- #setDirection
- #getFormats
- #setFormats
- #getParams
- #setParams
- #addParam
Setup ▸
- Static members
- .byValue
- .toString
- .reverse
SimulcastInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #addSimulcastAlternativeStreams
- #addSimulcastStream
- #getSimulcastStreams
TrackInfo ▸
- Static members
- .expand
- Instance members
- #clone
- #plain
- #getMedia
- #setMediaId
- #getMediaId
- #getId
- #addSSRC
- #getSSRCs
- #addSourceGroup
- #getSourceGroup
- #getSourceGroups
- #hasSourceGroup
- #getEncodings
- #addEncoding
- #addAlternativeEncodings
- #setEncodings
MediaInfo ▸
- Static members
- .create
- .expand
- Instance members
- #clone
- #plain
- #getType
- #getId
- #setId
- #addExtension
- #addRID
- #addCodec
- #setCodecs
- #getCodecForType
- #getCodec
- #hasCodec
- #getCodecs
- #hasRTX
- #getExtensions
- #getRIDs
- #getRID
- #getBitrate
- #setBitrate
- #getDirection
- #setDirection
- #hasControl
- #getControl
- #setControl
- #answer
- #getSimulcast
- #setSimulcast
SDPInfo ▸
- Static members
- .create
- .expand
- .process
- .parse
- Instance members
- #clone
- #plain
- #unify
- #setVersion
- #addMedia
- #getMedia
- #getMediasByType
- #getMediaById
- #replaceMedia
- #getMedias
- #getVersion
- #getDTLS
- #setDTLS
- #hasCrypto
- #getCrypto
- #setCrypto
- #hasICE
- #getICE
- #setICE
- #addCandidate
- #addCandidates
- #getCandidates
- #getStream
- #getStreams
- #getFirstStream
- #addStream
- #removeStream
- #removeAllStreams
- #getTrackByMediaId
- #getStreamByMediaId
- #answer
- #toString
- #toIceFragmentString

Need help reading this?

CandidateInfo

ICE candidate information

CandidateInfo

Parameters

foundation (String)

componentId (Number)

transport (String)

priority (Number)

address (String)

port (Number)

type (String)

relAddr (String)

relPort (String)

Static Members

▸ expand(plain)

Expands a plain JSON object containing an CandidateInfo

expand(plain: Object): CandidateInfo

Parameters

plain (Object) JSON object

Returns

CandidateInfo: Parsed Candidate info

Instance Members

▸ equals(candidate)

Check if the ice candadate has same info as us

equals(candidate: CandidateInfo): Boolean

Parameters

candidate (CandidateInfo) ICE candadate to check against

Returns

Boolean:

▸ clone()

Create a clone of this Candidate info object

clone(): CandidateInfo

Returns

CandidateInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getFoundation()

Get the candidate foundation

getFoundation(): String

Returns

String:

▸ getComponentId()

Get the candidate component id

getComponentId(): Number

Returns

Number:

▸ getTransport()

Get the candidate transport type

getTransport(): String

Returns

String:

▸ getPriority()

Get the candidate priority

getPriority(): Number

Returns

Number:

▸ getAddress()

Get the candidate IP address

getAddress(): String

Returns

String:

▸ getPort()

Get the candidate IP port

getPort(): Number

Returns

Number:

▸ getType()

Get the candidate type

getType(): String

Returns

String:

▸ getRelAddr()

Get the candidate related IP address for relfexive candidates

getRelAddr(): String

Returns

String:

▸ getRelPort()

Get the candidate related IP port for relfexive candidates

getRelPort(): Number

Returns

Number:

CryptoInfo

SDES peer info

CryptoInfo

Parameters

tag (Number)

suite (String)

keyParams (String)

sessionParams (String)

Static Members

▸ expand(plain)

Expands a plain JSON object containing an CryptoInfo

expand(plain: Object): CryptoInfo

Parameters

plain (Object) JSON object

Returns

CryptoInfo: Parsed SDES info

Instance Members

▸ clone()

Create a clone of this SDES info object

clone(): CryptoInfo

Returns

CryptoInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getSessionParams()

Return the SDES session params

getSessionParams(): String

Returns

String:

▸ getKeyParams()

Return the SDES key params

getKeyParams(): String

Returns

String:

▸ getSuite()

Returns the chypher suite

getSuite(): String

Returns

String:

▸ getTag()

Get SDES tag

getTag(): Number

Returns

Number:

RTCPFeedbackInfo

RTCP Feedback parameter

RTCPFeedbackInfo

Parameters

id (String) RTCP feedback id

params (Array<String>) RTCP feedback params

Static Members

▸ expand(plain)

Expands a plain JSON object containing an CodecInfo

expand(plain: Object): CodecInfo

Parameters

plain (Object) JSON object

Returns

CodecInfo: Parsed Codec info

Instance Members

▸ clone()

Create a clone of this RTCPFeedbackParameter info object

clone(): RTCPFeedbackInfo

Returns

RTCPFeedbackInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getId()

Get id fo the rtcp feedback parameter

getId(): String

Returns

String:

▸ getParams()

Get codec rtcp feedback parameters

getParams(): Array<String>

Returns

Array<String>: parameters

SourceInfo

Strem Source information

SourceInfo

Parameters

ssrc (Number)

Static Members

▸ expand(plain)

Expands a plain JSON object containing an SourceInfo

expand(plain: Object): SourceInfo

Parameters

plain (Object) JSON object

Returns

SourceInfo: Parsed Source info

Instance Members

▸ clone()

Create a clone of this source info object

clone(): SourceInfo

Returns

SourceInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getCName()

Get source CName

getCName(): String

Returns

String:

▸ setCName(cname)

Set source CName

setCName(cname: String)

Parameters

cname (String)

▸ getStreamId()

Get associated stream id

getStreamId(): Number

Returns

Number:

▸ setStreamId(streamId)

Set associated stream id for this ssrc

setStreamId(streamId: String)

Parameters

streamId (String)

▸ getTrackId()

Get associated track id

getTrackId(): Number

Returns

Number:

▸ setTrackId(trackId)

Set associated track id for this ssrc

setTrackId(trackId: String)

Parameters

trackId (String)

▸ getSSRC()

Get ssrc from source

getSSRC(): Number

Returns

Number:

CodecInfo

Codec information extracted for RTP payloads

CodecInfo

Parameters

codec (String) Codec name

type (Number) the payload type number

params (Object) Format params for codec

Static Members

▸ expand(plain)

Expands a plain JSON object containing an CodecInfo

expand(plain: Object): CodecInfo

Parameters

plain (Object) JSON object

Returns

CodecInfo: Parsed Codec info

▸ MapFromNames(names, rtx, rtcpfbs, params)

Create a map of CodecInfo from codec names. Payload type is assigned dinamically

MapFromNames(names: Array<String>, rtx: Boolean, rtcpfbs: any, params: Array<String>): Map<String, CodecInfo>

Parameters

names (Array<String>)

rtx (Boolean) Should we add rtx?

rtcpfbs (any)

params (Array<String>) RTCP feedback params

Returns

Map<String, CodecInfo>:

Instance Members

▸ clone()

Create a clone of this Codec info object

clone(): CodecInfo

Returns

CodecInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ setRTX(rtx)

Set the RTX payload type number for this codec

setRTX(rtx: Number)

Parameters

rtx (Number)

▸ getType()

Get payload type for codec

getType(): Number

Returns

Number:

▸ setType(type)

Set the payload type for codec

setType(type: Number)

Parameters

type (Number)

▸ getCodec()

Get codec name

getCodec(): String

Returns

String:

▸ getParams()

Get codec format parameters

getParams()

▸ addParam(key, value)

Add codec info param

addParam(key: String, value: String)

Parameters

key (String)

value (String)

▸ hasParam(key)

Check if codec has requested param

hasParam(key: String): Boolean

Parameters

key (String)

Returns

Boolean:

▸ getParam(key, defaultValue)

Get param

getParam(key: String, defaultValue: String): Boolean

Parameters

key (String)

defaultValue (String) default value if param is not found

Returns

Boolean:

▸ hasRTX()

Check if this codec has an associated RTX payload type

hasRTX(): Number

Returns

Number:

▸ getRTX()

Get the associated RTX payload type for this codec

getRTX(): Number

Returns

Number:

▸ hasChannels()

Check if this codec has number of channels

hasChannels(): Number

Returns

Number:

▸ getChannels()

Get the number of channels

getChannels(): Number

Returns

Number:

▸ setChannels(channels)

Set the number of channels

setChannels(channels: Number)

Parameters

channels (Number)

▸ addRTCPFeedback(rtcpfb)

Add an RTCP feedback parameter to this codec type

addRTCPFeedback(rtcpfb: RTCPFeedbackInfo)

Parameters

rtcpfb (RTCPFeedbackInfo) RTCP feedback info object

▸ getRTCPFeedbacks()

Get all extensions rtcp feedback parameters in this codec info

getRTCPFeedbacks(): Set<RTCPFeedbackInfo>

Returns

Set<RTCPFeedbackInfo>:

SimulcastStreamInfo

Simulcast streams info

SimulcastStreamInfo

Parameters

id (String) rid for this simulcast stream

paused (Boolean) If this stream is initially paused

Static Members

▸ expand(plain)

Expands a plain JSON object containing an SimulcastStreamInfo

expand(plain: Object): SimulcastStreamInfo

Parameters

plain (Object) JSON object

Returns

SimulcastStreamInfo: Parsed SimulcastStream info

Instance Members

▸ clone()

Create a clone of this simulcast stream info object

clone(): SimulcastStreamInfo

Returns

SimulcastStreamInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ isPaused()

Is the stream paused

isPaused(): Boolean

Returns

Boolean:

▸ getId()

Get rid in this stream

getId(): String

Returns

String:

SourceGroupInfo

Group of SSRCS info

SourceGroupInfo

Parameters

semantics (String) Group semantics

ssrcs (Array<Number>) SSRC list

Static Members

▸ expand(plain)

Expands a plain JSON object containing an SourceGroupInfo

expand(plain: Object): SourceGroupInfo

Parameters

plain (Object) JSON object

Returns

SourceGroupInfo: Parsed SourceGroup info

Instance Members

▸ clone()

Create a clone of this source group info object

clone(): SourceGroupInfo

Returns

SourceGroupInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getSemantics()

Get group semantics

getSemantics(): String

Returns

String:

▸ getSSRCs()

Get list of ssrcs from this group

getSSRCs(): Array<Number>

Returns

Array<Number>:

StreamInfo

Media Stream information

StreamInfo

Parameters

id (String)

Static Members

▸ expand(plain)

Expands a plain JSON object containing an StreamInfo

expand(plain: Object): StreamInfo

Parameters

plain (Object) JSON object

Returns

StreamInfo: Parsed Stream info

Instance Members

▸ clone()

Create a clone of this stream info object

clone(): StreamInfo

Returns

StreamInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getId()

Get the media stream id

getId(): String

Returns

String:

▸ addTrack(track)

Add media track

addTrack(track: TrackInfo)

Parameters

track (TrackInfo)

▸ getFirstTrack(media)

Get firs track for the media type

getFirstTrack(media: String): TrackInfo

Parameters

media (String) Media type "audio"|"video"

Returns

TrackInfo:

▸ getTracks()

Get all tracks from the media stream

getTracks(): Map.TrackInfo

Returns

Map.TrackInfo:

▸ removeAllTracks()

Remove all tracks from media sream

removeAllTracks()

▸ getTrack(trackId)

Get track by id

getTrack(trackId: String): TrackInfo

Parameters

trackId (String)

Returns

TrackInfo:

TrackEncodingInfo

Simulcast encoding layer information for track

TrackEncodingInfo

Parameters

id (String) rid value

paused (any)

Static Members

▸ expand(plain)

Expands a plain JSON object containing an TrackEncodingInfo

expand(plain: Object): TrackEncodingInfo

Parameters

plain (Object) JSON object

Returns

TrackEncodingInfo: Parsed TrackEncoding info

Instance Members

▸ clone()

Create a clone of this RID info object

clone(): TrackEncodingInfo

Returns

TrackEncodingInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getId()

Get the rid id value

getId(): String

Returns

String:

▸ getCodecs()

Get codec information for this encoding (if any)

getCodecs(): Map<String, CodecInfo>

Returns

Map<String, CodecInfo>:

▸ addCodec(codec)

Add codec info

addCodec(codec: CodecInfo)

Parameters

codec (CodecInfo) Codec Info

▸ getParams()

Get the rid params

getParams(): Map<String, String>

Returns

Map<String, String>: The params map

▸ setParams(params)

Set the rid params

setParams(params: Map<String, String>)

Parameters

params (Map<String, String>) rid params map

▸ addParam(id, param)

Add an rid param

addParam(id: String, param: String)

Parameters

id (String)

param (String)

▸ isPaused()

Is the stream paused

isPaused(): Boolean

Returns

Boolean:

DTLSInfo

DTLS peer info

DTLSInfo

Parameters

setup (Setup) Setup type

hash (String) Hash function

fingerprint (String) Peer fingerprint

Static Members

▸ expand(plain)

Expands a plain JSON object containing an DTLSInfo

expand(plain: Object): DTLSInfo

Parameters

plain (Object) JSON object

Returns

DTLSInfo: Parsed DTLS info

Instance Members

▸ clone()

Create a clone of this DTLS info object

clone(): DTLSInfo

Returns

DTLSInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getFingerprint()

Get peer fingerprint

getFingerprint(): String

Returns

String:

▸ getHash()

Get hash function name

getHash(): String

Returns

String:

▸ getSetup()

Get connection setup

getSetup(): Setup

Returns

Setup:

▸ setSetup(setup)

Set connection setup

setSetup(setup: Setup)

Parameters

setup (Setup)

Direction

Enum for Direction values.

Direction

Type: number

Static Members

▸ byValue(direction)

Get Direction by name

byValue(direction: string): Direction

Parameters

direction (string)

Returns

Direction:

▸ toString(direction)

Get Direction name

toString(direction: Direction): String

Parameters

direction (Direction)

Returns

String:

▸ reverse(direction)

Get reverse direction

reverse(direction: Direction): Direction

Parameters

direction (Direction)

Returns

Direction: Reversed direction

DirectionWay

Enum for DirectionWay Way values.

DirectionWay

Type: number

Static Members

▸ byValue(direction)

Get Direction Way by name

byValue(direction: string): DirectionWay

Parameters

direction (string)

Returns

DirectionWay:

▸ toString(direction)

Get Direction Way name

toString(direction: DirectionWay): String

Parameters

direction (DirectionWay)

Returns

String:

▸ reverse(direction)

Get reverse direction way

reverse(direction: DirectionWay): DirectionWay

Parameters

direction (DirectionWay)

Returns

DirectionWay: Reversed direction

ICEInfo

ICE information for a peer

ICEInfo

Parameters

ufrag (String) Peer ICE username framgent

pwd (String) Peer ICE password

Static Members

▸ generate(lite)

Genereate a new peer ICE info with ramdom values

generate(lite: Boolean): ICEInfo

Parameters

lite (Boolean) Set ICE lite flag

Returns

ICEInfo:

▸ expand(plain)

Expands a plain JSON object containing an ICEInfo

expand(plain: Object): ICEInfo

Parameters

plain (Object) JSON object

Returns

ICEInfo: Parsed ICE info

Instance Members

▸ clone()

Create a clone of this Codec info object

clone(): ICEInfo

Returns

ICEInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getUfrag()

Get username fragment

getUfrag(): String

Returns

String: ufrag

▸ getPwd()

Get username password

getPwd(): String

Returns

String: password

▸ isLite()

Is peer ICE lite

isLite(): Boolean

Returns

Boolean:

▸ setLite(lite)

Set peer as ICE lite

setLite(lite: boolean)

Parameters

lite (boolean)

RIDInfo

RID info

RIDInfo

Parameters

id (String) rid value

direction (DirectionWay) direction

Static Members

▸ expand(plain)

Expands a plain JSON object containing an RIDInfo

expand(plain: Object): RIDInfo

Parameters

plain (Object) JSON object

Returns

RIDInfo: Parsed RID info

Instance Members

▸ clone()

Create a clone of this RID info object

clone(): RIDInfo

Returns

RIDInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getId()

Get the rid id value

getId(): String

Returns

String:

▸ getDirection()

Get rid direction

getDirection(): DirectionWay

Returns

DirectionWay:

▸ getDirection()

Get rid direction

getDirection(): DirectionWay

Returns

DirectionWay:

▸ setDirection(direction)

Set direction setup

setDirection(direction: DirectionWay)

Parameters

direction (DirectionWay)

▸ setDirection(direction)

Set direction setup

setDirection(direction: DirectionWay)

Parameters

direction (DirectionWay)

▸ getFormats()

Get pt formats for rid

getFormats(): Array.Number

Returns

Array.Number:

▸ setFormats(formats)

Set pt formats for rid

setFormats(formats: Array)

Parameters

formats (Array)

▸ getParams()

Get the rid params

getParams(): Map<String, String>

Returns

Map<String, String>: The params map

▸ setParams(params)

Set the rid params

setParams(params: Map<String, String>)

Parameters

params (Map<String, String>) rid params map

▸ addParam(id, param)

Add an rid param

addParam(id: String, param: String)

Parameters

id (String)

param (String)

Setup

Enum for Setup values.

Setup

Type: number

Static Members

▸ byValue(setup)

Get Setup by name

byValue(setup: string): Setup

Parameters

setup (string)

Returns

Setup:

▸ toString(setup)

Get Setup name

toString(setup: Setup): String

Parameters

setup (Setup)

Returns

String:

▸ reverse(setup)

Get reverse Setup

reverse(setup: Setup): Setup

Parameters

setup (Setup)

Returns

Setup:

SimulcastInfo

Simulcast information

SimulcastInfo

Static Members

▸ expand(plain)

Expands a plain JSON object containing an SimulcastInfo

expand(plain: Object): SimulcastInfo

Parameters

plain (Object) JSON object

Returns

SimulcastInfo: Parsed Simulcast info

Instance Members

▸ clone()

Create a clone of this track info object

clone(): SimulcastInfo

Returns

SimulcastInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ addSimulcastAlternativeStreams(direction, streams)

Add a simulcast alternative streams for the specific direction

addSimulcastAlternativeStreams(direction: DirectionWay, streams: Array<SimulcastStreamInfo>)

Parameters

direction (DirectionWay) Which direction you want the streams for

streams (Array<SimulcastStreamInfo>) Stream info of all the alternatives

▸ addSimulcastStream(direction, stream)

Add a single simulcast stream for the specific direction

addSimulcastStream(direction: DirectionWay, stream: Array<SimulcastStreamInfo>)

Parameters

direction (DirectionWay) Which direction you want the streams for

stream (Array<SimulcastStreamInfo>) Stream info of all the alternatives

▸ getSimulcastStreams(direction)

Get all simulcast streams by direction

getSimulcastStreams(direction: DirectionWay): Array<Array<SimulcastStreamInfo>>

Parameters

direction (DirectionWay) Which direction you want the streams for

Returns

Array<Array<SimulcastStreamInfo>>:

TrackInfo

Media Track information

TrackInfo

Parameters

media (String) Media type "audio"|"video"

id (String) Track id

Static Members

▸ expand(plain)

Expands a plain JSON object containing an TrackInfo

expand(plain: Object): TrackInfo

Parameters

plain (Object) JSON object

Returns

TrackInfo: Parsed Track info

Instance Members

▸ clone()

Create a clone of this track info object

clone(): TrackInfo

Returns

TrackInfo:

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getMedia()

Get media type

getMedia(): String

Returns

String: "audio"|"video"

▸ setMediaId(mediaId)

Set the media line id this track belongs to. Set to null for first media line of the media type

setMediaId(mediaId: String)

Parameters

mediaId (String) MediaInfo id

▸ getMediaId()

Returns the MediaInfo id this track belongs two (unified) or undefined if indiferent (plan B)

getMediaId(): String

Returns

String:

▸ getId()

Get track id

getId(): String

Returns

String:

▸ addSSRC(ssrc)

Add ssrc for this track

addSSRC(ssrc: Number)

Parameters

ssrc (Number)

▸ getSSRCs()

Get all

getSSRCs(): Array

Returns

Array:

▸ addSourceGroup(group)

Add source group to track

addSourceGroup(group: SourceGroupInfo)

Parameters

group (SourceGroupInfo)

▸ getSourceGroup(schematics)

Get the source group fot the desired type

getSourceGroup(schematics: String): SourceGroupInfo

Parameters

schematics (String) Group type

Returns

SourceGroupInfo:

▸ getSourceGroups()

Get all source groups for this track

getSourceGroups(): Array<SourceGroupInfo>

Returns

Array<SourceGroupInfo>:

▸ hasSourceGroup(schematics)

Check if track has a group for this type

hasSourceGroup(schematics: String): Boolean

Parameters

schematics (String)

Returns

Boolean:

▸ getEncodings()

Get simulcast encoding information for this track (if any)

getEncodings(): Array<Array<TrackEncodingInfo>>

Returns

Array<Array<TrackEncodingInfo>>:

▸ addEncoding(encoding)

Add simulcast encoding information for this track

addEncoding(encoding: TrackEncodingInfo)

Parameters

encoding (TrackEncodingInfo) Simulcast encoding info

▸ addAlternativeEncodings(alternatives)

Add simulcast encoding information for this track

addAlternativeEncodings(alternatives: Array<TrackEncodingInfo>)

Parameters

alternatives (Array<TrackEncodingInfo>) Simulcast encoding info

▸ setEncodings(encodings)

Add simulcast encoding information for this track

setEncodings(encodings: Array<Array<TrackEncodingInfo>>)

Parameters

encodings (Array<Array<TrackEncodingInfo>>) Simulcast encoding info

MediaInfo

Media information (relates to a m-line in SDP)

MediaInfo

Parameters

id (String) Media id

type (String) Media type "audio"|"video"

Static Members

▸ create(type, supported, null-null, rtx, rtcpbfs)

Helper factory for creating media info objects.

create(type: any, supported: Object, null-null: String, rtx: Boolean, rtcpbfs: Object): MediaInfo

Parameters

type (any)

supported (Object) Supported media capabilities to be included on media info

Name	Description
supported.codecs `(Map<String, CodecInfo> \| Array<String>)`	Map or codecInfo or list of strings with the supported codec names

null-null (String) Media type

rtx (Boolean) If rtx is supported for codecs (only needed if passing codec names instead of CodecInfo)

rtcpbfs (Object)

Returns

MediaInfo:

▸ expand(plain)

Expands a plain JSON object containing an MediaInfo

expand(plain: Object): MediaInfo

Parameters

plain (Object) JSON object

Returns

MediaInfo: Parsed Media info

Instance Members

▸ clone()

Clone MediaInfo object

clone(): MediaInfo

Returns

MediaInfo: cloned object

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ getType()

Get media type "audio"|"video"

getType(): String

Returns

String:

▸ getId()

Get id (msid) for the media info

getId(): String

Returns

String:

▸ setId(id)

Set id (msid) for the media info

setId(id: String)

Parameters

id (String)

▸ addExtension(id, name)

Add rtp header extension support

addExtension(id: Number, name: String)

Parameters

id (Number)

name (String)

▸ addRID(ridInfo)

Add rid information

addRID(ridInfo: RIDInfo)

Parameters

ridInfo (RIDInfo)

▸ addCodec(codecInfo)

Add Codec support information

addCodec(codecInfo: CodecInfo)

Parameters

codecInfo (CodecInfo) Codec info object

▸ setCodecs(codecs)

Set codec map

setCodecs(codecs: Map<Number, CodecInfo>)

Parameters

codecs (Map<Number, CodecInfo>) Map of codec info objecs

▸ getCodecForType(type)

Get codec for payload type number

getCodecForType(type: Number): CodecInfo

Parameters

type (Number) Payload type number

Returns

CodecInfo: codec info object

▸ getCodec(codec)

Get codec by codec name

getCodec(codec: String): CodecInfo

Parameters

codec (String) Codec name (eg: "vp8")

Returns

CodecInfo:

▸ hasCodec(codec)

Check if this media has information for this codec

hasCodec(codec: String): Boolean

Parameters

codec (String) Codec name

Returns

Boolean:

▸ getCodecs()

Get all codecs in this media

getCodecs(): Map<Number, CodecInfo>

Returns

Map<Number, CodecInfo>:

▸ hasRTX()

Check if any of the codecs on the media description supports rtx

hasRTX(): Boolean

Returns

Boolean:

▸ getExtensions()

Get all extensions registered in this media info

getExtensions(): Map<Number, String>

Returns

Map<Number, String>:

▸ getRIDs()

Get all rids registered in this media info

getRIDs(): Map<String, RIDInfo>

Returns

Map<String, RIDInfo>:

▸ getRID(id)

Get rid info for id

getRID(id: String): RIDInfo

Parameters

id (String) rid value to get info for

Returns

RIDInfo:

▸ getBitrate()

Returns maximum bitrate for this media

getBitrate(): Number

Returns

Number:

▸ setBitrate(bitrate)

Set maximum bitrate for this media

setBitrate(bitrate: Number)

Parameters

bitrate (Number)

▸ getDirection()

Get media direction

getDirection(): Direction

Returns

Direction:

▸ setDirection(direction)

Set media direction

setDirection(direction: Direction)

Parameters

direction (Direction)

▸ hasControl()

Check if media has control attribute

hasControl(): Boolean

Returns

Boolean:

▸ getControl()

Get control attribute

getControl(): String

Returns

String:

▸ setControl(control)

Set control attribute

setControl(control: String)

Parameters

control (String)

▸ answer(supported)

Helper usefull for creating media info answers.

Will reverse the direction
For each supported codec, it will change the payload type to match the offer and append it to the answer
For each supported extension, it will append the ones present on the offer with the id offered

answer(supported: Object): MediaInfo

Parameters

supported (Object) Supported codecs and extensions to be included on answer

Name	Description
supported.codecs `Map<String, CodecInfo>`	List of strings with the supported codec names
supported.extensions `Set<String>`	List of strings with the supported codec names
supported.simulcast `Boolean`	Simulcast is enabled
supported.rtcpfbs `Array<String>`	Supported RTCP feedback params

Returns

MediaInfo:

▸ getSimulcast()

Get Simulcast info

getSimulcast(): SimulcastInfo

Returns

SimulcastInfo:

▸ setSimulcast(simulcast)

Set stream simulcast info

setSimulcast(simulcast: SimulcastInfo)

Parameters

simulcast (SimulcastInfo) Simulcast stream info

SDPInfo

SDP semantic info object This object represent the minimal information of an WebRTC SDP in a semantic hierarchy

SDPInfo

Parameters

version (Number) SDP version attribute

Static Members

▸ create(params)

Create sdp based on the following info

create(params: Object): SDPInfo

Parameters

params (Object) Parameters to create ansser

Name	Description
params.ice `(ICEInfo \| Object)`	ICE info object
params.dtls `(DTLSInfo \| Object)`	DTLS info object
params.candidates `Array<CandidateInfo>`	Array of Ice candidates

Returns

SDPInfo: answer

▸ expand(plain)

Expands a plain JSON object containing an SDP INFO

expand(plain: Object): SDPInfo

Parameters

plain (Object) JSON object

Returns

SDPInfo: Parsed SDP info

▸ process(string)

Process an SDP string and convert it to a semantic SDP info

process(string: String): SDPInfo

Deprecated: Use SDPInfo.parse instead

Parameters

string (String) SDP

Returns

SDPInfo: Parsed SDP info

▸ parse(string)

Parses an SDP string and convert it to a semantic SDP info

parse(string: String): SDPInfo

Parameters

string (String) SDP

Returns

SDPInfo: Parsed SDP info

Instance Members

▸ clone()

Clone SDPinfo object

clone(): SDPInfo

Returns

SDPInfo: cloned object

▸ plain()

Return a plain javascript object which can be converted to JSON

plain(): Object

Returns

Object: Plain javascript object

▸ unify()

Returns an unified plan version of the SDP info

unify(): SDPInfo

Returns

SDPInfo: Unified version

▸ setVersion(version)

Set SDP version

setVersion(version: Number)

Parameters

version (Number)

▸ addMedia(media)

Add a new media description information to this sdp info

addMedia(media: MediaInfo)

Parameters

media (MediaInfo)

▸ getMedia(type)

Get first media description info associated to the media type

getMedia(type: String): MediaInfo

Parameters

type (String) Media type ('audio'|'video')

Returns

MediaInfo: or null if not found

▸ getMediasByType(type)

Get all media description info associated to the media type

getMediasByType(type: String): Array<MediaInfo>

Parameters

type (String) Media type ('audio'|'video')

Returns

Array<MediaInfo>: or null if not found

▸ getMediaById(msid)

Get media description info associated by media Ide

getMediaById(msid: String): MediaInfo

Parameters

msid (String) Media type ('audio'|'video')

Returns

MediaInfo: or null if not found

▸ replaceMedia(media)

Replace media with same id with the new one

replaceMedia(media: MediaInfo): boolean

Parameters

media (MediaInfo) The new media

Returns

boolean: true if the media was replaced, false if not found

▸ getMedias()

Return all media description information

getMedias(): Array<MediaInfo>

Returns

Array<MediaInfo>:

▸ getVersion()

Return SDP version attribute

getVersion(): Number

Returns

Number:

▸ getDTLS()

Get DTLS info for the transport bundle

getDTLS(): DTLSInfo

Returns

DTLSInfo: DTLS info object

▸ setDTLS(dtlsInfo)

Set DTLS info object for the transport bundle

setDTLS(dtlsInfo: DTLSInfo)

Parameters

dtlsInfo (DTLSInfo) DTLS info object

▸ hasCrypto()

Check if sdp is using crypto

hasCrypto(): boolean

Returns

boolean:

▸ getCrypto()

Get SDES info for the transport bundle

getCrypto(): SDESInfo

Returns

SDESInfo: DTLS info object

▸ setCrypto(cryptoInfo)

Set SDES info object for the transport bundle

setCrypto(cryptoInfo: SDESInfo)

Parameters

cryptoInfo (SDESInfo) DTLS info object

▸ hasICE()

Check if sdp is using ice

hasICE(): boolean

Returns

boolean:

▸ getICE()

Get the ICE info object for the transport bundle

getICE(): ICEInfo

Returns

ICEInfo: ICE info object

▸ setICE(iceInfo)

Set ICE info object for the transport bundle

setICE(iceInfo: ICEInfo)

Parameters

iceInfo (ICEInfo) ICE info object

▸ addCandidate(candidate)

Add ICE candidate for transport

addCandidate(candidate: CandidateInfo)

Parameters

candidate (CandidateInfo) ICE candidate

▸ addCandidates(candidates)

Add ICE candidates for transport

addCandidates(candidates: any)

Parameters

candidates (any)

▸ getCandidates()

Get all ICE candidates for this transport

getCandidates(): Array<CandidateInfo>

Returns

Array<CandidateInfo>:

▸ getStream(id)

Get announced stream

getStream(id: String): StreamInfo

Parameters

id (String)

Returns

StreamInfo:

▸ getStreams()

Get all announced stream

getStreams(): Array<StreamInfo>

Returns

Array<StreamInfo>:

▸ getFirstStream()

Get first announced stream

getFirstStream(): StreamInfo

Returns

StreamInfo:

▸ addStream(stream)

Announce a new stream in SDP

addStream(stream: StreamInfo)

Parameters

stream (StreamInfo)

▸ removeStream(stream)

Remove an announced stream from SDP

removeStream(stream: StreamInfo): boolean

Parameters

stream (StreamInfo)

Returns

boolean:

▸ removeAllStreams()

Remove all streams

removeAllStreams()

▸ getTrackByMediaId(mid)

getTrackByMediaId(mid: String): TrackInfo

Parameters

mid (String) Media Id

Returns

TrackInfo: Track info

▸ getStreamByMediaId(mid)

getStreamByMediaId(mid: String): TrackInfo

Parameters

mid (String) Media Id

Returns

TrackInfo: Streaminfo

▸ answer(params)

Create answer to this SDP

answer(params: Object): SDPInfo

Parameters

params (Object) Parameters to create ansser

Name	Description
params.ice `ICEInfo`	ICE info object
params.dtls `DTLSInfo`	DTLS info object
params.candidates `Array<CandidateInfo>`	Array of Ice candidates

Returns

SDPInfo: answer

▸ toString()

Convert to an SDP string

toString(): String

Returns

String:

▸ toIceFragmentString()

Convert to an SDP string for trickle-ice-sdpfrag

toIceFragmentString(): String

Returns

String: