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

Public Member Functions
java.util.HashMap< String, String >	deserializeFormatSpecificParameters ()
	Creates a dictionary map from the format specific parameters. More...
	FormatParametersAttribute (int format)
	Initializes a new instance of the fm.liveswitch.sdp.FormatParametersAttribute class. More...
	FormatParametersAttribute (int format, String formatSpecificParameters)
	Initializes a new instance of the fm.liveswitch.sdp.FormatParametersAttribute class. More...
int	getFormat ()
	Gets the format. More...
String	getFormatSpecificParameter (String key)
	Gets a format specific parameter. More...
String	getFormatSpecificParameters ()
	Gets the format-specific parameters. More...
void	serializeFormatSpecificParameters (java.util.HashMap< String, String > map)
	Updates the format specific parameters based on a dictionary map. More...
void	setFormat (int value)
	Sets the format. More...
void	setFormatSpecificParameter (String key, String value)
	Sets a format specific parameter. More...
boolean	tryGetFormatSpecificParameter (String key, fm.liveswitch.Holder< String > value)
	Tries to get a format specific parameter. More...
boolean	unsetFormatSpecificParameter (String key)
	Unsets a format specific parameter. More...
Public Member Functions inherited from fm.liveswitch.sdp.Attribute
fm.liveswitch.sdp.AttributeType	getAttributeType ()
	Gets this Attribute's Type. More...
fm.liveswitch.sdp.AttributeCategory	getMultiplexingCategory ()
	Gets the Multiplexing Category of this Attribute. More...
void	setAttributeType (fm.liveswitch.sdp.AttributeType value)
	Sets this Attribute's Type. More...
String	toString ()
	Converts this instance to a string. More...

Static Public Member Functions
static fm.liveswitch.sdp.FormatParametersAttribute	fromAttributeValue (String value)
	Initializes a new instance of the fm.liveswitch.sdp.FormatParametersAttribute class. More...
Static Public Member Functions inherited from fm.liveswitch.sdp.Attribute
static fm.liveswitch.sdp.Attribute	createAttribute (String name, String value)
	Creates an attribute. More...
static String	getTypeName (@SuppressWarnings("rawtypes") Class type)
	Gets the name of the attribute type. More...
static boolean	isMediaLevel (@SuppressWarnings("rawtypes") Class type)
	Determines whether the type applies to media streams. More...
static boolean	isSessionLevel (@SuppressWarnings("rawtypes") Class type)
	Determines whether the type applies to sessions. More...
static fm.liveswitch.sdp.Attribute	parse (String s)
	Creates an fm.liveswitch.sdp.ConnectionData instance from a string. More...

Protected Member Functions
String	getAttributeValue ()
	Gets the internal value of the attribute. More...
Protected Member Functions inherited from fm.liveswitch.sdp.Attribute
	Attribute ()
void	setMultiplexingCategory (fm.liveswitch.sdp.AttributeCategory value)
	Sets the Multiplexing Category of this Attribute. 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.

Constructor & Destructor Documentation

FormatParametersAttribute() [1/2]

fm.liveswitch.sdp.FormatParametersAttribute.FormatParametersAttribute

(

int

format

)

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

Parameters

format

The format.

FormatParametersAttribute() [2/2]

fm.liveswitch.sdp.FormatParametersAttribute.FormatParametersAttribute	(	int	format,
		String	formatSpecificParameters
	)

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

Parameters

format	The format.
formatSpecificParameters	The format-specific parameters.

Member Function Documentation

deserializeFormatSpecificParameters()

java.util.HashMap<String,String> fm.liveswitch.sdp.FormatParametersAttribute.deserializeFormatSpecificParameters

(

)

Creates a dictionary map from the format specific parameters.

fromAttributeValue()

static fm.liveswitch.sdp.FormatParametersAttribute fm.liveswitch.sdp.FormatParametersAttribute.fromAttributeValue ( String  value )

static

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

Parameters

value

The attribute value.

getAttributeValue()

String fm.liveswitch.sdp.FormatParametersAttribute.getAttributeValue ( )

protected

Gets the internal value of the attribute.

Reimplemented from fm.liveswitch.sdp.Attribute.

getFormat()

int fm.liveswitch.sdp.FormatParametersAttribute.getFormat

(

)

Gets the format.

getFormatSpecificParameter()

String fm.liveswitch.sdp.FormatParametersAttribute.getFormatSpecificParameter

(

String

key

)

Gets a format specific parameter.

Parameters

key

The key.

getFormatSpecificParameters()

String fm.liveswitch.sdp.FormatParametersAttribute.getFormatSpecificParameters

(

)

Gets the format-specific parameters.

serializeFormatSpecificParameters()

void fm.liveswitch.sdp.FormatParametersAttribute.serializeFormatSpecificParameters

(

java.util.HashMap< String, String >

map

)

Updates the format specific parameters based on a dictionary map.

Parameters

map

The map.

setFormat()

void fm.liveswitch.sdp.FormatParametersAttribute.setFormat

(

int

value

)

Sets the format.

setFormatSpecificParameter()

void fm.liveswitch.sdp.FormatParametersAttribute.setFormatSpecificParameter	(	String	key,
		String	value
	)

Sets a format specific parameter.

Parameters

key	The key.
value	The value.

tryGetFormatSpecificParameter()

boolean fm.liveswitch.sdp.FormatParametersAttribute.tryGetFormatSpecificParameter	(	String	key,
		fm.liveswitch.Holder< String >	value
	)

Tries to get a format specific parameter.

Parameters

key	The key.
value	The value.

unsetFormatSpecificParameter()

boolean fm.liveswitch.sdp.FormatParametersAttribute.unsetFormatSpecificParameter

(

String

key

)

Unsets a format specific parameter.

Parameters

key

The key.