FMIceLinkSdpMediaDescription Class Reference

Inherits from NSObject
Declared in FMIceLinkSdpMediaDescription.h
FMIceLinkSdpMediaDescription.m

Overview

An SDP [media](#//api/name/media) [description](#//api/name/description) element.

– addBandwidth:

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

Parameters

bandwidth

The proposed bandwidth to add.

Discussion

Adds a proposed bandwidth.

Declared In

FMIceLinkSdpMediaDescription.h

– addMediaAttribute:

Adds a media-level attribute.
- (void)addMediaAttribute:(FMIceLinkSdpAttribute *)attribute

Parameters

attribute

The session-level attribute to add.

Discussion

Adds a media-level attribute.

Declared In

FMIceLinkSdpMediaDescription.h

– bandwidths

Gets the array of proposed bandwidths to be used by the [media](#//api/name/media).
- (NSMutableArray *)bandwidths

Discussion

Gets the array of proposed bandwidths to be used by the [media](#//api/name/media).

Declared In

FMIceLinkSdpMediaDescription.h

– connectionData

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

Discussion

Gets media-level connection data.

Declared In

FMIceLinkSdpMediaDescription.h

– cryptoAttributes

Gets CryptoAttributes associated with this MediaDescription.
- (NSMutableArray *)cryptoAttributes

Discussion

Gets CryptoAttributes associated with this MediaDescription.

Declared In

FMIceLinkSdpMediaDescription.h

– description

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

Discussion

Converts this instance to a string.

Declared In

FMIceLinkSdpMediaDescription.h

– encryptionKey

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

Discussion

Gets the media-level encryption key.

Declared In

FMIceLinkSdpMediaDescription.h

– fingerprintAttribute

Gets the Fingerprint Attribute from this MediaDescription
- (FMIceLinkSdpIceFingerprintAttribute *)fingerprintAttribute

Discussion

Gets the Fingerprint Attribute from this MediaDescription

Declared In

FMIceLinkSdpMediaDescription.h

– getCandidateAttributes

Obtains Ice Candidate attributes associated with this [media](#//api/name/media) [description](#//api/name/description).
- (NSMutableArray *)getCandidateAttributes

Discussion

Obtains Ice Candidate attributes associated with this [media](#//api/name/media) [description](#//api/name/description).

Declared In

FMIceLinkSdpMediaDescription.h

– getCcmFirFeedbackAttributeWithPayloadType:

Gets the RTCP "ccm fir" feedback attribute for the given payload type.
- (FMIceLinkSdpRtcpFeedbackAttribute *)getCcmFirFeedbackAttributeWithPayloadType:(int)payloadType

Parameters

payloadType

The payload type.

Discussion

Gets the RTCP "ccm fir" feedback attribute for the given payload type.

Declared In

FMIceLinkSdpMediaDescription.h

– getFormatParametersAttributeWithPayloadType:

Gets the format parameters attribute for the given payload type.
- (FMIceLinkSdpFormatParametersAttribute *)getFormatParametersAttributeWithPayloadType:(int)payloadType

Parameters

payloadType

The payload type.

Discussion

Gets the format parameters attribute for the given payload type.

Declared In

FMIceLinkSdpMediaDescription.h

– getIceOptionAttributes

Obtains Ice Options attributes associated with this [media](#//api/name/media) [description](#//api/name/description).
- (NSMutableArray *)getIceOptionAttributes

Discussion

Obtains Ice Options attributes associated with this [media](#//api/name/media) [description](#//api/name/description).

Declared In

FMIceLinkSdpMediaDescription.h

– getMaxPacketTimeAttribute

Obtains the maximum packet time attribute.
- (FMIceLinkSdpMaxPacketTimeAttribute *)getMaxPacketTimeAttribute

Discussion

Obtains the maximum packet time attribute.

Declared In

FMIceLinkSdpMediaDescription.h

– getNackFeedbackAttributeWithPayloadType:

Gets the RTCP "nack" feedback attribute for the given payload type.
- (FMIceLinkSdpRtcpFeedbackAttribute *)getNackFeedbackAttributeWithPayloadType:(int)payloadType

Parameters

payloadType

The payload type.

Discussion

Gets the RTCP "nack" feedback attribute for the given payload type.

Declared In

FMIceLinkSdpMediaDescription.h

– getNackPliFeedbackAttributeWithPayloadType:

Gets the RTCP "nack pli" feedback attribute for the given payload type.
- (FMIceLinkSdpRtcpFeedbackAttribute *)getNackPliFeedbackAttributeWithPayloadType:(int)payloadType

Parameters

payloadType

The payload type.

Discussion

Gets the RTCP "nack pli" feedback attribute for the given payload type.

Declared In

FMIceLinkSdpMediaDescription.h

– getNackRpsiFeedbackAttributeWithPayloadType:

Gets the RTCP "nack rpsi" feedback attribute for the given payload type.
- (FMIceLinkSdpRtcpFeedbackAttribute *)getNackRpsiFeedbackAttributeWithPayloadType:(int)payloadType

Parameters

payloadType

The payload type.

Discussion

Gets the RTCP "nack rpsi" feedback attribute for the given payload type.

Declared In

FMIceLinkSdpMediaDescription.h

– getNackSliFeedbackAttributeWithPayloadType:

Gets the RTCP "nack sli" feedback attribute for the given payload type.
- (FMIceLinkSdpRtcpFeedbackAttribute *)getNackSliFeedbackAttributeWithPayloadType:(int)payloadType

Parameters

payloadType

The payload type.

Discussion

Gets the RTCP "nack sli" feedback attribute for the given payload type.

Declared In

FMIceLinkSdpMediaDescription.h

– getPacketTimeAttribute

Obtains the packet time attribute.
- (FMIceLinkSdpPacketTimeAttribute *)getPacketTimeAttribute

Discussion

Obtains the packet time attribute.

Declared In

FMIceLinkSdpMediaDescription.h

– getRtcpFeedbackAttributeWithPayloadType:type:subType:

Gets the RTCP feedback attribute for the given payload type.
- (FMIceLinkSdpRtcpFeedbackAttribute *)getRtcpFeedbackAttributeWithPayloadType:(int)payloadType type:(NSString *)type subType:(NSString *)subType

Parameters

payloadType

The payload type.
type

The type.
subType

The sub-type.

Discussion

Gets the RTCP feedback attribute for the given payload type.

Declared In

FMIceLinkSdpMediaDescription.h

– getRtpExtMapAttributes

Obtains the RTP ext-map attributes.
- (NSMutableArray *)getRtpExtMapAttributes

Discussion

Obtains the RTP ext-map attributes.

Declared In

FMIceLinkSdpMediaDescription.h

– getRtpMapAttributes

Obtains the RTP map attributes.
- (NSMutableArray *)getRtpMapAttributes

Discussion

Obtains the RTP map attributes.

Declared In

FMIceLinkSdpMediaDescription.h

– getRtpMapAttributesWithFormatName:clockRate:formatParameters:

Obtains the RTP map attributes for a given format.
- (NSMutableArray *)getRtpMapAttributesWithFormatName:(NSString *)formatName clockRate:(int)clockRate formatParameters:(NSString *)formatParameters

Parameters

formatName

Format name.
clockRate

Clock rate.
formatParameters

Format parameters.

Discussion

Obtains the RTP map attributes for a given format.

Declared In

FMIceLinkSdpMediaDescription.h

– getRtpMapAttributesWithFormatName:clockRate:formatParameters:rtpMapAttributeIndices:

Obtains the RTP map attributes for a given format.
- (NSMutableArray *)getRtpMapAttributesWithFormatName:(NSString *)formatName clockRate:(int)clockRate formatParameters:(NSString *)formatParameters rtpMapAttributeIndices:(NSMutableArray **)rtpMapAttributeIndices

Parameters

formatName

Format name.
clockRate

Clock rate.
formatParameters

Format parameters.
rtpMapAttributeIndices

The indeces of the FMIceLinkSdpRtpMapAttribute.

Discussion

Obtains the RTP map attributes for a given format.

Declared In

FMIceLinkSdpMediaDescription.h

– getRtpMapAttributeWithFormatName:clockRate:formatParameters:

Obtains the RTP map attribute for a given format.
- (FMIceLinkSdpRtpMapAttribute *)getRtpMapAttributeWithFormatName:(NSString *)formatName clockRate:(int)clockRate formatParameters:(NSString *)formatParameters

Parameters

formatName

Format name.
clockRate

Clock rate.
formatParameters

Format parameters.

Discussion

Obtains the RTP map attribute for a given format.

Declared In

FMIceLinkSdpMediaDescription.h

– getRtpMapAttributeWithFormatName:clockRate:formatParameters:rtpMapAttributeIndex:

Obtains the RTP map attribute for a given format.
- (FMIceLinkSdpRtpMapAttribute *)getRtpMapAttributeWithFormatName:(NSString *)formatName clockRate:(int)clockRate formatParameters:(NSString *)formatParameters rtpMapAttributeIndex:(int *)rtpMapAttributeIndex

Parameters

formatName

Format name.
clockRate

Clock rate.
formatParameters

Format parameters.
rtpMapAttributeIndex

The index of the FMIceLinkSdpRtpMapAttribute.

Discussion

Obtains the RTP map attribute for a given format.

Declared In

FMIceLinkSdpMediaDescription.h

– getSsrcAttributes

Obtains the SSRC attributes.
- (NSMutableArray *)getSsrcAttributes

Discussion

Obtains the SSRC attributes.

Declared In

FMIceLinkSdpMediaDescription.h

– getSsrcAttributesWithSsrc:

Obtains the SSRC attributes matching a given synchronization source.
- (NSMutableArray *)getSsrcAttributesWithSsrc:(long long)ssrc

Parameters

ssrc

The synchronization source.

Discussion

Obtains the SSRC attributes matching a given synchronization source.

Declared In

FMIceLinkSdpMediaDescription.h

– getSsrcAttributesWithSsrc:name:

Obtains the SSRC attributes matching a given synchronization source and name.
- (NSMutableArray *)getSsrcAttributesWithSsrc:(long long)ssrc name:(NSString *)name

Parameters

ssrc

The synchronization source.
name

The attribute name.

Discussion

Obtains the SSRC attributes matching a given synchronization source and name.

Declared In

FMIceLinkSdpMediaDescription.h

– getSsrcAttributeWithSsrc:name:value:

Obtains the SSRC attribute matching a given synchronization source, name, and value.
- (FMIceLinkSdpRtpSsrcAttribute *)getSsrcAttributeWithSsrc:(long long)ssrc name:(NSString *)name value:(NSString *)value

Parameters

ssrc

The synchronization source.
name

The attribute name.
value

The attribute value.

Discussion

Obtains the SSRC attribute matching a given synchronization source, name, and value.

Declared In

FMIceLinkSdpMediaDescription.h

– icePasswordAttribute

Gets the IcePasswordAttribute associated with this MediaDescription
- (FMIceLinkSdpIcePasswordAttribute *)icePasswordAttribute

Discussion

Gets the IcePasswordAttribute associated with this MediaDescription

Declared In

FMIceLinkSdpMediaDescription.h

– iceUfragAttribute

Gets the IceUfragAttribute associated with this MediaDescription
- (FMIceLinkSdpIceUfragAttribute *)iceUfragAttribute

Discussion

Gets the IceUfragAttribute associated with this MediaDescription

Declared In

FMIceLinkSdpMediaDescription.h

– initWithMedia:

Initializes a new instance of the FMIceLinkSdpMediaDescription class.
- (instancetype)initWithMedia:(FMIceLinkSdpMedia *)media

Parameters

media

The media name and transport address.

Discussion

Initializes a new instance of the FMIceLinkSdpMediaDescription class.

Declared In

FMIceLinkSdpMediaDescription.h

– insertCcmFirAttributeWithFormatName:clockRate:formatParameters:

Inserts a CCM-FIR attribute for the given format if it doesn't already exist.
- (bool)insertCcmFirAttributeWithFormatName:(NSString *)formatName clockRate:(int)clockRate formatParameters:(NSString *)formatParameters

Parameters

formatName

Format name.
clockRate

Clock rate.
formatParameters

Format parameters.

Discussion

Inserts a CCM-FIR attribute for the given format if it doesn't already exist.

Declared In

FMIceLinkSdpMediaDescription.h

– insertMediaAttribute:index:

DEPRECATED: Use AddMediaAttribute instead. Inserts a media-level attribute at the given index.
- (void)insertMediaAttribute:(FMIceLinkSdpAttribute *)attribute index:(int)index

Parameters

attribute

The session-level attribute to add.
index

The index.

Discussion

DEPRECATED: Use AddMediaAttribute instead. Inserts a media-level attribute at the given index.

Declared In

FMIceLinkSdpMediaDescription.h

– insertNackPliAttributeWithFormatName:clockRate:formatParameters:

Inserts a NACK-PLI attribute for the given format if it doesn't already exist.
- (bool)insertNackPliAttributeWithFormatName:(NSString *)formatName clockRate:(int)clockRate formatParameters:(NSString *)formatParameters

Parameters

formatName

Format name.
clockRate

Clock rate.
formatParameters

Format parameters.

Discussion

Inserts a NACK-PLI attribute for the given format if it doesn't already exist.

Declared In

FMIceLinkSdpMediaDescription.h

– insertRembAttributeWithFormatName:clockRate:formatParameters:

Inserts a REMB attribute for the given format if it doesn't already exist.
- (bool)insertRembAttributeWithFormatName:(NSString *)formatName clockRate:(int)clockRate formatParameters:(NSString *)formatParameters

Parameters

formatName

Format name.
clockRate

Clock rate.
formatParameters

Format parameters.

Discussion

Inserts a REMB attribute for the given format if it doesn't already exist.

Declared In

FMIceLinkSdpMediaDescription.h

– isApplication

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents an application stream ([media](#//api/name/media) type == "application").
- (bool)isApplication

Discussion

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents an application stream ([media](#//api/name/media) type == "application").

Declared In

FMIceLinkSdpMediaDescription.h

– isAudio

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents an audio stream ([media](#//api/name/media) type == "audio").
- (bool)isAudio

Discussion

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents an audio stream ([media](#//api/name/media) type == "audio").

Declared In

FMIceLinkSdpMediaDescription.h

– isMessage

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents a message stream ([media](#//api/name/media) type == "message").
- (bool)isMessage

Discussion

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents a message stream ([media](#//api/name/media) type == "message").

Declared In

FMIceLinkSdpMediaDescription.h

– isText

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents a text stream ([media](#//api/name/media) type == "text").
- (bool)isText

Discussion

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents a text stream ([media](#//api/name/media) type == "text").

Declared In

FMIceLinkSdpMediaDescription.h

– isVideo

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents a video stream ([media](#//api/name/media) type == "video").
- (bool)isVideo

Discussion

Gets whether this [media](#//api/name/media) [description](#//api/name/description) represents a video stream ([media](#//api/name/media) type == "video").

Declared In

FMIceLinkSdpMediaDescription.h

– media

Gets the media name and transport address.
- (FMIceLinkSdpMedia *)media

Discussion

Gets the media name and transport address.

Declared In

FMIceLinkSdpMediaDescription.h

– mediaAttributes

Gets the array of media-level attributes.
- (NSMutableArray *)mediaAttributes

Discussion

Gets the array of media-level attributes.

Declared In

FMIceLinkSdpMediaDescription.h

+ mediaDescriptionWithMedia:

Initializes a new instance of the FMIceLinkSdpMediaDescription class.
+ (FMIceLinkSdpMediaDescription *)mediaDescriptionWithMedia:(FMIceLinkSdpMedia *)media

Parameters

media

The media name and transport address.

Discussion

Initializes a new instance of the FMIceLinkSdpMediaDescription class.

Declared In

FMIceLinkSdpMediaDescription.h

– mediaTitle

Gets the [media](#//api/name/media) title.
- (NSString *)mediaTitle

Discussion

Gets the [media](#//api/name/media) title.

Declared In

FMIceLinkSdpMediaDescription.h

+ parseWithS:

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

Parameters

s

The string to parse.

Discussion

Creates an FMIceLinkSdpMediaDescription instance from a string.

Declared In

FMIceLinkSdpMediaDescription.h

– qualityAttribute

Gets the QualityAttribute associated with this MediaDescription.
- (FMIceLinkSdpQualityAttribute *)qualityAttribute

Discussion

Gets the QualityAttribute associated with this MediaDescription.

Declared In

FMIceLinkSdpMediaDescription.h

– removeBandwidth:

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

Parameters

bandwidth

The proposed bandwidth to remove.

Discussion

Removes a proposed bandwidth.

Declared In

FMIceLinkSdpMediaDescription.h

– removeMediaAttribute:

Removes a media-level attribute.
- (bool)removeMediaAttribute:(FMIceLinkSdpAttribute *)attribute

Parameters

attribute

The session-level attribute to remove.

Discussion

Removes a media-level attribute.

Declared In

FMIceLinkSdpMediaDescription.h

– rtcpAttribute

Gets Rtcp Attributes associated with this [media](#//api/name/media) [description](#//api/name/description).
- (FMIceLinkSdpRtcpAttribute *)rtcpAttribute

Discussion

Gets Rtcp Attributes associated with this [media](#//api/name/media) [description](#//api/name/description).

Declared In

FMIceLinkSdpMediaDescription.h

– rtcpMultiplexingSupported

Gets a value indicating support for RTCP Multiplexing.
- (bool)rtcpMultiplexingSupported

Discussion

Gets a value indicating support for RTCP Multiplexing.

Declared In

FMIceLinkSdpMediaDescription.h

– sctpMapAttribute

Gets the Sctp Map Attribute, if it is present in the Media Description.
- (FMIceLinkSdpSctpMapAttribute *)sctpMapAttribute

Discussion

Gets the Sctp Map Attribute, if it is present in the Media Description.

Declared In

FMIceLinkSdpMediaDescription.h

– sctpMaxMessageSizeAttribute

Gets the Sctp Max Message Size Attribute, if it is present in the Media Description.
- (FMIceLinkSdpSctpMaxMessageSizeAttribute *)sctpMaxMessageSizeAttribute

Discussion

Gets the Sctp Max Message Size Attribute, if it is present in the Media Description.

Declared In

FMIceLinkSdpMediaDescription.h

– setConnectionData:

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

Discussion

Sets media-level connection data.

Declared In

FMIceLinkSdpMediaDescription.h

– setEncryptionKey:

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

Discussion

Sets the media-level encryption key.

Declared In

FMIceLinkSdpMediaDescription.h

– setMediaTitle:

Sets the [media](#//api/name/media) title.
- (void)setMediaTitle:(NSString *)value

Discussion

Sets the [media](#//api/name/media) title.

Declared In

FMIceLinkSdpMediaDescription.h

– setQualityAttribute:

Sets the QualityAttribute associated with this MediaDescription.
- (void)setQualityAttribute:(FMIceLinkSdpQualityAttribute *)value

Discussion

Sets the QualityAttribute associated with this MediaDescription.

Declared In

FMIceLinkSdpMediaDescription.h

– setRtcpAttribute:

Sets Rtcp Attributes associated with this [media](#//api/name/media) [description](#//api/name/description).
- (void)setRtcpAttribute:(FMIceLinkSdpRtcpAttribute *)value

Discussion

Sets Rtcp Attributes associated with this [media](#//api/name/media) [description](#//api/name/description).

Declared In

FMIceLinkSdpMediaDescription.h

– setSetupAttribute:

Sets the SetupAttribute associated with this MediaDescription.
- (void)setSetupAttribute:(FMIceLinkSdpSetupAttribute *)value

Discussion

Sets the SetupAttribute associated with this MediaDescription.

Declared In

FMIceLinkSdpMediaDescription.h

– setStreamDirection:

Sets the stream direction indicated in Media Description. Getter returns StreamDirection if DirectionAttribute is present; otherwise, returns StreamDirection.Unset.
- (void)setStreamDirection:(FMIceLinkStreamDirection)value

Discussion

Sets the stream direction indicated in Media Description. Getter returns StreamDirection if DirectionAttribute is present; otherwise, returns StreamDirection.Unset.

Declared In

FMIceLinkSdpMediaDescription.h

– setupAttribute

Gets the SetupAttribute associated with this MediaDescription.
- (FMIceLinkSdpSetupAttribute *)setupAttribute

Discussion

Gets the SetupAttribute associated with this MediaDescription.

Declared In

FMIceLinkSdpMediaDescription.h

– streamDirection

Gets the stream direction indicated in Media Description. Getter returns StreamDirection if DirectionAttribute is present; otherwise, returns StreamDirection.Unset.
- (FMIceLinkStreamDirection)streamDirection

Discussion

Gets the stream direction indicated in Media Description. Getter returns StreamDirection if DirectionAttribute is present; otherwise, returns StreamDirection.Unset.

Declared In

FMIceLinkSdpMediaDescription.h

– supportsIce

Gets a value indicating whether this SDP MediaDescription suggests support for ICE.

@return

- (bool)supportsIce

Discussion

Gets a value indicating whether this SDP MediaDescription suggests support for ICE.

@return

Declared In

FMIceLinkSdpMediaDescription.h

– supportsRtcpMultiplexing

Gets a value stating whether this [media](#//api/name/media) [description](#//api/name/description) indicates RTCP Multiplexing support
- (bool)supportsRtcpMultiplexing

Discussion

Gets a value stating whether this [media](#//api/name/media) [description](#//api/name/description) indicates RTCP Multiplexing support

Declared In

FMIceLinkSdpMediaDescription.h

– updateQualityAttributeValueWithQuality:

Updates SDP Quality Attribute associated with this [media](#//api/name/media) [description](#//api/name/description) if one is present. Otherwise, creates a new one and inserts it into this [media](#//api/name/media) [description](#//api/name/description).

@param quality

- (void)updateQualityAttributeValueWithQuality:(int)quality

Discussion

Updates SDP Quality Attribute associated with this [media](#//api/name/media) [description](#//api/name/description) if one is present. Otherwise, creates a new one and inserts it into this [media](#//api/name/media) [description](#//api/name/description).

@param quality

Declared In

FMIceLinkSdpMediaDescription.h