Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • Attribute
    • FormatParametersAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.sdp.formatParametersAttribute class.

    Parameters

    • format: number

      The format.

    Returns FormatParametersAttribute

  • Initializes a new instance of the fm.icelink.sdp.formatParametersAttribute class.
    Initializes a new instance of the fm.icelink.sdp.formatParametersAttribute class.

    Returns FormatParametersAttribute

  • Initializes a new instance of the fm.icelink.sdp.formatParametersAttribute class.

    Parameters

    • format: number

      The format.

    • formatSpecificParameters: string

      The format-specific parameters.

    Returns FormatParametersAttribute

Properties

Private _format

_format: number
internal

Private _formatSpecificParameters

_formatSpecificParameters: string
internal

Methods

deserializeFormatSpecificParameters

  • deserializeFormatSpecificParameters(): Hash<string, string>
  • Creates a dictionary map from the format specific parameters.

    Returns Hash<string, string>

getAttributeType

  • getAttributeType(): AttributeType
  • Gets this Attribute's Type.

    Returns AttributeType

Protected getAttributeValue

  • getAttributeValue(): string
  • Gets the internal value of the attribute.

    Returns string

getFormat

  • getFormat(): number
  • Gets the format.

    Returns number

getFormatSpecificParameter

  • getFormatSpecificParameter(key: string): string
  • Gets a format specific parameter.

    Parameters

    • key: string

      The key.

    Returns string

getFormatSpecificParameters

  • getFormatSpecificParameters(): string
  • Gets the format-specific parameters.

    Returns string

getTypeString

  • getTypeString(): string

  • Returns string

serializeFormatSpecificParameters

  • serializeFormatSpecificParameters(map: Hash<string, string>): void
  • Updates the format specific parameters based on a dictionary map.

    Parameters

    • map: Hash<string, string>

      The map.

    Returns void

setAttributeType

  • setAttributeType(value: AttributeType): void
  • Sets this Attribute's Type.

    Parameters

    • value: AttributeType

    Returns void

Private setFormat

  • setFormat(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setFormatSpecificParameter

  • setFormatSpecificParameter(key: string, value: string): void
  • Sets a format specific parameter.

    Parameters

    • key: string

      The key.

    • value: string

      The value.

    Returns void

Private setFormatSpecificParameters

  • setFormatSpecificParameters(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

toString

  • toString(): string
  • Converts this instance to a string.

    Returns string

tryGetFormatSpecificParameter

  • tryGetFormatSpecificParameter(key: string, value: Holder<string>): boolean
  • Tries to get a format specific parameter.

    Parameters

    • key: string

      The key.

    • value: Holder<string>

      The value.

    Returns boolean

unsetFormatSpecificParameter

  • unsetFormatSpecificParameter(key: string): boolean
  • Unsets a format specific parameter.

    Parameters

    • key: string

      The key.

    Returns boolean

Static createAttribute

  • createAttribute(name: string, value: string): Attribute
  • Creates an attribute.

    Parameters

    • name: string

      The name.

    • value: string

      The value.

    Returns Attribute

Static fromAttributeValue

  • fromAttributeValue(value: string): FormatParametersAttribute
  • Initializes a new instance of the fm.icelink.sdp.formatParametersAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns FormatParametersAttribute

Static getTypeName

  • getTypeName(type: Type): string
  • Gets the name of the attribute type.

    Parameters

    • type: Type

      The attribute type.

    Returns string

Static isMediaLevel

  • isMediaLevel(type: Type): boolean
  • Determines whether the type applies to media streams.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static isSessionLevel

  • isSessionLevel(type: Type): boolean
  • Determines whether the type applies to sessions.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static parse

  • parse(s: string): Attribute
  • Creates an fm.icelink.sdp.connectionData instance from a string.

    Parameters

    • s: string

      The string to parse.

    Returns Attribute