Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OptionsAttribute

The "ice-options" attribute is a session-level attribute. It contains a series of tokens that identify the options supported by the agent.

Hierarchy

  • Attribute
    • OptionsAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

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

    Parameters

    • tags: Array<OptionTag>

      The tokens that identify options supported by the agent.

    Returns OptionsAttribute

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

    Returns OptionsAttribute

Properties

Private _tags

_tags: Array<OptionTag>
internal

Methods

getAttributeType

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

    Returns AttributeType

Protected getAttributeValue

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

    Returns string

getTags

  • getTags(): Array<OptionTag>
  • Gets the tokens that identify options supported by the agent.

    Returns Array<OptionTag>

getTrickleOptionSet

  • getTrickleOptionSet(): boolean
  • Gets a value indicating whether trickle-ice is supported.

    Returns boolean

getTypeString

  • getTypeString(): string

  • Returns string

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

Private setTags

  • setTags(value: Array<OptionTag>): void
  • internal

    Parameters

    • value: Array<OptionTag>

    Returns void

setTrickleOptionSet

  • setTrickleOptionSet(value: boolean): void
  • Sets a value indicating whether trickle-ice is supported.

    Parameters

    • value: boolean

    Returns void

toString

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

    Returns string

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): OptionsAttribute
  • Initializes a new instance of the fm.icelink.sdp.ice.optionsAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns OptionsAttribute

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