FMLiveSwitchSdpFormatParametersAttribute Class Reference

This attribute allows parameters that are specific to a particular format to be conveyed in a way that SDP does not have to understand them. More...

Instance Methods
(NSMutableDictionary< NSString *, NSString * > *)	- deserializeFormatSpecificParameters
	Creates a dictionary map from the format specific parameters. More...
(int)	- format
	Gets the format. More...
(NSString *)	- formatSpecificParameters
	Gets the format-specific parameters. More...
(NSString *)	- getAttributeValue
	Gets the internal value of the attribute. More...
(NSString *)	- getFormatSpecificParameterWithKey:
	Gets a format specific parameter. More...
(instancetype)	- initWithFormat:
	Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class. More...
(instancetype)	- initWithFormat:formatSpecificParameters:
	Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class. More...
(void)	- serializeFormatSpecificParametersWithMap:
	Updates the format specific parameters based on a dictionary map. More...
(void)	- setFormat:
	Sets the format. More...
(void)	- setFormatSpecificParameterWithKey:value:
	Sets a format specific parameter. More...
(bool)	- tryGetFormatSpecificParameterWithKey:value:
	Tries to get a format specific parameter. More...
(bool)	- unsetFormatSpecificParameterWithKey:
	Unsets a format specific parameter. More...
Instance Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttributeType)	- attributeType
	Gets this Attribute's Type. More...
(NSString *)	- description
	Converts this instance to a string. More...
(instancetype)	- init
(FMLiveSwitchSdpAttributeCategory)	- multiplexingCategory
	Gets the Multiplexing Category of this Attribute. More...
(void)	- setAttributeType:
	Sets this Attribute's Type. More...
(void)	- setMultiplexingCategory:
	Sets the Multiplexing Category of this Attribute. More...

Class Methods
(FMLiveSwitchSdpFormatParametersAttribute *)	+ formatParametersAttributeWithFormat:
	Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class. More...
(FMLiveSwitchSdpFormatParametersAttribute *)	+ formatParametersAttributeWithFormat:formatSpecificParameters:
	Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class. More...
(FMLiveSwitchSdpFormatParametersAttribute *)	+ fromAttributeValue:
	Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class. More...
Class Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttribute *)	+ attribute
(FMLiveSwitchSdpAttribute *)	+ createAttributeWithName:value:
	Creates an attribute. More...
(NSString *)	+ getTypeNameWithType:
	Gets the name of the attribute type. More...
(bool)	+ isMediaLevelWithType:
	Determines whether the type applies to media streams. More...
(bool)	+ isSessionLevelWithType:
	Determines whether the type applies to sessions. More...
(FMLiveSwitchSdpAttribute *)	+ parseWithS:
	Creates an FMLiveSwitchSdpConnectionData instance from a string. More...

Detailed Description

This attribute allows parameters that are specific to a particular format to be conveyed in a way that SDP does not have to understand them.

The format must be one of the formats specified for the media. Format-specific parameters may be any set of parameters required to be conveyed by SDP and given unchanged to the media tool that will use this format. At most one instance of this attribute is allowed for each format.

Method Documentation

deserializeFormatSpecificParameters

- (NSMutableDictionary<NSString*,NSString*>*) deserializeFormatSpecificParameters

Creates a dictionary map from the format specific parameters.

format

- (int) format

Gets the format.

formatParametersAttributeWithFormat:

+ (FMLiveSwitchSdpFormatParametersAttribute*) formatParametersAttributeWithFormat:

(int)

format

Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class.

Parameters

format

The format.

formatParametersAttributeWithFormat:formatSpecificParameters:

+ (FMLiveSwitchSdpFormatParametersAttribute*) formatParametersAttributeWithFormat:		(int)	format
formatSpecificParameters:		(NSString *)	formatSpecificParameters

Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class.

Parameters

format	The format.
formatSpecificParameters	The format-specific parameters.

formatSpecificParameters

- (NSString*) formatSpecificParameters

Gets the format-specific parameters.

fromAttributeValue:

+ (FMLiveSwitchSdpFormatParametersAttribute*) fromAttributeValue:

(NSString *)

value

Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class.

Parameters

value

The attribute value.

getAttributeValue

- (NSString*) getAttributeValue

Gets the internal value of the attribute.

Implements FMLiveSwitchSdpAttribute.

getFormatSpecificParameterWithKey:

- (NSString*) getFormatSpecificParameterWithKey:

(NSString *)

key

Gets a format specific parameter.

Parameters

key

The key.

initWithFormat:

- (instancetype) initWithFormat:

(int)

format

Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class.

Parameters

format

The format.

initWithFormat:formatSpecificParameters:

- (instancetype) initWithFormat:		(int)	format
formatSpecificParameters:		(NSString *)	formatSpecificParameters

Initializes a new instance of the FMLiveSwitchSdpFormatParametersAttribute class.

Parameters

format	The format.
formatSpecificParameters	The format-specific parameters.

serializeFormatSpecificParametersWithMap:

- (void) serializeFormatSpecificParametersWithMap:

(NSMutableDictionary< NSString *, NSString * > *)

map

Updates the format specific parameters based on a dictionary map.

Parameters

map

The map.

setFormat:

- (void) setFormat:

(int)

value

Sets the format.

setFormatSpecificParameterWithKey:value:

- (void) setFormatSpecificParameterWithKey:		(NSString *)	key
value:		(NSString *)	value

Sets a format specific parameter.

Parameters

key	The key.
value	The value.

tryGetFormatSpecificParameterWithKey:value:

- (bool) tryGetFormatSpecificParameterWithKey:		(NSString *)	key
value:		(NSString **)	value

Tries to get a format specific parameter.

Parameters

key	The key.
value	The value.

unsetFormatSpecificParameterWithKey:

- (bool) unsetFormatSpecificParameterWithKey:

(NSString *)

key

Unsets a format specific parameter.

Parameters

key

The key.