FMIceLinkSdpMessage Class Reference

Inherits from NSObject
Declared in FMIceLinkSdpMessage.h
FMIceLinkSdpMessage.m

Overview

An SDP message.

– addBandwidth:

Adds a proposed bandwidth.
- (void)addBandwidth:(FMIceLinkSdpBandwidth *)bandwidth

Parameters

bandwidth

The proposed bandwidth to add.

Discussion

Adds a proposed bandwidth.

Declared In

FMIceLinkSdpMessage.h

– addMediaDescription:

Adds a media [description](#//api/name/description).
- (void)addMediaDescription:(FMIceLinkSdpMediaDescription *)mediaDescription

Parameters

mediaDescription

The media description to add.

Discussion

Adds a media [description](#//api/name/description).

Declared In

FMIceLinkSdpMessage.h

– addSessionAttribute:

Adds a session-level attribute.
- (void)addSessionAttribute:(FMIceLinkSdpAttribute *)attribute

Parameters

attribute

The session-level attribute to add.

Discussion

Adds a session-level attribute.

Declared In

FMIceLinkSdpMessage.h

– addTimeDescription:

Adds a start, stop, and repeat time.
- (void)addTimeDescription:(FMIceLinkSdpTimeDescription *)timeDescription

Parameters

timeDescription

The start, stop, and repeat time to add.

Discussion

Adds a start, stop, and repeat time.

Declared In

FMIceLinkSdpMessage.h

– applicationDescription

Gets the first media [description](#//api/name/description) of type "application".
- (FMIceLinkSdpMediaDescription *)applicationDescription

Discussion

Gets the first media [description](#//api/name/description) of type "application".

Declared In

FMIceLinkSdpMessage.h

– applicationDescriptions

Gets any media descriptions of type "application".
- (NSMutableArray *)applicationDescriptions

Discussion

Gets any media descriptions of type "application".

Declared In

FMIceLinkSdpMessage.h

– audioDescription

Gets the first media [description](#//api/name/description) of type "audio".
- (FMIceLinkSdpMediaDescription *)audioDescription

Discussion

Gets the first media [description](#//api/name/description) of type "audio".

Declared In

FMIceLinkSdpMessage.h

– audioDescriptions

Gets any media descriptions of type "audio".
- (NSMutableArray *)audioDescriptions

Discussion

Gets any media descriptions of type "audio".

Declared In

FMIceLinkSdpMessage.h

– bandwidths

Gets the array of proposed bandwidths to be used by the session.
- (NSMutableArray *)bandwidths

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– connectionData

Gets session-level connection data.
- (FMIceLinkSdpConnectionData *)connectionData

Discussion

Gets session-level connection data.

Declared In

FMIceLinkSdpMessage.h

– description

Converts this instance to a string.
- (NSString *)description

Discussion

Converts this instance to a string.

Declared In

FMIceLinkSdpMessage.h

– emailAddress

Gets the email address for the person responsible for the conference.
- (NSString *)emailAddress

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– encryptionKey

Gets the session-level encryption key.
- (FMIceLinkSdpEncryptionKey *)encryptionKey

Discussion

Gets the session-level encryption key.

Declared In

FMIceLinkSdpMessage.h

– 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.
- (NSMutableArray *)getSessionLevelCryptoAttributes

Discussion

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.

Declared In

FMIceLinkSdpMessage.h

– 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.
- (FMIceLinkStreamDirection)getSessionLevelDirection

Discussion

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.

Declared In

FMIceLinkSdpMessage.h

– 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.
- (FMIceLinkSdpIceFingerprintAttribute *)getSessionLevelFingerprintAttribute

Discussion

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.

Declared In

FMIceLinkSdpMessage.h

– getSessionLevelIceOptionAttributes

Obtains session-level Ice Options attributes associated with the Sdp Message.
- (NSMutableArray *)getSessionLevelIceOptionAttributes

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– 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.
- (FMIceLinkSdpIcePasswordAttribute *)getSessionLevelIcePasswordAttribute

Discussion

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.

Declared In

FMIceLinkSdpMessage.h

– 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.
- (FMIceLinkSdpIceUfragAttribute *)getSessionLevelIceUfragAttribute

Discussion

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.

Declared In

FMIceLinkSdpMessage.h

– 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.
- (bool)getSessionLevelRtcpMultiplexingSupport

Discussion

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.

Declared In

FMIceLinkSdpMessage.h

– getSessionLevelRtpExtMapAttributes

Obtains session-level RTP ext-map attributes associated with the Sdp Message.
- (NSMutableArray *)getSessionLevelRtpExtMapAttributes

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– 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.
- (FMIceLinkSdpSetupAttribute *)getSessionLevelSetupAttribute

Discussion

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.

Declared In

FMIceLinkSdpMessage.h

– initWithOrigin:

Initializes a new instance of the FMIceLinkSdpMessage class.
- (instancetype)initWithOrigin:(FMIceLinkSdpOrigin *)origin

Parameters

origin

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

Discussion

Initializes a new instance of the FMIceLinkSdpMessage class.

Declared In

FMIceLinkSdpMessage.h

– initWithOrigin:sessionName:

Initializes a new instance of the FMIceLinkSdpMessage class.
- (instancetype)initWithOrigin:(FMIceLinkSdpOrigin *)origin sessionName:(NSString *)sessionName

Parameters

origin

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

The textual session name.

Discussion

Initializes a new instance of the FMIceLinkSdpMessage class.

Declared In

FMIceLinkSdpMessage.h

– initWithOrigin:sessionName:timeDescriptions:

Initializes a new instance of the FMIceLinkSdpMessage class.
- (instancetype)initWithOrigin:(FMIceLinkSdpOrigin *)origin sessionName:(NSString *)sessionName timeDescriptions:(NSMutableArray *)timeDescriptions

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.

Discussion

Initializes a new instance of the FMIceLinkSdpMessage class.

Declared In

FMIceLinkSdpMessage.h

– mediaDescriptions

Gets the array of media descriptions.
- (NSMutableArray *)mediaDescriptions

Discussion

Gets the array of media descriptions.

Declared In

FMIceLinkSdpMessage.h

– messageDescription

Gets the first media [description](#//api/name/description) of type "message".
- (FMIceLinkSdpMediaDescription *)messageDescription

Discussion

Gets the first media [description](#//api/name/description) of type "message".

Declared In

FMIceLinkSdpMessage.h

– messageDescriptions

Gets any media descriptions of type "message".
- (NSMutableArray *)messageDescriptions

Discussion

Gets any media descriptions of type "message".

Declared In

FMIceLinkSdpMessage.h

+ messageWithOrigin:

Initializes a new instance of the FMIceLinkSdpMessage class.
+ (FMIceLinkSdpMessage *)messageWithOrigin:(FMIceLinkSdpOrigin *)origin

Parameters

origin

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

Discussion

Initializes a new instance of the FMIceLinkSdpMessage class.

Declared In

FMIceLinkSdpMessage.h

+ messageWithOrigin:sessionName:

Initializes a new instance of the FMIceLinkSdpMessage class.
+ (FMIceLinkSdpMessage *)messageWithOrigin:(FMIceLinkSdpOrigin *)origin sessionName:(NSString *)sessionName

Parameters

origin

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

The textual session name.

Discussion

Initializes a new instance of the FMIceLinkSdpMessage class.

Declared In

FMIceLinkSdpMessage.h

+ messageWithOrigin:sessionName:timeDescriptions:

Initializes a new instance of the FMIceLinkSdpMessage class.
+ (FMIceLinkSdpMessage *)messageWithOrigin:(FMIceLinkSdpOrigin *)origin sessionName:(NSString *)sessionName timeDescriptions:(NSMutableArray *)timeDescriptions

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.

Discussion

Initializes a new instance of the FMIceLinkSdpMessage class.

Declared In

FMIceLinkSdpMessage.h

– origin

Gets the originator of the session plus a session identifier and version number.
- (FMIceLinkSdpOrigin *)origin

Discussion

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

Declared In

FMIceLinkSdpMessage.h

+ parseWithS:

Creates an FMIceLinkSdpMessage instance from a string.
+ (FMIceLinkSdpMessage *)parseWithS:(NSString *)s

Parameters

s

The string to parse.

Discussion

Creates an FMIceLinkSdpMessage instance from a string.

Declared In

FMIceLinkSdpMessage.h

– phoneNumber

Gets the phone number for the person responsible for the conference.
- (NSString *)phoneNumber

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– protocolVersion

Gets the version of the Session Description Protocol.
- (NSString *)protocolVersion

Discussion

Gets the version of the Session Description Protocol.

Declared In

FMIceLinkSdpMessage.h

– removeBandwidth:

Removes a proposed bandwidth.
- (bool)removeBandwidth:(FMIceLinkSdpBandwidth *)bandwidth

Parameters

bandwidth

The proposed bandwidth to remove.

Discussion

Removes a proposed bandwidth.

Declared In

FMIceLinkSdpMessage.h

– removeMediaDescription:

Removes a media [description](#//api/name/description).
- (bool)removeMediaDescription:(FMIceLinkSdpMediaDescription *)mediaDescription

Parameters

mediaDescription

The media description to remove.

Discussion

Removes a media [description](#//api/name/description).

Declared In

FMIceLinkSdpMessage.h

– removeSessionAttributeWithAttributeType:

Removes a session-level attribute.
- (bool)removeSessionAttributeWithAttributeType:(FMIceLinkSdpAttributeType)attributeType

Parameters

attributeType

The session-level attribute type to remove.

Discussion

Removes a session-level attribute.

Declared In

FMIceLinkSdpMessage.h

– removeTimeDescription:

Removes a start, stop, and repeat time.
- (bool)removeTimeDescription:(FMIceLinkSdpTimeDescription *)timeDescription

Parameters

timeDescription

The start, stop, and repeat time to remove.

Discussion

Removes a start, stop, and repeat time.

Declared In

FMIceLinkSdpMessage.h

– removeTimeDescriptions

Removes all time descriptions.
- (void)removeTimeDescriptions

Discussion

Removes all time descriptions.

Declared In

FMIceLinkSdpMessage.h

– sessionAttributes

Gets the array of session-level attributes.
- (NSMutableArray *)sessionAttributes

Discussion

Gets the array of session-level attributes.

Declared In

FMIceLinkSdpMessage.h

– sessionInformation

Gets textual information about the session.
- (NSString *)sessionInformation

Discussion

Gets textual information about the session.

Declared In

FMIceLinkSdpMessage.h

– sessionName

Gets the textual session name.
- (NSString *)sessionName

Discussion

Gets the textual session name.

Declared In

FMIceLinkSdpMessage.h

– setConnectionData:

Sets session-level connection data.
- (void)setConnectionData:(FMIceLinkSdpConnectionData *)value

Discussion

Sets session-level connection data.

Declared In

FMIceLinkSdpMessage.h

– setEmailAddress:

Sets the email address for the person responsible for the conference.
- (void)setEmailAddress:(NSString *)value

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– setEncryptionKey:

Sets the session-level encryption key.
- (void)setEncryptionKey:(FMIceLinkSdpEncryptionKey *)value

Discussion

Sets the session-level encryption key.

Declared In

FMIceLinkSdpMessage.h

– setPhoneNumber:

Sets the phone number for the person responsible for the conference.
- (void)setPhoneNumber:(NSString *)value

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– setSessionInformation:

Sets textual information about the session.
- (void)setSessionInformation:(NSString *)value

Discussion

Sets textual information about the session.

Declared In

FMIceLinkSdpMessage.h

– setTimeZoneAdjustments:

Sets the time zone adjustments.
- (void)setTimeZoneAdjustments:(FMIceLinkSdpTimeZones *)value

Discussion

Sets the time zone adjustments.

Declared In

FMIceLinkSdpMessage.h

– setUri:

Sets the pointer to additional information about the session.
- (void)setUri:(NSURL *)value

Discussion

Sets the pointer to additional information about the session.

Declared In

FMIceLinkSdpMessage.h

– textDescription

Gets the first media [description](#//api/name/description) of type "text".
- (FMIceLinkSdpMediaDescription *)textDescription

Discussion

Gets the first media [description](#//api/name/description) of type "text".

Declared In

FMIceLinkSdpMessage.h

– textDescriptions

Gets any media descriptions of type "text".
- (NSMutableArray *)textDescriptions

Discussion

Gets any media descriptions of type "text".

Declared In

FMIceLinkSdpMessage.h

– timeDescriptions

Gets the array of start, stop, and repeat times for the session.
- (NSMutableArray *)timeDescriptions

Discussion

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

Declared In

FMIceLinkSdpMessage.h

– timeZoneAdjustments

Gets the time zone adjustments.
- (FMIceLinkSdpTimeZones *)timeZoneAdjustments

Discussion

Gets the time zone adjustments.

Declared In

FMIceLinkSdpMessage.h

– updateSetupValue:

Updates SDP Setup Value associated with the session [description](#//api/name/description).

@param setupValue

- (void)updateSetupValue:(NSString *)setupValue

Discussion

Updates SDP Setup Value associated with the session [description](#//api/name/description).

@param setupValue

Declared In

FMIceLinkSdpMessage.h

– uri

Gets the pointer to additional information about the session.
- (NSURL *)uri

Discussion

Gets the pointer to additional information about the session.

Declared In

FMIceLinkSdpMessage.h

– videoDescription

Gets the first media [description](#//api/name/description) of type "video".
- (FMIceLinkSdpMediaDescription *)videoDescription

Discussion

Gets the first media [description](#//api/name/description) of type "video".

Declared In

FMIceLinkSdpMessage.h

– videoDescriptions

Gets any media descriptions of type "video".
- (NSMutableArray *)videoDescriptions

Discussion

Gets any media descriptions of type "video".

Declared In

FMIceLinkSdpMessage.h