fm.liveswitch.sdp.Message Class Reference

An SDP message. More...

Public Member Functions
void	addBandwidth (fm.liveswitch.sdp.Bandwidth bandwidth)
	Adds a proposed bandwidth. More...
void	addMediaDescription (fm.liveswitch.sdp.MediaDescription mediaDescription)
	Adds a media description. More...
void	addSessionAttribute (fm.liveswitch.sdp.Attribute attribute)
	Adds a session-level attribute. More...
void	addTimeDescription (fm.liveswitch.sdp.TimeDescription timeDescription)
	Adds a start, stop, and repeat time. More...
fm.liveswitch.sdp.MediaDescription	getApplicationDescription ()
	Gets the first media description of type "application". More...
fm.liveswitch.sdp.MediaDescription[]	getApplicationDescriptions ()
	Gets any media descriptions of type "application". More...
fm.liveswitch.sdp.MediaDescription	getAudioDescription ()
	Gets the first media description of type "audio". More...
fm.liveswitch.sdp.MediaDescription[]	getAudioDescriptions ()
	Gets any media descriptions of type "audio". More...
fm.liveswitch.sdp.Bandwidth[]	getBandwidths ()
	Gets the array of proposed bandwidths to be used by the session. More...
fm.liveswitch.sdp.BundleGroup[]	getBundleGroups ()
	Gets bundle groups in this media description. More...
fm.liveswitch.sdp.ConnectionData	getConnectionData ()
	Gets session-level connection data. More...
String	getEmailAddress ()
	Gets the email address for the person responsible for the conference. More...
fm.liveswitch.sdp.EncryptionKey	getEncryptionKey ()
	Gets the session-level encryption key. More...
fm.liveswitch.sdp.MediaDescription[]	getMediaDescriptions ()
	Gets the array of media descriptions. More...
fm.liveswitch.sdp.MediaDescription	getMessageDescription ()
	Gets the first media description of type "message". More...
fm.liveswitch.sdp.MediaDescription[]	getMessageDescriptions ()
	Gets any media descriptions of type "message". More...
fm.liveswitch.sdp.Origin	getOrigin ()
	Gets the originator of the session plus a session identifier and version number. More...
String	getPhoneNumber ()
	Gets the phone number for the person responsible for the conference. More...
String	getProtocolVersion ()
	Gets the version of the Session Description Protocol. More...
fm.liveswitch.sdp.Attribute[]	getSessionAttributes ()
	Gets the array of session-level attributes. More...
String	getSessionInformation ()
	Gets textual information about the session. More...
fm.liveswitch.sdp.CryptoAttribute[]	getSessionLevelCryptoAttributes ()
	Obtains Crypto attributes from the session-level attributes in this message. More...
fm.liveswitch.StreamDirection	getSessionLevelDirection ()
	Obtains the stream direction indicated as a session-level attribute in this message. More...
fm.liveswitch.sdp.ice.FingerprintAttribute	getSessionLevelFingerprintAttribute ()
	Obtains Fingerprint attribute from the session-level attributes in this message. More...
fm.liveswitch.sdp.Attribute[]	getSessionLevelIceOptionAttributes ()
	Obtains session-level Ice Options attributes associated with the Sdp Message. More...
fm.liveswitch.sdp.ice.PasswordAttribute	getSessionLevelIcePasswordAttribute ()
	Obtains Ice Password Attribute from the session-level attributes in this message. More...
fm.liveswitch.sdp.ice.UfragAttribute	getSessionLevelIceUfragAttribute ()
	Obtains Ice Ufrag Attribute from the session-level attributes in this message. More...
boolean	getSessionLevelRtcpMultiplexingSupport ()
	Returns a value stating whether Rtcp Multiplexing support is indicated as a session-level attribute in this message. More...
fm.liveswitch.sdp.Attribute[]	getSessionLevelRtpExtMapAttributes ()
	Obtains session-level RTP ext-map attributes associated with the Sdp Message. More...
fm.liveswitch.sdp.SetupAttribute	getSessionLevelSetupAttribute ()
	Obtains Setup Attribute from the session-level attributes in this message. More...
String	getSessionName ()
	Gets the textual session name. More...
boolean	getSupportsRtcpMultiplexing ()
	Gets a value indicating whether the SDP Message implies RTP/RTCP Multiplexing Support. More...
boolean	getSupportsTrickleIce ()
	Gets a value indicating whether Trickle-ICE is supported. More...
fm.liveswitch.sdp.MediaDescription	getTextDescription ()
	Gets the first media description of type "text". More...
fm.liveswitch.sdp.MediaDescription[]	getTextDescriptions ()
	Gets any media descriptions of type "text". More...
fm.liveswitch.sdp.TimeDescription[]	getTimeDescriptions ()
	Gets the array of start, stop, and repeat times for the session. More...
fm.liveswitch.sdp.TimeZones	getTimeZoneAdjustments ()
	Gets the time zone adjustments. More...
java.net.URI	getUri ()
	Gets the pointer to additional information about the session. More...
fm.liveswitch.sdp.MediaDescription	getVideoDescription ()
	Gets the first media description of type "video". More...
fm.liveswitch.sdp.MediaDescription[]	getVideoDescriptions ()
	Gets any media descriptions of type "video". More...
void	insertMediaDescription (int index, fm.liveswitch.sdp.MediaDescription mediaDescription)
	Adds a media description at the given index. More...
	Message (fm.liveswitch.sdp.Origin origin)
	Initializes a new instance of the fm.liveswitch.sdp.Message class. More...
	Message (fm.liveswitch.sdp.Origin origin, String sessionName)
	Initializes a new instance of the fm.liveswitch.sdp.Message class. More...
	Message (fm.liveswitch.sdp.Origin origin, String sessionName, fm.liveswitch.sdp.TimeDescription[] timeDescriptions)
	Initializes a new instance of the fm.liveswitch.sdp.Message class. More...
boolean	removeBandwidth (fm.liveswitch.sdp.Bandwidth bandwidth)
	Removes a proposed bandwidth. More...
boolean	removeMediaDescription (fm.liveswitch.sdp.MediaDescription mediaDescription)
	Removes a media description. More...
boolean	removeSessionAttribute (fm.liveswitch.sdp.AttributeType attributeType)
	Removes a session-level attribute. More...
boolean	removeTimeDescription (fm.liveswitch.sdp.TimeDescription timeDescription)
	Removes a start, stop, and repeat time. More...
void	removeTimeDescriptions ()
	Removes all time descriptions. More...
void	setConnectionData (fm.liveswitch.sdp.ConnectionData value)
	Sets session-level connection data. More...
void	setEmailAddress (String value)
	Sets the email address for the person responsible for the conference. More...
void	setEncryptionKey (fm.liveswitch.sdp.EncryptionKey value)
	Sets the session-level encryption key. More...
void	setPhoneNumber (String value)
	Sets the phone number for the person responsible for the conference. More...
void	setSessionInformation (String value)
	Sets textual information about the session. More...
void	setSupportsTrickleIce (boolean value)
	Sets a value indicating whether Trickle-ICE is supported. More...
void	setTimeZoneAdjustments (fm.liveswitch.sdp.TimeZones value)
	Sets the time zone adjustments. More...
void	setUri (java.net.URI value)
	Sets the pointer to additional information about the session. More...
String	toString ()
	Converts this instance to a string. More...
void	updateSetupValue (String setupValue)
	Updates SDP Setup Value associated with the session description. More...

Static Public Member Functions
static fm.liveswitch.sdp.Message	parse (String s)
	Creates an fm.liveswitch.sdp.Message instance from a string. More...

Detailed Description

An SDP message.

Constructor & Destructor Documentation

Message() [1/3]

fm.liveswitch.sdp.Message.Message

(

fm.liveswitch.sdp.Origin

origin

)

Initializes a new instance of the fm.liveswitch.sdp.Message class.

Parameters

origin

The originator of the session plus a session identifier and version number.

Message() [2/3]

fm.liveswitch.sdp.Message.Message	(	fm.liveswitch.sdp.Origin	origin,
		String	sessionName
	)

Initializes a new instance of the fm.liveswitch.sdp.Message class.

Parameters

origin	The originator of the session plus a session identifier and version number.
sessionName	The textual session name.

Message() [3/3]

fm.liveswitch.sdp.Message.Message	(	fm.liveswitch.sdp.Origin	origin,
		String	sessionName,
		fm.liveswitch.sdp.TimeDescription[]	timeDescriptions
	)

Initializes a new instance of the fm.liveswitch.sdp.Message class.

Parameters

origin	The originator of the session plus a session identifier and version number.
sessionName	The textual session name.
timeDescriptions	The array of start, stop, and repeat times for the session.

Member Function Documentation

addBandwidth()

void fm.liveswitch.sdp.Message.addBandwidth

(

fm.liveswitch.sdp.Bandwidth

bandwidth

)

Adds a proposed bandwidth.

Parameters

bandwidth

The proposed bandwidth to add.

addMediaDescription()

void fm.liveswitch.sdp.Message.addMediaDescription

(

fm.liveswitch.sdp.MediaDescription

mediaDescription

)

Adds a media description.

Parameters

mediaDescription

The media description to add.

addSessionAttribute()

void fm.liveswitch.sdp.Message.addSessionAttribute

(

fm.liveswitch.sdp.Attribute

attribute

)

Adds a session-level attribute.

Parameters

attribute

The session-level attribute to add.

addTimeDescription()

void fm.liveswitch.sdp.Message.addTimeDescription

(

fm.liveswitch.sdp.TimeDescription

timeDescription

)

Adds a start, stop, and repeat time.

Parameters

timeDescription

The start, stop, and repeat time to add.

getApplicationDescription()

fm.liveswitch.sdp.MediaDescription fm.liveswitch.sdp.Message.getApplicationDescription

(

)

Gets the first media description of type "application".

getApplicationDescriptions()

fm.liveswitch.sdp.MediaDescription [] fm.liveswitch.sdp.Message.getApplicationDescriptions

(

)

Gets any media descriptions of type "application".

getAudioDescription()

fm.liveswitch.sdp.MediaDescription fm.liveswitch.sdp.Message.getAudioDescription

(

)

Gets the first media description of type "audio".

getAudioDescriptions()

fm.liveswitch.sdp.MediaDescription [] fm.liveswitch.sdp.Message.getAudioDescriptions

(

)

Gets any media descriptions of type "audio".

getBandwidths()

fm.liveswitch.sdp.Bandwidth [] fm.liveswitch.sdp.Message.getBandwidths

(

)

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

getBundleGroups()

fm.liveswitch.sdp.BundleGroup [] fm.liveswitch.sdp.Message.getBundleGroups

(

)

Gets bundle groups in this media description.

getConnectionData()

fm.liveswitch.sdp.ConnectionData fm.liveswitch.sdp.Message.getConnectionData

(

)

Gets session-level connection data.

getEmailAddress()

String fm.liveswitch.sdp.Message.getEmailAddress

(

)

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

getEncryptionKey()

fm.liveswitch.sdp.EncryptionKey fm.liveswitch.sdp.Message.getEncryptionKey

(

)

Gets the session-level encryption key.

getMediaDescriptions()

fm.liveswitch.sdp.MediaDescription [] fm.liveswitch.sdp.Message.getMediaDescriptions

(

)

Gets the array of media descriptions.

getMessageDescription()

fm.liveswitch.sdp.MediaDescription fm.liveswitch.sdp.Message.getMessageDescription

(

)

Gets the first media description of type "message".

getMessageDescriptions()

fm.liveswitch.sdp.MediaDescription [] fm.liveswitch.sdp.Message.getMessageDescriptions

(

)

Gets any media descriptions of type "message".

getOrigin()

fm.liveswitch.sdp.Origin fm.liveswitch.sdp.Message.getOrigin

(

)

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

getPhoneNumber()

String fm.liveswitch.sdp.Message.getPhoneNumber

(

)

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

getProtocolVersion()

String fm.liveswitch.sdp.Message.getProtocolVersion

(

)

Gets the version of the Session Description Protocol.

getSessionAttributes()

fm.liveswitch.sdp.Attribute [] fm.liveswitch.sdp.Message.getSessionAttributes

(

)

Gets the array of session-level attributes.

getSessionInformation()

String fm.liveswitch.sdp.Message.getSessionInformation

(

)

Gets textual information about the session.

getSessionLevelCryptoAttributes()

fm.liveswitch.sdp.CryptoAttribute [] fm.liveswitch.sdp.Message.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.

getSessionLevelDirection()

fm.liveswitch.StreamDirection fm.liveswitch.sdp.Message.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.

getSessionLevelFingerprintAttribute()

fm.liveswitch.sdp.ice.FingerprintAttribute fm.liveswitch.sdp.Message.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.

getSessionLevelIceOptionAttributes()

fm.liveswitch.sdp.Attribute [] fm.liveswitch.sdp.Message.getSessionLevelIceOptionAttributes

(

)

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

getSessionLevelIcePasswordAttribute()

fm.liveswitch.sdp.ice.PasswordAttribute fm.liveswitch.sdp.Message.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.

getSessionLevelIceUfragAttribute()

fm.liveswitch.sdp.ice.UfragAttribute fm.liveswitch.sdp.Message.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.

getSessionLevelRtcpMultiplexingSupport()

boolean fm.liveswitch.sdp.Message.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.

getSessionLevelRtpExtMapAttributes()

fm.liveswitch.sdp.Attribute [] fm.liveswitch.sdp.Message.getSessionLevelRtpExtMapAttributes

(

)

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

getSessionLevelSetupAttribute()

fm.liveswitch.sdp.SetupAttribute fm.liveswitch.sdp.Message.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.

getSessionName()

String fm.liveswitch.sdp.Message.getSessionName

(

)

Gets the textual session name.

getSupportsRtcpMultiplexing()

boolean fm.liveswitch.sdp.Message.getSupportsRtcpMultiplexing

(

)

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

getSupportsTrickleIce()

boolean fm.liveswitch.sdp.Message.getSupportsTrickleIce

(

)

Gets a value indicating whether Trickle-ICE is supported.

getTextDescription()

fm.liveswitch.sdp.MediaDescription fm.liveswitch.sdp.Message.getTextDescription

(

)

Gets the first media description of type "text".

getTextDescriptions()

fm.liveswitch.sdp.MediaDescription [] fm.liveswitch.sdp.Message.getTextDescriptions

(

)

Gets any media descriptions of type "text".

getTimeDescriptions()

fm.liveswitch.sdp.TimeDescription [] fm.liveswitch.sdp.Message.getTimeDescriptions

(

)

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

getTimeZoneAdjustments()

fm.liveswitch.sdp.TimeZones fm.liveswitch.sdp.Message.getTimeZoneAdjustments

(

)

Gets the time zone adjustments.

getUri()

java.net.URI fm.liveswitch.sdp.Message.getUri

(

)

Gets the pointer to additional information about the session.

getVideoDescription()

fm.liveswitch.sdp.MediaDescription fm.liveswitch.sdp.Message.getVideoDescription

(

)

Gets the first media description of type "video".

getVideoDescriptions()

fm.liveswitch.sdp.MediaDescription [] fm.liveswitch.sdp.Message.getVideoDescriptions

(

)

Gets any media descriptions of type "video".

insertMediaDescription()

void fm.liveswitch.sdp.Message.insertMediaDescription	(	int	index,
		fm.liveswitch.sdp.MediaDescription	mediaDescription
	)

Adds a media description at the given index.

Parameters

index	The index at which to add the media description.
mediaDescription	The media description to add.

parse()

static fm.liveswitch.sdp.Message fm.liveswitch.sdp.Message.parse ( String  s )

static

Creates an fm.liveswitch.sdp.Message instance from a string.

Parameters

s	The string to parse.

removeBandwidth()

boolean fm.liveswitch.sdp.Message.removeBandwidth

(

fm.liveswitch.sdp.Bandwidth

bandwidth

)

Removes a proposed bandwidth.

Parameters

bandwidth

The proposed bandwidth to remove.

removeMediaDescription()

boolean fm.liveswitch.sdp.Message.removeMediaDescription

(

fm.liveswitch.sdp.MediaDescription

mediaDescription

)

Removes a media description.

Parameters

mediaDescription

The media description to remove.

removeSessionAttribute()

boolean fm.liveswitch.sdp.Message.removeSessionAttribute

(

fm.liveswitch.sdp.AttributeType

attributeType

)

Removes a session-level attribute.

Parameters

attributeType

The session-level attribute type to remove.

removeTimeDescription()

boolean fm.liveswitch.sdp.Message.removeTimeDescription

(

fm.liveswitch.sdp.TimeDescription

timeDescription

)

Removes a start, stop, and repeat time.

Parameters

timeDescription

The start, stop, and repeat time to remove.

removeTimeDescriptions()

void fm.liveswitch.sdp.Message.removeTimeDescriptions

(

)

Removes all time descriptions.

setConnectionData()

void fm.liveswitch.sdp.Message.setConnectionData

(

fm.liveswitch.sdp.ConnectionData

value

)

Sets session-level connection data.

setEmailAddress()

void fm.liveswitch.sdp.Message.setEmailAddress

(

String

value

)

Sets the email address for the person responsible for the conference.

setEncryptionKey()

void fm.liveswitch.sdp.Message.setEncryptionKey

(

fm.liveswitch.sdp.EncryptionKey

value

)

Sets the session-level encryption key.

setPhoneNumber()

void fm.liveswitch.sdp.Message.setPhoneNumber

(

String

value

)

Sets the phone number for the person responsible for the conference.

setSessionInformation()

void fm.liveswitch.sdp.Message.setSessionInformation

(

String

value

)

Sets textual information about the session.

setSupportsTrickleIce()

void fm.liveswitch.sdp.Message.setSupportsTrickleIce

(

boolean

value

)

Sets a value indicating whether Trickle-ICE is supported.

setTimeZoneAdjustments()

void fm.liveswitch.sdp.Message.setTimeZoneAdjustments

(

fm.liveswitch.sdp.TimeZones

value

)

Sets the time zone adjustments.

setUri()

void fm.liveswitch.sdp.Message.setUri

(

java.net.URI

value

)

Sets the pointer to additional information about the session.

toString()

String fm.liveswitch.sdp.Message.toString

(

)

Converts this instance to a string.

updateSetupValue()

void fm.liveswitch.sdp.Message.updateSetupValue

(

String

setupValue

)

Updates SDP Setup Value associated with the session description.

Parameters

setupValue