Class Message

An SDP message.

Inheritance

System.Object

Message

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: FM.LiveSwitch.Sdp

Assembly: FM.LiveSwitch.dll

Syntax

public class Message

Constructors

Message(Origin)

Initializes a new instance of the Message class.

Declaration

public Message(Origin origin)

Parameters

Type	Name	Description
Origin	origin	The originator of the session plus a session identifier and version number.

Message(Origin, String)

Initializes a new instance of the Message class.

Declaration

public Message(Origin origin, string sessionName)

Parameters

Type	Name	Description
Origin	origin	The originator of the session plus a session identifier and version number.
System.String	sessionName	The textual session name.

Message(Origin, String, TimeDescription[])

Initializes a new instance of the Message class.

Declaration

public Message(Origin origin, string sessionName, TimeDescription[] timeDescriptions)

Parameters

Type	Name	Description
Origin	origin	The originator of the session plus a session identifier and version number.
System.String	sessionName	The textual session name.
TimeDescription[]	timeDescriptions	The array of start, stop, and repeat times for the session.

Properties

ApplicationDescription

Gets the first media description of type "application".

Declaration

public MediaDescription ApplicationDescription { get; }

Property Value

Type	Description
MediaDescription

ApplicationDescriptions

Gets any media descriptions of type "application".

Declaration

public MediaDescription[] ApplicationDescriptions { get; }

Property Value

Type	Description
MediaDescription[]

AudioDescription

Gets the first media description of type "audio".

Declaration

public MediaDescription AudioDescription { get; }

Property Value

Type	Description
MediaDescription

AudioDescriptions

Gets any media descriptions of type "audio".

Declaration

public MediaDescription[] AudioDescriptions { get; }

Property Value

Type	Description
MediaDescription[]

Bandwidths

Gets the array of proposed bandwidths to be used by the session.

Declaration

public Bandwidth[] Bandwidths { get; }

Property Value

Type	Description
Bandwidth[]

BundleGroups

Gets bundle groups in this media description.

Declaration

public BundleGroup[] BundleGroups { get; }

Property Value

Type	Description
BundleGroup[]

ConnectionData

Gets or sets session-level connection data.

Declaration

public ConnectionData ConnectionData { get; set; }

Property Value

Type	Description
ConnectionData

EmailAddress

Gets or sets the email address for the person responsible for the conference.

Declaration

public string EmailAddress { get; set; }

Property Value

Type	Description
System.String

EncryptionKey

Gets or sets the session-level encryption key.

Declaration

public EncryptionKey EncryptionKey { get; set; }

Property Value

Type	Description
EncryptionKey

MediaDescriptions

Gets the array of media descriptions.

Declaration

public MediaDescription[] MediaDescriptions { get; }

Property Value

Type	Description
MediaDescription[]

MessageDescription

Gets the first media description of type "message".

Declaration

public MediaDescription MessageDescription { get; }

Property Value

Type	Description
MediaDescription

MessageDescriptions

Gets any media descriptions of type "message".

Declaration

public MediaDescription[] MessageDescriptions { get; }

Property Value

Type	Description
MediaDescription[]

Origin

Gets or sets the originator of the session plus a session identifier and version number.

Declaration

public Origin Origin { get; }

Property Value

Type	Description
Origin

PhoneNumber

Gets or sets the phone number for the person responsible for the conference.

Declaration

public string PhoneNumber { get; set; }

Property Value

Type	Description
System.String

ProtocolVersion

Gets or sets the version of the Session Description Protocol.

Declaration

public string ProtocolVersion { get; }

Property Value

Type	Description
System.String

SessionAttributes

Gets the array of session-level attributes.

Declaration

public Attribute[] SessionAttributes { get; }

Property Value

Type	Description
Attribute[]

SessionInformation

Gets or sets textual information about the session.

Declaration

public string SessionInformation { get; set; }

Property Value

Type	Description
System.String

SessionName

Gets or sets the textual session name.

Declaration

public string SessionName { get; }

Property Value

Type	Description
System.String

SupportsRtcpMultiplexing

Gets a value indicating whether the SDP Message implies RTP/RTCP Multiplexing Support.

Declaration

public bool SupportsRtcpMultiplexing { get; }

Property Value

Type	Description
System.Boolean

SupportsTrickleIce

Gets or sets a value indicating whether Trickle-ICE is supported.

Declaration

public bool SupportsTrickleIce { get; set; }

Property Value

Type	Description
System.Boolean

TextDescription

Gets the first media description of type "text".

Declaration

public MediaDescription TextDescription { get; }

Property Value

Type	Description
MediaDescription

TextDescriptions

Gets any media descriptions of type "text".

Declaration

public MediaDescription[] TextDescriptions { get; }

Property Value

Type	Description
MediaDescription[]

TimeDescriptions

Gets the array of start, stop, and repeat times for the session.

Declaration

public TimeDescription[] TimeDescriptions { get; }

Property Value

Type	Description
TimeDescription[]

TimeZoneAdjustments

Gets or sets the time zone adjustments.

Declaration

public TimeZones TimeZoneAdjustments { get; set; }

Property Value

Type	Description
TimeZones

Uri

Gets or sets the pointer to additional information about the session.

Declaration

public Uri Uri { get; set; }

Property Value

Type	Description
System.Uri

VideoDescription

Gets the first media description of type "video".

Declaration

public MediaDescription VideoDescription { get; }

Property Value

Type	Description
MediaDescription

VideoDescriptions

Gets any media descriptions of type "video".

Declaration

public MediaDescription[] VideoDescriptions { get; }

Property Value

Type	Description
MediaDescription[]

Methods

AddBandwidth(Bandwidth)

Adds a proposed bandwidth.

Declaration

public void AddBandwidth(Bandwidth bandwidth)

Parameters

Type	Name	Description
Bandwidth	bandwidth	The proposed bandwidth to add.

AddMediaDescription(MediaDescription)

Adds a media description.

Declaration

public void AddMediaDescription(MediaDescription mediaDescription)

Parameters

Type	Name	Description
MediaDescription	mediaDescription	The media description to add.

AddSessionAttribute(Attribute)

Adds a session-level attribute.

Declaration

public void AddSessionAttribute(Attribute attribute)

Parameters

Type	Name	Description
Attribute	attribute	The session-level attribute to add.

AddTimeDescription(TimeDescription)

Adds a start, stop, and repeat time.

Declaration

public void AddTimeDescription(TimeDescription timeDescription)

Parameters

Type	Name	Description
TimeDescription	timeDescription	The start, stop, and repeat time to add.

GetSessionLevelCryptoAttributes()

Obtains Crypto attributes from the session-level attributes in this message. Crypto attributes may also be sent as a media-level argument, so individual media descriptions must also be examined.

Declaration

public CryptoAttribute[] GetSessionLevelCryptoAttributes()

Returns

Type	Description
CryptoAttribute[]

GetSessionLevelDirection()

Obtains the stream direction indicated as a session-level attribute in this message. If none is supplied, StreamDirection.Unset is returned. Stream Direction may also be (and most likely is) indicated as a media-level attribute, so individual media descriptions must also be examined.

Declaration

public StreamDirection GetSessionLevelDirection()

Returns

Type	Description
StreamDirection

GetSessionLevelFingerprintAttribute()

Obtains Fingerprint attribute from the session-level attributes in this message. Fingerprint attribute may also be sent as a media-level argument, so individual media descriptions must also be examined.

Declaration

public FingerprintAttribute GetSessionLevelFingerprintAttribute()

Returns

Type	Description
FingerprintAttribute

GetSessionLevelIceOptionAttributes()

Obtains session-level Ice Options attributes associated with the Sdp Message.

Declaration

public Attribute[] GetSessionLevelIceOptionAttributes()

Returns

Type	Description
Attribute[]

GetSessionLevelIcePasswordAttribute()

Obtains Ice Password Attribute from the session-level attributes in this message. Ice Password attribute may also be sent as a media-level argument, so individual media descriptions must also be examined.

Declaration

public PasswordAttribute GetSessionLevelIcePasswordAttribute()

Returns

Type	Description
PasswordAttribute

GetSessionLevelIceUfragAttribute()

Obtains Ice Ufrag Attribute from the session-level attributes in this message. Ice Ufrag Attributes may also be sent as a media-level argument, so individual media descriptions must also be examined.

Declaration

public UfragAttribute GetSessionLevelIceUfragAttribute()

Returns

Type	Description
UfragAttribute

GetSessionLevelRtcpMultiplexingSupport()

Returns a value stating whether Rtcp Multiplexing support is indicated as a session-level attribute in this message. Rtcp Multiplexing support may also be indicated via a media-level argument, so individual media descriptions must also be examined.

Declaration

public bool GetSessionLevelRtcpMultiplexingSupport()

Returns

Type	Description
System.Boolean

GetSessionLevelRtpExtMapAttributes()

Obtains session-level RTP ext-map attributes associated with the Sdp Message.

Declaration

public Attribute[] GetSessionLevelRtpExtMapAttributes()

Returns

Type	Description
Attribute[]

GetSessionLevelSetupAttribute()

Obtains Setup Attribute from the session-level attributes in this message. Setup Attributes may also be sent as a media-level argument, so individual media descriptions must also be examined.

Declaration

public SetupAttribute GetSessionLevelSetupAttribute()

Returns

Type	Description
SetupAttribute

InsertMediaDescription(Int32, MediaDescription)

Adds a media description at the given index.

Declaration

public void InsertMediaDescription(int index, MediaDescription mediaDescription)

Parameters

Type	Name	Description
System.Int32	index	The index at which to add the media description.
MediaDescription	mediaDescription	The media description to add.

Parse(String)

Creates an Message instance from a string.

Declaration

public static Message Parse(string s)

Parameters

Type	Name	Description
System.String	s	The string to parse.

Returns

Type	Description
Message

RemoveBandwidth(Bandwidth)

Removes a proposed bandwidth.

Declaration

public bool RemoveBandwidth(Bandwidth bandwidth)

Parameters

Type	Name	Description
Bandwidth	bandwidth	The proposed bandwidth to remove.

Returns

Type	Description
System.Boolean

RemoveMediaDescription(MediaDescription)

Removes a media description.

Declaration

public bool RemoveMediaDescription(MediaDescription mediaDescription)

Parameters

Type	Name	Description
MediaDescription	mediaDescription	The media description to remove.

Returns

Type	Description
System.Boolean

RemoveSessionAttribute(AttributeType)

Removes a session-level attribute.

Declaration

public bool RemoveSessionAttribute(AttributeType attributeType)

Parameters

Type	Name	Description
AttributeType	attributeType	The session-level attribute type to remove.

Returns

Type	Description
System.Boolean

RemoveTimeDescription(TimeDescription)

Removes a start, stop, and repeat time.

Declaration

public bool RemoveTimeDescription(TimeDescription timeDescription)

Parameters

Type	Name	Description
TimeDescription	timeDescription	The start, stop, and repeat time to remove.

Returns

Type	Description
System.Boolean

RemoveTimeDescriptions()

Removes all time descriptions.

Declaration

public void RemoveTimeDescriptions()

ToString()

Converts this instance to a string.

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

UpdateSetupValue(String)

Updates SDP Setup Value associated with the session description.

Declaration

public void UpdateSetupValue(string setupValue)

Parameters

Type	Name	Description
System.String	setupValue