Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Attribute

The RTCP attribute is used to document the RTCP port used for media stream, when that port is not the next higher (odd) port number following the RTP port described in the media line.

Hierarchy

  • Attribute
    • Attribute

Index

Constructors

constructor

  • new Attribute(): Attribute
  • new Attribute(port: number, connectionAddress: string): Attribute
  • Initializes a new instance of the fm.icelink.sdp.rtcp.attribute class.

    Returns Attribute

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

    Parameters

    • port: number

      The RTCP port number.

    • connectionAddress: string

      The RTCP connection address.

    Returns Attribute

Properties

Private _addressType

_addressType: string
internal

Private _connectionAddress

_connectionAddress: string
internal

Private _networkType

_networkType: string
internal

Private _port

_port: number
internal

Methods

getAddressType

  • getAddressType(): string
  • Gets the type of the address. See fm.icelink.sdp.rtcp.attribute.addressType for possible values.

    Returns string

getAttributeType

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

    Returns AttributeType

Protected getAttributeValue

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

    Returns string

getConnectionAddress

  • getConnectionAddress(): string
  • Gets the RTCP connection address.

    Returns string

getNetworkType

  • getNetworkType(): string
  • Gets the type of network. See fm.icelink.sdp.rtcp.attribute.networkType for possible values.

    Returns string

getPort

  • getPort(): number
  • Gets the RTCP port number.

    Returns number

getTypeString

  • getTypeString(): string
  • Returns string

Private setAddressType

  • setAddressType(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

Private setConnectionAddress

  • setConnectionAddress(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setNetworkType

  • setNetworkType(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setPort

  • setPort(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

toString

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

    Returns string

update

  • update(port: number, connectionAddress: string): void
  • Updates the port and connection address.

    Parameters

    • port: number

      The port.

    • connectionAddress: string

      The connection address.

    Returns void

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

    Parameters

    • value: string

      The attribute value.

    Returns Attribute

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