Class FormatParametersAttribute

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.

Inheritance

System.Object

Attribute

FormatParametersAttribute

Inherited Members

Attribute.AttributeType

Attribute.MultiplexingCategory

Attribute.GetTypeName(Type)

Attribute.IsSessionLevel(Type)

Attribute.IsMediaLevel(Type)

Attribute.CreateAttribute(String, String)

Attribute.ToString()

Attribute.Parse(String)

Namespace: FM.LiveSwitch.Sdp

Assembly: FM.LiveSwitch.dll

Syntax

public class FormatParametersAttribute : Attribute

Constructors

FormatParametersAttribute(Int32)

Initializes a new instance of the FormatParametersAttribute class.

Declaration

public FormatParametersAttribute(int format)

Parameters

Type	Name	Description
System.Int32	format	The format.

FormatParametersAttribute(Int32, String)

Initializes a new instance of the FormatParametersAttribute class.

Declaration

public FormatParametersAttribute(int format, string formatSpecificParameters)

Parameters

Type	Name	Description
System.Int32	format	The format.
System.String	formatSpecificParameters	The format-specific parameters.

Properties

Format

Gets or sets the format.

Declaration

public int Format { get; set; }

Property Value

Type	Description
System.Int32

FormatSpecificParameters

Gets the format-specific parameters.

Declaration

public string FormatSpecificParameters { get; }

Property Value

Type	Description
System.String

Methods

DeserializeFormatSpecificParameters()

Creates a dictionary map from the format specific parameters.

Declaration

public Dictionary<string, string> DeserializeFormatSpecificParameters()

Returns

Type	Description
Dictionary<System.String, System.String>

FromAttributeValue(String)

Initializes a new instance of the FormatParametersAttribute class.

Declaration

public static FormatParametersAttribute FromAttributeValue(string value)

Parameters

Type	Name	Description
System.String	value	The attribute value.

Returns

Type	Description
FormatParametersAttribute

GetAttributeValue()

Gets the internal value of the attribute.

Declaration

protected override string GetAttributeValue()

Returns

Type	Description
System.String

Overrides

Attribute.GetAttributeValue()

GetFormatSpecificParameter(String)

Gets a format specific parameter.

Declaration

public string GetFormatSpecificParameter(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Returns

Type	Description
System.String

SerializeFormatSpecificParameters(Dictionary<String, String>)

Updates the format specific parameters based on a dictionary map.

Declaration

public void SerializeFormatSpecificParameters(Dictionary<string, string> map)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	map	The map.

SetFormatSpecificParameter(String, String)

Sets a format specific parameter.

Declaration

public void SetFormatSpecificParameter(string key, string value)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	value	The value.

TryGetFormatSpecificParameter(String, out String)

Tries to get a format specific parameter.

Declaration

public bool TryGetFormatSpecificParameter(string key, out string value)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	value	The value.

Returns

Type	Description
System.Boolean

UnsetFormatSpecificParameter(String)

Unsets a format specific parameter.

Declaration

public bool UnsetFormatSpecificParameter(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Returns

Type	Description
System.Boolean