SDP Objects

Session Description Protocol (SDP) objects represent a multimedia session described by the SDP. An SDP object can be received from either Session Initiation Protocol (SIP Invite, Response, or Ack) or Media Gateway Control Protocol (MGCP).

SdpConnection

Provides the connection information for the session.

.network type
Type:

String

Description:

Type of network. For example, IN = Internet.

.address type
Type:

String

Description:

Type of address specified by the address property that follows. For example, IP4 or IP6.

.address
Type:

String

Description:

Connection address.

.TTL
Type:

Number

Description:

Time to live value that, along with the address property, defines the scope multicast packets in this connection are sent with.

.address count
Type:

Number

Description:

Number of addresses. This property can be used for applications requiring multiple multicast groups. If the number of addresses is not given, it is assumed to be 1.

SdpMedia

Describes the media that is offered for the session.

.media
Type:

String

Description:

Type of media to be offered in the session.

.port
Type:

Number

Description:

First port to be used for the session.

.port count
Type:

Number

Description:

Total number of ports to be used for the session.

.transport
Type:

String

Description:

Transport protocol used for the session.

Note

The ports used for the session depend on the transport protocol.

.fmt list
Type:

String

Description:

One or more media formats to be used for the session.

SdpOrigin

Specifies the originator information for the session.

.username
Type:

String

Description:

User name on the originating host.

.session id
Type:

String

Description:

Numeric string such that the tuple of username, session id, network type, address type, and address form a globally unique identifier for the session.

.version
Type:

String

Description:

Version number for this announcement.

.network type
Type:

String

Description:

Type of network. For example, IN = Internet.

.address type
Type:

String

Description:

Type of address specified by the address property that follows. For example, IP4 or IP6.

.address
Type:

String

Description:

Globally unique address of the machine that the session was created from.

SdpRtpMap

Array of strings, each corresponding to an a=line that is associated with this media description.

.payload type
Type:

Number

Description:

Type of payload for the session.

.encoding name
Type:

String

Description:

Name of the media encoding encapsulated in the RTP stream.

.clock rate
Type:

Number

Description:

Clock rate or frequency (Hz) of the media stream.

.encoding parameters
Type:

Number

Description:

Number of audio channels. This can be omitted if only one channel is provided.

Note

No encoding parameters are currently specified for video streams.

SdpSubject

Simple “string” parameter that specifies the session subject information. For example, phone call.

SdpTime

Indicates the time during which the session will be active.

.start
Type:

String

Description:

Time the session starts.

.stop
Type:

String

Description:

Time the session ends.

Note

These values are the decimal representation of Network Time Protocol (NTP) time values in seconds.

SdpVersion

Simple “number” parameter that specifies the SDP version number. For example, 0.