Show / Hide Table of Contents

Class SDP

Inheritance
System.Object
SDP
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: SIPSorcery.Net
Assembly: SIPSorcery.dll
Syntax
public class SDP

Constructors

| Improve this Doc View Source

SDP()

Declaration
public SDP()
| Improve this Doc View Source

SDP(IPAddress)

Declaration
public SDP(IPAddress address)
Parameters
Type Name Description
System.Net.IPAddress address

Fields

| Improve this Doc View Source

ADDRESS_TYPE_IPV4

Declaration
public const string ADDRESS_TYPE_IPV4 = "IP4"
Field Value
Type Description
System.String
| Improve this Doc View Source

ADDRESS_TYPE_IPV6

Declaration
public const string ADDRESS_TYPE_IPV6 = "IP6"
Field Value
Type Description
System.String
| Improve this Doc View Source

AddressOrHost

Declaration
public string AddressOrHost
Field Value
Type Description
System.String
| Improve this Doc View Source

AddressType

Declaration
public string AddressType
Field Value
Type Description
System.String
| Improve this Doc View Source

AnnouncementVersion

Declaration
public ulong AnnouncementVersion
Field Value
Type Description
System.UInt64
| Improve this Doc View Source

BandwidthAttributes

Declaration
public List<string> BandwidthAttributes
Field Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

Connection

Declaration
public SDPConnectionInformation Connection
Field Value
Type Description
SDPConnectionInformation
| Improve this Doc View Source

CRLF

Declaration
public const string CRLF = "\r\n"
Field Value
Type Description
System.String
| Improve this Doc View Source

DEFAULT_STREAM_STATUS

Declaration
public const MediaStreamStatusEnum DEFAULT_STREAM_STATUS = MediaStreamStatusEnum.SendRecv
Field Value
Type Description
MediaStreamStatusEnum
| Improve this Doc View Source

DEFAULT_TIMING

Declaration
public const string DEFAULT_TIMING = "0 0"
Field Value
Type Description
System.String
| Improve this Doc View Source

DTLS_FINGERPRINT_ATTRIBUTE_PREFIX

Declaration
public const string DTLS_FINGERPRINT_ATTRIBUTE_PREFIX = "fingerprint"
Field Value
Type Description
System.String
| Improve this Doc View Source

DtlsFingerprint

Declaration
public string DtlsFingerprint
Field Value
Type Description
System.String
| Improve this Doc View Source

END_ICE_CANDIDATES_ATTRIBUTE

Declaration
public const string END_ICE_CANDIDATES_ATTRIBUTE = "end-of-candidates"
Field Value
Type Description
System.String
| Improve this Doc View Source

ExtraSessionAttributes

Declaration
public List<string> ExtraSessionAttributes
Field Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

Group

Indicates multiple media offers will be bundled on a single RTP connection. Example: a=group:BUNDLE audio video

Declaration
public string Group
Field Value
Type Description
System.String
| Improve this Doc View Source

GROUP_ATRIBUTE_PREFIX

Declaration
public const string GROUP_ATRIBUTE_PREFIX = "group"
Field Value
Type Description
System.String
| Improve this Doc View Source

ICE_CANDIDATE_ATTRIBUTE_PREFIX

Declaration
public const string ICE_CANDIDATE_ATTRIBUTE_PREFIX = "candidate"
Field Value
Type Description
System.String
| Improve this Doc View Source

ICE_LITE_IMPLEMENTATION_ATTRIBUTE_PREFIX

Declaration
public const string ICE_LITE_IMPLEMENTATION_ATTRIBUTE_PREFIX = "ice-lite"
Field Value
Type Description
System.String
| Improve this Doc View Source

ICE_OPTIONS

Declaration
public const string ICE_OPTIONS = "ice-options"
Field Value
Type Description
System.String
| Improve this Doc View Source

ICE_PWD_ATTRIBUTE_PREFIX

Declaration
public const string ICE_PWD_ATTRIBUTE_PREFIX = "ice-pwd"
Field Value
Type Description
System.String
| Improve this Doc View Source

ICE_SETUP_ATTRIBUTE_PREFIX

Declaration
public const string ICE_SETUP_ATTRIBUTE_PREFIX = "setup"
Field Value
Type Description
System.String
| Improve this Doc View Source

ICE_UFRAG_ATTRIBUTE_PREFIX

Declaration
public const string ICE_UFRAG_ATTRIBUTE_PREFIX = "ice-ufrag"
Field Value
Type Description
System.String
| Improve this Doc View Source

IceCandidates

Declaration
public List<string> IceCandidates
Field Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

IceImplementation

Declaration
public IceImplementationEnum IceImplementation
Field Value
Type Description
IceImplementationEnum
| Improve this Doc View Source

IcePwd

Declaration
public string IcePwd
Field Value
Type Description
System.String
| Improve this Doc View Source

IceRole

Declaration
public IceRolesEnum? IceRole
Field Value
Type Description
System.Nullable<IceRolesEnum>
| Improve this Doc View Source

IceUfrag

Declaration
public string IceUfrag
Field Value
Type Description
System.String
| Improve this Doc View Source

IGNORE_RTP_PORT_NUMBER

Declaration
public const int IGNORE_RTP_PORT_NUMBER = 9
Field Value
Type Description
System.Int32
| Improve this Doc View Source

Media

Declaration
public List<SDPMediaAnnouncement> Media
Field Value
Type Description
System.Collections.Generic.List<SDPMediaAnnouncement>
| Improve this Doc View Source

MEDIA_ID_ATTRIBUTE_PREFIX

Declaration
public const string MEDIA_ID_ATTRIBUTE_PREFIX = "mid"
Field Value
Type Description
System.String
| Improve this Doc View Source

MEDIA_INDEX_NOT_PRESENT

Declaration
public const int MEDIA_INDEX_NOT_PRESENT = -1
Field Value
Type Description
System.Int32
| Improve this Doc View Source

MEDIA_INDEX_TAG_NOT_PRESENT

Declaration
public const string MEDIA_INDEX_TAG_NOT_PRESENT = ""
Field Value
Type Description
System.String
| Improve this Doc View Source

NetworkType

Declaration
public string NetworkType
Field Value
Type Description
System.String
| Improve this Doc View Source

OriginatorEmailAddresses

Declaration
public string[] OriginatorEmailAddresses
Field Value
Type Description
System.String[]
| Improve this Doc View Source

OriginatorPhoneNumbers

Declaration
public string[] OriginatorPhoneNumbers
Field Value
Type Description
System.String[]
| Improve this Doc View Source

SDP_MIME_CONTENTTYPE

Declaration
public const string SDP_MIME_CONTENTTYPE = "application/sdp"
Field Value
Type Description
System.String
| Improve this Doc View Source

SDP_PROTOCOL_VERSION

Declaration
public const decimal SDP_PROTOCOL_VERSION = 0M
Field Value
Type Description
System.Decimal
| Improve this Doc View Source

SessionDescription

Declaration
public string SessionDescription
Field Value
Type Description
System.String
| Improve this Doc View Source

SessionId

Declaration
public string SessionId
Field Value
Type Description
System.String
| Improve this Doc View Source

SessionName

Declaration
public string SessionName
Field Value
Type Description
System.String
| Improve this Doc View Source

TELEPHONE_EVENT_ATTRIBUTE

Declaration
public const string TELEPHONE_EVENT_ATTRIBUTE = "telephone-event"
Field Value
Type Description
System.String
| Improve this Doc View Source

Timing

Declaration
public string Timing
Field Value
Type Description
System.String
| Improve this Doc View Source

URI

Declaration
public string URI
Field Value
Type Description
System.String
| Improve this Doc View Source

Username

Declaration
public string Username
Field Value
Type Description
System.String
| Improve this Doc View Source

Version

Declaration
public decimal Version
Field Value
Type Description
System.Decimal

Properties

| Improve this Doc View Source

Owner

Declaration
public string Owner { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SessionMediaStreamStatus

The stream status of this session. The default is sendrecv. If child media announcements have an explicit status set then they take precedence.

Declaration
public MediaStreamStatusEnum? SessionMediaStreamStatus { get; set; }
Property Value
Type Description
System.Nullable<MediaStreamStatusEnum>

Methods

| Improve this Doc View Source

AddExtra(String)

Declaration
public void AddExtra(string attribute)
Parameters
Type Name Description
System.String attribute
| Improve this Doc View Source

GetIndexForMediaType(SDPMediaTypesEnum, Int32)

Media announcements can be placed in SDP in any order BUT the orders must match up in offer/answer pairs. This method can be used to get the index for a specific media type. It is useful for obtaining the index of a particular media type when constructing an SDP answer.

Declaration
public (int, string) GetIndexForMediaType(SDPMediaTypesEnum mediaType, int mediaIndex)
Parameters
Type Name Description
SDPMediaTypesEnum mediaType
System.Int32 mediaIndex
Returns
Type Description
System.ValueTuple<System.Int32, System.String>
| Improve this Doc View Source

GetMediaStreamStatus(SDPMediaTypesEnum, Int32)

Gets the media stream status for the specified media announcement.

Declaration
public MediaStreamStatusEnum GetMediaStreamStatus(SDPMediaTypesEnum mediaType, int announcementIndex)
Parameters
Type Name Description
SDPMediaTypesEnum mediaType

The type of media (audio, video etc) to get the status for.

System.Int32 announcementIndex

THe index of the announcement to get the status for.

Returns
Type Description
MediaStreamStatusEnum

The media stream status set on the announcement or if there is none the session. If there is also no status set on the session then the default value of sendrecv is returned.

| Improve this Doc View Source

GetSDPRTPEndPoint()

A convenience method to get the RTP end point for single audio offer SDP payloads.

Declaration
public IPEndPoint GetSDPRTPEndPoint()
Returns
Type Description
System.Net.IPEndPoint

The RTP end point for the first media end point.

| Improve this Doc View Source

GetSDPRTPEndPoint(String)

A convenience method to get the RTP end point for single audio offer SDP payloads.

Declaration
public static IPEndPoint GetSDPRTPEndPoint(string sdpMessage)
Parameters
Type Name Description
System.String sdpMessage

A string representing the SDP payload.

Returns
Type Description
System.Net.IPEndPoint

The RTP end point for the first media end point.

| Improve this Doc View Source

ParseSDPDescription(String)

Declaration
public static SDP ParseSDPDescription(string sdpDescription)
Parameters
Type Name Description
System.String sdpDescription
Returns
Type Description
SDP
| Improve this Doc View Source

RawString()

Declaration
public string RawString()
Returns
Type Description
System.String
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Extension Methods

JSONWriter.ToJson(Object)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX