/ fm / liveswitch / sdp / FormatParametersAttribute

Class: FormatParametersAttribute

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

Hierarchy

• Attribute

  ↳ FormatParametersAttribute

Table of contents

Constructors

• constructor

Methods

• deserializeFormatSpecificParameters
• fmliveswitchsdpFormatParametersAttributeInit
• getAttributeType
• getAttributeValue
• getFormat
• getFormatSpecificParameter
• getFormatSpecificParameters
• getMultiplexingCategory
• getTypeString
• serializeFormatSpecificParameters
• setAttributeType
• setFormat
• setFormatSpecificParameter
• setMultiplexingCategory
• toString
• tryGetFormatSpecificParameter
• unsetFormatSpecificParameter
• createAttribute
• fromAttributeValue
• getTypeName
• isMediaLevel
• isSessionLevel
• parse

Constructors

constructor

+ new FormatParametersAttribute(): FormatParametersAttribute

Returns: FormatParametersAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:27

+ new FormatParametersAttribute(format: number): FormatParametersAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.formatParametersAttribute]] class.

Parameters:

Name	Type	Description
format	number	The format.

Returns: FormatParametersAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:28

+ new FormatParametersAttribute(format: number, formatSpecificParameters: string): FormatParametersAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.formatParametersAttribute]] class.

Parameters:

Name	Type	Description
format	number	The format.
formatSpecificParameters	string	The format-specific parameters.

Returns: FormatParametersAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:35

Methods

deserializeFormatSpecificParameters

▸ deserializeFormatSpecificParameters(): Hash<string, string>

Creates a dictionary map from the format specific parameters.

Returns: Hash<string, string>

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:115

---

fmliveswitchsdpFormatParametersAttributeInit

▸ PrivatefmliveswitchsdpFormatParametersAttributeInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:24

---

getAttributeType

▸ getAttributeType(): AttributeType

Gets this Attribute's Type.

Returns: AttributeType

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:582

---

getAttributeValue

▸ ProtectedgetAttributeValue(): string

Gets the internal value of the attribute.

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:141

---

getFormat

▸ getFormat(): number

Gets the format.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:157

---

getFormatSpecificParameter

▸ getFormatSpecificParameter(key: string): string

Gets a format specific parameter.

Parameters:

Name	Type	Description
key	string	The key.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:170

---

getFormatSpecificParameters

▸ getFormatSpecificParameters(): string

Gets the format-specific parameters.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:182

---

getMultiplexingCategory

▸ getMultiplexingCategory(): AttributeCategory

Gets the Multiplexing Category of this Attribute.

Returns: AttributeCategory

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:600

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:16

---

serializeFormatSpecificParameters

▸ serializeFormatSpecificParameters(map: Hash<string, string>): void

Updates the format specific parameters based on a dictionary map.

Parameters:

Name	Type	Description
map	Hash<string, string>	The map.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:195

---

setAttributeType

▸ setAttributeType(value: AttributeType): void

Sets this Attribute's Type.

Parameters:

Name	Type
value	AttributeType

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:612

---

setFormat

▸ setFormat(value: number): void

Sets the format.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:215

---

setFormatSpecificParameter

▸ setFormatSpecificParameter(key: string, value: string): void

Sets a format specific parameter.

Parameters:

Name	Type	Description
key	string	The key.
value	string	The value.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:230

---

setMultiplexingCategory

▸ ProtectedsetMultiplexingCategory(value: AttributeCategory): void

Sets the Multiplexing Category of this Attribute.

Parameters:

Name	Type
value	AttributeCategory

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:624

---

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:636

---

tryGetFormatSpecificParameter

▸ tryGetFormatSpecificParameter(key: string, value: Holder<string>): boolean

Tries to get a format specific parameter.

Parameters:

Name	Type	Description
key	string	The key.
value	Holder<string>	The value.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:254

---

unsetFormatSpecificParameter

▸ unsetFormatSpecificParameter(key: string): boolean

Unsets a format specific parameter.

Parameters:

Name	Type	Description
key	string	The key.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:270

---

createAttribute

▸ StaticcreateAttribute(name: string, value: string): Attribute

Creates an attribute.

Parameters:

Name	Type	Description
name	string	The name.
value	string	The value.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:42

---

fromAttributeValue

▸ StaticfromAttributeValue(value: string): FormatParametersAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.formatParametersAttribute]] class.

Parameters:

Name	Type	Description
value	string	The attribute value.

Returns: FormatParametersAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/FormatParametersAttribute.ts:97

---

getTypeName

▸ StaticgetTypeName(type: Type): string

Gets the name of the attribute type.

Parameters:

Name	Type	Description
type	Type	The attribute type.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:467

---

isMediaLevel

▸ StaticisMediaLevel(type: Type): boolean

Determines whether the type applies to media streams.

Parameters:

Name	Type	Description
type	Type	The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:492

---

isSessionLevel

▸ StaticisSessionLevel(type: Type): boolean

Determines whether the type applies to sessions.

Parameters:

Name	Type	Description
type	Type	The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:516

---

parse

▸ Staticparse(s: string): Attribute

Creates an [[fm.liveswitch.sdp.connectionData]] instance from a string.

Parameters:

Name	Type	Description
s	string	The string to parse.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:540