Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeywordsAttribute

Like the cat attribute, this is to assist identifying wanted sessions at the receiver. This allows a receiver to select interesting session based on keywords describing the purpose of the session; there is no central registry of keywords. It is a session-level attribute. It is a charset-dependent attribute, meaning that its value should be interpreted in the charset specified for the session description if one is specified, or by default in ISO 10646/UTF-8.

Hierarchy

  • Attribute
    • KeywordsAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

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

    Parameters

    • keywords: string

      The keywords describing the purpose of the session.

    Returns KeywordsAttribute

Properties

Private _keywords

_keywords: string
internal

Methods

getAttributeType

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

    Returns AttributeType

Protected getAttributeValue

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

    Returns string

getKeywords

  • getKeywords(): string
  • Gets the keywords describing the purpose of the session.

    Returns string

getTypeString

  • getTypeString(): string

  • Returns string

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

Private setKeywords

  • setKeywords(value: string): void
  • internal

    Parameters

    • value: string

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

    Parameters

    • value: string

      The attribute value.

    Returns KeywordsAttribute

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